org.castor.cpa.query.object.parameter
Class CastorParameter

java.lang.Object
  org.castor.cpa.query.object.AbstractQueryObject
      org.castor.cpa.query.object.expression.AbstractExpression
          org.castor.cpa.query.object.parameter.AbstractParameter
              org.castor.cpa.query.object.parameter.CastorParameter

All Implemented Interfaces:

Expression, Parameter, QueryObject

public final class CastorParameter
extends AbstractParameter

Final immutable class that represents a Castor Parameter.

Version:

$Revision: 8994 $

Author:

Ralf Joachim, Johannes Venzke

Constructor Summary

CastorParameter(int position)
Construct Castor Parameter with given position.

CastorParameter(int position, String type)
Construct Castor Parameter with given position and type.

Method Summary

int	getPosition() Get the position of the Castor Parameter.
String	getType() Get the type of the Castor Parameter.
StringBuilder	toString(StringBuilder sb) Append a string representation of the object to the given StringBuilder.

Methods inherited from class org.castor.cpa.query.object.parameter.AbstractParameter

isNotNull, isNull

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

CastorParameter

public CastorParameter(int position)

Construct Castor Parameter with given position.

Parameters:

position - Position of the Castor Parameter.

CastorParameter

public CastorParameter(int position,
                       String type)

Construct Castor Parameter with given position and type.

Parameters:

position - Position of the Castor Parameter.

type - The type of the Castor Parameter.

Method Detail

getPosition

public int getPosition()

Get the position of the Castor Parameter.

Returns:

Position of the Castor Parameter.

getType

public String getType()

Get the type of the Castor Parameter.

Returns:

Type of the Castor Parameter.

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.