org.eclipse.incquery.viewers.runtime.model.patterns.util

Class ChildrenQuerySpecification

java.lang.Object

org.eclipse.incquery.runtime.api.impl.BaseQuerySpecification<Matcher>

org.eclipse.incquery.runtime.api.impl.BaseGeneratedEMFQuerySpecification<ChildrenMatcher>

org.eclipse.incquery.viewers.runtime.model.patterns.util.ChildrenQuerySpecification

All Implemented Interfaces:

IQuerySpecification<ChildrenMatcher>, PQueryHeader

public final class ChildrenQuerySpecification
extends BaseGeneratedEMFQuerySpecification<ChildrenMatcher>

A pattern-specific query specification that can instantiate ChildrenMatcher in a type-safe way.

See Also:

ChildrenMatcher, ChildrenMatch

Method Summary

Modifier and Type	Method and Description
static ChildrenQuerySpecification	instance()
ChildrenMatch	newEmptyMatch() Returns an empty, mutable Match compatible with matchers of this query.
ChildrenMatch	newMatch(java.lang.Object... parameters) Returns a new (partial) Match object compatible with matchers of this query.

Methods inherited from class org.eclipse.incquery.runtime.api.impl.BaseGeneratedEMFQuerySpecification

getPreferredScopeClass

Methods inherited from class org.eclipse.incquery.runtime.api.impl.BaseQuerySpecification

getAllAnnotations, getAnnotationsByName, getFirstAnnotationByName, getFullyQualifiedName, getInternalQueryRepresentation, getMatcher, getMatcher, getParameterNames, getParameters, getPositionOfParameter

Methods inherited from class java.lang.Object

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

Method Detail

instance

public static ChildrenQuerySpecification instance()
                                           throws IncQueryException

Returns:

the singleton instance of the query specification

Throws:

IncQueryException - if the pattern definition could not be loaded

newEmptyMatch

public ChildrenMatch newEmptyMatch()

Description copied from interface: IQuerySpecification

Returns an empty, mutable Match compatible with matchers of this query. 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.

Returns:

the empty match

newMatch

public ChildrenMatch newMatch(java.lang.Object... parameters)

Description copied from interface: IQuerySpecification

Returns a new (partial) Match object compatible with matchers of this query. This can be used e.g. to call the matcher with a partial match.

The returned match will be immutable. Use IQuerySpecification.newEmptyMatch() to obtain a mutable match object.

Parameters:

parameters - the fixed value of pattern parameters, or null if not bound.

Returns:

the (partial) match object.