Package tools.refinery.interpreter.matchers.psystem.queries

Interface PQueryHeader

All Known Subinterfaces:
InitializablePQuery, IQuerySpecification<Matcher>, PQuery
All Known Implementing Classes:
BasePQuery, BaseQuerySpecification, GenericQuerySpecification
public interface PQueryHeader
Represents header information (metainfo) about a query.

To be implemented both by IQuerySpecifications intended for end users, and the internal query representation PQuery.

Since:
0.9

  • Method Details

    • getFullyQualifiedName

      String getFullyQualifiedName()
      Identifies the pattern for which matchers can be instantiated.

    • getParameterNames

      List<String> getParameterNames()
      Return the list of parameter names
      Returns:
      a non-null, but possibly empty list of parameter names

    • getParameters

      List<PParameter> getParameters()
      Returns a list of parameter descriptions
      Returns:
      a non-null, but possibly empty list of parameter descriptions

    • getPositionOfParameter

      Integer getPositionOfParameter(String parameterName)
      Returns the index of a named parameter
      Parameters:
      parameterName -
      Returns:
      the index, or null of no such parameter is available

    • getParameter

      default Optional<PParameter> getParameter(String parameterName)
      Returns a parameter by name if exists
      Since:
      2.1

    • getAllAnnotations

      List<PAnnotation> getAllAnnotations()
      Returns the list of annotations specified for this query
      Returns:
      a non-null, but possibly empty list of annotations

    • getAnnotationsByName

      List<PAnnotation> getAnnotationsByName(String annotationName)
      Returns the list of annotations with a specified name
      Parameters:
      annotationName -
      Returns:
      a non-null, but possibly empty list of annotations

    • getFirstAnnotationByName

      Optional<PAnnotation> getFirstAnnotationByName(String annotationName)
      Returns the first annotation with a specified name
      Since:
      2.0

    • getVisibility

      PVisibility getVisibility()
      Returns the visibility information about the query.
      Since:
      2.0

    • getSimpleName

      default String getSimpleName()
      Returns the non-qualified name of the query. By default this means returning the qualified name after the last '.' character.
      Since:
      2.0