org.apache.polygene.spi.entitystore.helpers

Class DefaultEntityState

java.lang.Object

org.apache.polygene.spi.entitystore.helpers.DefaultEntityState

All Implemented Interfaces:

EntityState

public final class DefaultEntityState
extends Object
implements EntityState

Standard implementation of EntityState.

Constructor Summary

Constructors

Constructor and Description
DefaultEntityState(Instant currentTime, EntityReference reference, EntityDescriptor entityDescriptor)
DefaultEntityState(String version, Instant lastModified, EntityReference reference, EntityStatus status, EntityDescriptor entityDescriptor, Map<QualifiedName,Object> properties, Map<QualifiedName,EntityReference> associations, Map<QualifiedName,List<EntityReference>> manyAssociations, Map<QualifiedName,Map<String,EntityReference>> namedAssociations)

Method Summary

Modifier and Type	Method and Description
Map<QualifiedName,EntityReference>	associations()
EntityReference	associationValueOf(QualifiedName stateName)
void	copyTo(DefaultEntityState entityState)
EntityDescriptor	entityDescriptor()
EntityReference	entityReference() Returns the reference of the entity that this EntityState represents.
boolean	isAssignableTo(Class<?> type)
Instant	lastModified() Last modified timestamp of the entity.
Map<QualifiedName,List<EntityReference>>	manyAssociations()
ManyAssociationState	manyAssociationValueOf(QualifiedName stateName)
void	markUpdated()
Map<QualifiedName,Map<String,EntityReference>>	namedAssociations()
NamedAssociationState	namedAssociationValueOf(QualifiedName stateName)
Map<QualifiedName,Object>	properties()
Object	propertyValueOf(QualifiedName stateName)
void	remove() Remove the entity represented by this EntityState when the unit of work is completed.
void	setAssociationValue(QualifiedName stateName, EntityReference newEntity)
void	setPropertyValue(QualifiedName stateName, Object newValue)
EntityStatus	status() The status of this EntityState
String	toString()
String	version() Version of the entity.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

DefaultEntityState

public DefaultEntityState(Instant currentTime,
                          EntityReference reference,
                          EntityDescriptor entityDescriptor)

DefaultEntityState

public DefaultEntityState(String version,
                          Instant lastModified,
                          EntityReference reference,
                          EntityStatus status,
                          EntityDescriptor entityDescriptor,
                          Map<QualifiedName,Object> properties,
                          Map<QualifiedName,EntityReference> associations,
                          Map<QualifiedName,List<EntityReference>> manyAssociations,
                          Map<QualifiedName,Map<String,EntityReference>> namedAssociations)

Method Detail

version

public final String version()

Description copied from interface: EntityState

Version of the entity. This is managed by the EntityStore.

If the underlying EntityStore does not support versioning, then version must always be set to 0.

Specified by:

version in interface EntityState

Returns:

version of the entity

lastModified

public Instant lastModified()

Description copied from interface: EntityState

Last modified timestamp of the entity. This is managed by the EntityStore.

If the underlying EntityStore does not support timestamping, then last modified must always be set to the current time.

Specified by:

lastModified in interface EntityState

Returns:

last modified timestamp of the entity, as defined by SystemTime.now()

entityReference

public EntityReference entityReference()

Description copied from interface: EntityState

Returns the reference of the entity that this EntityState represents.

Specified by:

entityReference in interface EntityState

Returns:

the reference of the entity that this EntityState represents.

propertyValueOf

public Object propertyValueOf(QualifiedName stateName)

Specified by:

propertyValueOf in interface EntityState

setPropertyValue

public void setPropertyValue(QualifiedName stateName,
                             Object newValue)

Specified by:

setPropertyValue in interface EntityState

associationValueOf

public EntityReference associationValueOf(QualifiedName stateName)

Specified by:

associationValueOf in interface EntityState

setAssociationValue

public void setAssociationValue(QualifiedName stateName,
                                EntityReference newEntity)

Specified by:

setAssociationValue in interface EntityState

manyAssociationValueOf

public ManyAssociationState manyAssociationValueOf(QualifiedName stateName)

Specified by:

manyAssociationValueOf in interface EntityState

namedAssociationValueOf

public NamedAssociationState namedAssociationValueOf(QualifiedName stateName)

Specified by:

namedAssociationValueOf in interface EntityState

copyTo

public void copyTo(DefaultEntityState entityState)

remove

public void remove()

Description copied from interface: EntityState

Remove the entity represented by this EntityState when the unit of work is completed.

Specified by:

remove in interface EntityState

status

public EntityStatus status()

Description copied from interface: EntityState

The status of this EntityState

Specified by:

status in interface EntityState

Returns:

the status

isAssignableTo

public boolean isAssignableTo(Class<?> type)

Specified by:

isAssignableTo in interface EntityState

entityDescriptor

public EntityDescriptor entityDescriptor()

Specified by:

entityDescriptor in interface EntityState

properties

public Map<QualifiedName,Object> properties()

associations

public Map<QualifiedName,EntityReference> associations()

manyAssociations

public Map<QualifiedName,List<EntityReference>> manyAssociations()

namedAssociations

public Map<QualifiedName,Map<String,EntityReference>> namedAssociations()

toString

public String toString()

Overrides:

toString in class Object

markUpdated

public void markUpdated()