agi.foundation.coverage

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

Class CoverageDefinitionOnSingleObject

java.lang.Object

agi.foundation.infrastructure.DefinitionalObject

agi.foundation.coverage.CoverageDefinitionOnSingleObject

All Implemented Interfaces:

ICloneWithContext, IEnumerateDependencies, IEquatableDefinition, IFreezable

public class CoverageDefinitionOnSingleObject
extends DefinitionalObject

This coverage definition provides a convenient way to organize and compute a coverage calculation between an object of interest and an associated group of assets.

Constructor Summary

Constructors

Modifier	Constructor and Description
	CoverageDefinitionOnSingleObject() Initializes a new instance with default values.
protected	CoverageDefinitionOnSingleObject(CoverageDefinitionOnSingleObject existingInstance, CopyContext context) Initializes a new instance as a copy of an existing instance.
	CoverageDefinitionOnSingleObject(IServiceProvider coverageTarget) Initializes a new instance with a specified coverage target.

Method Summary

Modifier and Type	Method and Description
void	addAsset(AssetDefinition assetDefinition) Add an asset to the coverage definition.
void	addAsset(Object assetKey, AccessQuery query) Add an asset to the coverage definition.
void	addAssetRange(Iterable<? extends AssetDefinition> assets) Add a range of assets to the coverage definition.
protected boolean	checkForSameDefinition(CoverageDefinitionOnSingleObject other) Checks to determine if another instance has the same definition as this instance and returns true if it does.
protected boolean	checkForSameDefinition(DefinitionalObject 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.
CoverageQueryResult	computeCoverage(JulianDate start, JulianDate stop) Computes the coverage intervals.
CoverageQueryResult	computeCoverage(JulianDate start, JulianDate stop, ITrackCalculationProgress tracker) Computes the coverage intervals.
CoverageQueryResult	computeCoverage(TimeIntervalCollection consideredIntervals) Computes the coverage intervals.
CoverageQueryResult	computeCoverage(TimeIntervalCollection consideredIntervals, ITrackCalculationProgress tracker) Computes the coverage intervals.
protected int	computeCurrentDefinitionHashCode() Computes a hash code based on the current properties of this object.
void	enumerateDependencies(DependencyEnumerator enumerator) Enumerates the dependencies of this object by calling DependencyEnumerator#enumerate(T) for each object that this object directly depends upon.
List<AssetDefinition>	getAssets() Gets the assets providing coverage to CoverageTarget (get / set)
IServiceProvider	getCoverageTarget() Gets the object which is the target of the coverage calculation
CoverageFilter	getFilter() Gets a constraint indicating how many assets must have access in order to have coverage
void	removeAllAssets() Remove all assets from the coverage definition.
void	removeAsset(AssetDefinition assetDefinition) Removes the specified asset definition from the list of assets.
void	removeAsset(Object asset) Removes the specified asset from the list of assets.
void	setCoverageTarget(IServiceProvider value) Sets the object which is the target of the coverage calculation
void	setFilter(CoverageFilter value) Sets a constraint indicating how many assets must have access in order to have coverage

Methods inherited from class agi.foundation.infrastructure.DefinitionalObject

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

CoverageDefinitionOnSingleObject

public CoverageDefinitionOnSingleObject()

Initializes a new instance with default values. Filter (get / set) defaults to CoverageFilterType.AT_LEAST_N where N is 1.

CoverageDefinitionOnSingleObject

public CoverageDefinitionOnSingleObject(IServiceProvider coverageTarget)

Initializes a new instance with a specified coverage target.

Parameters:

coverageTarget - The coverage target to analyze.

CoverageDefinitionOnSingleObject

protected CoverageDefinitionOnSingleObject(@Nonnull
                                           CoverageDefinitionOnSingleObject 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(@Nullable
                                         CoverageDefinitionOnSingleObject 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 CoverageDefinitionOnSingleObject.checkForSameDefinition(agi.foundation.infrastructure.DefinitionalObject) method.

Overrides:

computeCurrentDefinitionHashCode in class DefinitionalObject

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.

getCoverageTarget

public final IServiceProvider getCoverageTarget()

Gets the object which is the target of the coverage calculation

setCoverageTarget

public final void setCoverageTarget(IServiceProvider value)

Sets the object which is the target of the coverage calculation

getAssets

@Nonnull
public final List<AssetDefinition> getAssets()

Gets the assets providing coverage to CoverageTarget (get / set)

getFilter

public final CoverageFilter getFilter()

Gets a constraint indicating how many assets must have access in order to have coverage

setFilter

public final void setFilter(CoverageFilter value)

Sets a constraint indicating how many assets must have access in order to have coverage

addAsset

public final void addAsset(AssetDefinition assetDefinition)

Add an asset to the coverage definition.

Parameters:

assetDefinition - The asset definition to add.

addAsset

public final void addAsset(Object assetKey,
                           AccessQuery query)

Add an asset to the coverage definition.

Parameters:

assetKey - The asset to add, which will be used as a reference key when retrieving data.

query - The query that must be satisfied for the asset to provide coverage.

removeAsset

public final void removeAsset(AssetDefinition assetDefinition)

Removes the specified asset definition from the list of assets.

If the specified definition has been added to the list multiple times, this method will remove the first occurrence.

Parameters:

assetDefinition - The asset definition to remove.

removeAsset

public final void removeAsset(Object asset)

Removes the specified asset from the list of assets.

If the list of assets contains multiple AssetDefinition instances involving this asset, all of them will be removed by this method.

Parameters:

asset - The asset to remove.

removeAllAssets

public final void removeAllAssets()

Remove all assets from the coverage definition.

addAssetRange

public final void addAssetRange(@Nonnull
                                Iterable<? extends AssetDefinition> assets)

Add a range of assets to the coverage definition.

Parameters:

assets - The set of assets to add.

computeCoverage

public final CoverageQueryResult computeCoverage(@Nonnull
                                                 JulianDate start,
                                                 @Nonnull
                                                 JulianDate stop)

Computes the coverage intervals.

Parameters:

start - The start time of the interval to consider.

stop - The stop time of the interval to consider.

Returns:

The time intervals when the CoverageTarget (get / set) has satisfactory coverage.

Throws:

PropertyInvalidException - The Filter (get / set) property is null.

IllegalStateException - No Assets (get) have been specified, or a particular AssetObject (get / set) exists twice in the Assets (get) list.

computeCoverage

public final CoverageQueryResult computeCoverage(@Nonnull
                                                 TimeIntervalCollection consideredIntervals)

Computes the coverage intervals.

Parameters:

consideredIntervals - The intervals to consider.

Returns:

The time intervals when the CoverageTarget (get / set) has satisfactory coverage.

Throws:

PropertyInvalidException - The Filter (get / set) property is null.

IllegalStateException - No Assets (get) have been specified, or a particular AssetObject (get / set) exists twice in the Assets (get) list.

computeCoverage

public final CoverageQueryResult computeCoverage(@Nonnull
                                                 JulianDate start,
                                                 @Nonnull
                                                 JulianDate stop,
                                                 @Nullable
                                                 ITrackCalculationProgress tracker)

Computes the coverage intervals.

Parameters:

start - The start time of the interval to consider.

stop - The stop time of the interval to consider.

tracker - A tracker which can track the progress of the calculation and provides a way to smoothly cancel execution.

Returns:

The time intervals when the CoverageTarget (get / set) has satisfactory coverage.

Throws:

PropertyInvalidException - The Filter (get / set) property is null.

IllegalStateException - No Assets (get) have been specified, or a particular AssetObject (get / set) exists twice in the Assets (get) list.

computeCoverage

public final CoverageQueryResult computeCoverage(@Nonnull
                                                 TimeIntervalCollection consideredIntervals,
                                                 @Nullable
                                                 ITrackCalculationProgress tracker)

Computes the coverage intervals.

Parameters:

consideredIntervals - The intervals to consider.

tracker - A tracker which can track the progress of the calculation and provides a way to smoothly cancel execution.

Returns:

The time intervals when the CoverageTarget (get / set) has satisfactory coverage.

Throws:

PropertyInvalidException - The Filter (get / set) property is null.

IllegalStateException - No Assets (get) have been specified, or a particular AssetObject (get / set) exists twice in the Assets (get) list.