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

java.lang.Object
  org.castor.cpa.query.object.AbstractQueryObject
      org.castor.cpa.query.object.expression.AbstractExpression
          org.castor.cpa.query.object.function.AbstractFunction
              org.castor.cpa.query.object.function.CustomFunction

All Implemented Interfaces:

Expression, Function, QueryObject

public final class CustomFunction
extends AbstractFunction

Final class that represents functions with custom names of CastorQL.

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

CustomFunction(String name)
Construct a new CustomFunction with given name.

Method Summary

String	getName() Gets the name of CastorFunction.
List<Expression>	getParameters() Gets the list of parameter expressions of CastorFunction.
void	setParameters(List<Expression> parameters) Sets the list of parameter expressions of CastorFunction.
StringBuilder	toString(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

CustomFunction

public CustomFunction(String name)

Construct a new CustomFunction with given name.

Parameters:

name - Name of the function.

Method Detail

getName

public String getName()

Gets the name of CastorFunction.

Returns:

The name of CastorFunction.

getParameters

public List<Expression> getParameters()

Gets the list of parameter expressions of CastorFunction.

Returns:

The list of parameter expressions of CastorFunction.

setParameters

public void setParameters(List<Expression> parameters)

Sets the list of parameter expressions of CastorFunction.

Parameters:

parameters - The list of parameter expressions of CastorFunction.

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.