com.graphaware.tx.event.improved.data.lazy

Class LazyEntityTransactionData<T extends org.neo4j.graphdb.Entity>

java.lang.Object

com.graphaware.tx.event.improved.data.lazy.LazyEntityTransactionData<T>

Type Parameters:

T - type of the entity.

All Implemented Interfaces:

EntityTransactionData<T>

Direct Known Subclasses:

LazyNodeTransactionData, LazyRelationshipTransactionData

public abstract class LazyEntityTransactionData<T extends org.neo4j.graphdb.Entity>
extends Object
implements EntityTransactionData<T>

EntityTransactionData that lazily initializes its internal structures (indexed transaction data) as they are needed by callers to prevent unnecessary overheads.

Constructor Summary

Constructors

Constructor and Description
LazyEntityTransactionData()

Method Summary

Modifier and Type	Method and Description
protected abstract Iterable<org.neo4j.graphdb.event.PropertyEntry<T>>	assignedProperties() Get all assigned properties from the Neo4j API.
protected boolean	changedContainsKey(T candidate)
Map<String,Change<Object>>	changedProperties(T entity) Get properties changed in the transaction.
protected Change<T>	createChangeObject(T candidate)
protected abstract Iterable<T>	created() Get all entities created in the transaction from the Neo4j API.
Map<String,Object>	createdProperties(T entity) Get properties created in the transaction.
protected abstract Iterable<T>	deleted() Get all entities deleted in the transaction from the Neo4j API.
Map<String,Object>	deletedProperties(T entity) Get properties deleted in the transaction.
protected void	doInitializeChanged()
Collection<Change<T>>	getAllChanged() Get all entities changed in the transaction.
Collection<T>	getAllCreated() Get all entities created in the transaction.
Collection<T>	getAllDeleted() Get all entities deleted in the transaction as they were before the transaction started.
Change<T>	getChanged(T entity) Get a entity that has been changed in this transaction as it was before the transaction started and as it is now.
T	getDeleted(T entity) Get a entity that has been deleted in this transaction as it was before the transaction started.
boolean	hasBeenChanged(T entity) Check whether a entity has been changed in the transaction, i.e.
boolean	hasBeenCreated(T entity) Check whether the given entity has been created in the transaction.
boolean	hasBeenDeleted(T entity) Check whether the given entity has been deleted in the transaction.
boolean	hasPropertyBeenChanged(T entity, String key) Check whether a property has been changed in the transaction.
boolean	hasPropertyBeenCreated(T entity, String key) Check whether a property has been created in the transaction.
boolean	hasPropertyBeenDeleted(T entity, String key) Check whether a property has been deleted in the transaction.
protected void	initializeChanged()
protected abstract T	newSnapshot(T original) Create a new snapshot of an original entity.
protected abstract T	oldSnapshot(T original) Create an old snapshot of an original entity.
Map<String,Object>	propertiesOfDeletedEntity(T entity) Get properties of a deleted entity.
protected void	registerChange(T candidate)
protected abstract Iterable<org.neo4j.graphdb.event.PropertyEntry<T>>	removedProperties() Get all removed properties from the Neo4j API.

Methods inherited from class java.lang.Object

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

Constructor Detail

LazyEntityTransactionData

public LazyEntityTransactionData()

Method Detail

oldSnapshot

protected abstract T oldSnapshot(T original)

Create an old snapshot of an original entity.

Parameters:

original - to create a snapshot from.

Returns:

the snapshot.

newSnapshot

protected abstract T newSnapshot(T original)

Create a new snapshot of an original entity.

Parameters:

original - to create a snapshot from.

Returns:

the snapshot.

hasBeenCreated

public boolean hasBeenCreated(T entity)

Check whether the given entity has been created in the transaction.

Specified by:

hasBeenCreated in interface EntityTransactionData<T extends org.neo4j.graphdb.Entity>

Parameters:

entity - to check.

Returns:

true iff the entity has been created.

getAllCreated

public Collection<T> getAllCreated()

Get all entities created in the transaction.

Specified by:

getAllCreated in interface EntityTransactionData<T extends org.neo4j.graphdb.Entity>

Returns:

read-only collection of all created entities.

created

protected abstract Iterable<T> created()

Get all entities created in the transaction from the Neo4j API.

Returns:

created entities.

hasBeenDeleted

public boolean hasBeenDeleted(T entity)

Check whether the given entity has been deleted in the transaction.

Specified by:

hasBeenDeleted in interface EntityTransactionData<T extends org.neo4j.graphdb.Entity>

Parameters:

entity - to check.

Returns:

true iff the entity has been deleted.

getDeleted

public T getDeleted(T entity)

Get a entity that has been deleted in this transaction as it was before the transaction started.

Specified by:

getDeleted in interface EntityTransactionData<T extends org.neo4j.graphdb.Entity>

Parameters:

entity - to get.

Returns:

snapshot of the entity before the transaction started.

getAllDeleted

public Collection<T> getAllDeleted()

Get all entities deleted in the transaction as they were before the transaction started.

Specified by:

getAllDeleted in interface EntityTransactionData<T extends org.neo4j.graphdb.Entity>

Returns:

read-only collection of all deleted entities as they were before the transaction started (snapshots).

deleted

protected abstract Iterable<T> deleted()

Get all entities deleted in the transaction from the Neo4j API.

Returns:

created entities.

hasBeenChanged

public boolean hasBeenChanged(T entity)

Check whether a entity has been changed in the transaction, i.e. if any of its properties have been changed.

Specified by:

hasBeenChanged in interface EntityTransactionData<T extends org.neo4j.graphdb.Entity>

Parameters:

entity - to check.

Returns:

true iff the entity has been changed.

getChanged

public Change<T> getChanged(T entity)

Get a entity that has been changed in this transaction as it was before the transaction started and as it is now.

Specified by:

getChanged in interface EntityTransactionData<T extends org.neo4j.graphdb.Entity>

Parameters:

entity - to get.

Returns:

snapshot of the entity before the transaction started and the current state of the entity.

getAllChanged

public Collection<Change<T>> getAllChanged()

Get all entities changed in the transaction.

Specified by:

getAllChanged in interface EntityTransactionData<T extends org.neo4j.graphdb.Entity>

Returns:

a read-only collection of all changed entities as they were before the transaction started and as they are now.

initializeChanged

protected void initializeChanged()

doInitializeChanged

protected void doInitializeChanged()

registerChange

protected void registerChange(T candidate)

changedContainsKey

protected boolean changedContainsKey(T candidate)

createChangeObject

protected Change<T> createChangeObject(T candidate)

assignedProperties

protected abstract Iterable<org.neo4j.graphdb.event.PropertyEntry<T>> assignedProperties()

Get all assigned properties from the Neo4j API.

Returns:

assigned properties.

removedProperties

protected abstract Iterable<org.neo4j.graphdb.event.PropertyEntry<T>> removedProperties()

Get all removed properties from the Neo4j API.

Returns:

removed properties.

hasPropertyBeenCreated

public boolean hasPropertyBeenCreated(T entity,
                                      String key)

Check whether a property has been created in the transaction.

Specified by:

hasPropertyBeenCreated in interface EntityTransactionData<T extends org.neo4j.graphdb.Entity>

Parameters:

entity - to check.

key - of the property to check.

Returns:

true iff the property has been created.

createdProperties

public Map<String,Object> createdProperties(T entity)

Get properties created in the transaction.

Specified by:

createdProperties in interface EntityTransactionData<T extends org.neo4j.graphdb.Entity>

Parameters:

entity - for which to get created properties.

Returns:

read-only properties created for the given entity.

hasPropertyBeenDeleted

public boolean hasPropertyBeenDeleted(T entity,
                                      String key)

Check whether a property has been deleted in the transaction.

Specified by:

hasPropertyBeenDeleted in interface EntityTransactionData<T extends org.neo4j.graphdb.Entity>

Parameters:

entity - to check.

key - of the property to check.

Returns:

true iff the property has been deleted.

deletedProperties

public Map<String,Object> deletedProperties(T entity)

Get properties deleted in the transaction.

Specified by:

deletedProperties in interface EntityTransactionData<T extends org.neo4j.graphdb.Entity>

Parameters:

entity - for which to get deleted properties.

Returns:

read-only properties deleted for the given entity, where the value is the property value before the transaction started.

propertiesOfDeletedEntity

public Map<String,Object> propertiesOfDeletedEntity(T entity)

Get properties of a deleted entity.

Specified by:

propertiesOfDeletedEntity in interface EntityTransactionData<T extends org.neo4j.graphdb.Entity>

Parameters:

entity - deleted entity.

Returns:

read-only properties of the deleted entity, where the value is the property value before the transaction started.

hasPropertyBeenChanged

public boolean hasPropertyBeenChanged(T entity,
                                      String key)

Check whether a property has been changed in the transaction.

Specified by:

hasPropertyBeenChanged in interface EntityTransactionData<T extends org.neo4j.graphdb.Entity>

Parameters:

entity - to check.

key - of the property to check.

Returns:

true iff the property has been changed.

changedProperties

public Map<String,Change<Object>> changedProperties(T entity)

Get properties changed in the transaction.

Specified by:

changedProperties in interface EntityTransactionData<T extends org.neo4j.graphdb.Entity>

Parameters:

entity - for which to get changed properties.

Returns:

read-only properties changed for the given entity, where the value is the property value before and after the transaction started, respectively.