Module org.eclipse.persistence.jpa.jpql
Package org.eclipse.persistence.jpa.jpql.parser

Class InputParameter

java.lang.Object
org.eclipse.persistence.jpa.jpql.parser.AbstractExpression
org.eclipse.persistence.jpa.jpql.parser.InputParameter
All Implemented Interfaces:
Expression
public final class InputParameter extends AbstractExpression
Either positional or named parameters may be used. Positional and named parameters may not be mixed in a single query. Input parameters can only be used in the WHERE clause or HAVING clause of a query.
Since:
2.3
Version:
2.5

  • Constructor Details

    • InputParameter

      public InputParameter(AbstractExpression parent, String parameter)
      Creates a new InputParameter.
      Parameters:
      parent - The parent of this expression
      parameter - The input parameter, which starts with either '?' or ':'

  • Method Details

    • accept

      public void accept(ExpressionVisitor visitor)
      Description copied from interface: Expression
      Visits this Expression by the given visitor.
      Parameters:
      visitor - The ExpressionVisitor to visit this object

    • acceptChildren

      public void acceptChildren(ExpressionVisitor visitor)
      Description copied from interface: Expression
      Visits the children of this Expression. This method can be used to optimize traversing the children since a new list is not created every time Expression.children() is called.

      This does not traverse the Expression sub-hierarchy, use a subclass of AbstractTraverseChildrenVisitor in order to traverse the entire sub-hierarchy.

      Parameters:
      visitor - The visitor to visit the children of this object.

    • addOrderedChildrenTo

      protected void addOrderedChildrenTo(List<Expression> children)
      Description copied from class: AbstractExpression
      Adds the children of this AbstractExpression to the given list.
      Overrides:
      addOrderedChildrenTo in class AbstractExpression
      Parameters:
      children - The list used to store the string representation of this AbstractExpression

    • getParameter

      public String getParameter()
      Returns the positional parameter or the named parameter, which includes the identifier.
      Returns:
      The parameter following the constant used to determine if it's a positional or named parameter
      See Also:

    • getParameterName

      public String getParameterName()
      Returns the positional parameter or the named parameter without the identifier.
      Returns:
      The parameter following the constant used to determine if it's a positional or named parameter
      Since:
      2.5
      See Also:

    • getQueryBNF

      public JPQLQueryBNF getQueryBNF()
      Description copied from interface: Expression
      Returns the BNF of this Expression.
      Returns:
      The JPQLQueryBNF, which represents the grammar of this Expression

    • isNamed

      public boolean isNamed()
      Determines whether this parameter is a positional parameter, i.e. the parameter type is '?'.
      Returns:
      true if the parameter type is '?'; false if it's ':'

    • isPositional

      public boolean isPositional()
      Determines whether this parameter is a positional parameter, i.e. the parameter type is ':'.
      Returns:
      true if the parameter type is ':'; false if it's '?'

    • parse

      protected void parse(WordParser wordParser, boolean tolerant)
      Description copied from class: AbstractExpression
      Parses the query by starting at the current position, which is part of the given WordParser.
      Specified by:
      parse in class AbstractExpression
      Parameters:
      wordParser - The text to parse based on the current position of the cursor
      tolerant - Determines whether the parsing system should be tolerant, meaning if it should try to parse invalid or incomplete queries

    • toActualText

      public String toActualText()
      Description copied from interface: Expression
      Generates a string representation of this Expression, which needs to include any characters that are considered virtual, i.e. that was parsed when the query is incomplete and is needed for functionality like content assist.
      Specified by:
      toActualText in interface Expression
      Overrides:
      toActualText in class AbstractExpression
      Returns:
      The string representation of this Expression

    • toParsedText

      public String toParsedText()
      Description copied from interface: Expression
      Returns a string representation of this Expression and its children. The expression should contain whitespace even if the beautified version would not have any. For instance, "SELECT e " should be returned where Expression.toActualText() would return "SELECT e".
      Specified by:
      toParsedText in interface Expression
      Overrides:
      toParsedText in class AbstractExpression
      Returns:
      The string representation of this Expression

    • toParsedText

      protected void toParsedText(StringBuilder writer, boolean actual)
      Description copied from class: AbstractExpression
      Generates a string representation of this Expression, including its children, if it has any.
      Specified by:
      toParsedText in class AbstractExpression
      Parameters:
      writer - The buffer used to append this Expression's string representation
      actual - Determines whether the string representation should represent what was parsed, i.e. include any "virtual" whitespace (such as ending whitespace) and the actual case of the JPQL identifiers