com.amazon.carbonado.layout

Interface StoredLayout

All Superinterfaces:

Storable<StoredLayout>, Unevolvable

@AlternateKeys(value=@Key(value={"storableTypeName","generation"}))
@PrimaryKey(value="layoutID")
@Independent
@Alias(value="CARBONADO_LAYOUT")
public interface StoredLayout
extends Storable<StoredLayout>, Unevolvable

Stored information regarding the layout of a Storable type, which is used internally by Layout. This interface is public only because Carbonado requires storable type definitions to be public.

Author:

Brian S O'Neill

Method Summary

Methods

Modifier and Type	Method and Description
java.lang.String	getCreationHost() Returns the host machine that created this generation.
long	getCreationTimestamp() Returns the milliseconds from 1970-01-01T00:00:00Z when this record was created.
java.lang.String	getCreationUser() Returns the user that created this generation.
byte[]	getExtraData() Since this record cannot evolve, this property allows it to be extended without conflicting with existing records.
int	getGeneration() Generation of storable, where 0 represents the first generation.
long	getLayoutID()
java.lang.String	getStorableTypeName() Storable type name is a fully qualified Java class name.
int	getVersionNumber() Record version number for this StoredTypeLayout instance.
void	setCreationHost(java.lang.String host)
void	setCreationTimestamp(long timestamp)
void	setCreationUser(java.lang.String user)
void	setExtraData(byte[] data)
void	setGeneration(int generation)
void	setLayoutID(long typeID)
void	setStorableTypeName(java.lang.String typeName)
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

getLayoutID

long getLayoutID()

setLayoutID

void setLayoutID(long typeID)

getStorableTypeName

java.lang.String getStorableTypeName()

Storable type name is a fully qualified Java class name.

setStorableTypeName

void setStorableTypeName(java.lang.String typeName)

getGeneration

int getGeneration()

Generation of storable, where 0 represents the first generation.

setGeneration

void setGeneration(int generation)

getCreationTimestamp

long getCreationTimestamp()

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

setCreationTimestamp

void setCreationTimestamp(long timestamp)

getCreationUser

@Nullable
java.lang.String getCreationUser()

Returns the user that created this generation.

setCreationUser

void setCreationUser(java.lang.String user)

getCreationHost

@Nullable
java.lang.String getCreationHost()

Returns the host machine that created this generation.

setCreationHost

void setCreationHost(java.lang.String host)

getVersionNumber

@Version
int getVersionNumber()

Record version number for this StoredTypeLayout 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)