agi.foundation.access

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

Class AccessQueryStartAndMaintain

java.lang.Object

agi.foundation.infrastructure.DefinitionalObject

agi.foundation.access.AccessQuery

agi.foundation.access.AccessQueryStartAndMaintain

All Implemented Interfaces:

ICloneWithContext, IEnumerateDependencies, IEquatableDefinition, IFreezable

public class AccessQueryStartAndMaintain
extends AccessQuery

An AccessQuery that can define separate constraints for starting and maintaining access. This query will be considered satisfied after the StartQuery (get / set) is satisfied, and for as long as the MaintainQuery (get / set) is satisfied.

Constructor Summary

Constructors

Constructor and Description
AccessQueryStartAndMaintain() Initializes a new instance.
AccessQueryStartAndMaintain(AccessQuery startQuery, AccessQuery maintainQuery) Initializes a new instance representing the start and maintain queries.
AccessQueryStartAndMaintain(AccessQuery startQuery, AccessQuery maintainQuery, boolean allowAccessBeforeStart) Initializes a new instance representing the start and maintain queries.
AccessQueryStartAndMaintain(AccessQuery startQuery, AccessQuery maintainQuery, boolean allowAccessBeforeStart, JulianDate startQueryEvaluationStartDate) Initializes a new instance representing the start and maintain queries.
AccessQueryStartAndMaintain(AccessQuery startQuery, AccessQuery maintainQuery, boolean allowAccessBeforeStart, JulianDate startQueryEvaluationStartDate, boolean useStartDateForIntervalEvaluation) Initializes a new instance representing the start and maintain queries.

Method Summary

Modifier and Type	Method and Description
protected boolean	checkForSameDefinition(AccessQuery other) Checks to determine if another instance has the same definition as this instance and returns true if it does.
protected boolean	checkForSameDefinition(AccessQueryStartAndMaintain 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.
void	enumerateDependencies(DependencyEnumerator enumerator) Enumerates the dependencies of this object by calling DependencyEnumerator#enumerate(T) for each object that this object directly depends upon.
boolean	getAllowAccessBeforeStart() Gets a value indicating whether the query is considered satisfied when the MaintainQuery (get / set) is satisfied at the start of the evaluated interval.
int	getEvaluationOrder() Gets the suggested evaluation order of this query by adding up the evaluation orders of this query's sub-queries, as returned by their AccessQuery.getEvaluationOrder() methods.
AccessEvaluator	getEvaluator(IServiceProvider timeObserver, EvaluatorGroup group) Gets an evaluator that can be used to evaluate this query for a given time or for intervals of time.
AccessQuery	getMaintainQuery() Gets the AccessQuery that represents the condition for maintaining access.
AccessQuery	getStartQuery() Gets the AccessQuery that represents the condition for establishing access.
JulianDate	getStartQueryEvaluationStartDate() Gets the JulianDate that will be used as the start date for evaluation.
boolean	getUseStartDateForIntervalEvaluation() Gets a value indicating whether calls to AccessEvaluator.evaluate(TimeIntervalCollection,ITrackCalculationProgress) will also start at StartQueryEvaluationStartDate (get / set).
void	setAllowAccessBeforeStart(boolean value) Sets a value indicating whether the query is considered satisfied when the MaintainQuery (get / set) is satisfied at the start of the evaluated interval.
void	setMaintainQuery(AccessQuery value) Sets the AccessQuery that represents the condition for maintaining access.
void	setStartQuery(AccessQuery value) Sets the AccessQuery that represents the condition for establishing access.
void	setStartQueryEvaluationStartDate(JulianDate value) Sets the JulianDate that will be used as the start date for evaluation.
void	setUseStartDateForIntervalEvaluation(boolean value) Sets a value indicating whether calls to AccessEvaluator.evaluate(TimeIntervalCollection,ITrackCalculationProgress) will also start at StartQueryEvaluationStartDate (get / set).
AccessQuery	toDisjunctiveNormalForm() Transforms this query to disjunctive normal form (DNF).

Methods inherited from class agi.foundation.access.AccessQuery

and, and, anyPath, anyPath, anyPath, anyPath, anyPath, anyPath, atLeastN, atMostN, checkForSameDefinition, exactlyN, fromObject, fromObjectAllowNoConstraints, getDebuggingLogger, getEvaluator, getEvaluator, not, or, or, setDebuggingLogger

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

AccessQueryStartAndMaintain

public AccessQueryStartAndMaintain()

Initializes a new instance.

AccessQueryStartAndMaintain

public AccessQueryStartAndMaintain(AccessQuery startQuery,
                                   AccessQuery maintainQuery)

Initializes a new instance representing the start and maintain queries.

Parameters:

startQuery - The AccessQuery that represents the condition for establishing access. Whenever this query is satisfied, the AccessQueryStartAndMaintain is considered satisfied.

maintainQuery - The AccessQuery that represents the condition for maintaining access. Whenever this query is satisfied while the startQuery is also satisfied, the AccessQueryStartAndMaintain will be satisfied for as long as this query is satisfied, even after the startQuery is no longer satisfied.

AccessQueryStartAndMaintain

public AccessQueryStartAndMaintain(AccessQuery startQuery,
                                   AccessQuery maintainQuery,
                                   boolean allowAccessBeforeStart)

Initializes a new instance representing the start and maintain queries.

Parameters:

startQuery - The AccessQuery that represents the condition for establishing access. Whenever this query is satisfied, the AccessQueryStartAndMaintain is considered satisfied.

maintainQuery - The AccessQuery that represents the condition for maintaining access. Whenever this query is satisfied while the startQuery is also satisfied, the AccessQueryStartAndMaintain will be satisfied for as long as this query is satisfied, even after the startQuery is no longer satisfied.

allowAccessBeforeStart - Determines whether the startQuery is considered satisfied at the beginning of the considered intervals.

AccessQueryStartAndMaintain

public AccessQueryStartAndMaintain(AccessQuery startQuery,
                                   AccessQuery maintainQuery,
                                   boolean allowAccessBeforeStart,
                                   @Nonnull
                                   JulianDate startQueryEvaluationStartDate)

Initializes a new instance representing the start and maintain queries.

Parameters:

startQuery - The AccessQuery that represents the condition for establishing access. Whenever this query is satisfied, the AccessQueryStartAndMaintain is considered satisfied.

maintainQuery - The AccessQuery that represents the condition for maintaining access. Whenever this query is satisfied while the startQuery is also satisfied, the AccessQueryStartAndMaintain will be satisfied for as long as this query is satisfied, even after the startQuery is no longer satisfied.

allowAccessBeforeStart - Determines whether the startQuery is considered satisfied at the beginning of the considered intervals.

startQueryEvaluationStartDate - When Evaluator.evaluate(JulianDate) is called, the evaluator will start at this date to determine if the startQuery is satisfied.

AccessQueryStartAndMaintain

public AccessQueryStartAndMaintain(AccessQuery startQuery,
                                   AccessQuery maintainQuery,
                                   boolean allowAccessBeforeStart,
                                   @Nonnull
                                   JulianDate startQueryEvaluationStartDate,
                                   boolean useStartDateForIntervalEvaluation)

Initializes a new instance representing the start and maintain queries.

Parameters:

startQuery - The AccessQuery that represents the condition for establishing access. Whenever this query is satisfied, the AccessQueryStartAndMaintain is considered satisfied.

maintainQuery - The AccessQuery that represents the condition for maintaining access. Whenever this query is satisfied while the startQuery is also satisfied, the AccessQueryStartAndMaintain will be satisfied for as long as this query is satisfied, even after the startQuery is no longer satisfied.

allowAccessBeforeStart - Determines whether the startQuery is considered satisfied at the beginning of the considered intervals.

startQueryEvaluationStartDate - When Evaluator.evaluate(JulianDate) is called, the evaluator will start at this date to determine if the startQuery is satisfied.

useStartDateForIntervalEvaluation - If set to true, calls to AccessEvaluator.evaluate(TimeIntervalCollection,ITrackCalculationProgress) will also start at startQueryEvaluationStartDate.

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(AccessQuery 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 AccessQuery

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
                                         AccessQueryStartAndMaintain 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 AccessQueryStartAndMaintain.checkForSameDefinition(agi.foundation.access.AccessQuery) method.

Overrides:

computeCurrentDefinitionHashCode in class AccessQuery

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.

getStartQuery

public final AccessQuery getStartQuery()

Gets the AccessQuery that represents the condition for establishing access. Whenever this query is satisfied, the AccessQueryStartAndMaintain is considered satisfied.

setStartQuery

public final void setStartQuery(AccessQuery value)

Sets the AccessQuery that represents the condition for establishing access. Whenever this query is satisfied, the AccessQueryStartAndMaintain is considered satisfied.

getMaintainQuery

public final AccessQuery getMaintainQuery()

Gets the AccessQuery that represents the condition for maintaining access. Whenever this query is satisfied while the StartQuery (get / set) is also satisfied, the AccessQueryStartAndMaintain will be satisfied for as long as this query is satisfied, even after the StartQuery (get / set) is no longer satisfied.

setMaintainQuery

public final void setMaintainQuery(AccessQuery value)

Sets the AccessQuery that represents the condition for maintaining access. Whenever this query is satisfied while the StartQuery (get / set) is also satisfied, the AccessQueryStartAndMaintain will be satisfied for as long as this query is satisfied, even after the StartQuery (get / set) is no longer satisfied.

getAllowAccessBeforeStart

public final boolean getAllowAccessBeforeStart()

Gets a value indicating whether the query is considered satisfied when the MaintainQuery (get / set) is satisfied at the start of the evaluated interval.

setAllowAccessBeforeStart

public final void setAllowAccessBeforeStart(boolean value)

Sets a value indicating whether the query is considered satisfied when the MaintainQuery (get / set) is satisfied at the start of the evaluated interval.

getStartQueryEvaluationStartDate

@Nonnull
public final JulianDate getStartQueryEvaluationStartDate()

Gets the JulianDate that will be used as the start date for evaluation. When Evaluator.evaluate(JulianDate) is called, the evaluator will start at this date to determine if the StartQuery (get / set) is satisfied.

This must be set for evaluation at a single JulianDate to work correctly. When evaluating at a single JulianDate evaluation before this date will result in an exception.

setStartQueryEvaluationStartDate

public final void setStartQueryEvaluationStartDate(@Nonnull
                                                   JulianDate value)

Sets the JulianDate that will be used as the start date for evaluation. When Evaluator.evaluate(JulianDate) is called, the evaluator will start at this date to determine if the StartQuery (get / set) is satisfied.

This must be set for evaluation at a single JulianDate to work correctly. When evaluating at a single JulianDate evaluation before this date will result in an exception.

getUseStartDateForIntervalEvaluation

public final boolean getUseStartDateForIntervalEvaluation()

Gets a value indicating whether calls to AccessEvaluator.evaluate(TimeIntervalCollection,ITrackCalculationProgress) will also start at StartQueryEvaluationStartDate (get / set). This setting either truncates the evaluation interval if the StartQueryEvaluationStartDate (get / set) is after the interval start or expands the interval if the StartQueryEvaluationStartDate (get / set) is before the interval start.

setUseStartDateForIntervalEvaluation

public final void setUseStartDateForIntervalEvaluation(boolean value)

Sets a value indicating whether calls to AccessEvaluator.evaluate(TimeIntervalCollection,ITrackCalculationProgress) will also start at StartQueryEvaluationStartDate (get / set). This setting either truncates the evaluation interval if the StartQueryEvaluationStartDate (get / set) is after the interval start or expands the interval if the StartQueryEvaluationStartDate (get / set) is before the interval start.

getEvaluationOrder

public int getEvaluationOrder()

Gets the suggested evaluation order of this query by adding up the evaluation orders of this query's sub-queries, as returned by their AccessQuery.getEvaluationOrder() methods.

Specified by:

getEvaluationOrder in class AccessQuery

Returns:

The suggested evaluation order.

toDisjunctiveNormalForm

public AccessQuery toDisjunctiveNormalForm()

Transforms this query to disjunctive normal form (DNF).

Specified by:

toDisjunctiveNormalForm in class AccessQuery

Returns:

An equivalent query expressed in disjunctive normal form (DNF).

getEvaluator

public AccessEvaluator getEvaluator(IServiceProvider timeObserver,
                                    EvaluatorGroup group)

Gets an evaluator that can be used to evaluate this query for a given time or for intervals of time.

Specified by:

getEvaluator in class AccessQuery

Parameters:

timeObserver - The IServiceProvider time observer to use when evaluating this query.

group - The group with which to associate the new evaluator. By grouping evaluators that are often evaluated at the same Julian dates, common computations can be performed only once for the entire group instead of multiple times for each evaluator.

Returns:

The evaluator.

Throws:

ArgumentNullException - Thrown when group is null.

PropertyInvalidException - Thrown when StartQuery (get / set) or MaintainQuery (get / set) is null.