com.ibm.xtools.modeler.ui

Interface IOclQueryHelper

public interface IOclQueryHelper

A convenience interface for the execution of OCL expressions and queries on EMF models.

Note that this interface is not intended to be implemented by clients.

Method Summary

Modifier and Type	Method and Description
java.lang.Object	evaluate(org.eclipse.emf.ecore.EObject self, java.lang.String oclExpression, org.eclipse.core.runtime.IProgressMonitor monitor) Evaluates the OCL expression specified by oclExpression using self as the context for the expression evaluation.
java.util.Set<java.lang.Object>	executeOclStatement(org.eclipse.emf.ecore.EObject self, org.eclipse.emf.ecore.EClass selfType, java.lang.String oclStatement, org.eclipse.core.runtime.IProgressMonitor monitor) Deprecated. Use the evaluate(EObject, String, IProgressMonitor) method, instead, because it preserves the ordering of collection-valued OCL expressions in case the expression is of an ordered collection (list) type
java.util.Set<org.eclipse.emf.ecore.EObject>	executeQueryUsingOclFilter(org.eclipse.emf.ecore.EObject queryRoot, org.eclipse.emf.ecore.EClass selfType, java.lang.String oclFilter, org.eclipse.core.runtime.IProgressMonitor monitor) Executes a query using queryRoot as the root of the subtree to be searched and an OCL filter specified by oclFilter.

Method Detail

executeQueryUsingOclFilter

java.util.Set<org.eclipse.emf.ecore.EObject> executeQueryUsingOclFilter(org.eclipse.emf.ecore.EObject queryRoot,
                                                                        org.eclipse.emf.ecore.EClass selfType,
                                                                        java.lang.String oclFilter,
                                                                        org.eclipse.core.runtime.IProgressMonitor monitor)
                                                                 throws java.lang.InterruptedException,
                                                                        InvalidOclExpressionException

Executes a query using queryRoot as the root of the subtree to be searched and an OCL filter specified by oclFilter. EObjects satisfying the OCL filter condition are returned.

Parameters:

queryRoot - The root element to recursively search

selfType - Type of the "self" element specified in the query text. Use null to specify a context-free OCL query (in which case no syntactic validation of the OCL expression can be performed)

oclFilter - The string specifying the OCL query condition

monitor - The monitor to use to display progress and/or cancel

Returns:

A collection of EObjects in the queryRoot subtree that match the oclFilter condition

Throws:

java.lang.InterruptedException - if the query operation was interrupted

InvalidOclExpressionException - if the specified OCL expression is invalid

java.lang.IllegalArgumentException - if the oclFilter is an empty string

java.lang.NullPointerException - if any argument is null

executeOclStatement

java.util.Set<java.lang.Object> executeOclStatement(org.eclipse.emf.ecore.EObject self,
                                                    org.eclipse.emf.ecore.EClass selfType,
                                                    java.lang.String oclStatement,
                                                    org.eclipse.core.runtime.IProgressMonitor monitor)
                                             throws java.lang.InterruptedException,
                                                    InvalidOclExpressionException

Deprecated. Use the evaluate(EObject, String, IProgressMonitor) method, instead, because it preserves the ordering of collection-valued OCL expressions in case the expression is of an ordered collection (list) type

Executes the OCL statement specified by oclStatement using self as the context for the statement evaluation. The statement will only be applied to self without recursing into its contents.

Parameters:

self - The context to use for the OCL statement evaluation

selfType - Type of the self. Use null to specify a context-free OCL statement (in which case no syntactic validation of the OCL expression can be performed)

oclStatement - The string specifying the OCL statement

monitor - The monitor to use to display progress and/or cancel

Returns:

The set of Objects produced by executing the OCL statement. Can contain EObjects, Strings, Numbers, even nulls. However, the result itself will not be null

Throws:

java.lang.InterruptedException - if the statement execution was interrupted

InvalidOclExpressionException - if the specified oclStatement is invalid

java.lang.IllegalArgumentException - if the oclStatement is an empty string

java.lang.NullPointerException - if one of the arguments was null

evaluate

java.lang.Object evaluate(org.eclipse.emf.ecore.EObject self,
                          java.lang.String oclExpression,
                          org.eclipse.core.runtime.IProgressMonitor monitor)
                   throws java.lang.InterruptedException,
                          InvalidOclExpressionException

Evaluates the OCL expression specified by oclExpression using self as the context for the expression evaluation. The expression will only be evaluated on self without recursing into children.

Parameters:

self - The context to use for the OCL expression evaluation

oclExpression - The string specifying the OCL expression

monitor - The monitor to use to display progress and/or cancel

Returns:

the value of the OCL expression, if any. The value may be

• null if the expression's value is null or if it is a statement that has no result type
• an EObject if the value is a model element
• a Java Object if the value is some primitive value or other kind of Java object such as a string or a date
• a Collection of some kind if the value is some kind of OCL collection. This may be an ordered collection (List), a set (Set), or a bag (Collection)
. The collection could be empty and might contain any type of object (even collections).

Throws:

java.lang.InterruptedException - The expression evaluation was interrupted

InvalidOclExpressionException - The specified OCL expression is invalid

java.lang.IllegalArgumentException - oclExpression/code> is an empty string

java.lang.NullPointerException - One of the arguments was null