Class Locate

All Implemented Interfaces:
Expression, Function, QueryObject

public final class Locate extends AbstractFunction
Final class that represents LOCATE function.
Since:
1.3
Version:
$Revision: 7121 $ $Date: 2006-04-25 16:09:10 -0600 (Tue, 25 Apr 2006) $
Author:
Udai Gupta, Ralf Joachim
  • Constructor Details

    • Locate

      public Locate()
      Construct an instance of Locate function with default start position.
  • Method Details

    • getString

      public Expression getString()
      Gets the string expression to be searched in by LOCATE function.
      Returns:
      The string expression to be searched in by LOCATE function.
    • setString

      public void setString(Expression string)
      Sets the string expression to be searched in by LOCATE function.
      Parameters:
      string - The new string expression to be searched in by LOCATE function.
    • getValue

      public Expression getValue()
      Gets the expression to search for by LOCATE function.
      Returns:
      The expression to search for by LOCATE function.
    • setValue

      public void setValue(Expression value)
      Sets the expression to search for by LOCATE function.
      Parameters:
      value - The new expression to search for by LOCATE function.
    • getIndex

      public Expression getIndex()
      Gets the expression defining the start position of LOCATE function.
      Returns:
      The expression defining the start position of LOCATE function.
    • setIndex

      public void setIndex(Expression index)
      Sets the expression defining the start position of LOCATE function.
      Parameters:
      index - The new expression defining the start position of LOCATE function.
    • toString

      public StringBuilder toString(StringBuilder sb)
      Append a string representation of the object to the given StringBuilder. In general, the toString method for query objects appends a string that textually represents this object. The result should be a query string that complies to EJB QL specification as long as the query object represents a syntay element of it. It is required that all subclasses override this method. The toString method defined at class Object is overwritten and calls this method.
      Parameters:
      sb - StringBuilder to append the string representation of this object to.
      Returns:
      Same instance of StringBuilder given as parameter.