org.castor.cpa.query.object.function
Class Substring

java.lang.Object
  extended by org.castor.cpa.query.object.AbstractQueryObject
      extended by org.castor.cpa.query.object.expression.AbstractExpression
          extended by org.castor.cpa.query.object.function.AbstractFunction
              extended by org.castor.cpa.query.object.function.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 Summary
Substring()
           
 
Method Summary
 Expression getIndex()
          Gets the start expression of SUBSTRING function.
 Expression getLength()
          Gets the length expression of SUBSTRING function.
 Expression getString()
          Gets the string expression of SUBSTRING function.
 void setIndex(Expression index)
          Sets the start expression of SUBSTRING function.
 void setLength(Expression length)
          Sets the length expression of SUBSTRING function.
 void setString(Expression string)
          Sets the string expression of SUBSTRING function.
 java.lang.StringBuilder toString(java.lang.StringBuilder sb)
          Append a string representation of the object to the given StringBuilder.
 
Methods inherited from class org.castor.cpa.query.object.expression.AbstractExpression
abs, add, add, add, add, between, between, between, between, between, between, between, concat, concat, divide, divide, divide, divide, equal, equal, equal, equal, equal, equal, equal, equal, greaterEqual, greaterEqual, greaterEqual, greaterEqual, greaterEqual, greaterEqual, greaterEqual, greaterThan, greaterThan, greaterThan, greaterThan, greaterThan, greaterThan, greaterThan, length, lessEqual, lessEqual, lessEqual, lessEqual, lessEqual, lessEqual, lessEqual, lessThan, lessThan, lessThan, lessThan, lessThan, lessThan, lessThan, like, like, like, like, like, like, locate, locate, locate, locate, locate, locate, lower, multiply, multiply, multiply, multiply, negate, notBetween, notBetween, notBetween, notBetween, notBetween, notBetween, notBetween, notEqual, notEqual, notEqual, notEqual, notEqual, notEqual, notEqual, notEqual, notLike, notLike, notLike, notLike, notLike, notLike, plus, remainder, remainder, remainder, remainder, sqrt, substring, substring, substring, substring, subtract, subtract, subtract, subtract, trim, trim, trim, trim, trim, trim, upper
 
Methods inherited from class org.castor.cpa.query.object.AbstractQueryObject
toString
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 
Methods inherited from interface org.castor.cpa.query.Expression
abs, add, add, add, add, between, between, between, between, between, between, between, concat, concat, divide, divide, divide, divide, equal, equal, equal, equal, equal, equal, equal, equal, greaterEqual, greaterEqual, greaterEqual, greaterEqual, greaterEqual, greaterEqual, greaterEqual, greaterThan, greaterThan, greaterThan, greaterThan, greaterThan, greaterThan, greaterThan, length, lessEqual, lessEqual, lessEqual, lessEqual, lessEqual, lessEqual, lessEqual, lessThan, lessThan, lessThan, lessThan, lessThan, lessThan, lessThan, like, like, like, like, like, like, locate, locate, locate, locate, locate, locate, lower, multiply, multiply, multiply, multiply, negate, notBetween, notBetween, notBetween, notBetween, notBetween, notBetween, notBetween, notEqual, notEqual, notEqual, notEqual, notEqual, notEqual, notEqual, notEqual, notLike, notLike, notLike, notLike, notLike, notLike, plus, remainder, remainder, remainder, remainder, sqrt, substring, substring, substring, substring, subtract, subtract, subtract, subtract, trim, trim, trim, trim, trim, trim, upper
 

Constructor Detail

Substring

public Substring()
Method Detail

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 java.lang.StringBuilder toString(java.lang.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.


Intalio Inc. (C) 1999-2008. All rights reserved http://www.intalio.com