agi.foundation.segmentpropagation

(agi.foundation.segmentpropagation-2023r1.jar)

Class SingleValueStateUpdater

java.lang.Object

agi.foundation.infrastructure.DefinitionalObject

agi.foundation.segmentpropagation.StateUpdaterDefinition

agi.foundation.segmentpropagation.SingleValueStateUpdater

All Implemented Interfaces:

ICloneWithContext, IEnumerateDependencies, IEquatableDefinition, IFreezable

public class SingleValueStateUpdater
extends StateUpdaterDefinition

Updates the propagated state where a single value will change a value or values in the state. This can add the single value to a scalar, or multiple several values in the state by the single value, or set a value in the state to a specific value. The single value is a value that a variable in a TargetedSegmentListDifferentialCorrector can edit.

Constructor Summary

Constructors

Modifier	Constructor and Description
	SingleValueStateUpdater() Initializes a new instance.
	SingleValueStateUpdater(Scalar value, SingleValueUpdaterCallback callback) Initializes a new instance.
protected	SingleValueStateUpdater(SingleValueStateUpdater existingInstance, CopyContext context) Initializes a new instance as a copy of an existing instance.

Method Summary

Modifier and Type	Method and Description
protected boolean	checkForSameDefinition(SingleValueStateUpdater other) Checks to determine if another instance has the same definition as this instance and returns true if it does.
protected boolean	checkForSameDefinition(StateUpdaterDefinition 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.
static SingleValueStateUpdater	createAddSingleValueToScalar(Scalar value, String elementIdentifier) Creates a SingleValueStateUpdater where the value will be added to the scalar value in the propagated state.
static SingleValueStateUpdater	createMultiplySingleValueToScalar(Scalar value, String elementIdentifier) Creates a SingleValueStateUpdater where the value will be multiplied with the scalar value in the propagated state.
static SingleValueStateUpdater	createSetSingleValueToScalar(Scalar value, String elementIdentifier) Creates a SingleValueStateUpdater where the value will be set to the scalar value in the propagated state.
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.
StateUpdaterEvaluator	getEvaluator(EvaluatorGroup group) Gets the StateUpdaterEvaluator for this StateUpdaterDefinition.
SingleValueUpdaterCallback	getUpdaterCallback() Gets the callback that will update the state.
Scalar	getValue() Gets the value that will be used to update the state.
void	setUpdaterCallback(SingleValueUpdaterCallback value) Sets the callback that will update the state.
void	setValue(Scalar value) Sets the value that will be used to update the state.

Methods inherited from class agi.foundation.segmentpropagation.StateUpdaterDefinition

checkForSameDefinition, getName, setName

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, toString, wait, wait, wait

Constructor Detail

SingleValueStateUpdater

public SingleValueStateUpdater()

Initializes a new instance.

SingleValueStateUpdater

public SingleValueStateUpdater(Scalar value,
                               SingleValueUpdaterCallback callback)

Initializes a new instance.

Parameters:

value - The value to use in the callback.

callback - The callback that will update the state.

SingleValueStateUpdater

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

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

Overrides:

computeCurrentDefinitionHashCode in class StateUpdaterDefinition

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 DefinitionalObject

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 DefinitionalObject

createAddSingleValueToScalar

@Nonnull
public static SingleValueStateUpdater createAddSingleValueToScalar(Scalar value,
                                                                             String elementIdentifier)

Creates a SingleValueStateUpdater where the value will be added to the scalar value in the propagated state.

Parameters:

value - The value to add to the scalar element in the propagated state.

elementIdentifier - The identifier of the scalar element in the propagated state.

Returns:

A SingleValueStateUpdater where the value will be added to the scalar value in the propagated state.

createMultiplySingleValueToScalar

@Nonnull
public static SingleValueStateUpdater createMultiplySingleValueToScalar(Scalar value,
                                                                                  String elementIdentifier)

Creates a SingleValueStateUpdater where the value will be multiplied with the scalar value in the propagated state.

Parameters:

value - The value to multiply the scalar element in the propagated state.

elementIdentifier - The identifier of the scalar element in the propagated state.

Returns:

A SingleValueStateUpdater where the value will be multiplied the scalar value in the propagated state.

createSetSingleValueToScalar

@Nonnull
public static SingleValueStateUpdater createSetSingleValueToScalar(Scalar value,
                                                                             String elementIdentifier)

Creates a SingleValueStateUpdater where the value will be set to the scalar value in the propagated state.

Parameters:

value - The value to set the scalar element in the propagated state.

elementIdentifier - The identifier of the scalar element in the propagated state.

Returns:

A SingleValueStateUpdater where the value will be set to the scalar value in the propagated state.

getValue

public final Scalar getValue()

Gets the value that will be used to update the state. This value could add an value to a specified element, or it could several values in the propagated state could be multiplied by this value.

setValue

public final void setValue(Scalar value)

Sets the value that will be used to update the state. This value could add an value to a specified element, or it could several values in the propagated state could be multiplied by this value.

getUpdaterCallback

public final SingleValueUpdaterCallback getUpdaterCallback()

Gets the callback that will update the state.

setUpdaterCallback

public final void setUpdaterCallback(SingleValueUpdaterCallback value)

Sets the callback that will update the state.

getEvaluator

public StateUpdaterEvaluator getEvaluator(EvaluatorGroup group)

Gets the StateUpdaterEvaluator for this StateUpdaterDefinition.

Specified by:

getEvaluator in class StateUpdaterDefinition

Parameters:

group - The EvaluatorGroup to use create any evaluators needed.

Returns:

The StateUpdaterEvaluator for this StateUpdaterDefinition.