agi.foundation.segmentpropagation

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

Class TargetedSegmentListOperatorResults

java.lang.Object

agi.foundation.segmentpropagation.TargetedSegmentListOperatorResults

All Implemented Interfaces:

ICloneWithContext

Direct Known Subclasses:

TargetedSegmentListDifferentialCorrectorResults, TargetedSegmentListParameterOptimizerResults

public class TargetedSegmentListOperatorResults
extends Object
implements ICloneWithContext

The base class that gets returned when a TargetedSegmentListOperatorEvaluator is computed. Typically this class should be extended unless the operation produces no results itself. In addition to the properties in this type, any other data that your operator computed that an end user might care about should be added to your type inheriting from this one.

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	TargetedSegmentListOperatorResults(TargetedSegmentListOperator identifier) Initializes a new instance.
	TargetedSegmentListOperatorResults(TargetedSegmentListOperator identifier, boolean completedSuccessfully, TargetedSegmentListConfiguration parentConfiguration) Initializes a new instance.
protected	TargetedSegmentListOperatorResults(TargetedSegmentListOperatorResults existingInstance, CopyContext context) Initializes a new instance as a copy of an existing instance.

Method Summary

Modifier and Type	Method and Description
Object	clone(CopyContext context) Clones this object using the specified context.
boolean	getCompletedSuccessfully() Gets a value indicating whether the operator run completed successfully.
SegmentListResults	getFinalSegmentsResults() Gets the SegmentListResults of the segments propagated after the operator was executed.
TargetedSegmentListOperator	getIdentifier() Gets the definition of the operator that ran.
TargetedSegmentListConfiguration	getParentConfiguration() Gets the configuration of the TargetedSegmentList that the operator was a part of.
protected void	setCompletedSuccessfully(boolean value) Sets a value indicating whether the operator run completed successfully.
void	setFinalSegmentsResults(SegmentListResults value) Sets the SegmentListResults of the segments propagated after the operator was executed.
protected void	setIdentifier(TargetedSegmentListOperator value) Sets the definition of the operator that ran.

Methods inherited from class java.lang.Object

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

Constructor Detail

TargetedSegmentListOperatorResults

public TargetedSegmentListOperatorResults(TargetedSegmentListOperator identifier,
                                          boolean completedSuccessfully,
                                          @Nonnull
                                          TargetedSegmentListConfiguration parentConfiguration)

Initializes a new instance.

Parameters:

identifier - The identifier of the operator that produced these results.

completedSuccessfully - A boolean indicating if the operator completed successfully. This is not the same thing as if the operator converged.

parentConfiguration - The SegmentConfiguration of the TargetedSegmentList that these results are a part of.

TargetedSegmentListOperatorResults

protected TargetedSegmentListOperatorResults(TargetedSegmentListOperator identifier)

Initializes a new instance.

Parameters:

identifier - The operator definition that created the object that calculated these results.

TargetedSegmentListOperatorResults

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

Parameters:

context - The context to use to perform the copy.

Returns:

A new instance which is a copy of this object.

getCompletedSuccessfully

public final boolean getCompletedSuccessfully()

Gets a value indicating whether the operator run completed successfully.

setCompletedSuccessfully

protected final void setCompletedSuccessfully(boolean value)

Sets a value indicating whether the operator run completed successfully.

getIdentifier

public final TargetedSegmentListOperator getIdentifier()

Gets the definition of the operator that ran.

setIdentifier

protected final void setIdentifier(TargetedSegmentListOperator value)

Sets the definition of the operator that ran.

getFinalSegmentsResults

public final SegmentListResults getFinalSegmentsResults()

Gets the SegmentListResults of the segments propagated after the operator was executed.

setFinalSegmentsResults

public final void setFinalSegmentsResults(SegmentListResults value)

Sets the SegmentListResults of the segments propagated after the operator was executed.

getParentConfiguration

public TargetedSegmentListConfiguration getParentConfiguration()

Gets the configuration of the TargetedSegmentList that the operator was a part of. The configuration is a mutable object, and it is possible that an operator made some change to it or a copy of it. This must return the configuration that the propagator should use after running the operator that made this set of results. If no changes were made to the configuration, it should return the configuration that the operator was given.