agi.foundation.segmentpropagation

(agi.foundation.segmentpropagation-2024r2.jar)

Class TargetedSegmentList

java.lang.Object

agi.foundation.infrastructure.DefinitionalObject

agi.foundation.segmentpropagation.SegmentDefinition

agi.foundation.segmentpropagation.SegmentList

agi.foundation.segmentpropagation.TargetedSegmentList

All Implemented Interfaces:

ICloneWithContext, IEnumerateDependencies, IEquatableDefinition, IFreezable

public class TargetedSegmentList
extends SegmentList

A SegmentList that can control and change properties of the segments it is propagating by using operators at propagation time.

The results returned when this segments propagator is propagated will always be and can be safely cast as a TargetedSegmentListResults.

Constructor Summary

Constructors

Modifier	Constructor and Description
	TargetedSegmentList() Initializes a new instance.
protected	TargetedSegmentList(TargetedSegmentList existingInstance, CopyContext context) Initializes a new instance as a copy of an existing instance.

Method Summary

Modifier and Type	Method and Description
void	addPropagationFinishedEvent(EventHandler<SegmentPropagationEventArgs> value) An event that gets raised when propagation is complete.
protected boolean	checkForSameDefinition(SegmentList other) Checks to determine if another instance has the same definition as this instance and returns true if it does.
protected boolean	checkForSameDefinition(TargetedSegmentList 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.
protected SegmentPropagator	createSegmentPropagator(EvaluatorGroup group, SegmentDefinition previousSegment) Creates, configures, and returns the SegmentPropagator for this segment.
void	enumerateDependencies(DependencyEnumerator enumerator) Enumerates the dependencies of this object by calling DependencyEnumerator#enumerate(T) for each object that this object directly depends upon.
protected void	freezeAggregatedObjects() Called by DefinitionalObject.freeze() to also freeze any objects that are considered to be a part of this object.
boolean	getContinueIfOperatorsDoNotConverge() Gets a value indicating whether the next operator should continue if the operators do not converge.
TargetedSegmentListOperatorConvergenceBehavior	getConvergenceBehavior() Gets the behavior that should be done when an operators converges.
TargetedSegmentListOperatorBehavior	getOperatorAction() Gets how the propagator will run the operators (will the operators be run normally, be run once, or just run the nominal sequence).
List<TargetedSegmentListOperator>	getOperators() Gets the operators that this segment will run.
boolean	getResetBetweenRuns() Gets a value indicating whether or not this TargetedSegmentList should be reset at the start of every run initiated by this segments parent.
void	removePropagationFinishedEvent(EventHandler<SegmentPropagationEventArgs> value) An event that gets raised when propagation is complete.
void	setContinueIfOperatorsDoNotConverge(boolean value) Sets a value indicating whether the next operator should continue if the operators do not converge.
void	setConvergenceBehavior(TargetedSegmentListOperatorConvergenceBehavior value) Sets the behavior that should be done when an operators converges.
void	setOperatorAction(TargetedSegmentListOperatorBehavior value) Sets how the propagator will run the operators (will the operators be run normally, be run once, or just run the nominal sequence).
void	setResetBetweenRuns(boolean value) Sets a value indicating whether or not this TargetedSegmentList should be reset at the start of every run initiated by this segments parent.

Methods inherited from class agi.foundation.segmentpropagation.SegmentList

checkForSameDefinition, getElementAdapter, getElements, getFirstSegmentDefinitionByName, getSegmentListPropagator, getSegmentListPropagator, getSegmentListPropagator, getSegmentListPropagator, getSegments, getSegmentToInitializeNextSegmentWith

Methods inherited from class agi.foundation.segmentpropagation.SegmentDefinition

checkForSameDefinition, containsElement, getDefinedIn, getName, getNextStateBehavior, getPassAllElementsToNextSegment, getPropagationDirection, getSegmentPropagator, getSegmentPropagator, getSegmentPropagator, getSegmentPropagator, removeElement, setElementAndAdapter, setName, setNextStateBehavior, setPropagationDirection, toString

Methods inherited from class agi.foundation.infrastructure.DefinitionalObject

areSameDefinition, areSameDefinition, areSameDefinition, areSameDefinition, areSameDefinition, collectionItemsAreSameDefinition, collectionItemsAreSameDefinition, collectionItemsAreSameDefinition, dictionaryItemsAreSameDefinition, freeze, 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, wait, wait, wait

Constructor Detail

TargetedSegmentList

public TargetedSegmentList()

Initializes a new instance. At least one SegmentDefinition must be added to Segments (get), and at least one operator must be added to the Operators (get).

TargetedSegmentList

protected TargetedSegmentList(@Nonnull
                              TargetedSegmentList 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

Overrides:

clone in class SegmentList

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(SegmentList 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).

Overrides:

checkForSameDefinition in class SegmentList

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(TargetedSegmentList 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 TargetedSegmentList.checkForSameDefinition(agi.foundation.segmentpropagation.SegmentList) method.

Overrides:

computeCurrentDefinitionHashCode in class SegmentList

Returns:

The computed hash code.

enumerateDependencies

public void enumerateDependencies(DependencyEnumerator enumerator)

Enumerates the dependencies of this object by calling DependencyEnumerator#enumerate(T) for each object that this object directly depends upon. Derived classes which contain additional dependencies MUST override this method, call the base implementation, and enumerate dependencies introduced by the derived class.

Specified by:

enumerateDependencies in interface IEnumerateDependencies

Overrides:

enumerateDependencies in class SegmentList

Parameters:

enumerator - The enumerator that is informed of the dependencies of this object.

freezeAggregatedObjects

protected void freezeAggregatedObjects()

Called by DefinitionalObject.freeze() to also freeze any objects that are considered to be a part of this object. Derived classes which contain additional aggregated objects MUST override this method, call the base implementation, and freeze aggregated objects introduced by the derived class. The objects that need to be frozen in this method are frequently created in this object's constructor and are not settable via properties.

Overrides:

freezeAggregatedObjects in class SegmentList

getOperators

@Nonnull
public final List<TargetedSegmentListOperator> getOperators()

Gets the operators that this segment will run. Operators will in some way edit the segments configuration which will affect the propagation. The operators will be run in series, the modified segments of one passed into the next.

getContinueIfOperatorsDoNotConverge

public final boolean getContinueIfOperatorsDoNotConverge()

Gets a value indicating whether the next operator should continue if the operators do not converge. If set to true, the next operators will continue to run as if it did converge. If false, a property on the results will be set to indicate that all propagation should stop and the results will be returned.

setContinueIfOperatorsDoNotConverge

public final void setContinueIfOperatorsDoNotConverge(boolean value)

Sets a value indicating whether the next operator should continue if the operators do not converge. If set to true, the next operators will continue to run as if it did converge. If false, a property on the results will be set to indicate that all propagation should stop and the results will be returned.

getOperatorAction

@Nonnull
public final TargetedSegmentListOperatorBehavior getOperatorAction()

Gets how the propagator will run the operators (will the operators be run normally, be run once, or just run the nominal sequence).

setOperatorAction

public final void setOperatorAction(@Nonnull
                                    TargetedSegmentListOperatorBehavior value)

Sets how the propagator will run the operators (will the operators be run normally, be run once, or just run the nominal sequence).

getConvergenceBehavior

@Nonnull
public final TargetedSegmentListOperatorConvergenceBehavior getConvergenceBehavior()

Gets the behavior that should be done when an operators converges.

setConvergenceBehavior

public final void setConvergenceBehavior(@Nonnull
                                         TargetedSegmentListOperatorConvergenceBehavior value)

Sets the behavior that should be done when an operators converges.

getResetBetweenRuns

public final boolean getResetBetweenRuns()

Gets a value indicating whether or not this TargetedSegmentList should be reset at the start of every run initiated by this segments parent. This is most relevant when this TargetedSegmentList is a child segment of another TargetedSegmentList. This should be set to true if your initial configuration is a better guess than this segments previous run. This is false by default.

setResetBetweenRuns

public final void setResetBetweenRuns(boolean value)

Sets a value indicating whether or not this TargetedSegmentList should be reset at the start of every run initiated by this segments parent. This is most relevant when this TargetedSegmentList is a child segment of another TargetedSegmentList. This should be set to true if your initial configuration is a better guess than this segments previous run. This is false by default.

createSegmentPropagator

protected SegmentPropagator createSegmentPropagator(EvaluatorGroup group,
                                                    SegmentDefinition previousSegment)

Creates, configures, and returns the SegmentPropagator for this segment. This method should check that all of the required properties on the concrete instance are configured properly before constructing the SegmentPropagator to be returned.

Overrides:

createSegmentPropagator in class SegmentList

Parameters:

group - The group to use during creation.

previousSegment - The previous segment. Some segments will require the previousSegment to be set, whereas other will require that the previous segment not be null, whereas others will only use information from it if provided. It is up to you writing a concrete type to enforce what makes sense for your particular segment in this method.

Returns:

The propagator for this segment.

addPropagationFinishedEvent

public void addPropagationFinishedEvent(EventHandler<SegmentPropagationEventArgs> value)

An event that gets raised when propagation is complete.

Overrides:

addPropagationFinishedEvent in class SegmentList

removePropagationFinishedEvent

public void removePropagationFinishedEvent(EventHandler<SegmentPropagationEventArgs> value)

An event that gets raised when propagation is complete.

Overrides:

removePropagationFinishedEvent in class SegmentList