Package tools.refinery.interpreter.api.impl

Class BaseQuerySpecification<Matcher extends InterpreterMatcher<? extends IPatternMatch>>

java.lang.Object

tools.refinery.interpreter.api.impl.BaseQuerySpecification<Matcher>

All Implemented Interfaces:

IQuerySpecification<Matcher>, PQueryHeader

Direct Known Subclasses:

GenericQuerySpecification

public abstract class BaseQuerySpecification<Matcher extends InterpreterMatcher<? extends IPatternMatch>>
extends Object
implements IQuerySpecification<Matcher>

Base implementation of IQuerySpecification.

Field Summary

Fields

Modifier and Type	Field	Description
protected final PQuery	wrappedPQuery

Constructor Summary

Constructors

Constructor	Description
BaseQuerySpecification(PQuery wrappedPQuery)	Instantiates query specification for the given internal query representation.

Method Summary

Modifier and Type	Method	Description
protected void	ensureInitializedInternal()
List<PAnnotation>	getAllAnnotations()	Returns the list of annotations specified for this query
List<PAnnotation>	getAnnotationsByName(String annotationName)	Returns the list of annotations with a specified name
Optional<PAnnotation>	getFirstAnnotationByName(String annotationName)	Returns the first annotation with a specified name
String	getFullyQualifiedName()	Identifies the pattern for which matchers can be instantiated.
PQuery	getInternalQueryRepresentation()	Returns the definition of the query in a format intended for consumption by the query evaluator.
Matcher	getMatcher(InterpreterEngine engine)	Initializes the pattern matcher within an existing InterpreterEngine.
List<String>	getParameterNames()	Return the list of parameter names
List<PParameter>	getParameters()	Returns a list of parameter descriptions
Integer	getPositionOfParameter(String parameterName)	Returns the index of a named parameter
PVisibility	getVisibility()	Returns the visibility information about the query.
Matcher	instantiate()	This method has a default implementation returning null, indicating that a matcher can only be created using the old method, which ignores the hints provided by the user.
protected abstract Matcher	instantiate(InterpreterEngine engine)
protected static InterpreterException	processInitializerError(ExceptionInInitializerError err)

Methods inherited from class java.lang.Object

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

Methods inherited from interface tools.refinery.interpreter.api.IQuerySpecification

getPProblems, getPreferredScopeClass, getStatus, newEmptyMatch, newMatch

Methods inherited from interface tools.refinery.interpreter.matchers.psystem.queries.PQueryHeader

getParameter, getSimpleName

Field Details

wrappedPQuery

protected final PQuery wrappedPQuery

Constructor Details

BaseQuerySpecification

public BaseQuerySpecification(PQuery wrappedPQuery)

Instantiates query specification for the given internal query representation.

Method Details

processInitializerError

protected static InterpreterException processInitializerError(ExceptionInInitializerError err)

Since:

1.6

instantiate

protected abstract Matcher instantiate(InterpreterEngine engine)

instantiate

public Matcher instantiate()

This method has a default implementation returning null, indicating that a matcher can only be created using the old method, which ignores the hints provided by the user.

Specified by:

instantiate in interface IQuerySpecification<Matcher extends InterpreterMatcher<? extends IPatternMatch>>

Since:

1.4

getInternalQueryRepresentation

public PQuery getInternalQueryRepresentation()

Description copied from interface: IQuerySpecification

Returns the definition of the query in a format intended for consumption by the query evaluator.

Specified by:

getInternalQueryRepresentation in interface IQuerySpecification<Matcher extends InterpreterMatcher<? extends IPatternMatch>>

Returns:

the internal representation of the query.

getMatcher

public Matcher getMatcher(InterpreterEngine engine)

Description copied from interface: IQuerySpecification

Initializes the pattern matcher within an existing InterpreterEngine. If the pattern matcher is already constructed in the engine, only a lightweight reference is created.

The match set will be incrementally refreshed upon updates.

Specified by:

getMatcher in interface IQuerySpecification<Matcher extends InterpreterMatcher<? extends IPatternMatch>>

Parameters:

engine - the existing Refinery Interpreter engine in which this matcher will be created.

ensureInitializedInternal

protected void ensureInitializedInternal()

getAllAnnotations

public List<PAnnotation> getAllAnnotations()

Description copied from interface: PQueryHeader

Returns the list of annotations specified for this query

Specified by:

getAllAnnotations in interface PQueryHeader

Returns:

a non-null, but possibly empty list of annotations

getAnnotationsByName

public List<PAnnotation> getAnnotationsByName(String annotationName)

Description copied from interface: PQueryHeader

Returns the list of annotations with a specified name

Specified by:

getAnnotationsByName in interface PQueryHeader

Parameters:

annotationName -

Returns:

a non-null, but possibly empty list of annotations

getFirstAnnotationByName

public Optional<PAnnotation> getFirstAnnotationByName(String annotationName)

Description copied from interface: PQueryHeader

Returns the first annotation with a specified name

Specified by:

getFirstAnnotationByName in interface PQueryHeader

getFullyQualifiedName

public String getFullyQualifiedName()

Description copied from interface: PQueryHeader

Identifies the pattern for which matchers can be instantiated.

Specified by:

getFullyQualifiedName in interface PQueryHeader

getParameterNames

public List<String> getParameterNames()

Description copied from interface: PQueryHeader

Return the list of parameter names

Specified by:

getParameterNames in interface PQueryHeader

Returns:

a non-null, but possibly empty list of parameter names

getParameters

public List<PParameter> getParameters()

Description copied from interface: PQueryHeader

Returns a list of parameter descriptions

Specified by:

getParameters in interface PQueryHeader

Returns:

a non-null, but possibly empty list of parameter descriptions

getPositionOfParameter

public Integer getPositionOfParameter(String parameterName)

Description copied from interface: PQueryHeader

Returns the index of a named parameter

Specified by:

getPositionOfParameter in interface PQueryHeader

Parameters:

parameterName -

Returns:

the index, or null of no such parameter is available

getVisibility

public PVisibility getVisibility()

Description copied from interface: PQueryHeader

Returns the visibility information about the query.

Specified by:

getVisibility in interface PQueryHeader

Since:

2.0