BaseCoverageDefinition | DME Component Libraries for Java 2024 r3

java.lang.Object
- agi.foundation.infrastructure.DefinitionalObject
- - agi.foundation.coverage.BaseCoverageDefinition

All Implemented Interfaces:

ICloneWithContext, IEnumerateDependencies, IEquatableDefinition, IFreezable

Direct Known Subclasses:

ContinuousCoverageDefinition, DiscreteCoverageDefinition
```
public abstract class BaseCoverageDefinition
extends DefinitionalObject
```
The abstract base class for coverage definitions.

Method Summary

All Methods Instance Methods Abstract Methods Concrete Methods
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 abstract boolean`	`checkForSameDefinition(BaseCoverageDefinition 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.
`protected int`	`computeCurrentDefinitionHashCode()` Computes a hash code based on the current properties of this object.
`abstract CoverageGridPointWithResults`	`createGridPoint(CoverageGridPoint coverageGridPoint)` Creates a `CoverageGridPointWithResults` suitable for computing coverage.
`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.
`protected ArrayList<AssetDefinition>`	`getAssetDefinitions()` Gets the asset definitions defined for this coverage definition.
`List<AssetDefinition>`	`getAssets()` Gets a read-only collection of assets which provide coverage over the grid.
`CoverageFilter`	`getFilter()` Gets the constraint which indicates the bound on the number of assets which must have access to a grid point in order to provide coverage.
`ICoverageGrid`	`getGrid()` Gets the grid used to generate points of interest over which to analyze coverage.
`protected IServiceProvider`	`getGridPointService()` Gets the service used at each grid point.
`boolean`	`getMultithreadCoverage()` Gets a value indicating whether to use multiple threads to compute coverage.
`void`	`removeAllAssets()` Removes all asset definitions for all assets from this 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.
`protected void`	`setAssetDefinitions(ArrayList<AssetDefinition> value)` Sets the asset definitions defined for this coverage definition.
`void`	`setFilter(CoverageFilter value)` Sets the constraint which indicates the bound on the number of assets which must have access to a grid point in order to provide coverage.
`void`	`setGrid(ICoverageGrid value)` Sets the grid used to generate points of interest over which to analyze coverage.
`protected void`	`setGridPointService(IServiceProvider value)` Sets the service used at each grid point.
`void`	`setMultithreadCoverage(boolean value)` Sets a value indicating whether to use multiple threads to compute coverage.
`protected void`	`validateProperties()` Validates all of the properties of the coverage definition.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Method Detail
  - 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 abstract boolean checkForSameDefinition(BaseCoverageDefinition 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 BaseCoverageDefinition.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.
  - 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
  - validateProperties
```
protected void validateProperties()
```
    Validates all of the properties of the coverage definition.
    This should be called in any derived coverage definition types before computing coverage.
    Throws:
    
    PropertyInvalidException - Thrown when Grid (get / set), GridPointService (get / set), or Filter (get / set) is null.
    IllegalStateException -
    Thrown when any of the following conditions are met:
    
    No Assets (get) were specified.
    
    Duplicate Assets (get) were specified.
    
    No grid points were generated with the supplied definition of Grid (get / set).
  - createGridPoint
```
@Nonnull
public abstract CoverageGridPointWithResults createGridPoint(CoverageGridPoint coverageGridPoint)
```
    Creates a CoverageGridPointWithResults suitable for computing coverage.
    
    Parameters:
    
    coverageGridPoint - The geometric grid point produced by the gridding algorithm.
    
    Returns:
    
    A properly setup CoverageGridPointWithResults.
  - getAssets
```
@Nonnull
public final List<AssetDefinition> getAssets()
```
    Gets a read-only collection of assets which provide coverage over the grid.
  - getFilter
```
public final CoverageFilter getFilter()
```
    Gets the constraint which indicates the bound on the number of assets which must have access to a grid point in order to provide coverage.
    By default, the constraint is: at least one asset (CoverageFilterType.AT_LEAST_N).
  - setFilter
```
public final void setFilter(CoverageFilter value)
```
    Sets the constraint which indicates the bound on the number of assets which must have access to a grid point in order to provide coverage.
    By default, the constraint is: at least one asset (CoverageFilterType.AT_LEAST_N).
  - getGrid
```
public final ICoverageGrid getGrid()
```
    Gets the grid used to generate points of interest over which to analyze coverage.
  - setGrid
```
public final void setGrid(ICoverageGrid value)
```
    Sets the grid used to generate points of interest over which to analyze coverage.
  - getGridPointService
```
protected final IServiceProvider getGridPointService()
```
    Gets the service used at each grid point. This should be an IPlaceHolderService in the case of delegate based coverage definitions such as, MaterializedSpatiallyPartitionedCoverageDefinition. This should be an Object with an ILocationPointService in the case of template based coverage definitions such as ParameterizedSpatiallyPartitionedCoverageDefinition.
  - setGridPointService
```
protected final void setGridPointService(IServiceProvider value)
```
    Sets the service used at each grid point. This should be an IPlaceHolderService in the case of delegate based coverage definitions such as, MaterializedSpatiallyPartitionedCoverageDefinition. This should be an Object with an ILocationPointService in the case of template based coverage definitions such as ParameterizedSpatiallyPartitionedCoverageDefinition.
  - getMultithreadCoverage
```
public final boolean getMultithreadCoverage()
```
    Gets a value indicating whether to use multiple threads to compute coverage. This is true by default.
    It is also possible to set the number of available threads in the NumberOfThreads (get / set) which will also control both whether coverage uses multiple threads, and if so, how many.
  - setMultithreadCoverage
```
public final void setMultithreadCoverage(boolean value)
```
    Sets a value indicating whether to use multiple threads to compute coverage. This is true by default.
    It is also possible to set the number of available threads in the NumberOfThreads (get / set) which will also control both whether coverage uses multiple threads, and if so, how many.
  - 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.
  - 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.
  - 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()
```
    Removes all asset definitions for all assets from this coverage definition.
  - getAssetDefinitions
```
@Nonnull
protected final ArrayList<AssetDefinition> getAssetDefinitions()
```
    Gets the asset definitions defined for this coverage definition.
  - setAssetDefinitions
```
protected final void setAssetDefinitions(@Nonnull
                                         ArrayList<AssetDefinition> value)
```
    Sets the asset definitions defined for this coverage definition.

Class BaseCoverageDefinition

Method Summary

Methods inherited from class agi.foundation.infrastructure.DefinitionalObject

Methods inherited from class java.lang.Object

Method Detail

checkForSameDefinition

checkForSameDefinition

computeCurrentDefinitionHashCode

enumerateDependencies

freezeAggregatedObjects

validateProperties

createGridPoint

getAssets

getFilter

setFilter

getGrid

setGrid

getGridPointService

setGridPointService

getMultithreadCoverage

setMultithreadCoverage

addAsset

addAsset

addAssetRange

removeAsset

removeAsset

removeAllAssets

getAssetDefinitions

setAssetDefinitions