org.castor.cpa.query.object.function

Class Locate

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.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 Summary

Constructors

Constructor and Description
Locate() Construct an instance of Locate function with default start position.

Method Summary

Methods

Modifier and Type	Method and Description
Expression	getIndex() Gets the expression defining the start position of LOCATE function.
Expression	getString() Gets the string expression to be searched in by LOCATE function.
Expression	getValue() Gets the expression to search for by LOCATE function.
void	setIndex(Expression index) Sets the expression defining the start position of LOCATE function.
void	setString(Expression string) Sets the string expression to be searched in by LOCATE function.
void	setValue(Expression value) Sets the expression to search for by LOCATE function.
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

Locate

public Locate()

Construct an instance of Locate function with default start position.

Method Detail

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.