Package org.datanucleus.store.rdbms.sql.expression

Class StringLiteral

java.lang.Object

org.datanucleus.store.rdbms.sql.expression.SQLExpression

org.datanucleus.store.rdbms.sql.expression.StringExpression

org.datanucleus.store.rdbms.sql.expression.StringLiteral

All Implemented Interfaces:

SQLLiteral

public class StringLiteral
extends StringExpression
implements SQLLiteral

Representation of a string literal.

Nested Class Summary

Nested classes/interfaces inherited from class org.datanucleus.store.rdbms.sql.expression.SQLExpression

SQLExpression.ColumnExpressionList

Field Summary

Fields inherited from class org.datanucleus.store.rdbms.sql.expression.SQLExpression

lowestOperator, mapping, parameterName, st, stmt, subExprs, table

Constructor Summary

Constructors

Constructor	Description
StringLiteral(SQLStatement stmt, JavaTypeMapping mapping, Object value, String parameterName)	Constructor for a String literal with a value.

Method Summary

Modifier and Type	Method	Description
SQLExpression	add(SQLExpression expr)	Additive Operator.
BooleanExpression	eq(SQLExpression expr)	Equality operator (equals to)
BooleanExpression	ge(SQLExpression expr)	Relational operator (greater than or equals)
void	generateStatementWithoutQuotes()	Convenience method to generate the statement without any quotes.
Object	getValue()	Accessor to the literal value
BooleanExpression	gt(SQLExpression expr)	Relational operator (greater than)
BooleanExpression	le(SQLExpression expr)	Relational operator (lower than or equals)
BooleanExpression	lt(SQLExpression expr)	Relational operator (lower than)
BooleanExpression	ne(SQLExpression expr)	Not equality operator (not equals to)
void	setNotParameter()	Method to set this literal as not being a parameter.
protected void	setStatement()

Methods inherited from class org.datanucleus.store.rdbms.sql.expression.StringExpression

in, invoke

Methods inherited from class org.datanucleus.store.rdbms.sql.expression.SQLExpression

and, bitAnd, bitOr, cast, com, distinct, div, encloseInParentheses, eor, getJavaTypeMapping, getLowestOperator, getNumberOfSubExpressions, getParameterName, getSQLStatement, getSQLTable, getSubExpression, ior, is, isParameter, mod, mul, neg, not, setJavaTypeMapping, sub, toSQLText, unDistinct

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

StringLiteral

public StringLiteral(SQLStatement stmt,
                     JavaTypeMapping mapping,
                     Object value,
                     String parameterName)

Constructor for a String literal with a value.

Parameters:

stmt - the SQL statement

mapping - the mapping

value - the value

parameterName - Name of the parameter that this represents (as JDBC "?")

Method Detail

generateStatementWithoutQuotes

public void generateStatementWithoutQuotes()

Convenience method to generate the statement without any quotes. This is called when we create a literal using a mapping, and don't want quotes because the string is an SQL keyword.

getValue

public Object getValue()

Description copied from interface: SQLLiteral

Accessor to the literal value

Specified by:

getValue in interface SQLLiteral

Returns:

the value of the literal

eq

public BooleanExpression eq(SQLExpression expr)

Description copied from class: SQLExpression

Equality operator (equals to)

Overrides:

eq in class StringExpression

Parameters:

expr - the right-hand operand

Returns:

The type of an equality expression is a boolean

ne

public BooleanExpression ne(SQLExpression expr)

Description copied from class: SQLExpression

Not equality operator (not equals to)

Overrides:

ne in class StringExpression

Parameters:

expr - the right-hand operand

Returns:

The type of an equality expression is a boolean

lt

public BooleanExpression lt(SQLExpression expr)

Description copied from class: SQLExpression

Relational operator (lower than)

Overrides:

lt in class StringExpression

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.

le

public BooleanExpression le(SQLExpression expr)

Description copied from class: SQLExpression

Relational operator (lower than or equals)

Overrides:

le in class StringExpression

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(SQLExpression expr)

Description copied from class: SQLExpression

Relational operator (greater than)

Overrides:

gt in class StringExpression

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.

ge

public BooleanExpression ge(SQLExpression expr)

Description copied from class: SQLExpression

Relational operator (greater than or equals)

Overrides:

ge in class StringExpression

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 SQLExpression add(SQLExpression expr)

Description copied from class: SQLExpression

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 StringExpression

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;

setNotParameter

public void setNotParameter()

Description copied from interface: SQLLiteral

Method to set this literal as not being a parameter. If the literal if not currently a parameter then does nothing. Updates any underlying SQL to have the value.

Specified by:

setNotParameter in interface SQLLiteral

setStatement

protected void setStatement()