agi.foundation.access

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

Class ConstraintQueryBuilder

java.lang.Object

agi.foundation.access.ConstraintQueryBuilder

public class ConstraintQueryBuilder
extends Object

This type is used to build an AccessQuery from a single constraint by assembling all of the individual functions that make up the constraint.

Constructor Summary

Constructors

Constructor and Description
ConstraintQueryBuilder() Initializes a new instance.

Method Summary

Modifier and Type	Method and Description
void	addConstraintFunction(AccessConstraintEvaluator evaluator) Adds a constraint function to the query.
void	addConstraintFunction(AccessConstraintEvaluator evaluator, IServiceProvider requiredTimeObserver) Adds a constraint function to the query.
List<AccessConstraintEvaluator>	getEvaluators() Gets the list of evaluators that are part of this constraint query.
IServiceProvider	getInputTimeObserver() Gets the IServiceProvider to use as the time observer for this query.
List<IServiceProvider>	getRequiredTimeObservers() Gets the list of time observers required by each evaluator in this constraint query.
void	setInputTimeObserver(IServiceProvider value) Sets the IServiceProvider to use as the time observer for this query.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

ConstraintQueryBuilder

public ConstraintQueryBuilder()

Initializes a new instance.

Method Detail

getInputTimeObserver

public final IServiceProvider getInputTimeObserver()

Gets the IServiceProvider to use as the time observer for this query. Inputs into this query will be adjusted as necessary for the time observers of the constraints in the query.

setInputTimeObserver

public final void setInputTimeObserver(IServiceProvider value)

Sets the IServiceProvider to use as the time observer for this query. Inputs into this query will be adjusted as necessary for the time observers of the constraints in the query.

getEvaluators

@Nonnull
public final List<AccessConstraintEvaluator> getEvaluators()

Gets the list of evaluators that are part of this constraint query. To add a constraint evaluator to the list, call ConstraintQueryBuilder.addConstraintFunction(AccessConstraintEvaluator,IServiceProvider).

getRequiredTimeObservers

@Nonnull
public final List<IServiceProvider> getRequiredTimeObservers()

Gets the list of time observers required by each evaluator in this constraint query. There will be one item in this list for each item in Evaluators (get).

addConstraintFunction

public final void addConstraintFunction(AccessConstraintEvaluator evaluator)

Adds a constraint function to the query. Times passed to the evaluator will be expressed on the default participant for the constraint.

The default participant for a constraint is:

• In a constraint that implements ISingleObjectConstraint, the ConstrainedObject (get / set).
• In a constraint that implements ILinkConstraint, the participant on the end of the ConstrainedLink (get / set) indicated by ConstrainedLinkEnd (get / set).

Parameters:

evaluator - The evaluator for the constraint function to add.

addConstraintFunction

public final void addConstraintFunction(AccessConstraintEvaluator evaluator,
                                        IServiceProvider requiredTimeObserver)

Adds a constraint function to the query. Times passed to the evaluator will be expressed on the given participant.

Parameters:

evaluator - The evaluator for the constraint function to add.

requiredTimeObserver - The participant on which times passed to the evaluator should be expressed. For a constraint that implements ISingleObjectConstraint, this parameter must be null or the same as ConstrainedObject (get / set). For a constraint that implements ILinkConstraint, this parameter must be null or the same as one of the two ends of the ConstrainedLink (get / set). If this parameter is null, this method is identical to ConstraintQueryBuilder.addConstraintFunction(AccessConstraintEvaluator).