com.graphaware.tx.event.improved.data.filtered

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

java.lang.Object

com.graphaware.tx.event.improved.data.filtered.FilteredEntityTransactionData<T>

Direct Known Subclasses:

FilteredNodeTransactionData, FilteredRelationshipTransactionData

public abstract class FilteredEntityTransactionData<T extends org.neo4j.graphdb.Entity>
extends Object

Decorator of EntityTransactionData that filters out Entitys and properties based on provided EntityInclusionPolicy and PropertyInclusionPolicy.

Results of most methods returning Collections and Maps will be filtered. boolean and single object returning methods (and propertiesOfDeletedEntity(org.neo4j.graphdb.Entity) will always return the full truth no matter the policies. All returned Entitys will be wrapped in FilteredEntity.

So for example:

getAllCreated() can return 5 objects, but hasBeenCreated(org.neo4j.graphdb.Entity) can return true for more of them, as it ignores the filtering.

When traversing the graph using an object returned by this API (such as FilteredNode), nodes, properties, and relationships not included by the InclusionPolicies will be excluded. The only exception to this are relationship start and end nodes - they are returned even if they would normally be filtered out. This is a design decision in order to honor the requirement that relationships must have start and end node.

Field Summary

Fields

Modifier and Type	Field and Description
protected InclusionPolicies	policies

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	FilteredEntityTransactionData(InclusionPolicies policies) Construct filtered entity transaction data.

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.
protected Collection<Change<T>>	filterChangedEntities(Collection<Change<T>> toFilter) Filter changed entities according to provided policies.
protected abstract T	filtered(T original) Create a filtered instance of a entity.
protected Change<T>	filteredChange(Change<T> change) Make both objects contained in the changed object filtered.
protected Collection<T>	filterEntities(Collection<T> toFilter) Filter entities according to provided EntityInclusionPolicy.
protected <V> Map<String,V>	filterProperties(Map<String,V> properties, T entity) Filter properties according to provided PropertyInclusionPolicy.
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.
protected abstract EntityInclusionPolicy<T>	getEntityInclusionPolicy() Get entity inclusion policy for the appropriate entity.
protected abstract PropertyInclusionPolicy<T>	getPropertyInclusionPolicy() Get property inclusion policy for the appropriate entity.
protected abstract EntityTransactionData<T>	getWrapped() Get the wrapped/decorated EntityTransactionData.
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.
protected boolean	hasChanged(Change<T> candidate)
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.

Methods inherited from class java.lang.Object

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

Field Detail

policies

protected final InclusionPolicies policies

Constructor Detail

FilteredEntityTransactionData

protected FilteredEntityTransactionData(InclusionPolicies policies)

Construct filtered entity transaction data.

Parameters:

policies - for filtering.

Method Detail

getWrapped

protected abstract EntityTransactionData<T> getWrapped()

Get the wrapped/decorated EntityTransactionData.

Returns:

wrapped object.

getEntityInclusionPolicy

protected abstract EntityInclusionPolicy<T> getEntityInclusionPolicy()

Get entity inclusion policy for the appropriate entity.

Returns:

policy.

getPropertyInclusionPolicy

protected abstract PropertyInclusionPolicy<T> getPropertyInclusionPolicy()

Get property inclusion policy for the appropriate entity.

Returns:

policy.

filtered

protected abstract T filtered(T original)

Create a filtered instance of a entity.

Parameters:

original - instance to be wrapped in the filtering decorator.

Returns:

filtered instance.

hasBeenCreated

public 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. Full truth, no filtering performed.

getAllCreated

public Collection<T> getAllCreated()

Get all entities created in the transaction.

Returns:

read-only collection of all created entities. Filtered according to provided policies.

hasBeenDeleted

public 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. Full truth, no filtering performed.

getDeleted

public 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. Filtering not applied on retrieving the object, but the result is decorated by a FilteredEntity.

Throws:

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

getAllDeleted

public 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). Filtered according to provided policies.

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.

Parameters:

entity - to check.

Returns:

true iff the entity has been changed. Full truth, no filtering performed.

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.

Parameters:

entity - to get.

Returns:

snapshot of the entity before the transaction started and the current state of the entity. Filtering not applied on retrieving the object, but the result is decorated by a FilteredEntity.

Throws:

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

getAllChanged

public 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. Filtered according to provided policies.

hasPropertyBeenCreated

public 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. Full truth, no filtering performed.

createdProperties

public 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. Filtered according to provided PropertyInclusionPolicy. Compliance with the EntityInclusionPolicy is not verified.

hasPropertyBeenDeleted

public 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. Full truth, no filtering performed.

deletedProperties

public 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. Filtered according to provided PropertyInclusionPolicy. Compliance with the EntityInclusionPolicy is not verified.

propertiesOfDeletedEntity

public 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. Full truth, no filtering performed (because this is a Neo4j API workaround, not available through the public API (api package)).

hasPropertyBeenChanged

public 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. Full truth, no filtering performed.

changedProperties

public 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. Filtered according to provided PropertyInclusionPolicy. Compliance with the EntityInclusionPolicy is not verified.

filterEntities

protected final Collection<T> filterEntities(Collection<T> toFilter)

Filter entities according to provided EntityInclusionPolicy.

Parameters:

toFilter - entities to filter.

Returns:

filtered entities.

filterChangedEntities

protected final Collection<Change<T>> filterChangedEntities(Collection<Change<T>> toFilter)

Filter changed entities according to provided policies. Only those complying with the provided EntityInclusionPolicy with at least one property created, deleted, or changed that complies with the provided PropertyInclusionPolicy will be returned.

Parameters:

toFilter - changed entities to filter.

Returns:

filtered changed entities.

hasChanged

protected boolean hasChanged(Change<T> candidate)

filterProperties

protected final <V> Map<String,V> filterProperties(Map<String,V> properties,
                                                   T entity)

Filter properties according to provided PropertyInclusionPolicy. EntityInclusionPolicy is ignored!

Type Parameters:

V - property value type.

Parameters:

properties - to filter.

entity - to which the properties belong.

Returns:

filtered properties.

filteredChange

protected final Change<T> filteredChange(Change<T> change)

Make both objects contained in the changed object filtered.

Parameters:

change - to decorate with filtering entities.

Returns:

decorated change.