agi.foundation.platforms

(agi.foundation.platforms.graphics-2023r2.jar)

Class AccessQueryGraphicsParameter<T>

java.lang.Object

agi.foundation.infrastructure.DefinitionalObject

agi.foundation.platforms.advanced.GraphicsParameter<T>

agi.foundation.platforms.AccessQueryGraphicsParameter<T>

Type Parameters:

T - The type of parameter.

All Implemented Interfaces:

ICloneWithContext, IEnumerateDependencies, IEquatableDefinition, IFreezable, IGraphicsParameter

public class AccessQueryGraphicsParameter<T>
extends GraphicsParameter<T>

A GraphicsParameter which maps the result of an AccessQuery to different values depending on access availability.

Constructor Summary

Constructors

Modifier	Constructor and Description
	AccessQueryGraphicsParameter() Initializes a new instance.
	AccessQueryGraphicsParameter(AccessConstraint constraint, T accessExists, T accessUnknown, T noAccess) Initializes a new instance with the specified parameters.
protected	AccessQueryGraphicsParameter(AccessQueryGraphicsParameter<T> existingInstance, CopyContext context) Initializes a new instance as a copy of an existing instance.
	AccessQueryGraphicsParameter(AccessQuery query, IServiceProvider timeObserver, T accessExists, T accessUnknown, T noAccess) Initializes a new instance with the specified parameters.
	AccessQueryGraphicsParameter(AccessQuery query, T accessExists, T accessUnknown, T noAccess) Initializes a new instance with the specified parameters.

Method Summary

Modifier and Type	Method and Description
protected boolean	checkForSameDefinition(AccessQueryGraphicsParameter<T> other) Checks to determine if another instance has the same definition as this instance and returns true if it does.
protected boolean	checkForSameDefinition(GraphicsParameter<T> 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.
T	getAccessExists() Gets the value to return if access exists.
T	getAccessUnknown() Gets the value to return if access is unknown.
Evaluator<T>	getEvaluator(EvaluatorGroup group) Gets an Evaluator which returns a value based on the result of access at the specified time.
T	getNoAccess() Gets the value to return if there is no access.
AccessQuery	getQuery() Gets the access query to evaluate.
IServiceProvider	getTimeObserver() Gets the IServiceProvider to use as the time observer for the query.
void	setAccessExists(T value) Sets the value to return if access exists.
void	setAccessUnknown(T value) Sets the value to return if access is unknown.
void	setNoAccess(T value) Sets the value to return if there is no access.
void	setQuery(AccessQuery value) Sets the access query to evaluate.
void	setTimeObserver(IServiceProvider value) Sets the IServiceProvider to use as the time observer for the query.

Methods inherited from class agi.foundation.platforms.advanced.GraphicsParameter

checkForSameDefinition, getObjectEvaluator, isSameDefinition

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

AccessQueryGraphicsParameter

public AccessQueryGraphicsParameter()

Initializes a new instance.

AccessQueryGraphicsParameter

public AccessQueryGraphicsParameter(AccessConstraint constraint,
                                    T accessExists,
                                    T accessUnknown,
                                    T noAccess)

Initializes a new instance with the specified parameters.

Parameters:

constraint - The constraint to evaluate.

accessExists - The value to return if access exists.

accessUnknown - The value to return if access is unknown.

noAccess - The value to return if there is no access.

AccessQueryGraphicsParameter

public AccessQueryGraphicsParameter(AccessQuery query,
                                    T accessExists,
                                    T accessUnknown,
                                    T noAccess)

Initializes a new instance with the specified parameters.

Parameters:

query - The access query to evaluate.

accessExists - The value to return if access exists.

accessUnknown - The value to return if access is unknown.

noAccess - The value to return if there is no access.

AccessQueryGraphicsParameter

public AccessQueryGraphicsParameter(AccessQuery query,
                                    IServiceProvider timeObserver,
                                    T accessExists,
                                    T accessUnknown,
                                    T noAccess)

Initializes a new instance with the specified parameters.

Parameters:

query - The access query to evaluate.

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

accessExists - The value to return if access exists.

accessUnknown - The value to return if access is unknown.

noAccess - The value to return if there is no access.

AccessQueryGraphicsParameter

protected AccessQueryGraphicsParameter(@Nonnull
                                       AccessQueryGraphicsParameter<T> 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(GraphicsParameter<T> 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 GraphicsParameter<T>

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(AccessQueryGraphicsParameter<T> 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 AccessQueryGraphicsParameter.checkForSameDefinition(agi.foundation.platforms.advanced.GraphicsParameter<T>) method.

Overrides:

computeCurrentDefinitionHashCode in class GraphicsParameter<T>

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.

getQuery

public final AccessQuery getQuery()

Gets the access query to evaluate.

setQuery

public final void setQuery(AccessQuery value)

Sets the access query to evaluate.

getTimeObserver

public final IServiceProvider getTimeObserver()

Gets the IServiceProvider to use as the time observer for the query.

setTimeObserver

public final void setTimeObserver(IServiceProvider value)

Sets the IServiceProvider to use as the time observer for the query.

getAccessExists

public final T getAccessExists()

Gets the value to return if access exists.

setAccessExists

public final void setAccessExists(T value)

Sets the value to return if access exists.

getAccessUnknown

public final T getAccessUnknown()

Gets the value to return if access is unknown.

setAccessUnknown

public final void setAccessUnknown(T value)

Sets the value to return if access is unknown.

getNoAccess

public final T getNoAccess()

Gets the value to return if there is no access.

setNoAccess

public final void setNoAccess(T value)

Sets the value to return if there is no access.

getEvaluator

public Evaluator<T> getEvaluator(EvaluatorGroup group)

Gets an Evaluator which returns a value based on the result of access at the specified time.

Specified by:

getEvaluator in class GraphicsParameter<T>

Parameters:

group - The group in which to create the evaluator.

Returns:

An Evaluator which returns a value based on the result of access at the specified time.