com.amazon.carbonado.repo.indexed

Interface StoredIndexInfo

All Superinterfaces:

Storable, Unevolvable, Unindexed

@PrimaryKey(value="indexName")
@Independent
@Alias(value="CARBONADO_INDEX_INFO")
public interface StoredIndexInfo
extends Storable, Unevolvable, Unindexed

Stores basic information about the indexes managed by IndexedRepository.

Note: This storable cannot have indexes defined, since it is used to discover information about indexes. It would create a cyclic dependency.

Author:

Brian S O'Neill

Method Summary

Methods

Modifier and Type	Method and Description
long	getCreationTimestamp() Returns the milliseconds from 1970-01-01T00:00:00Z when this record was created.
byte[]	getExtraData() Since this record cannot evolve, this property allows it to be extended without conflicting with existing records.
java.lang.String	getIndexName() Returns the index name, which is also a valid index name descriptor.
java.lang.String	getIndexTypeDescriptor() Returns the types of the index properties.
int	getVersionNumber() Record version number for this StoredIndexInfo instance.
void	setCreationTimestamp(long timestamp)
void	setExtraData(byte[] data)
void	setIndexName(java.lang.String name)
void	setIndexTypeDescriptor(java.lang.String descriptor)
void	setVersionNumber(int version)

Methods inherited from interface com.amazon.carbonado.Storable

copy, copyAllProperties, copyDirtyProperties, copyPrimaryKeyProperties, copyUnequalProperties, copyVersionProperty, delete, equalPrimaryKeys, equalProperties, equals, getPropertyValue, hasDirtyProperties, hashCode, insert, isPropertyClean, isPropertyDirty, isPropertySupported, isPropertyUninitialized, load, markAllPropertiesClean, markAllPropertiesDirty, markPropertiesClean, markPropertiesDirty, prepare, propertyMap, readFrom, setPropertyValue, storableType, toString, toStringKeyOnly, tryDelete, tryInsert, tryLoad, tryUpdate, update, writeTo

Method Detail

getIndexName

java.lang.String getIndexName()

Returns the index name, which is also a valid index name descriptor. This descriptor is defined by StorableIndex. The name descriptor does not contain type information.

setIndexName

void setIndexName(java.lang.String name)

getIndexTypeDescriptor

@Nullable
java.lang.String getIndexTypeDescriptor()

Returns the types of the index properties. This descriptor is defined by StorableIndex.

setIndexTypeDescriptor

void setIndexTypeDescriptor(java.lang.String descriptor)

getCreationTimestamp

long getCreationTimestamp()

Returns the milliseconds from 1970-01-01T00:00:00Z when this record was created.

setCreationTimestamp

void setCreationTimestamp(long timestamp)

getVersionNumber

@Version
int getVersionNumber()

Record version number for this StoredIndexInfo instance. Some encoding strategies require a version number.

setVersionNumber

void setVersionNumber(int version)

getExtraData

@Nullable
byte[] getExtraData()

Since this record cannot evolve, this property allows it to be extended without conflicting with existing records. This record cannot evolve because an evolution strategy likely depends on this interface remaining stable, avoiding a cyclic dependency.

setExtraData

void setExtraData(byte[] data)