org.castor.cpa.query.object
Class ProjectionImpl

java.lang.Object
  org.castor.cpa.query.object.AbstractQueryObject
      org.castor.cpa.query.object.expression.AbstractExpression
          org.castor.cpa.query.object.AbstractField
              org.castor.cpa.query.object.ProjectionImpl

All Implemented Interfaces:

Expression, Field, Projection, QueryObject

public final class ProjectionImpl
extends AbstractField
implements Projection

Final immutable class that a projection of a select query.

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

ProjectionImpl(Field field)
Construct projection with given field.

ProjectionImpl(Field field, String alias)
Construct projection with given field and alias.

Method Summary

String	getAlias() Gets the alias of the projection.
Field	getField() Gets the field or schema of the projection.
String	toFullString() Append full string representation of projection to the given StringBuilder.
StringBuilder	toFullString(StringBuilder sb) Append full string representation of projection to the given StringBuilder.
StringBuilder	toString(StringBuilder sb) Append a string representation of the object to the given StringBuilder.

Methods inherited from class org.castor.cpa.query.object.AbstractField

field, in, isNotNull, isNull, notIn

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

field, in, isNotNull, isNull, notIn

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

ProjectionImpl

public ProjectionImpl(Field field)

Construct projection with given field.

Parameters:

field - The field or schema of the projection.

ProjectionImpl

public ProjectionImpl(Field field,
                      String alias)

Construct projection with given field and alias.

Parameters:

field - The field or schema of the projection.

alias - The alias of the projection.

Method Detail

getField

public Field getField()

Gets the field or schema of the projection.

Returns:

The field of the projection.

getAlias

public String getAlias()

Gets the alias of the projection.

Returns:

The alias of the projection.

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.

Specified by:

toString in interface QueryObject

Parameters:

sb - StringBuilder to append the string representation of this object to.

Returns:

Same instance of StringBuilder given as parameter.

toFullString

public StringBuilder toFullString(StringBuilder sb)

Append full string representation of projection to the given StringBuilder. For projection toString() method returns alias only. To get full projection string one has to call toFullString() method.

Specified by:

toFullString in interface Projection

Parameters:

sb - StringBuilder to append the string representation of this object to.

Returns:

Same instance of StringBuilder given as parameter.

toFullString

public String toFullString()

Append full string representation of projection to the given StringBuilder. For projection toString() method returns alias only. To get full projection string one has to call toFullString() method.

Specified by:

toFullString in interface Projection

Returns:

String with full representation of projection.