org.apache.polygene.spi.entitystore

Class DefaultEntityStoreUnitOfWork

java.lang.Object

org.apache.polygene.spi.entitystore.DefaultEntityStoreUnitOfWork

All Implemented Interfaces:

EntityStoreUnitOfWork

public final class DefaultEntityStoreUnitOfWork
extends Object
implements EntityStoreUnitOfWork

Default EntityStore UnitOfWork.

Constructor Summary

Constructors

Constructor and Description
DefaultEntityStoreUnitOfWork(ModuleDescriptor module, EntityStoreSPI entityStoreSPI, Identity identity, Usecase usecase, Instant currentTime)

Method Summary

Modifier and Type	Method and Description
StateCommitter	applyChanges()
Instant	currentTime()
void	discard()
EntityState	entityStateOf(ModuleDescriptor module, EntityReference anIdentity) Get the EntityState for a given reference.
Identity	identity()
ModuleDescriptor	module()
EntityState	newEntityState(EntityReference anIdentity, EntityDescriptor descriptor) Create new EntityState for a given reference.
Usecase	usecase()
String	versionOf(EntityReference anIdentity)

Methods inherited from class java.lang.Object

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

Constructor Detail

DefaultEntityStoreUnitOfWork

public DefaultEntityStoreUnitOfWork(ModuleDescriptor module,
                                    EntityStoreSPI entityStoreSPI,
                                    Identity identity,
                                    Usecase usecase,
                                    Instant currentTime)

Method Detail

identity

public Identity identity()

Specified by:

identity in interface EntityStoreUnitOfWork

currentTime

public Instant currentTime()

Specified by:

currentTime in interface EntityStoreUnitOfWork

usecase

public Usecase usecase()

Specified by:

usecase in interface EntityStoreUnitOfWork

module

public ModuleDescriptor module()

Specified by:

module in interface EntityStoreUnitOfWork

newEntityState

public EntityState newEntityState(EntityReference anIdentity,
                                  EntityDescriptor descriptor)
                           throws EntityStoreException

Description copied from interface: EntityStoreUnitOfWork

Create new EntityState for a given reference.

This should only create the EntityState and not insert it into any database, since that should occur during the EntityStoreUnitOfWork.applyChanges() call.

Specified by:

newEntityState in interface EntityStoreUnitOfWork

Parameters:

anIdentity - the reference of the entity

descriptor - entity descriptor

Returns:

The new entity state.

Throws:

EntityStoreException - Thrown if creational fails.

entityStateOf

public EntityState entityStateOf(ModuleDescriptor module,
                                 EntityReference anIdentity)
                          throws EntityNotFoundException

Description copied from interface: EntityStoreUnitOfWork

Get the EntityState for a given reference. Throws EntityNotFoundException if the entity with given anIdentity is not found.

Specified by:

entityStateOf in interface EntityStoreUnitOfWork

Parameters:

module - Module descriptor

anIdentity - The entity reference. This argument must not be null.

Returns:

Entity state given the composite descriptor and reference.

Throws:

EntityNotFoundException - if requested entity does not exist

versionOf

public String versionOf(EntityReference anIdentity)
                 throws EntityNotFoundException

Specified by:

versionOf in interface EntityStoreUnitOfWork

Throws:

EntityNotFoundException

applyChanges

public StateCommitter applyChanges()
                            throws EntityStoreException

Specified by:

applyChanges in interface EntityStoreUnitOfWork

Throws:

EntityStoreException

discard

public void discard()

Specified by:

discard in interface EntityStoreUnitOfWork