com.amazon.carbonado.layout
Interface StoredLayoutProperty

All Superinterfaces:

Storable<StoredLayoutProperty>, Unevolvable

@AlternateKeys(value=@Key(value={"layoutID","propertyName"}))
@PrimaryKey(value={"layoutID","ordinal"})
@Independent
@Alias(value="CARBONADO_LAYOUT_PROPERTY")
public interface StoredLayoutProperty
extends Storable<StoredLayoutProperty>, Unevolvable

Stored property joined to a StoredLayout, which is used internally by LayoutProperty. This interface is public only because Carbonado requires storable type definitions to be public.

Author:

Brian S O'Neill

Method Summary

String	getAdapterParams() Parameters for adapter, or null if property has no explicit adapter.
String	getAdapterTypeName() Adapter type name is a fully qualified Java class name.
byte[]	getExtraData() Since this record cannot evolve, this property allows it to be extended without conflicting with existing records.
long	getLayoutID()
int	getOrdinal() Ordinal defines the order in which this property appears in it enclosing layout.
String	getPropertyName()
String	getPropertyTypeDescriptor() Property type descriptor is a Java type descriptor.
int	getVersionNumber() Record version number for this StoredPropertyLayout instance.
boolean	isNullable() Returns true of property value can be set to null.
boolean	isPrimaryKeyMember() Returns true if property is a member of the primary key.
boolean	isVersion() Returns true if this property is the designated version number for the Storable.
void	setAdapterParams(String params)
void	setAdapterTypeName(String name)
void	setExtraData(byte[] data)
void	setLayoutID(long typeID)
void	setNullable(boolean nullable)
void	setOrdinal(int ordinal)
void	setPrimaryKeyMember(boolean pk)
void	setPropertyName(String name)
void	setPropertyTypeDescriptor(String type)
void	setVersion(boolean version)
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)

getOrdinal

int getOrdinal()

Ordinal defines the order in which this property appears in it enclosing layout.

setOrdinal

void setOrdinal(int ordinal)

getPropertyName

String getPropertyName()

setPropertyName

void setPropertyName(String name)

getPropertyTypeDescriptor

String getPropertyTypeDescriptor()

Property type descriptor is a Java type descriptor.

setPropertyTypeDescriptor

void setPropertyTypeDescriptor(String type)

isNullable

boolean isNullable()

Returns true of property value can be set to null.

setNullable

void setNullable(boolean nullable)

isPrimaryKeyMember

boolean isPrimaryKeyMember()

Returns true if property is a member of the primary key.

setPrimaryKeyMember

void setPrimaryKeyMember(boolean pk)

isVersion

boolean isVersion()

Returns true if this property is the designated version number for the Storable.

setVersion

void setVersion(boolean version)

getAdapterTypeName

@Nullable
String getAdapterTypeName()

Adapter type name is a fully qualified Java class name. If property has no adapter, then null is returned.

setAdapterTypeName

void setAdapterTypeName(String name)

getAdapterParams

@Nullable
String getAdapterParams()

Parameters for adapter, or null if property has no explicit adapter.

setAdapterParams

void setAdapterParams(String params)

getVersionNumber

@Version
int getVersionNumber()

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