Class Substring

All Implemented Interfaces:
Expression, Function, QueryObject

public final class Substring extends AbstractFunction
Final class that represents SUBSTRING 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

    • Substring

      public Substring()
  • Method Details

    • getString

      public Expression getString()
      Gets the string expression of SUBSTRING function.
      Returns:
      The string expression of SUBSTRING function.
    • setString

      public void setString(Expression string)
      Sets the string expression of SUBSTRING function.
      Parameters:
      string - The new string expression of SUBSTRING function.
    • getIndex

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

      public void setIndex(Expression index)
      Sets the start expression of SUBSTRING function.
      Parameters:
      index - The new start expression of SUBSTRING function.
    • getLength

      public Expression getLength()
      Gets the length expression of SUBSTRING function.
      Returns:
      The length expression of SUBSTRING function.
    • setLength

      public void setLength(Expression length)
      Sets the length expression of SUBSTRING function.
      Parameters:
      length - The new length expression of SUBSTRING 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.