agi.foundation.tracking

(agi.foundation.tracking-2025r1.jar)

Class EntityFilterChain<TEntity extends IEntityIdentifier>

java.lang.Object

agi.foundation.infrastructure.DefinitionalObject

agi.foundation.tracking.EntityFilterChain<TEntity>

Type Parameters:

TEntity - The type of entity.

All Implemented Interfaces:

ICloneWithContext, IEnumerateDependencies, IEquatableDefinition, IFreezable

public class EntityFilterChain<TEntity extends IEntityIdentifier>
extends DefinitionalObject

Groups entities into EntitySets with a series of filters.

See Also:

Filtering topic

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	EntityFilterChain(EntityFilterChain<TEntity> existingInstance, CopyContext context) Initializes a new instance as a copy of an existing instance.
	EntityFilterChain(EntitySet<TEntity> inputEntities, MatchingStrategy matchingStrategy) Initializes a new instance using the provided EntitySet and value indicating if entities should be matched against multiple filters.

Method Summary

Modifier and Type	Method and Description
void	applyChanges() Applies any changes so that they take effect the next time EntityFilterChain.redistributeEntities() is invoked.
protected boolean	checkForSameDefinition(DefinitionalObject other) Checks to determine if another instance has the same definition as this instance and returns true if it does.
protected boolean	checkForSameDefinition(EntityFilterChain<TEntity> other) Checks to determine if another instance has the same definition as this instance and returns true if it does.
Object	clone(CopyContext context) Clones this object using the specified context.
protected int	computeCurrentDefinitionHashCode() Computes a hash code based on the current properties of this object.
EntityFilterCollection<TEntity>	getFilters() Gets the list of filters being managed by this chain.
EntitySet<TEntity>	getHomelessEntities() Gets the set of entities that do not match any of the filters in the chain.
EntitySet<TEntity>	getInputEntities() Gets the input entity set being filtered.
MatchingStrategy	getMatchingStrategy() Gets the MatchingStrategy used to place entities into the Filters (get) collection.
void	redistributeEntities() Redistributes all entities in InputEntities (get / set) among the specified Filters (get) using a new Transaction.
void	redistributeEntities(Transaction transaction) Redistributes all entities in InputEntities (get / set) among the specified Filters (get) using the provided Transaction.
void	setInputEntities(EntitySet<TEntity> value) Sets the input entity set being filtered.
void	setMatchingStrategy(MatchingStrategy value) Sets the MatchingStrategy used to place entities into the Filters (get) collection.

Methods inherited from class agi.foundation.infrastructure.DefinitionalObject

areSameDefinition, areSameDefinition, areSameDefinition, areSameDefinition, areSameDefinition, collectionItemsAreSameDefinition, collectionItemsAreSameDefinition, collectionItemsAreSameDefinition, dictionaryItemsAreSameDefinition, enumerateDependencies, freeze, freezeAggregatedObjects, getCollectionHashCode, getCollectionHashCode, getCollectionHashCode, getDefinitionHashCode, getDefinitionHashCode, getDefinitionHashCode, getDefinitionHashCode, getDefinitionHashCode, getDefinitionHashCode, getDictionaryHashCode, getIsFrozen, isSameDefinition, throwIfFrozen

Methods inherited from class java.lang.Object

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

Constructor Detail

EntityFilterChain

public EntityFilterChain(@Nonnull
                         EntitySet<TEntity> inputEntities,
                         @Nonnull
                         MatchingStrategy matchingStrategy)

Initializes a new instance using the provided EntitySet and value indicating if entities should be matched against multiple filters.

Parameters:

inputEntities - The entity set to be processed.

matchingStrategy - The entity matching strategy to be used.

EntityFilterChain

protected EntityFilterChain(@Nonnull
                            EntityFilterChain<TEntity> existingInstance,
                            @Nonnull
                            CopyContext context)

Initializes a new instance as a copy of an existing instance.

See ICloneWithContext.clone(CopyContext) for more information about how to implement this constructor in a derived class.

Parameters:

existingInstance - The existing instance to copy.

context - A CopyContext that controls the depth of the copy.

Throws:

ArgumentNullException - Thrown when existingInstance or context is null.

Method Detail

clone

public Object clone(CopyContext context)

Clones this object using the specified context.

This method should be implemented to call a copy constructor on the class of the object being cloned. The copy constructor should take the CopyContext as a parameter in addition to the existing instance to copy. The copy constructor should first call CopyContext.addObjectMapping(T, T) to identify the newly constructed instance as a copy of the existing instance. It should then copy all fields, using CopyContext.updateReference(T) to copy any reference fields.

A typical implementation of ICloneWithContext:

public static class MyClass implements ICloneWithContext {
    public MyClass(MyClass existingInstance, CopyContext context) {
        context.addObjectMapping(existingInstance, this);
        someReference = context.updateReference(existingInstance.someReference);
    }

    @Override
    public final Object clone(CopyContext context) {
        return new MyClass(this, context);
    }

    private Object someReference;
}

In general, all fields that are reference types should be copied with a call to CopyContext.updateReference(T). There are a couple of exceptions:

1. Fields that are aggregate parts of the object should always be copied. A referenced object is an aggregate if properties or methods on the object being copied can modify the externally-visible value of the referenced object.
2. If the semantics of the referenced object require that it have a single parent, owner, context, etc., and the object being copied is that parent, owner, or context, then the referenced object should always be copied.

If one of these exceptions applies, the CopyContext should be given an opportunity to update the reference before the reference is copied explicitly. Use CopyContext.updateReference(T) to update the reference. If CopyContext.updateReference(T) returns the original object, indicating that the context does not have a replacement registered, then copy the object manually by invoking a Clone method, a copy constructor, or by manually constructing a new instance and copying the values.

alwaysCopy = context.updateReference(existingInstance.alwaysCopy);
if (existingInstance.alwaysCopy != null && alwaysCopy == existingInstance.alwaysCopy) {
    alwaysCopy = (AlwaysCopy) existingInstance.alwaysCopy.clone(context);
}

If you are implementing an evaluator (a class that implements IEvaluator), the IEvaluator.updateEvaluatorReferences(agi.foundation.infrastructure.CopyContext) method shares some responsibilities with the copy context constructor. Code duplication can be avoided by doing the following:

1. For references to other evaluators ONLY, simply assign the reference in the constructor instead of calling CopyContext.updateReference(T). You should still call CopyContext.updateReference(T) on any references to non-evaluators.
2. Call IEvaluator.updateEvaluatorReferences(agi.foundation.infrastructure.CopyContext) as the last line in the constructor and pass it the same CopyContext passed to the constructor.
3. Implement IEvaluator.updateEvaluatorReferences(agi.foundation.infrastructure.CopyContext) as normal. See the reference documentation for IEvaluator.updateEvaluatorReferences(agi.foundation.infrastructure.CopyContext) for more information on implementing that method.

public MyClass(MyClass existingInstance, CopyContext context) {
    super(existingInstance, context);
    someReference = context.updateReference(existingInstance.someReference);
    evaluatorReference = existingInstance.evaluatorReference;
    updateEvaluatorReferences(context);
}

@Override
public void updateEvaluatorReferences(CopyContext context) {
    evaluatorReference = context.updateReference(evaluatorReference);
}

@Override
public Object clone(CopyContext context) {
    return new MyClass(this, context);
}

private Object someReference;
private IEvaluator evaluatorReference;

Specified by:

clone in interface ICloneWithContext

Specified by:

clone in class DefinitionalObject

Parameters:

context - The context to use to perform the copy.

Returns:

A new instance which is a copy of this object.

checkForSameDefinition

protected final boolean checkForSameDefinition(DefinitionalObject other)

Checks to determine if another instance has the same definition as this instance and returns true if it does. Derived classes MUST override this method and check all new fields introduced by the derived class for definitional equivalence. It is NOT necessary to check base class fields because the base class will already have done that. When overriding this method, you should NOT call the base implementation because it will return false for all derived-class instances. Derived classes should check the type of other to preserve the symmetric nature of IEquatableDefinition.isSameDefinition(java.lang.Object).

Specified by:

checkForSameDefinition in class DefinitionalObject

Parameters:

other - The other instance to compare to this one.

Returns:

true if the two objects are defined equivalently; otherwise false.

checkForSameDefinition

protected boolean checkForSameDefinition(EntityFilterChain<TEntity> other)

Checks to determine if another instance has the same definition as this instance and returns true if it does. Derived classes MUST override this method and check all new fields introduced by the derived class for definitional equivalence. It is NOT necessary to check base class fields because the base class will already have done that. When overriding this method, you should NOT call the base implementation because it will return false for all derived-class instances. Derived classes should check the type of other to preserve the symmetric nature of IEquatableDefinition.isSameDefinition(java.lang.Object).

Parameters:

other - The other instance to compare to this one.

Returns:

true if the two objects are defined equivalently; otherwise false.

computeCurrentDefinitionHashCode

protected int computeCurrentDefinitionHashCode()

Computes a hash code based on the current properties of this object. Derived classes MUST override this method and compute a hash code that combines: a unique hash code seed, the base implementation result, and the hash codes of all new fields introduced by the derived class which are used in the EntityFilterChain.checkForSameDefinition(agi.foundation.infrastructure.DefinitionalObject) method.

Overrides:

computeCurrentDefinitionHashCode in class DefinitionalObject

Returns:

The computed hash code.

getInputEntities

public final EntitySet<TEntity> getInputEntities()

Gets the input entity set being filtered. After setting this property, you must call EntityFilterChain.applyChanges() in order for the change to take effect.

setInputEntities

public final void setInputEntities(EntitySet<TEntity> value)

Sets the input entity set being filtered. After setting this property, you must call EntityFilterChain.applyChanges() in order for the change to take effect.

getMatchingStrategy

@Nonnull
public final MatchingStrategy getMatchingStrategy()

Gets the MatchingStrategy used to place entities into the Filters (get) collection. You must call EntityFilterChain.applyChanges() in order for the change to take effect.

setMatchingStrategy

public final void setMatchingStrategy(@Nonnull
                                      MatchingStrategy value)

Sets the MatchingStrategy used to place entities into the Filters (get) collection. You must call EntityFilterChain.applyChanges() in order for the change to take effect.

getFilters

public final EntityFilterCollection<TEntity> getFilters()

Gets the list of filters being managed by this chain. After changing this collection, you must call EntityFilterChain.applyChanges() in order for the changes to take effect.

getHomelessEntities

public final EntitySet<TEntity> getHomelessEntities()

Gets the set of entities that do not match any of the filters in the chain.

applyChanges

public final void applyChanges()

Applies any changes so that they take effect the next time EntityFilterChain.redistributeEntities() is invoked. It is necessary to call this method after setting the InputEntities (get / set) and MatchingStrategy (get / set) properties and after modifying the Filters (get) collection.

redistributeEntities

public final void redistributeEntities(@Nonnull
                                       Transaction transaction)

Redistributes all entities in InputEntities (get / set) among the specified Filters (get) using the provided Transaction.

Parameters:

transaction - The transaction to be used to match entities.

redistributeEntities

public final void redistributeEntities()

Redistributes all entities in InputEntities (get / set) among the specified Filters (get) using a new Transaction.