BaseMatcher

java.lang.Object
- org.eclipse.incquery.runtime.internal.apiimpl.QueryResultWrapper
- - org.eclipse.incquery.runtime.api.impl.BaseMatcher<Match>

Type Parameters:

Match -

All Implemented Interfaces:

IncQueryMatcher<Match>

Direct Known Subclasses:

ActionContextMatcher, ActionInputMatcher, ActionOutputMatcher, ActivityEdgeInGroupMatcher, ActivityGroupContainedEdgeMatcher, ActivityGroupContainedNodeMatcher, ActivityGroupInActivityMatcher, ActivityGroupMatcher, ActivityGroupSubgroupMatcher, ActivityGroupSuperGroupMatcher, ActivityNodeActivityMatcher, ActivityNodeInGroupMatcher, ActivityNodeMatcher, AssociationEndTypeMatcher, BehaviorContextMatcher, ChildrenMatcher, ClassExtensionMatcher, ClassifierAllParentsMatcher, ClassifierAttributeMatcher, ClassifierFeatureMatcher, ClassifierGeneralMatcher, ClassifierParentsMatcher, ClassSuperClassMatcher, ConnectableElementEndMatcher, ConnectorKindMatcher, DeploymentTargetDeployedElementMatcher, DirectedRelationshipSourceMatcher, DirectedRelationshipTargetMatcher, ElementOwnedElementMatcher, ElementOwnerMatcher, EmptyTraceMatcher, EncapsulatedClassifierOwnedPortMatcher, ExtensionMetaclassEndMatcher, ExtensionMetaclassMatcher, FeatureFeaturingClassifierMatcher, GenericPatternMatcher, MessageMessageKindMatcher, NamedElementClientDependencyMatcher, NamedElementNamespaceMatcher, NamedElementQualifiedNameMatcher, NamespaceImportedMemberMatcher, NamespaceMemberMatcher, NamespaceOwnedMemberMatcher, OpaqueExpressionResultMatcher, OperationReturnResultMatcher, PackageNestedPackageMatcher, PackageNestingPackageMatcher, PackageOwnedStereotypeMatcher, PackageOwnedTypeMatcher, PackageVisibleMemberMatcher, Param2containmentMatcher, Param2edgeMatcher, Param2itemMatcher, Param2targetMatcher, PropertyIsCompositeMatcher, ProtocolTransitionReferredMatcher, RedefinableElementRedefinedElementMatcher, RedefinableElementRedefinitionContextMatcher, RedefinableTemplateSignatureInheritedParameterMatcher, RelationshipRelatedElementMatcher, StateIsCompositeMatcher, StateIsOrthogonalMatcher, StructuredClassifierPartMatcher, StructuredClassifierRoleMatcher, Trace2objectMatcher, Trace2paramMatcher, Trace2targetMatcher, TraceMatcher, TypePackageMatcher, VertexIncomingMatcher, VertexOutgoingMatcher
```
public abstract class BaseMatcher<Match extends IPatternMatch>
extends QueryResultWrapper
implements IncQueryMatcher<Match>
```
Base implementation of IncQueryMatcher.

Author:

Bergmann Gábor

Constructor Summary

Constructors
Constructor and Description

BaseMatcher(IncQueryEngine engine, IQuerySpecification<? extends BaseMatcher<Match>> querySpecification)

Constructors
Constructor and Description
`BaseMatcher(IncQueryEngine engine, IQuerySpecification<? extends BaseMatcher<Match>> querySpecification)`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`int`	`countMatches()` Returns the number of all pattern matches.
`int`	`countMatches(Match partialMatch)` Returns the number of all matches of the pattern that conform to the given fixed values of some parameters.
`void`	`forEachMatch(IMatchProcessor<? super Match> processor)` Executes the given processor on each match of the pattern.
`void`	`forEachMatch(Match match, IMatchProcessor<? super Match> processor)` Executes the given processor on each match of the pattern that conforms to the given fixed values of some parameters.
`boolean`	`forOneArbitraryMatch(IMatchProcessor<? super Match> processor)` Executes the given processor on an arbitrarily chosen match of the pattern.
`boolean`	`forOneArbitraryMatch(Match partialMatch, IMatchProcessor<? super Match> processor)` Executes the given processor on an arbitrarily chosen match of the pattern that conforms to the given fixed values of some parameters.
`java.util.Collection<Match>`	`getAllMatches()` Returns the set of all pattern matches.
`java.util.Collection<Match>`	`getAllMatches(Match partialMatch)` Returns the set of all matches of the pattern that conform to the given fixed values of some parameters.
`java.util.Set<java.lang.Object>`	`getAllValues(java.lang.String parameterName)` Retrieve the set of values that occur in matches for the given parameterName.
`java.util.Set<java.lang.Object>`	`getAllValues(java.lang.String parameterName, Match partialMatch)` Retrieve the set of values that occur in matches for the given parameterName, that conforms to the given fixed values of some parameters.
`IncQueryEngine`	`getEngine()` Returns the engine that the matcher uses.
`Match`	`getOneArbitraryMatch()` Returns an arbitrarily chosen pattern match.
`Match`	`getOneArbitraryMatch(Match partialMatch)` Returns an arbitrarily chosen match of the pattern that conforms to the given fixed values of some parameters.
`java.util.List<java.lang.String>`	`getParameterNames()` Returns the array of symbolic parameter names.
`java.lang.String`	`getPatternName()` Fully qualified name of the pattern.
`java.lang.Integer`	`getPositionOfParameter(java.lang.String parameterName)` Returns the index of the symbolic parameter with the given name.
`IQuerySpecification<? extends BaseMatcher<Match>>`	`getSpecification()` The pattern that will be matched.
`boolean`	`hasMatch(Match partialMatch)` Indicates whether the given combination of specified pattern parameters constitute a valid pattern match, under any possible substitution of the unspecified parameters (if any).
`Match`	`newEmptyMatch()` Returns an empty, mutable Match for the matcher.
`Match`	`newMatch(java.lang.Object... parameters)` Returns a new (partial) Match object for the matcher.

Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - BaseMatcher
```
public BaseMatcher(IncQueryEngine engine,
                   IQuerySpecification<? extends BaseMatcher<Match>> querySpecification)
            throws IncQueryException
```
    Throws:
    
    IncQueryException
- Method Detail
  - getPositionOfParameter
```
public java.lang.Integer getPositionOfParameter(java.lang.String parameterName)
```
    Description copied from interface: IncQueryMatcher
    
    Returns the index of the symbolic parameter with the given name.
    
    Specified by:
    
    getPositionOfParameter in interface IncQueryMatcher<Match extends IPatternMatch>
  - getParameterNames
```
public java.util.List<java.lang.String> getParameterNames()
```
    Description copied from interface: IncQueryMatcher
    
    Returns the array of symbolic parameter names.
    
    Specified by:
    
    getParameterNames in interface IncQueryMatcher<Match extends IPatternMatch>
  - getAllMatches
```
public java.util.Collection<Match> getAllMatches()
```
    Description copied from interface: IncQueryMatcher
    
    Returns the set of all pattern matches.
    
    Specified by:
    
    getAllMatches in interface IncQueryMatcher<Match extends IPatternMatch>
    
    Returns:
    
    matches represented as a Match object.
  - getAllMatches
```
public java.util.Collection<Match> getAllMatches(Match partialMatch)
```
    Description copied from interface: IncQueryMatcher
    
    Returns the set of all matches of the pattern that conform to the given fixed values of some parameters.
    
    Specified by:
    
    getAllMatches in interface IncQueryMatcher<Match extends IPatternMatch>
    
    Parameters:
    
    partialMatch - a partial match of the pattern where each non-null field binds the corresponding pattern parameter to a fixed value.
    
    Returns:
    
    matches represented as a Match object.
  - getOneArbitraryMatch
```
public Match getOneArbitraryMatch()
```
    Description copied from interface: IncQueryMatcher
    
    Returns an arbitrarily chosen pattern match. Neither determinism nor randomness of selection is guaranteed.
    
    Specified by:
    
    getOneArbitraryMatch in interface IncQueryMatcher<Match extends IPatternMatch>
    
    Returns:
    
    a match represented as a Match object, or null if no match is found.
  - getOneArbitraryMatch
```
public Match getOneArbitraryMatch(Match partialMatch)
```
    Description copied from interface: IncQueryMatcher
    
    Returns an arbitrarily chosen match of the pattern that conforms to the given fixed values of some parameters. Neither determinism nor randomness of selection is guaranteed.
    
    Specified by:
    
    getOneArbitraryMatch in interface IncQueryMatcher<Match extends IPatternMatch>
    
    Parameters:
    
    partialMatch - a partial match of the pattern where each non-null field binds the corresponding pattern parameter to a fixed value.
    
    Returns:
    
    a match represented as a Match object, or null if no match is found.
  - hasMatch
```
public boolean hasMatch(Match partialMatch)
```
    Description copied from interface: IncQueryMatcher
    
    Indicates whether the given combination of specified pattern parameters constitute a valid pattern match, under any possible substitution of the unspecified parameters (if any).
    
    Specified by:
    
    hasMatch in interface IncQueryMatcher<Match extends IPatternMatch>
    
    Parameters:
    
    partialMatch - a (partial) match of the pattern where each non-null field binds the corresponding pattern parameter to a fixed value.
    
    Returns:
    
    true if the input is a valid (partial) match of the pattern.
  - countMatches
```
public int countMatches()
```
    Description copied from interface: IncQueryMatcher
    
    Returns the number of all pattern matches.
    
    Specified by:
    
    countMatches in interface IncQueryMatcher<Match extends IPatternMatch>
    
    Returns:
    
    the number of pattern matches found.
  - countMatches
```
public int countMatches(Match partialMatch)
```
    Description copied from interface: IncQueryMatcher
    
    Returns the number of all matches of the pattern that conform to the given fixed values of some parameters.
    
    Specified by:
    
    countMatches in interface IncQueryMatcher<Match extends IPatternMatch>
    
    Parameters:
    
    partialMatch - a partial match of the pattern where each non-null field binds the corresponding pattern parameter to a fixed value.
    
    Returns:
    
    the number of pattern matches found.
  - forEachMatch
```
public void forEachMatch(IMatchProcessor<? super Match> processor)
```
    Description copied from interface: IncQueryMatcher
    
    Executes the given processor on each match of the pattern.
    
    Specified by:
    
    forEachMatch in interface IncQueryMatcher<Match extends IPatternMatch>
    
    Parameters:
    
    processor - the action that will process each pattern match.
  - forEachMatch
```
public void forEachMatch(Match match,
                         IMatchProcessor<? super Match> processor)
```
    Description copied from interface: IncQueryMatcher
    
    Executes the given processor on each match of the pattern that conforms to the given fixed values of some parameters.
    
    Specified by:
    
    forEachMatch in interface IncQueryMatcher<Match extends IPatternMatch>
    
    Parameters:
    
    match - array where each non-null element binds the corresponding pattern parameter to a fixed value.
    
    processor - the action that will process each pattern match.
  - forOneArbitraryMatch
```
public boolean forOneArbitraryMatch(IMatchProcessor<? super Match> processor)
```
    Description copied from interface: IncQueryMatcher
    
    Executes the given processor on an arbitrarily chosen match of the pattern. Neither determinism nor randomness of selection is guaranteed.
    
    Specified by:
    
    forOneArbitraryMatch in interface IncQueryMatcher<Match extends IPatternMatch>
    
    Parameters:
    
    processor - the action that will process the selected match.
    
    Returns:
    
    true if the pattern has at least one match, false if the processor was not invoked
  - forOneArbitraryMatch
```
public boolean forOneArbitraryMatch(Match partialMatch,
                                    IMatchProcessor<? super Match> processor)
```
    Description copied from interface: IncQueryMatcher
    
    Executes the given processor on an arbitrarily chosen match of the pattern that conforms to the given fixed values of some parameters. Neither determinism nor randomness of selection is guaranteed.
    
    Specified by:
    
    forOneArbitraryMatch in interface IncQueryMatcher<Match extends IPatternMatch>
    
    Parameters:
    
    partialMatch - array where each non-null element binds the corresponding pattern parameter to a fixed value.
    
    processor - the action that will process the selected match.
    
    Returns:
    
    true if the pattern has at least one match with the given parameter values, false if the processor was not invoked
  - newEmptyMatch
```
public Match newEmptyMatch()
```
    Description copied from interface: IncQueryMatcher
    
    Returns an empty, mutable Match for the matcher. Fields of the mutable match can be filled to create a partial match, usable as matcher input. This can be used to call the matcher with a partial match even if the specific class of the matcher or the match is unknown.
    
    Specified by:
    
    newEmptyMatch in interface IncQueryMatcher<Match extends IPatternMatch>
    
    Returns:
    
    the empty match
  - newMatch
```
public Match newMatch(java.lang.Object... parameters)
```
    Description copied from interface: IncQueryMatcher
    
    Returns a new (partial) Match object for the matcher. This can be used e.g. to call the matcher with a partial match.
    The returned match will be immutable. Use IncQueryMatcher.newEmptyMatch() to obtain a mutable match object.
    
    Specified by:
    
    newMatch in interface IncQueryMatcher<Match extends IPatternMatch>
    
    Parameters:
    
    parameters - the fixed value of pattern parameters, or null if not bound.
    
    Returns:
    
    the (partial) match object.
  - getAllValues
```
public java.util.Set<java.lang.Object> getAllValues(java.lang.String parameterName)
```
    Description copied from interface: IncQueryMatcher
    
    Retrieve the set of values that occur in matches for the given parameterName.
    
    Specified by:
    
    getAllValues in interface IncQueryMatcher<Match extends IPatternMatch>
    
    Parameters:
    
    parameterName - name of the parameter for which values are returned
    
    Returns:
    
    the Set of all values for the given parameter, null if the parameter with the given name does not exists, empty set if there are no matches
  - getAllValues
```
public java.util.Set<java.lang.Object> getAllValues(java.lang.String parameterName,
                                                    Match partialMatch)
```
    Description copied from interface: IncQueryMatcher
    
    Retrieve the set of values that occur in matches for the given parameterName, that conforms to the given fixed values of some parameters.
    
    Specified by:
    
    getAllValues in interface IncQueryMatcher<Match extends IPatternMatch>
    
    Parameters:
    
    parameterName - name of the parameter for which values are returned
    
    partialMatch - a partial match of the pattern where each non-null field binds the corresponding pattern parameter to a fixed value.
    
    Returns:
    
    the Set of all values for the given parameter, null if the parameter with the given name does not exists or if the parameter with the given name is set in partialMatch, empty set if there are no matches
  - getEngine
```
public IncQueryEngine getEngine()
```
    Description copied from interface: IncQueryMatcher
    
    Returns the engine that the matcher uses.
    
    Specified by:
    
    getEngine in interface IncQueryMatcher<Match extends IPatternMatch>
    
    Returns:
    
    the engine
  - getSpecification
```
public IQuerySpecification<? extends BaseMatcher<Match>> getSpecification()
```
    Description copied from interface: IncQueryMatcher
    
    The pattern that will be matched.
    
    Specified by:
    
    getSpecification in interface IncQueryMatcher<Match extends IPatternMatch>
  - getPatternName
```
public java.lang.String getPatternName()
```
    Description copied from interface: IncQueryMatcher
    
    Fully qualified name of the pattern.
    
    Specified by:
    
    getPatternName in interface IncQueryMatcher<Match extends IPatternMatch>

Class BaseMatcher<Match extends IPatternMatch>

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

BaseMatcher

Method Detail

getPositionOfParameter

getParameterNames

getAllMatches

getAllMatches

getOneArbitraryMatch

getOneArbitraryMatch

hasMatch

countMatches

countMatches

forEachMatch

forEachMatch

forOneArbitraryMatch

forOneArbitraryMatch

newEmptyMatch

newMatch

getAllValues

getAllValues

getEngine

getSpecification

getPatternName