org.datanucleus.store.mapped.expression
Class CharacterLiteral

java.lang.Object
  extended by org.datanucleus.store.mapped.expression.ScalarExpression
      extended by org.datanucleus.store.mapped.expression.CharacterExpression
          extended by org.datanucleus.store.mapped.expression.CharacterLiteral
All Implemented Interfaces:
Literal

public class CharacterLiteral
extends CharacterExpression
implements Literal

Representation of a Character literal in a Query.

Version:
$Revision: 1.11 $

Nested Class Summary
 
Nested classes/interfaces inherited from class org.datanucleus.store.mapped.expression.ScalarExpression
ScalarExpression.DatastoreFieldExpression, ScalarExpression.DyadicOperator, ScalarExpression.ExpressionList, ScalarExpression.IllegalArgumentTypeException, ScalarExpression.IllegalOperationException, ScalarExpression.MethodInvocationException, ScalarExpression.MonadicOperator, ScalarExpression.Operator
 
Field Summary
 
Fields inherited from class org.datanucleus.store.mapped.expression.ScalarExpression
aliasIdentifier, checkForTypeAssignability, expressionList, FILTER, LOCALISER, lowestOperator, mapping, OP_ADD, OP_AND, OP_BETWEEN, OP_COM, OP_CONCAT, OP_DIV, OP_EQ, OP_GT, OP_GTEQ, OP_IN, OP_IS, OP_ISNOT, OP_LIKE, OP_LT, OP_LTEQ, OP_MOD, OP_MUL, OP_NEG, OP_NOT, OP_NOTEQ, OP_NOTIN, OP_NOTLIKE, OP_OR, OP_SUB, parameterName, PROJECTION, qs, st, te
 
Constructor Summary
CharacterLiteral(QueryExpression qs, JavaTypeMapping mapping, char value)
          Creates a char literal
CharacterLiteral(QueryExpression qs, JavaTypeMapping mapping, java.lang.String value)
          Creates a char literal
 
Method Summary
 ScalarExpression add(ScalarExpression expr)
          Additive Operator.
 ScalarExpression com()
          Bitwise Complement Operator
 BooleanExpression eq(ScalarExpression expr)
          Equality operator (equals to)
 java.lang.Object getRawValue()
          Accessor for the "raw" value that this literal represents.
 java.lang.Object getValue()
          Accessor to the literal value
 BooleanExpression gt(ScalarExpression expr)
          Relational operator (greater than)
 BooleanExpression gteq(ScalarExpression expr)
          Relational operator (greater than or equals)
 BooleanExpression lt(ScalarExpression expr)
          Relational operator (lower than)
 BooleanExpression lteq(ScalarExpression expr)
          Relational operator (lower than or equals)
 ScalarExpression mod(ScalarExpression expr)
          Method to return a modulus expression.
 ScalarExpression neg()
          Unary Minus Operator
 BooleanExpression noteq(ScalarExpression expr)
          Equality operator (not equals to)
 void setRawValue(java.lang.Object val)
          Method to save a "raw" value that this literal represents.
 ScalarExpression sub(ScalarExpression expr)
          Additive Operator.
 CharacterExpression toLowerCaseMethod()
          Converts the Character Literal to lower case
 CharacterExpression toUpperCaseMethod()
          Converts the Character Literal to upper case
 
Methods inherited from class org.datanucleus.store.mapped.expression.CharacterExpression
div, in, join, mul
 
Methods inherited from class org.datanucleus.store.mapped.expression.ScalarExpression
accessField, and, as, assertValidTypeForParameterComparison, callMethod, cast, checkForTypeAssignability, encloseWithInParentheses, eor, equals, getAlias, getConsistentTypeForParameterComparison, getExpressionList, getLogicSetExpression, getMapping, getNonAliasExpression, getQueryExpression, instanceOf, ior, not, setParameterName, toStatementText, toString
 
Methods inherited from class java.lang.Object
clone, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Constructor Detail

CharacterLiteral

public CharacterLiteral(QueryExpression qs,
                        JavaTypeMapping mapping,
                        char value)
Creates a char literal

Parameters:
qs - the QueryExpression
mapping - the mapping
value - the char value

CharacterLiteral

public CharacterLiteral(QueryExpression qs,
                        JavaTypeMapping mapping,
                        java.lang.String value)
Creates a char literal

Parameters:
qs - the QueryExpression
mapping - the mapping
value - the char value
Method Detail

getValue

public java.lang.Object getValue()
Description copied from interface: Literal
Accessor to the literal value

Specified by:
getValue in interface Literal
Returns:
the value of the literal

eq

public BooleanExpression eq(ScalarExpression expr)
Description copied from class: ScalarExpression
Equality operator (equals to)

Overrides:
eq in class CharacterExpression
Parameters:
expr - the right-hand operand
Returns:
The type of an equality expression is a boolean

noteq

public BooleanExpression noteq(ScalarExpression expr)
Description copied from class: ScalarExpression
Equality operator (not equals to)

Overrides:
noteq in class CharacterExpression
Parameters:
expr - the right-hand operand
Returns:
The type of an equality expression is a boolean

lt

public BooleanExpression lt(ScalarExpression expr)
Description copied from class: ScalarExpression
Relational operator (lower than)

Overrides:
lt in class CharacterExpression
Parameters:
expr - the right-hand operand
Returns:
true if the value of the left-hand operand is less than the value of the right-hand operand, and otherwise is false.

lteq

public BooleanExpression lteq(ScalarExpression expr)
Description copied from class: ScalarExpression
Relational operator (lower than or equals)

Overrides:
lteq in class CharacterExpression
Parameters:
expr - the right-hand operand
Returns:
true if the value of the left-hand operand is less than or equal to the value of the right-hand operand, and otherwise is false.

gt

public BooleanExpression gt(ScalarExpression expr)
Description copied from class: ScalarExpression
Relational operator (greater than)

Overrides:
gt in class CharacterExpression
Parameters:
expr - the right-hand operand
Returns:
true if the value of the left-hand operand is greater than the value of the right-hand operand, and otherwise is false.

gteq

public BooleanExpression gteq(ScalarExpression expr)
Description copied from class: ScalarExpression
Relational operator (greater than or equals)

Overrides:
gteq in class CharacterExpression
Parameters:
expr - the right-hand operand
Returns:
true if the value of the left-hand operand is greater than or equal the value of the right-hand operand, and otherwise is false.

add

public ScalarExpression add(ScalarExpression expr)
Description copied from class: ScalarExpression
Additive Operator. The binary + operator performs addition when applied to two operands of numeric type, producing the sum of the operands. If the type of either operand of a + operator is String, then the operation is string concatenation.

Overrides:
add in class CharacterExpression
Parameters:
expr - the right-hand operand
Returns:
If one of the operands is String, the returned value is the string concatenation; The sum of two operands of numeric type. The left-hand operand is the minuend and the right-hand operand is the subtrahend;

sub

public ScalarExpression sub(ScalarExpression expr)
Description copied from class: ScalarExpression
Additive Operator. The binary - operator subtracts right-hand operand from left-hand operand.

Overrides:
sub in class CharacterExpression
Parameters:
expr - the right-hand operand
Returns:
The binary - operator performs subtraction when applied to two operands of numeric type producing the difference of its operands; the left-hand operand is the minuend and the right-hand operand is the subtrahend.

mod

public ScalarExpression mod(ScalarExpression expr)
Description copied from class: CharacterExpression
Method to return a modulus expression.

Overrides:
mod in class CharacterExpression
Parameters:
expr - The expression to modulus against
Returns:
The modulus expression

toLowerCaseMethod

public CharacterExpression toLowerCaseMethod()
Converts the Character Literal to lower case

Overrides:
toLowerCaseMethod in class CharacterExpression
Returns:
the lowercased Character Literal

toUpperCaseMethod

public CharacterExpression toUpperCaseMethod()
Converts the Character Literal to upper case

Overrides:
toUpperCaseMethod in class CharacterExpression
Returns:
the uppercased Character Literal

neg

public ScalarExpression neg()
Description copied from class: ScalarExpression
Unary Minus Operator

Overrides:
neg in class CharacterExpression
Returns:
the type of the unary minus expression is the promoted type of the operand.

com

public ScalarExpression com()
Description copied from class: ScalarExpression
Bitwise Complement Operator

Overrides:
com in class CharacterExpression
Returns:
the type of the unary bitwise complement expression is the promoted type of the operand.

setRawValue

public void setRawValue(java.lang.Object val)
Method to save a "raw" value that this literal represents. This value differs from the literal value since that is of the same type as this literal.

Specified by:
setRawValue in interface Literal
Parameters:
val - The raw value

getRawValue

public java.lang.Object getRawValue()
Accessor for the "raw" value that this literal represents. This value differs from the literal value since that is of the same type as this literal.

Specified by:
getRawValue in interface Literal
Returns:
The raw value


Copyright © 2010. All Rights Reserved.