StorageEntity (MicroStream API)

All Known Implementing Classes:

StorageEntity.Default
```
public interface StorageEntity
```
Public API level type of a storage entity. Used for custom evaluators, filters, etc. Does intentionally not provide any means to load/access the entity's data or change any if its state. This is purely a querying interface, not a means to manipulate data via bypassing normal channels to do so.

Nested Class Summary

Nested Classes
Modifier and Type Interface and Description

static class StorageEntity.Default

static class StorageEntity.MaxObjectId

static class StorageEntity.MinObjectId

Nested Classes
Modifier and Type	Interface and Description
`static class`	`StorageEntity.Default`
`static class`	`StorageEntity.MaxObjectId`
`static class`	`StorageEntity.MinObjectId`

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method and Description
`long`	`cachedDataLength()` The length this entity occupies in the cache.
`long`	`clearCache()`
`void`	`copyCachedData(MemoryRangeReader entityDataCollector)`
`long`	`dataLength()`
`long`	`exportTo(one.microstream.afs.types.AWritableFile file)`
`boolean`	`hasReferences()`
`boolean`	`iterateReferenceIds(one.microstream.persistence.types.PersistenceObjectIdAcceptor referenceIdIterator)`
`long`	`lastTouched()` The approximate system time that this particular entity has been last touched.
`long`	`objectId()`
`StorageLiveDataFile`	`storageFile()`
`long`	`storagePosition()`
`long`	`typeId()`

- Method Detail
  - dataLength
```
long dataLength()
```
    Returns:
    
    The entity's data length, meaning the pure content length without any header or meta data.
  - typeId
```
long typeId()
```
    Returns:
    
    The entity's type id.
  - objectId
```
long objectId()
```
    Returns:
    
    The entity's biunique identifying id number.
  - hasReferences
```
boolean hasReferences()
```
    Returns:
    
    The information if this entity's type has reference fields (regardless of a particular entity's actual data).
  - cachedDataLength
```
long cachedDataLength()
```
    The length this entity occupies in the cache. This might be vary, even for fixed length typed, from the values returned by dataLength() as only parts of an entity (e.g. only references) might be loaded into cache and because the cache might hold the header/meta data of an entity as well.
    
    Returns:
    
    The length this entity occupies in the cache.
  - lastTouched
```
long lastTouched()
```
    The approximate system time that this particular entity has been last touched. The returned value is compatible to the value returned by System.currentTimeMillis().
    
    Returns:
    
    approximate system time that this particular entity has been last touched
  - storagePosition
```
long storagePosition()
```
  - storageFile
```
StorageLiveDataFile storageFile()
```
  - copyCachedData
```
void copyCachedData(MemoryRangeReader entityDataCollector)
```
  - clearCache
```
long clearCache()
```
  - iterateReferenceIds
```
boolean iterateReferenceIds(one.microstream.persistence.types.PersistenceObjectIdAcceptor referenceIdIterator)
```
  - exportTo
```
long exportTo(one.microstream.afs.types.AWritableFile file)
```

Interface StorageEntity

Nested Class Summary

Method Summary

Method Detail

dataLength

typeId

objectId

hasReferences

cachedDataLength

lastTouched

storagePosition

storageFile

copyCachedData

clearCache

iterateReferenceIds

exportTo