org.eclipse.ocl.pivot.internal.helper

Class QueryImpl

java.lang.Object

org.eclipse.ocl.pivot.internal.helper.QueryImpl

All Implemented Interfaces:

ProblemAware, Query

public class QueryImpl
extends java.lang.Object
implements Query, ProblemAware

An implementation of the model object 'Query'.

Constructor Summary

Constructors

Constructor and Description
QueryImpl(OCL ocl, ExpressionInOCL query)

Method Summary

Methods

Modifier and Type	Method and Description
boolean	checkBoxed(java.lang.Iterable<?> boxedObjects) Determines whether all of the boxedObjects satisfy the query.
boolean	checkBoxed(java.lang.Object boxedObject) Evaluates the query on a boxedObject.
boolean	checkEcore(java.lang.Iterable<?> ecoreObjects) Determines whether all of the ecoreObjects satisfy the query.
boolean	checkEcore(java.lang.Object ecoreObject) Evaluates the query on an ecoreObject.
java.util.List<?>	evaluateBoxed(java.lang.Iterable<?> boxedObjects) Evaluates the query on each of boxedObjects to return a list of boxedResults.
java.lang.Object	evaluateBoxed(java.lang.Object boxedValue) Evaluates the query on the boxedObject to return a boxedResult.
org.eclipse.emf.common.util.EList<?>	evaluateEcore(java.lang.Class<?> instanceClass, java.lang.Iterable<?> ecoreObjects) Evaluates the query on each of ecoreObjects to return a list of ecoreResults coerced, if non-null, to instanceClass.
java.lang.Object	evaluateEcore(java.lang.Class<?> instanceClass, java.lang.Object ecoreObject) Evaluates the query on the ecoreObject to return an ecoreResult coerced, if non-null, to instanceClass.
org.eclipse.emf.common.util.EList<?>	evaluateEcore(java.lang.Iterable<?> ecoreObjects) Evaluates the query on each of ecoreObjects to return a list of ecoreResults using Integer/Double for numerics.
java.lang.Object	evaluateEcore(java.lang.Object ecoreObject) Evaluates the query on the ecoreObject to return an ecoreResult using Integer/Double for numerics.
java.lang.Object	evaluateUnboxed(java.lang.Object unboxedObject) Evaluates the query on the unboxedObject to return an unboxedResult.
EvaluationEnvironment	getEvaluationEnvironment(java.lang.Object unboxedObject) Obtains the evaluation environment that I use to evaluate OCL expressions.
OCLExpression	getExpression() Obtains the expression that I evaluate (or check as a boolean constraint).
OCL	getOCL() Obtains the OCL that created me.
org.eclipse.emf.common.util.Diagnostic	getProblems() Retrieves the problems available on this problem aware object
java.lang.String	queryText() Translates the query back to an OCL text string.
<T> java.util.List<T>	rejectEcore(java.lang.Iterable<T> ecoreObjects) Determines the subset of ecoreObjects that do not satisfy the query.
Type	resultType() Obtains the OCL result type of the query.
<T> java.util.List<T>	selectEcore(java.lang.Iterable<T> ecoreObjects) Determines the subset of ecoreObjects that satisfy the query.
java.lang.String	toString()

Methods inherited from class java.lang.Object

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

Constructor Detail

QueryImpl

public QueryImpl(@NonNull
         OCL ocl,
         @NonNull
         ExpressionInOCL query)

Method Detail

checkBoxed

public boolean checkBoxed(@Nullable
                 java.lang.Object boxedObject)

Description copied from interface: Query

Evaluates the query on a boxedObject. The query must be a boolean valued constraint.

Specified by:

checkBoxed in interface Query

Parameters:

boxedObject - an Object or null if the query does not require an OCL 'self' context

Returns:

boolean true or false according to whether the constraint is met

checkBoxed

public boolean checkBoxed(@NonNull
                 java.lang.Iterable<?> boxedObjects)

Description copied from interface: Query

Determines whether all of the boxedObjects satisfy the query. The query must be a boolean-valued constraint.

Specified by:

checkBoxed in interface Query

Parameters:

boxedObjects - a list of objects to evaluate the constraint on

Returns:

true if all of the objects satisfy the constraint (including the trivial case of an empty input list); false, otherwise

checkEcore

public boolean checkEcore(@Nullable
                 java.lang.Object ecoreObject)

Description copied from interface: Query

Evaluates the query on an ecoreObject. The query must be a boolean valued constraint.

Specified by:

checkEcore in interface Query

Parameters:

ecoreObject - an Object or null if the query does not require an OCL 'self' context

Returns:

boolean true or false according to whether the constraint is met

checkEcore

public boolean checkEcore(@NonNull
                 java.lang.Iterable<?> ecoreObjects)

Description copied from interface: Query

Determines whether all of the ecoreObjects satisfy the query. The query must be a boolean-valued constraint.

Specified by:

checkEcore in interface Query

Parameters:

ecoreObjects - a list of objects to evaluate the constraint on

Returns:

true if all of the objects satisfy the constraint (including the trivial case of an empty input list); false, otherwise

evaluateBoxed

@Nullable
public java.lang.Object evaluateBoxed(@Nullable
                                      java.lang.Object boxedValue)

Description copied from interface: Query

Evaluates the query on the boxedObject to return a boxedResult.

Specified by:

evaluateBoxed in interface Query

evaluateBoxed

@NonNull
public java.util.List<?> evaluateBoxed(@NonNull
                                      java.lang.Iterable<?> boxedObjects)

Description copied from interface: Query

Evaluates the query on each of boxedObjects to return a list of boxedResults.

Specified by:

evaluateBoxed in interface Query

evaluateEcore

@Nullable
public java.lang.Object evaluateEcore(@Nullable
                                      java.lang.Object ecoreObject)
                               throws EvaluationException

Description copied from interface: Query

Evaluates the query on the ecoreObject to return an ecoreResult using Integer/Double for numerics.

Specified by:

evaluateEcore in interface Query

Throws:

EvaluationException

evaluateEcore

@Nullable
public java.lang.Object evaluateEcore(@Nullable
                                      java.lang.Class<?> instanceClass,
                                      @Nullable
                                      java.lang.Object ecoreObject)
                               throws EvaluationException

Description copied from interface: Query

Evaluates the query on the ecoreObject to return an ecoreResult coerced, if non-null, to instanceClass.

Specified by:

evaluateEcore in interface Query

Throws:

EvaluationException

evaluateEcore

@NonNull
public org.eclipse.emf.common.util.EList<?> evaluateEcore(@NonNull
                                                         java.lang.Iterable<?> ecoreObjects)
                                                   throws EvaluationException

Description copied from interface: Query

Evaluates the query on each of ecoreObjects to return a list of ecoreResults using Integer/Double for numerics.

Specified by:

evaluateEcore in interface Query

Throws:

EvaluationException

evaluateEcore

@NonNull
public org.eclipse.emf.common.util.EList<?> evaluateEcore(@Nullable
                                                         java.lang.Class<?> instanceClass,
                                                         @NonNull
                                                         java.lang.Iterable<?> ecoreObjects)

Description copied from interface: Query

Evaluates the query on each of ecoreObjects to return a list of ecoreResults coerced, if non-null, to instanceClass.

Specified by:

evaluateEcore in interface Query

evaluateUnboxed

@Nullable
public java.lang.Object evaluateUnboxed(@Nullable
                                        java.lang.Object unboxedObject)
                                 throws EvaluationException

Description copied from interface: Query

Evaluates the query on the unboxedObject to return an unboxedResult.

Specified by:

evaluateUnboxed in interface Query

Throws:

EvaluationException

getEvaluationEnvironment

@NonNull
public EvaluationEnvironment getEvaluationEnvironment(@Nullable
                                                     java.lang.Object unboxedObject)

Description copied from interface: Query

Obtains the evaluation environment that I use to evaluate OCL expressions. The EvaluationEnvironment is created lazily to suit the first evaluation and thereafter may be reused for the same query expression on many different objects. The associated ModelManager is obtained from the OCL that created this query, unless null in which case it is also created lazily to suit the first evaluation.

Specified by:

getEvaluationEnvironment in interface Query

Returns:

my environment

getExpression

@NonNull
public OCLExpression getExpression()

Description copied from interface: Query

Obtains the expression that I evaluate (or check as a boolean constraint).

Specified by:

getExpression in interface Query

Returns:

my OCL expression

getOCL

@NonNull
public OCL getOCL()

Description copied from interface: Query

Obtains the OCL that created me.

Specified by:

getOCL in interface Query

Returns:

my originating OCL instance

getProblems

public org.eclipse.emf.common.util.Diagnostic getProblems()

Description copied from interface: ProblemAware

Retrieves the problems available on this problem aware object

Specified by:

getProblems in interface ProblemAware

Returns:

the diagnostic object representing the problems or null in case that no problems are available.

queryText

public java.lang.String queryText()

Description copied from interface: Query

Translates the query back to an OCL text string.

Specified by:

queryText in interface Query

Returns:

the text of the OCL query expression

rejectEcore

@NonNull
public <T> java.util.List<T> rejectEcore(@NonNull
                                        java.lang.Iterable<T> ecoreObjects)

Description copied from interface: Query

Determines the subset of ecoreObjects that do not satisfy the query. The query must be a boolean valued constraint.

Specified by:

rejectEcore in interface Query

Parameters:

ecoreObjects - a list of objects to evaluate the constraint on

Returns:

the subset (possibly empty) of the objects that do not satisfy the constraint

resultType

public Type resultType()

Description copied from interface: Query

Obtains the OCL result type of the query. This may be a classifier in the user model, or it may represent a pre-defined OCL data type such as Boolean.

Specified by:

resultType in interface Query

Returns:

the query's result type

selectEcore

@NonNull
public <T> java.util.List<T> selectEcore(@NonNull
                                        java.lang.Iterable<T> ecoreObjects)

Description copied from interface: Query

Determines the subset of ecoreObjects that satisfy the query. The query must be a boolean valued constraint.

Specified by:

selectEcore in interface Query

Parameters:

ecoreObjects - a list of objects to evaluate the constraint on

Returns:

the subset (possibly empty) of the objects that satisfy the constraint

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object