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

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.Trim
All Implemented Interfaces:
Expression, Function, QueryObject

public final class Trim
extends AbstractFunction

Final class that represents TRIM 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
Trim()
          Construct an instance Trim function with default trim character and specification.
 
Method Summary
 Expression getCharacter()
          Gets the trim character expression of TRIM function.
 TrimSpecification getSpecification()
          Gets the trim specification of TRIM function.
 Expression getString()
          Gets the string expression of TRIM function.
 void setCharacter(Expression character)
          Sets the trim character expression of TRIM function.
 void setSpecification(TrimSpecification trimSpecification)
          Sets the trim specification of TRIM function.
 void setString(Expression string)
          Sets the string expression of TRIM 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

Trim

public Trim()
Construct an instance Trim function with default trim character and specification.

Method Detail

getString

public Expression getString()
Gets the string expression of TRIM function.

Returns:
The string expression of TRIM function.

setString

public void setString(Expression string)
Sets the string expression of TRIM function.

Parameters:
string - The new string expression of TRIM function.

getCharacter

public Expression getCharacter()
Gets the trim character expression of TRIM function.

Returns:
The trim character expression of TRIM function.

setCharacter

public void setCharacter(Expression character)
Sets the trim character expression of TRIM function.

Parameters:
character - Trim character expression TRIM function.

getSpecification

public TrimSpecification getSpecification()
Gets the trim specification of TRIM function.

Returns:
Trim specification of TRIM function.

setSpecification

public void setSpecification(TrimSpecification trimSpecification)
Sets the trim specification of TRIM function.

Parameters:
trimSpecification - Trim specification of TRIM 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