com.graphaware.tx.event.improved.data

Interface EntityTransactionData<T extends org.neo4j.graphdb.Entity>

Type Parameters:

T - type of the entity.

All Known Subinterfaces:

NodeTransactionData, RelationshipTransactionData

All Known Implementing Classes:

FilteredNodeTransactionData, FilteredRelationshipTransactionData, LazyEntityTransactionData, LazyNodeTransactionData, LazyRelationshipTransactionData

public interface EntityTransactionData<T extends org.neo4j.graphdb.Entity>

An alternative API to TransactionData for Entitys.

Method Summary

Modifier and Type	Method and Description
Map<String,Change<Object>>	changedProperties(T entity) Get properties changed in the transaction.
Map<String,Object>	createdProperties(T entity) Get properties created in the transaction.
Map<String,Object>	deletedProperties(T entity) Get properties deleted in the transaction.
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.
Map<String,Object>	propertiesOfDeletedEntity(T entity) Get properties of a deleted entity.

Method Detail

hasBeenCreated

boolean hasBeenCreated(T entity)

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

Parameters:

entity - to check.

Returns:

true iff the entity has been created.

getAllCreated

Collection<T> getAllCreated()

Get all entities created in the transaction.

Returns:

read-only collection of all created entities.

hasBeenDeleted

boolean hasBeenDeleted(T entity)

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

Parameters:

entity - to check.

Returns:

true iff the entity has been deleted.

getDeleted

T getDeleted(T entity)

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

Parameters:

entity - to get.

Returns:

snapshot of the entity before the transaction started.

Throws:

IllegalArgumentException - in case the given entity has not been deleted in the transaction.

getAllDeleted

Collection<T> getAllDeleted()

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

Returns:

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

hasBeenChanged

boolean hasBeenChanged(T entity)

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

Parameters:

entity - to check.

Returns:

true iff the entity has been changed.

getChanged

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.

Parameters:

entity - to get.

Returns:

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

Throws:

IllegalArgumentException - in case the given entity has not been changed in the transaction.

getAllChanged

Collection<Change<T>> getAllChanged()

Get all entities changed in the transaction.

Returns:

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

hasPropertyBeenCreated

boolean hasPropertyBeenCreated(T entity,
                               String key)

Check whether a property has been created in the transaction.

Parameters:

entity - to check.

key - of the property to check.

Returns:

true iff the property has been created.

createdProperties

Map<String,Object> createdProperties(T entity)

Get properties created in the transaction.

Parameters:

entity - for which to get created properties.

Returns:

read-only properties created for the given entity.

hasPropertyBeenDeleted

boolean hasPropertyBeenDeleted(T entity,
                               String key)

Check whether a property has been deleted in the transaction.

Parameters:

entity - to check.

key - of the property to check.

Returns:

true iff the property has been deleted.

deletedProperties

Map<String,Object> deletedProperties(T entity)

Get properties deleted in the transaction.

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

Map<String,Object> propertiesOfDeletedEntity(T entity)

Get properties of a deleted 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

boolean hasPropertyBeenChanged(T entity,
                               String key)

Check whether a property has been changed in the transaction.

Parameters:

entity - to check.

key - of the property to check.

Returns:

true iff the property has been changed.

changedProperties

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

Get properties changed in the transaction.

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.