org.eclipse.incquery.patternlanguage.helper

Class CorePatternLanguageHelper

java.lang.Object

org.eclipse.incquery.patternlanguage.helper.CorePatternLanguageHelper

public final class CorePatternLanguageHelper
extends java.lang.Object

Method Summary

Modifier and Type	Method and Description
static PatternBody	containerPatternBody(ValueReference val)
static java.util.Map<java.lang.String,java.lang.Object>	evaluateAnnotationParameters(Annotation annotation)
static java.util.Collection<org.eclipse.xtext.xbase.XExpression>	getAllTopLevelXBaseExpressions(org.eclipse.emf.ecore.EObject patternOrBody)
static org.eclipse.emf.common.util.EList<Variable>	getAllVariablesInBody(PatternBody body, org.eclipse.emf.common.util.EList<Variable> previous)
static java.util.Collection<ValueReference>	getAnnotationParameters(Annotation annotation, java.lang.String parameterName) Returns all annotation parameters with a selected name
static java.util.Collection<Annotation>	getAnnotationsByName(Pattern pattern, java.lang.String name) Returns the collection of annotations of a pattern by a name.
static Annotation	getFirstAnnotationByName(Pattern pattern, java.lang.String name) Returns the first annotation of a given name from a pattern.
static ValueReference	getFirstAnnotationParameter(Annotation annotation, java.lang.String parameterName) Returns the first annotation parameter with a selected name.
static java.lang.String	getFullyQualifiedName(Pattern pattern) Returns the name of the pattern, qualified by package name.
static java.lang.String	getPackageName(Pattern pattern) Returns the name of the container package of the selected pattern
static Variable	getParameterByName(Pattern pattern, java.lang.String name) Returns the parameter of a pattern by name
static java.util.Map<java.lang.String,java.lang.Integer>	getParameterPositionsByName(Pattern pattern) Compiles a map for name-based lookup of symbolic parameter positions.
static java.util.Set<Pattern>	getReferencedPatterns(Pattern sourcePattern) Finds all patterns referenced from the given pattern.
static java.util.Set<Pattern>	getReferencedPatternsTransitive(Pattern pattern)
static java.util.Set<Variable>	getReferencedPatternVariablesOfXExpression(org.eclipse.xtext.xbase.XExpression xExpression, org.eclipse.xtext.xbase.jvmmodel.IJvmModelAssociations associations) Finds all pattern variables referenced from the given XExpression.
static java.util.List<Variable>	getUnnamedRunningVariables(PatternBody patternBody)
static java.util.List<Variable>	getUsedVariables(org.eclipse.xtext.xbase.XExpression xExpression, java.lang.Iterable<Variable> allVariables)
static boolean	getValueOfFirstBooleanAnnotationParameter(Annotation annotation, java.lang.String parameterName, boolean defaultValue) Returns the value of the first Boolean annotation parameter with the given name.
static java.util.Set<Variable>	getVariablesFromValueReference(ValueReference valueReference)
static boolean	hasXBaseExpression(Pattern pattern)
static boolean	isPrivate(Pattern pattern)

Methods inherited from class java.lang.Object

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

Method Detail

getPackageName

public static java.lang.String getPackageName(Pattern pattern)

Returns the name of the container package of the selected pattern

Returns:

a name of the pattern; never null, but may be empty string

getFullyQualifiedName

public static java.lang.String getFullyQualifiedName(Pattern pattern)

Returns the name of the pattern, qualified by package name.

isPrivate

public static boolean isPrivate(Pattern pattern)

Parameters:

pattern -

Returns:

true if the pattern has a private modifier, false otherwise.

hasXBaseExpression

public static boolean hasXBaseExpression(Pattern pattern)

Parameters:

pattern -

Returns:

true if the pattern contains xbase check() or eval() expressions, false otherwise.

getAllTopLevelXBaseExpressions

public static java.util.Collection<org.eclipse.xtext.xbase.XExpression> getAllTopLevelXBaseExpressions(org.eclipse.emf.ecore.EObject patternOrBody)

Returns:

all xbase check() or eval() expressions in the pattern

getParameterByName

public static Variable getParameterByName(Pattern pattern,
                                          java.lang.String name)

Returns the parameter of a pattern by name

Parameters:

pattern -

name -

Returns:

the requested parameter of the pattern, or null if none exists

Since:

0.7.0

getParameterPositionsByName

public static java.util.Map<java.lang.String,java.lang.Integer> getParameterPositionsByName(Pattern pattern)

Compiles a map for name-based lookup of symbolic parameter positions.

getReferencedPatternVariablesOfXExpression

public static java.util.Set<Variable> getReferencedPatternVariablesOfXExpression(org.eclipse.xtext.xbase.XExpression xExpression,
                                                                                 org.eclipse.xtext.xbase.jvmmodel.IJvmModelAssociations associations)

Finds all pattern variables referenced from the given XExpression.

Warning This method cannot be used in JvmModelInferrer, as that is used to set up the list of available local variables.

getUsedVariables

public static java.util.List<Variable> getUsedVariables(org.eclipse.xtext.xbase.XExpression xExpression,
                                                        java.lang.Iterable<Variable> allVariables)

getAllVariablesInBody

public static org.eclipse.emf.common.util.EList<Variable> getAllVariablesInBody(PatternBody body,
                                                                                org.eclipse.emf.common.util.EList<Variable> previous)

getReferencedPatterns

public static java.util.Set<Pattern> getReferencedPatterns(Pattern sourcePattern)

Finds all patterns referenced from the given pattern.

getReferencedPatternsTransitive

public static java.util.Set<Pattern> getReferencedPatternsTransitive(Pattern pattern)

getFirstAnnotationByName

public static Annotation getFirstAnnotationByName(Pattern pattern,
                                                  java.lang.String name)

Returns the first annotation of a given name from a pattern. This method ignores multiple defined annotations by the same name. For getting a filtered collections of annotations, see getAnnotationsByName(Pattern, String)

Parameters:

pattern - the pattern instance

name - the name of the annotation to return

Since:

0.7.0

getAnnotationsByName

public static java.util.Collection<Annotation> getAnnotationsByName(Pattern pattern,
                                                                    java.lang.String name)

Returns the collection of annotations of a pattern by a name. For getting the first annotations by name, see #getAnnotationByName(Pattern, String)

Parameters:

pattern - the pattern instance

name - the name of the annotation to return

Since:

0.7.0

getAnnotationParameters

public static java.util.Collection<ValueReference> getAnnotationParameters(Annotation annotation,
                                                                           java.lang.String parameterName)

Returns all annotation parameters with a selected name

Parameters:

annotation -

parameterName -

Returns:

a lazy collection of annotation parameters with the selected name. May be empty, but is never null.

getFirstAnnotationParameter

public static ValueReference getFirstAnnotationParameter(Annotation annotation,
                                                         java.lang.String parameterName)

Returns the first annotation parameter with a selected name.

Parameters:

annotation -

parameterName -

Returns:

the annotation with the selected name, or null if no such annotation exists.

getValueOfFirstBooleanAnnotationParameter

public static boolean getValueOfFirstBooleanAnnotationParameter(Annotation annotation,
                                                                java.lang.String parameterName,
                                                                boolean defaultValue)

Returns the value of the first Boolean annotation parameter with the given name. If the parameter with the given name is not Boolean or is not defined then the default value is returned.

Parameters:

annotation -

parameterName -

defaultValue -

Returns:

the value of the first boolean parameter with the given name, otherwise defaultValue

getVariablesFromValueReference

public static java.util.Set<Variable> getVariablesFromValueReference(ValueReference valueReference)

Parameters:

valueReference -

Returns:

all variables from the ValueReference object. (Either referenced directly, or referenced throught an AggregatedValue.)

containerPatternBody

public static PatternBody containerPatternBody(ValueReference val)

Returns:

the pattern body that contains the value reference

getUnnamedRunningVariables

public static java.util.List<Variable> getUnnamedRunningVariables(PatternBody patternBody)

Parameters:

patternBody -

Returns:

A list of variables, which are running/unnamed variables in the pattern body. These variables' name starts with the "_" prefix, and can be found in find, count find calls.

evaluateAnnotationParameters

public static java.util.Map<java.lang.String,java.lang.Object> evaluateAnnotationParameters(Annotation annotation)