agi.foundation.access

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

Class AccessQueryAtMostN

java.lang.Object

agi.foundation.infrastructure.DefinitionalObject

agi.foundation.access.AccessQuery

agi.foundation.access.AccessQueryAtMostN

All Implemented Interfaces:

ICompositeAccessQuery, ICloneWithContext, IEnumerateDependencies, IEquatableDefinition, IFreezable

public final class AccessQueryAtMostN
extends AccessQuery
implements ICompositeAccessQuery

An AccessQuery that requires that no more than N of a list of sub-queries be satisfied in order to be considered satisfied itself.

Constructor Summary

Constructors

Constructor and Description
AccessQueryAtMostN() Initializes a new instance.
AccessQueryAtMostN(int n, AccessQuery... queries) Initializes a new instance.
AccessQueryAtMostN(int n, Iterable<? extends AccessQuery> queries) Initializes a new instance.

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.
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.
protected void	freezeAggregatedObjects() Called by DefinitionalObject.freeze() to also freeze any objects that are considered to be a part of this object.
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.
int	getN() Gets the number of Queries (get) that must be satisfied in order for this query to be satisfied.
AccessQueryCollection	getQueries() Gets the collection of queries, at most N (get / set) of which can be satisfied in order for this query to be satisfied.
void	setN(int value) Sets the number of Queries (get) that must be satisfied in order for this query to be satisfied.
AccessQuery	toDisjunctiveNormalForm() Transforms this query to disjunctive normal form (DNF).
String	toString() Returns a string which represents the current object.

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

Constructor Detail

AccessQueryAtMostN

public AccessQueryAtMostN()

Initializes a new instance.

AccessQueryAtMostN

public AccessQueryAtMostN(int n,
                          @Nonnull
                          AccessQuery... queries)

Initializes a new instance.

Parameters:

n - The maximum number of queries that must be satisfied.

queries - The queries, at most n of which can be satisfied in order for this query to be satisfied.

AccessQueryAtMostN

public AccessQueryAtMostN(int n,
                          @Nonnull
                          Iterable<? extends AccessQuery> queries)

Initializes a new instance.

Parameters:

n - The maximum number of queries that must be satisfied.

queries - The queries, at most n of which can be satisfied in order for this query to be satisfied.

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 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.

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 AccessQueryAtMostN.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.

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

getN

public final int getN()

Gets the number of Queries (get) that must be satisfied in order for this query to be satisfied.

setN

public final void setN(int value)

Sets the number of Queries (get) that must be satisfied in order for this query to be satisfied.

getQueries

public final AccessQueryCollection getQueries()

Gets the collection of queries, at most N (get / set) of which can be satisfied in order for this query to be satisfied.

Specified by:

getQueries in interface ICompositeAccessQuery

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.

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.

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).

toString

public String toString()

Returns a string which represents the current object.

Overrides:

toString in class Object

Returns:

A string which represents the current object.