Class TypeExpression
- java.lang.Object
-
- org.apache.openjpa.persistence.query.TypeExpression
-
- All Implemented Interfaces:
java.io.Serializable
,Aggregate
,Expression
,OrderByItem
,PredicateOperand
,SelectItem
,Visitable
public class TypeExpression extends java.lang.Object
Denotes TYPE(e) Expression.- Author:
- Pinaki Poddar
- See Also:
- Serialized Form
-
-
Field Summary
Fields Modifier and Type Field Description protected Expression
_e
protected UnaryFunctionalOperator
_op
static java.lang.String
CLOSE_BRACE
static java.lang.String
COMMA
static java.lang.String
EMPTY
static java.lang.String
OPEN_BRACE
static java.lang.String
SPACE
-
Constructor Summary
Constructors Constructor Description TypeExpression(Expression op)
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description Expression
abs()
Absolute value.OrderByItem
asc()
Return an OrderByItem referencing the SelectItem and specifying ascending ordering.java.lang.String
asExpression(org.apache.openjpa.persistence.query.AliasContext ctx)
Get a JPQL fragment as used in WHERE clause.java.lang.String
asJoinable(org.apache.openjpa.persistence.query.AliasContext ctx)
Gets the string representation in FROM clause.java.lang.String
asProjection(org.apache.openjpa.persistence.query.AliasContext ctx)
Gets the string representation in SELECT projection.Predicate
between(java.lang.Number arg1, java.lang.Number arg2)
Create a predicate for testing whether the PredicateOperand lies between (inclusive) the two arguments.Predicate
between(java.lang.Number arg1, PredicateOperand arg2)
Create a predicate for testing whether the PredicateOperand lies between (inclusive) the two arguments.Predicate
between(java.lang.String arg1, java.lang.String arg2)
Create a predicate for testing whether the PredicateOperand lies between (inclusive) the two arguments.Predicate
between(java.lang.String arg1, PredicateOperand arg2)
Create a predicate for testing whether the PredicateOperand lies between (inclusive) the two arguments.Predicate
between(java.util.Calendar arg1, java.util.Calendar arg2)
Create a predicate for testing whether the PredicateOperand lies between (inclusive) the two arguments.Predicate
between(java.util.Calendar arg1, PredicateOperand arg2)
Create a predicate for testing whether the PredicateOperand lies between (inclusive) the two arguments.Predicate
between(java.util.Date arg1, java.util.Date arg2)
Create a predicate for testing whether the PredicateOperand lies between (inclusive) the two arguments.Predicate
between(java.util.Date arg1, PredicateOperand arg2)
Create a predicate for testing whether the PredicateOperand lies between (inclusive) the two arguments.Predicate
between(PredicateOperand arg1, java.lang.Number arg2)
Create a predicate for testing whether the PredicateOperand lies between (inclusive) the two arguments.Predicate
between(PredicateOperand arg1, java.lang.String arg2)
Create a predicate for testing whether the PredicateOperand lies between (inclusive) the two arguments.Predicate
between(PredicateOperand arg1, java.util.Calendar arg2)
Create a predicate for testing whether the PredicateOperand lies between (inclusive) the two arguments.Predicate
between(PredicateOperand arg1, java.util.Date arg2)
Create a predicate for testing whether the PredicateOperand lies between (inclusive) the two arguments.Predicate
between(PredicateOperand arg1, PredicateOperand arg2)
Create a predicate for testing whether the PredicateOperand lies between (inclusive) the two arguments.Expression
concat(java.lang.String... str)
Concatenate a string with other string(s).Expression
concat(Expression... exprs)
Concatenate a string with other string(s).OrderByItem
desc()
Return an OrderByItem referencing the SelectItem and specifying descending ordering.Expression
distinct()
Specify that duplicates are to be removed before the aggregate operation is invoked.Expression
dividedBy(java.lang.Number num)
Division.Expression
dividedBy(Expression expr)
Division.Predicate
equal(boolean arg)
Create a predicate for testing equality with the specified argument.Predicate
equal(java.lang.Class cls)
Create a predicate for testing equality with the specified argument.Predicate
equal(java.lang.Enum<?> e)
Create a predicate for testing equality with the specified argument.Predicate
equal(java.lang.Number arg)
Create a predicate for testing equality with the specified argument.Predicate
equal(java.lang.String arg)
Create a predicate for testing equality with the specified argument.Predicate
equal(java.util.Calendar arg)
Create a predicate for testing equality with the specified argument.Predicate
equal(java.util.Date arg)
Create a predicate for testing equality with the specified argument.Predicate
equal(PredicateOperand arg)
Create a predicate for testing equality with the specified argument.java.lang.String
getAliasHint(org.apache.openjpa.persistence.query.AliasContext ctx)
Gets the hint to be used while creating alias.Expression
getOperand()
UnaryFunctionalOperator
getOperator()
Predicate
greaterEqual(java.lang.Number arg)
Create a predicate for testing whether the PredicateOperand is greater than or equal to the argument.Predicate
greaterEqual(java.lang.String arg)
Create a predicate for testing whether the PredicateOperand is greater than or equal to the argument.Predicate
greaterEqual(java.util.Calendar arg)
Create a predicate for testing whether the PredicateOperand is greater than or equal to the argument.Predicate
greaterEqual(java.util.Date arg)
Create a predicate for testing whether the PredicateOperand is greater than or equal to the argument.Predicate
greaterEqual(PredicateOperand arg)
Create a predicate for testing whether the PredicateOperand is greater than or equal to the argument.Predicate
greaterThan(java.lang.Number arg)
Create a predicate for testing whether the PredicateOperand is greater than the argument.Predicate
greaterThan(java.lang.String arg)
Create a predicate for testing whether the PredicateOperand is greater than the argument.Predicate
greaterThan(java.util.Calendar arg)
Create a predicate for testing whether the PredicateOperand is greater than the argument.Predicate
greaterThan(java.util.Date arg)
Create a predicate for testing whether the PredicateOperand is greater than the argument.Predicate
greaterThan(PredicateOperand arg)
Create a predicate for testing whether the PredicateOperand is greater than the argument.Predicate
in(java.lang.Class... classes)
Create a predicate for testing whether the expression value is a member of the argument list.Predicate
in(java.lang.Enum<?>... enums)
Create a predicate for testing whether the expression value is a member of the argument list.Predicate
in(java.lang.Number... nums)
Create a predicate for testing whether the expression value is a member of the argument list.Predicate
in(java.lang.String... strings)
Create a predicate for testing whether the expression value is a member of the argument list.Predicate
in(Expression... params)
Create a predicate for testing whether the expression value is a member of the argument list.Predicate
in(Subquery subquery)
Create a predicate for testing whether the expression value is a member of a subquery result.Predicate
isNull()
Create a predicate for testing whether the value of the expression is null.Expression
length()
String length This method must be invoked on an expression corresponding to a string.Predicate
lessEqual(java.lang.Number arg)
Create a predicate for testing whether the PredicateOperand is less than or equal to the argument.Predicate
lessEqual(java.lang.String arg)
Create a predicate for testing whether the PredicateOperand is less than or equal to the argument.Predicate
lessEqual(java.util.Calendar arg)
Create a predicate for testing whether the PredicateOperand is less than or equal to the argument.Predicate
lessEqual(java.util.Date arg)
Create a predicate for testing whether the PredicateOperand is less than or equal to the argument.Predicate
lessEqual(PredicateOperand arg)
Create a predicate for testing whether the PredicateOperand is less than or equal to the argument.Predicate
lessThan(java.lang.Number arg)
Create a predicate for testing whether the PredicateOperand is less than the argument.Predicate
lessThan(java.lang.String arg)
Create a predicate for testing whether the PredicateOperand is less than the argument.Predicate
lessThan(java.util.Calendar arg)
Create a predicate for testing whether the PredicateOperand is less than the argument.Predicate
lessThan(java.util.Date arg)
Create a predicate for testing whether the PredicateOperand is less than the argument.Predicate
lessThan(PredicateOperand arg)
Create a predicate for testing whether the PredicateOperand is less than the argument.Predicate
like(java.lang.String pattern)
Create a predicate for testing whether the PredicateOperand satisfies the given pattern.Predicate
like(java.lang.String pattern, char escChar)
Create a predicate for testing whether the PredicateOperand satisfies the given pattern.Predicate
like(java.lang.String pattern, PredicateOperand escapeChar)
Create a predicate for testing whether the PredicateOperand satisfies the given pattern.Predicate
like(PredicateOperand pattern)
Create a predicate for testing whether the PredicateOperand satisfies the given pattern.Predicate
like(PredicateOperand pattern, char escapeChar)
Create a predicate for testing whether the PredicateOperand satisfies the given pattern.Predicate
like(PredicateOperand pattern, PredicateOperand escChar)
Create a predicate for testing whether the PredicateOperand satisfies the given pattern.Expression
locate(java.lang.String str)
Locate a string contained within the string corresponding to the expression on which the method was invoked.Expression
locate(java.lang.String str, int position)
Locate a string contained within the string corresponding to the expression on which the method was invoked, starting at a specified search position.Expression
locate(java.lang.String str, Expression position)
Locate a string contained within the string corresponding to the expression on which the method was invoked, starting at a specified search position.Expression
locate(Expression expr)
Locate a string contained within the string corresponding to the expression on which the method was invoked.Expression
locate(Expression str, int position)
Locate a string contained within the string corresponding to the expression on which the method was invoked, starting at a specified search position.Expression
locate(Expression str, Expression position)
Locate a string contained within the string corresponding to the expression on which the method was invoked, starting at a specified search position.Expression
lower()
Convert string to lowercase.Predicate
member(PathExpression arg)
Create a predicate for testing whether the expression is a member of the association or element collection denoted by the path expression.Expression
minus()
Unary minus.Expression
minus(java.lang.Number num)
Subtraction.Expression
minus(Expression expr)
Subtraction.Expression
mod(int num)
Modulo operation.Expression
mod(Expression expr)
Modulo operation.Predicate
notEqual(boolean arg)
Create a predicate for testing inequality with the specified argument.Predicate
notEqual(java.lang.Class cls)
Create a predicate for testing inequality with the specified argument.Predicate
notEqual(java.lang.Enum<?> e)
Create a predicate for testing inequality with the specified argument.Predicate
notEqual(java.lang.Number arg)
Create a predicate for testing inequality with the specified argument.Predicate
notEqual(java.lang.String arg)
Create a predicate for testing inequality with the specified argument.Predicate
notEqual(java.util.Calendar arg)
Create a predicate for testing inequality with the specified argument.Predicate
notEqual(java.util.Date arg)
Create a predicate for testing inequality with the specified argument.Predicate
notEqual(PredicateOperand arg)
Create a predicate for testing inequality with the specified argument.Expression
plus(java.lang.Number num)
Addition.Expression
plus(Expression expr)
Addition.Expression
sqrt()
Square root.Expression
substring(int start)
Extract a substring starting at specified position through to the end of the string.Expression
substring(int start, int len)
Extract a substring.Expression
substring(int start, Expression len)
Extract a substring.Expression
substring(Expression start)
Extract a substring starting at specified position through to the end of the string.Expression
substring(Expression start, int len)
Extract a substring.Expression
substring(Expression start, Expression len)
Extract a substring.Expression
times(java.lang.Number num)
Multiplication.Expression
times(Expression expr)
Multiplication.Expression
trim()
Trim leading and trailing blanks.Expression
trim(char c)
Trim leading and trailing occurrences of character from the string.Expression
trim(char c, TrimSpec spec)
Trim occurrences of the character from leading or trailing (or both) positions of the string, as specified by trim spec.Expression
trim(Expression expr)
Trim leading and trailing occurrences of character specified by the expression argument from the string.Expression
trim(Expression expr, TrimSpec spec)
Trim occurrences of the character specified by the expression argument from leading or trailing (or both) positions of the string, as specified by trim spec.Expression
trim(TrimSpec spec)
Trim leading, trailing blanks (or both) as specified by trim spec.Expression
upper()
Convert string to uppercase.-
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
-
Methods inherited from interface org.apache.openjpa.persistence.query.Expression
abs, concat, concat, dividedBy, dividedBy, in, in, in, in, in, in, isNull, length, locate, locate, locate, locate, locate, locate, lower, member, minus, minus, minus, mod, mod, plus, plus, sqrt, substring, substring, substring, substring, substring, substring, times, times, trim, trim, trim, trim, trim, trim, upper
-
Methods inherited from interface org.apache.openjpa.persistence.query.PredicateOperand
between, between, between, between, between, between, between, between, between, between, between, between, between, equal, equal, equal, equal, equal, equal, equal, equal, greaterEqual, greaterEqual, greaterEqual, greaterEqual, greaterEqual, greaterThan, greaterThan, greaterThan, greaterThan, greaterThan, lessEqual, lessEqual, lessEqual, lessEqual, lessEqual, lessThan, lessThan, lessThan, lessThan, lessThan, like, like, like, like, like, like, notEqual, notEqual, notEqual, notEqual, notEqual, notEqual, notEqual, notEqual
-
Methods inherited from interface org.apache.openjpa.persistence.query.SelectItem
asc, desc
-
Methods inherited from interface org.apache.openjpa.persistence.query.Visitable
asJoinable
-
-
-
-
Field Detail
-
_e
protected final Expression _e
-
_op
protected final UnaryFunctionalOperator _op
-
SPACE
public static final java.lang.String SPACE
- See Also:
- Constant Field Values
-
OPEN_BRACE
public static final java.lang.String OPEN_BRACE
- See Also:
- Constant Field Values
-
CLOSE_BRACE
public static final java.lang.String CLOSE_BRACE
- See Also:
- Constant Field Values
-
COMMA
public static final java.lang.String COMMA
- See Also:
- Constant Field Values
-
EMPTY
public static final java.lang.String EMPTY
- See Also:
- Constant Field Values
-
-
Constructor Detail
-
TypeExpression
public TypeExpression(Expression op)
-
-
Method Detail
-
getOperand
public Expression getOperand()
-
getOperator
public UnaryFunctionalOperator getOperator()
-
distinct
public Expression distinct()
Description copied from interface:Aggregate
Specify that duplicates are to be removed before the aggregate operation is invoked.
-
asExpression
public java.lang.String asExpression(org.apache.openjpa.persistence.query.AliasContext ctx)
Description copied from interface:Visitable
Get a JPQL fragment as used in WHERE clause.- Specified by:
asExpression
in interfaceVisitable
-
asProjection
public java.lang.String asProjection(org.apache.openjpa.persistence.query.AliasContext ctx)
Description copied from interface:Visitable
Gets the string representation in SELECT projection.- Specified by:
asProjection
in interfaceVisitable
-
abs
public Expression abs()
Description copied from interface:Expression
Absolute value. This method must be invoked on an expression corresponding to a number.- Specified by:
abs
in interfaceExpression
- Returns:
- expression corresponding to the absolute value
-
concat
public Expression concat(java.lang.String... str)
Description copied from interface:Expression
Concatenate a string with other string(s). This method must be invoked on an expression corresponding to a string.- Specified by:
concat
in interfaceExpression
- Parameters:
str
- - string(s)- Returns:
- expression denoting the concatenation of the strings, starting with the string corresponding to the expression on which the method was invoked.
-
concat
public Expression concat(Expression... exprs)
Description copied from interface:Expression
Concatenate a string with other string(s). This method must be invoked on an expression corresponding to a string.- Specified by:
concat
in interfaceExpression
- Parameters:
exprs
- - expression(s) corresponding to string(s)- Returns:
- expression denoting the concatenation of the strings, starting with the string corresponding to the expression on which the method was invoked.
-
dividedBy
public Expression dividedBy(java.lang.Number num)
Description copied from interface:Expression
Division. This method must be invoked on an expression corresponding to a number.- Specified by:
dividedBy
in interfaceExpression
- Parameters:
num
- - divisor- Returns:
- expression denoting the result of dividing the number corresponding to the expression on which the method was invoked by the argument
-
dividedBy
public Expression dividedBy(Expression expr)
Description copied from interface:Expression
Division. This method must be invoked on an expression corresponding to a number.- Specified by:
dividedBy
in interfaceExpression
- Parameters:
expr
- - expression corresponding to the divisor- Returns:
- expression denoting the result of dividing the number corresponding to the expression on which the method was invoked by the number denoted by the argument
-
in
public Predicate in(java.lang.String... strings)
Description copied from interface:Expression
Create a predicate for testing whether the expression value is a member of the argument list.- Specified by:
in
in interfaceExpression
- Returns:
- conditional predicate
-
in
public Predicate in(java.lang.Number... nums)
Description copied from interface:Expression
Create a predicate for testing whether the expression value is a member of the argument list.- Specified by:
in
in interfaceExpression
- Returns:
- conditional predicate
-
in
public Predicate in(java.lang.Enum<?>... enums)
Description copied from interface:Expression
Create a predicate for testing whether the expression value is a member of the argument list.- Specified by:
in
in interfaceExpression
- Returns:
- conditional predicate
-
in
public Predicate in(java.lang.Class... classes)
Description copied from interface:Expression
Create a predicate for testing whether the expression value is a member of the argument list.- Specified by:
in
in interfaceExpression
- Returns:
- conditional predicate
-
in
public Predicate in(Expression... params)
Description copied from interface:Expression
Create a predicate for testing whether the expression value is a member of the argument list.- Specified by:
in
in interfaceExpression
- Returns:
- conditional predicate
-
in
public Predicate in(Subquery subquery)
Description copied from interface:Expression
Create a predicate for testing whether the expression value is a member of a subquery result.- Specified by:
in
in interfaceExpression
- Returns:
- conditional predicate
-
isNull
public Predicate isNull()
Description copied from interface:Expression
Create a predicate for testing whether the value of the expression is null.- Specified by:
isNull
in interfaceExpression
- Returns:
- conditional predicate
-
length
public Expression length()
Description copied from interface:Expression
String length This method must be invoked on an expression corresponding to a string.- Specified by:
length
in interfaceExpression
- Returns:
- expression denoting the length of the string.
-
locate
public Expression locate(java.lang.String str)
Description copied from interface:Expression
Locate a string contained within the string corresponding to the expression on which the method was invoked. The search is started at position 1 (first string position). This method must be invoked on an expression corresponding to a string.- Specified by:
locate
in interfaceExpression
- Parameters:
str
- - string to be located- Returns:
- expression denoting the first position at which the string was found or expression denoting 0 if the string was not found
-
locate
public Expression locate(Expression expr)
Description copied from interface:Expression
Locate a string contained within the string corresponding to the expression on which the method was invoked. The search is started at position 1 (first string position). This method must be invoked on an expression corresponding to a string.- Specified by:
locate
in interfaceExpression
- Parameters:
expr
- - expression corresponding to the string to be located- Returns:
- expression denoting the first position at which the string was found or expression denoting 0 if the string was not found
-
locate
public Expression locate(java.lang.String str, int position)
Description copied from interface:Expression
Locate a string contained within the string corresponding to the expression on which the method was invoked, starting at a specified search position. This method must be invoked on an expression corresponding to a string.- Specified by:
locate
in interfaceExpression
- Parameters:
str
- - string to be locatedposition
- - position at which to start the search- Returns:
- expression denoting the first position at which the string was found or expression denoting 0 if the string was not found
-
locate
public Expression locate(java.lang.String str, Expression position)
Description copied from interface:Expression
Locate a string contained within the string corresponding to the expression on which the method was invoked, starting at a specified search position. This method must be invoked on an expression corresponding to a string.- Specified by:
locate
in interfaceExpression
- Parameters:
str
- - string to be locatedposition
- - expression corresponding to position at which to start the search- Returns:
- expression denoting the first position at which the string was found or expression denoting 0 if the string was not found
-
locate
public Expression locate(Expression str, int position)
Description copied from interface:Expression
Locate a string contained within the string corresponding to the expression on which the method was invoked, starting at a specified search position. This method must be invoked on an expression corresponding to a string.- Specified by:
locate
in interfaceExpression
- Parameters:
str
- - expression corresponding to the string to be locatedposition
- - position at which to start the search- Returns:
- expression denoting the first position at which the string was found or expression denoting 0 if the string was not found
-
locate
public Expression locate(Expression str, Expression position)
Description copied from interface:Expression
Locate a string contained within the string corresponding to the expression on which the method was invoked, starting at a specified search position. This method must be invoked on an expression corresponding to a string.- Specified by:
locate
in interfaceExpression
- Parameters:
str
- - expression corresponding to the string to be locatedposition
- - expression corresponding to position at which to start the search- Returns:
- expression denoting the first position at which the string was found or expression denoting 0 if the string was not found
-
lower
public Expression lower()
Description copied from interface:Expression
Convert string to lowercase. This method must be invoked on an expression corresponding to a string.- Specified by:
lower
in interfaceExpression
- Returns:
- expression denoting the string in lowercase
-
member
public Predicate member(PathExpression arg)
Description copied from interface:Expression
Create a predicate for testing whether the expression is a member of the association or element collection denoted by the path expression. The argument must correspond to a collection-valued association or element collection of like type.- Specified by:
member
in interfaceExpression
- Parameters:
arg
- - a path expression that specifies a collection-valued association or an element collection- Returns:
- conditional predicate
-
minus
public Expression minus()
Description copied from interface:Expression
Unary minus. This method must be invoked on an expression corresponding to a number.- Specified by:
minus
in interfaceExpression
- Returns:
- expression denoting the unary minus of the expression
-
minus
public Expression minus(java.lang.Number num)
Description copied from interface:Expression
Subtraction. This method must be invoked on an expression corresponding to a number.- Specified by:
minus
in interfaceExpression
- Parameters:
num
- - subtrahend- Returns:
- expression denoting the result of subtracting the argument from the number corresponding to the expression on which the method was invoked.
-
minus
public Expression minus(Expression expr)
Description copied from interface:Expression
Subtraction. This method must be invoked on an expression corresponding to a number.- Specified by:
minus
in interfaceExpression
- Parameters:
expr
- - expression corresponding to subtrahend- Returns:
- expression denoting the result of subtracting the number denoted by the argument from the number corresponding to the expression on which the method was invoked.
-
mod
public Expression mod(int num)
Description copied from interface:Expression
Modulo operation. This must be invoked on an expression corresponding to an integer value- Specified by:
mod
in interfaceExpression
- Parameters:
num
- - integer divisor- Returns:
- expression corresponding to the integer remainder of the division of the integer corresponding to the expression on which the method was invoked by the argument.
-
mod
public Expression mod(Expression expr)
Description copied from interface:Expression
Modulo operation. This must be invoked on an expression corresponding to an integer value- Specified by:
mod
in interfaceExpression
- Parameters:
expr
- - expression corresponding to integer divisor- Returns:
- expression corresponding to the integer remainder of the division of the integer corresponding to the expression on which the method was invoked by the argument.
-
plus
public Expression plus(java.lang.Number num)
Description copied from interface:Expression
Addition. This method must be invoked on an expression corresponding to a number.- Specified by:
plus
in interfaceExpression
- Parameters:
num
- - number to be added- Returns:
- expression denoting the sum
-
plus
public Expression plus(Expression expr)
Description copied from interface:Expression
Addition. This method must be invoked on an expression corresponding to a number.- Specified by:
plus
in interfaceExpression
- Parameters:
expr
- - expression corresponding to number to be added- Returns:
- expression denoting the sum
-
sqrt
public Expression sqrt()
Description copied from interface:Expression
Square root. This method must be invoked on an expression corresponding to a number.- Specified by:
sqrt
in interfaceExpression
- Returns:
- expression corresponding to the square root
-
substring
public Expression substring(int start)
Description copied from interface:Expression
Extract a substring starting at specified position through to the end of the string. This method must be invoked on an expression corresponding to a string.- Specified by:
substring
in interfaceExpression
- Parameters:
start
- - start position (1 indicates first position)- Returns:
- expression denoting the extracted substring
-
substring
public Expression substring(Expression start)
Description copied from interface:Expression
Extract a substring starting at specified position through to the end of the string. This method must be invoked on an expression corresponding to a string.- Specified by:
substring
in interfaceExpression
- Parameters:
start
- - expression denoting start position (1 indicates first position)- Returns:
- expression denoting the extracted substring
-
substring
public Expression substring(int start, int len)
Description copied from interface:Expression
Extract a substring. This method must be invoked on an expression corresponding to a string.- Specified by:
substring
in interfaceExpression
- Parameters:
start
- - start position (1 indicates first position)len
- - length of the substring to be returned- Returns:
- expression denoting the extracted substring
-
substring
public Expression substring(int start, Expression len)
Description copied from interface:Expression
Extract a substring. This method must be invoked on an expression corresponding to a string.- Specified by:
substring
in interfaceExpression
- Parameters:
start
- - start position (1 indicates first position)len
- - expression denoting length of the substring to return- Returns:
- expression denoting the extracted substring
-
substring
public Expression substring(Expression start, int len)
Description copied from interface:Expression
Extract a substring. This method must be invoked on an expression corresponding to a string.- Specified by:
substring
in interfaceExpression
- Parameters:
start
- - expression denoting start position (1 indicates first position)len
- - length of the substring to return- Returns:
- expression denoting the extracted substring
-
substring
public Expression substring(Expression start, Expression len)
Description copied from interface:Expression
Extract a substring. This method must be invoked on an expression corresponding to a string.- Specified by:
substring
in interfaceExpression
- Parameters:
start
- - expression denoting start position (1 indicates first position)len
- - expression denoting length of the substring to return- Returns:
- expression denoting the extracted substring
-
times
public Expression times(java.lang.Number num)
Description copied from interface:Expression
Multiplication. This method must be invoked on an expression corresponding to a number.- Specified by:
times
in interfaceExpression
- Parameters:
num
- - multiplier- Returns:
- expression denoting the result of multiplying the argument with the number corresponding to the expression on which the method was invoked.
-
times
public Expression times(Expression expr)
Description copied from interface:Expression
Multiplication. This method must be invoked on an expression corresponding to a number.- Specified by:
times
in interfaceExpression
- Parameters:
expr
- - expression corresponding to the multiplier- Returns:
- expression denoting the result of multiplying the number denoted by the argument with the number corresponding to the expression on which the method was invoked.
-
trim
public Expression trim()
Description copied from interface:Expression
Trim leading and trailing blanks. This method must be invoked on an expression corresponding to a string.- Specified by:
trim
in interfaceExpression
- Returns:
- expression denoting trimmed string
-
trim
public Expression trim(TrimSpec spec)
Description copied from interface:Expression
Trim leading, trailing blanks (or both) as specified by trim spec. This method must be invoked on an expression corresponding to a string.- Specified by:
trim
in interfaceExpression
- Parameters:
spec
- - trim specification- Returns:
- expression denoting trimmed string
-
trim
public Expression trim(char c)
Description copied from interface:Expression
Trim leading and trailing occurrences of character from the string. This method must be invoked on an expression corresponding to a string.- Specified by:
trim
in interfaceExpression
- Parameters:
c
- - character to be trimmed- Returns:
- expression denoting trimmed string
-
trim
public Expression trim(char c, TrimSpec spec)
Description copied from interface:Expression
Trim occurrences of the character from leading or trailing (or both) positions of the string, as specified by trim spec. This method must be invoked on an expression corresponding to a string.- Specified by:
trim
in interfaceExpression
- Parameters:
c
- - character to be trimmedspec
- - trim specification- Returns:
- expression denoting trimmed string
-
trim
public Expression trim(Expression expr)
Description copied from interface:Expression
Trim leading and trailing occurrences of character specified by the expression argument from the string. This method must be invoked on an expression corresponding to a string.- Specified by:
trim
in interfaceExpression
- Parameters:
expr
- - expression corresponding to the character to be trimmed- Returns:
- expression denoting trimmed string
-
trim
public Expression trim(Expression expr, TrimSpec spec)
Description copied from interface:Expression
Trim occurrences of the character specified by the expression argument from leading or trailing (or both) positions of the string, as specified by trim spec. This method must be invoked on an expression corresponding to a string.- Specified by:
trim
in interfaceExpression
- Parameters:
expr
- - expression corresponding to the character to be trimmedspec
- - trim specification- Returns:
- expression denoting trimmed string
-
upper
public Expression upper()
Description copied from interface:Expression
Convert string to uppercase. This method must be invoked on an expression corresponding to a string.- Specified by:
upper
in interfaceExpression
- Returns:
- expression denoting the string in uppercase
-
asc
public OrderByItem asc()
Description copied from interface:SelectItem
Return an OrderByItem referencing the SelectItem and specifying ascending ordering. The SelectItem must correspond to an orderable value.- Specified by:
asc
in interfaceSelectItem
- Returns:
- order-by item
-
desc
public OrderByItem desc()
Description copied from interface:SelectItem
Return an OrderByItem referencing the SelectItem and specifying descending ordering. The SelectItem must correspond to an orderable value.- Specified by:
desc
in interfaceSelectItem
- Returns:
- order-by item
-
between
public Predicate between(PredicateOperand arg1, PredicateOperand arg2)
Description copied from interface:PredicateOperand
Create a predicate for testing whether the PredicateOperand lies between (inclusive) the two arguments.- Specified by:
between
in interfacePredicateOperand
- Parameters:
arg1
- - PredicateOperand instance or parameterarg2
- - PredicateOperand instance or parameter- Returns:
- conditional predicate
-
between
public Predicate between(PredicateOperand arg1, java.lang.Number arg2)
Description copied from interface:PredicateOperand
Create a predicate for testing whether the PredicateOperand lies between (inclusive) the two arguments.- Specified by:
between
in interfacePredicateOperand
- Parameters:
arg1
- - PredicateOperand instance or parameterarg2
- - numeric- Returns:
- conditional predicate
-
between
public Predicate between(java.lang.Number arg1, PredicateOperand arg2)
Description copied from interface:PredicateOperand
Create a predicate for testing whether the PredicateOperand lies between (inclusive) the two arguments.- Specified by:
between
in interfacePredicateOperand
- Parameters:
arg1
- - numericarg2
- - PredicateOperand instance or parameter- Returns:
- conditional predicate
-
between
public Predicate between(java.lang.Number arg1, java.lang.Number arg2)
Description copied from interface:PredicateOperand
Create a predicate for testing whether the PredicateOperand lies between (inclusive) the two arguments.- Specified by:
between
in interfacePredicateOperand
- Parameters:
arg1
- - numericarg2
- - numeric- Returns:
- conditional predicate
-
between
public Predicate between(PredicateOperand arg1, java.lang.String arg2)
Description copied from interface:PredicateOperand
Create a predicate for testing whether the PredicateOperand lies between (inclusive) the two arguments.- Specified by:
between
in interfacePredicateOperand
- Parameters:
arg1
- - PredicateOperand instance or parameterarg2
- - string- Returns:
- conditional predicate
-
between
public Predicate between(java.lang.String arg1, PredicateOperand arg2)
Description copied from interface:PredicateOperand
Create a predicate for testing whether the PredicateOperand lies between (inclusive) the two arguments.- Specified by:
between
in interfacePredicateOperand
- Parameters:
arg1
- - stringarg2
- - PredicateOperand instance or parameter- Returns:
- conditional predicate
-
between
public Predicate between(java.lang.String arg1, java.lang.String arg2)
Description copied from interface:PredicateOperand
Create a predicate for testing whether the PredicateOperand lies between (inclusive) the two arguments.- Specified by:
between
in interfacePredicateOperand
- Parameters:
arg1
- - stringarg2
- - string- Returns:
- conditional predicate
-
between
public Predicate between(PredicateOperand arg1, java.util.Date arg2)
Description copied from interface:PredicateOperand
Create a predicate for testing whether the PredicateOperand lies between (inclusive) the two arguments.- Specified by:
between
in interfacePredicateOperand
- Parameters:
arg1
- - PredicateOperand instance or parameterarg2
- - date- Returns:
- conditional predicate
-
between
public Predicate between(java.util.Date arg1, PredicateOperand arg2)
Description copied from interface:PredicateOperand
Create a predicate for testing whether the PredicateOperand lies between (inclusive) the two arguments.- Specified by:
between
in interfacePredicateOperand
- Parameters:
arg1
- - datearg2
- - PredicateOperand instance or parameter- Returns:
- conditional predicate
-
between
public Predicate between(java.util.Date arg1, java.util.Date arg2)
Description copied from interface:PredicateOperand
Create a predicate for testing whether the PredicateOperand lies between (inclusive) the two arguments.- Specified by:
between
in interfacePredicateOperand
- Parameters:
arg1
- - datearg2
- - date- Returns:
- conditional predicate
-
between
public Predicate between(PredicateOperand arg1, java.util.Calendar arg2)
Description copied from interface:PredicateOperand
Create a predicate for testing whether the PredicateOperand lies between (inclusive) the two arguments.- Specified by:
between
in interfacePredicateOperand
- Parameters:
arg1
- - PredicateOperand instance or parameterarg2
- - calendar- Returns:
- conditional predicate
-
between
public Predicate between(java.util.Calendar arg1, PredicateOperand arg2)
Description copied from interface:PredicateOperand
Create a predicate for testing whether the PredicateOperand lies between (inclusive) the two arguments.- Specified by:
between
in interfacePredicateOperand
- Parameters:
arg1
- - calendararg2
- - PredicateOperand instance or parameter- Returns:
- conditional predicate
-
between
public Predicate between(java.util.Calendar arg1, java.util.Calendar arg2)
Description copied from interface:PredicateOperand
Create a predicate for testing whether the PredicateOperand lies between (inclusive) the two arguments.- Specified by:
between
in interfacePredicateOperand
- Parameters:
arg1
- - calendararg2
- - calendar- Returns:
- conditional predicate
-
equal
public Predicate equal(PredicateOperand arg)
Description copied from interface:PredicateOperand
Create a predicate for testing equality with the specified argument.- Specified by:
equal
in interfacePredicateOperand
- Parameters:
arg
- - PredicateOperand instance or parameter- Returns:
- conditional predicate
-
equal
public Predicate equal(java.lang.Class cls)
Description copied from interface:PredicateOperand
Create a predicate for testing equality with the specified argument.- Specified by:
equal
in interfacePredicateOperand
- Parameters:
cls
- - entity class- Returns:
- conditional predicate
-
equal
public Predicate equal(java.lang.Number arg)
Description copied from interface:PredicateOperand
Create a predicate for testing equality with the specified argument.- Specified by:
equal
in interfacePredicateOperand
- Parameters:
arg
- - numeric- Returns:
- conditional predicate
-
equal
public Predicate equal(java.lang.String arg)
Description copied from interface:PredicateOperand
Create a predicate for testing equality with the specified argument.- Specified by:
equal
in interfacePredicateOperand
- Parameters:
arg
- - string value- Returns:
- conditional predicate
-
equal
public Predicate equal(boolean arg)
Description copied from interface:PredicateOperand
Create a predicate for testing equality with the specified argument.- Specified by:
equal
in interfacePredicateOperand
- Parameters:
arg
- - boolean value- Returns:
- conditional predicate
-
equal
public Predicate equal(java.util.Date arg)
Description copied from interface:PredicateOperand
Create a predicate for testing equality with the specified argument.- Specified by:
equal
in interfacePredicateOperand
- Parameters:
arg
- - date- Returns:
- conditional predicate
-
equal
public Predicate equal(java.util.Calendar arg)
Description copied from interface:PredicateOperand
Create a predicate for testing equality with the specified argument.- Specified by:
equal
in interfacePredicateOperand
- Parameters:
arg
- - calendar- Returns:
- conditional predicate
-
equal
public Predicate equal(java.lang.Enum<?> e)
Description copied from interface:PredicateOperand
Create a predicate for testing equality with the specified argument.- Specified by:
equal
in interfacePredicateOperand
- Parameters:
e
- - enum- Returns:
- conditional predicate
-
greaterEqual
public Predicate greaterEqual(PredicateOperand arg)
Description copied from interface:PredicateOperand
Create a predicate for testing whether the PredicateOperand is greater than or equal to the argument.- Specified by:
greaterEqual
in interfacePredicateOperand
- Parameters:
arg
- - PredicateOperand instance or parameter- Returns:
- conditional predicate
-
greaterEqual
public Predicate greaterEqual(java.lang.Number arg)
Description copied from interface:PredicateOperand
Create a predicate for testing whether the PredicateOperand is greater than or equal to the argument.- Specified by:
greaterEqual
in interfacePredicateOperand
- Parameters:
arg
- - numeric- Returns:
- conditional predicate
-
greaterEqual
public Predicate greaterEqual(java.lang.String arg)
Description copied from interface:PredicateOperand
Create a predicate for testing whether the PredicateOperand is greater than or equal to the argument.- Specified by:
greaterEqual
in interfacePredicateOperand
- Parameters:
arg
- - string- Returns:
- conditional predicate
-
greaterEqual
public Predicate greaterEqual(java.util.Date arg)
Description copied from interface:PredicateOperand
Create a predicate for testing whether the PredicateOperand is greater than or equal to the argument.- Specified by:
greaterEqual
in interfacePredicateOperand
- Parameters:
arg
- - date- Returns:
- conditional predicate
-
greaterEqual
public Predicate greaterEqual(java.util.Calendar arg)
Description copied from interface:PredicateOperand
Create a predicate for testing whether the PredicateOperand is greater than or equal to the argument.- Specified by:
greaterEqual
in interfacePredicateOperand
- Parameters:
arg
- - calendar- Returns:
- conditional predicate
-
greaterThan
public Predicate greaterThan(PredicateOperand arg)
Description copied from interface:PredicateOperand
Create a predicate for testing whether the PredicateOperand is greater than the argument.- Specified by:
greaterThan
in interfacePredicateOperand
- Parameters:
arg
- - PredicateOperand instance or parameter- Returns:
- conditional predicate
-
greaterThan
public Predicate greaterThan(java.lang.Number arg)
Description copied from interface:PredicateOperand
Create a predicate for testing whether the PredicateOperand is greater than the argument.- Specified by:
greaterThan
in interfacePredicateOperand
- Parameters:
arg
- - numeric- Returns:
- conditional predicate
-
greaterThan
public Predicate greaterThan(java.lang.String arg)
Description copied from interface:PredicateOperand
Create a predicate for testing whether the PredicateOperand is greater than the argument.- Specified by:
greaterThan
in interfacePredicateOperand
- Parameters:
arg
- - string- Returns:
- conditional predicate
-
greaterThan
public Predicate greaterThan(java.util.Date arg)
Description copied from interface:PredicateOperand
Create a predicate for testing whether the PredicateOperand is greater than the argument.- Specified by:
greaterThan
in interfacePredicateOperand
- Parameters:
arg
- - date- Returns:
- conditional predicate
-
greaterThan
public Predicate greaterThan(java.util.Calendar arg)
Description copied from interface:PredicateOperand
Create a predicate for testing whether the PredicateOperand is greater than the argument.- Specified by:
greaterThan
in interfacePredicateOperand
- Parameters:
arg
- - calendar- Returns:
- conditional predicate
-
lessEqual
public Predicate lessEqual(PredicateOperand arg)
Description copied from interface:PredicateOperand
Create a predicate for testing whether the PredicateOperand is less than or equal to the argument.- Specified by:
lessEqual
in interfacePredicateOperand
- Parameters:
arg
- - PredicateOperand instance or parameter- Returns:
- conditional predicate
-
lessEqual
public Predicate lessEqual(java.lang.Number arg)
Description copied from interface:PredicateOperand
Create a predicate for testing whether the PredicateOperand is less than or equal to the argument.- Specified by:
lessEqual
in interfacePredicateOperand
- Parameters:
arg
- - numeric- Returns:
- conditional predicate
-
lessEqual
public Predicate lessEqual(java.lang.String arg)
Description copied from interface:PredicateOperand
Create a predicate for testing whether the PredicateOperand is less than or equal to the argument.- Specified by:
lessEqual
in interfacePredicateOperand
- Parameters:
arg
- - string- Returns:
- conditional predicate
-
lessEqual
public Predicate lessEqual(java.util.Date arg)
Description copied from interface:PredicateOperand
Create a predicate for testing whether the PredicateOperand is less than or equal to the argument.- Specified by:
lessEqual
in interfacePredicateOperand
- Parameters:
arg
- - date- Returns:
- conditional predicate
-
lessEqual
public Predicate lessEqual(java.util.Calendar arg)
Description copied from interface:PredicateOperand
Create a predicate for testing whether the PredicateOperand is less than or equal to the argument.- Specified by:
lessEqual
in interfacePredicateOperand
- Parameters:
arg
- - calendar- Returns:
- conditional predicate
-
lessThan
public Predicate lessThan(PredicateOperand arg)
Description copied from interface:PredicateOperand
Create a predicate for testing whether the PredicateOperand is less than the argument.- Specified by:
lessThan
in interfacePredicateOperand
- Parameters:
arg
- - PredicateOperand instance or parameter- Returns:
- conditional predicate
-
lessThan
public Predicate lessThan(java.lang.Number arg)
Description copied from interface:PredicateOperand
Create a predicate for testing whether the PredicateOperand is less than the argument.- Specified by:
lessThan
in interfacePredicateOperand
- Parameters:
arg
- - numeric- Returns:
- conditional predicate
-
lessThan
public Predicate lessThan(java.lang.String arg)
Description copied from interface:PredicateOperand
Create a predicate for testing whether the PredicateOperand is less than the argument.- Specified by:
lessThan
in interfacePredicateOperand
- Parameters:
arg
- - string- Returns:
- conditional predicate
-
lessThan
public Predicate lessThan(java.util.Date arg)
Description copied from interface:PredicateOperand
Create a predicate for testing whether the PredicateOperand is less than the argument.- Specified by:
lessThan
in interfacePredicateOperand
- Parameters:
arg
- - date- Returns:
- conditional predicate
-
lessThan
public Predicate lessThan(java.util.Calendar arg)
Description copied from interface:PredicateOperand
Create a predicate for testing whether the PredicateOperand is less than the argument.- Specified by:
lessThan
in interfacePredicateOperand
- Parameters:
arg
- - calendar- Returns:
- conditional predicate
-
like
public Predicate like(PredicateOperand pattern)
Description copied from interface:PredicateOperand
Create a predicate for testing whether the PredicateOperand satisfies the given pattern.- Specified by:
like
in interfacePredicateOperand
- Returns:
- conditional predicate
-
like
public Predicate like(PredicateOperand pattern, PredicateOperand escChar)
Description copied from interface:PredicateOperand
Create a predicate for testing whether the PredicateOperand satisfies the given pattern.- Specified by:
like
in interfacePredicateOperand
- Returns:
- conditional predicate
-
like
public Predicate like(PredicateOperand pattern, char escapeChar)
Description copied from interface:PredicateOperand
Create a predicate for testing whether the PredicateOperand satisfies the given pattern.- Specified by:
like
in interfacePredicateOperand
- Returns:
- conditional predicate
-
like
public Predicate like(java.lang.String pattern)
Description copied from interface:PredicateOperand
Create a predicate for testing whether the PredicateOperand satisfies the given pattern.- Specified by:
like
in interfacePredicateOperand
- Returns:
- conditional predicate
-
like
public Predicate like(java.lang.String pattern, PredicateOperand escapeChar)
Description copied from interface:PredicateOperand
Create a predicate for testing whether the PredicateOperand satisfies the given pattern.- Specified by:
like
in interfacePredicateOperand
- Returns:
- conditional predicate
-
like
public Predicate like(java.lang.String pattern, char escChar)
Description copied from interface:PredicateOperand
Create a predicate for testing whether the PredicateOperand satisfies the given pattern.- Specified by:
like
in interfacePredicateOperand
- Returns:
- conditional predicate
-
notEqual
public Predicate notEqual(PredicateOperand arg)
Description copied from interface:PredicateOperand
Create a predicate for testing inequality with the specified argument.- Specified by:
notEqual
in interfacePredicateOperand
- Parameters:
arg
- - PredicateOperand instance or parameter- Returns:
- conditional predicate
-
notEqual
public Predicate notEqual(java.lang.Class cls)
Description copied from interface:PredicateOperand
Create a predicate for testing inequality with the specified argument.- Specified by:
notEqual
in interfacePredicateOperand
- Parameters:
cls
- - entity class- Returns:
- conditional predicate
-
notEqual
public Predicate notEqual(java.lang.Number arg)
Description copied from interface:PredicateOperand
Create a predicate for testing inequality with the specified argument.- Specified by:
notEqual
in interfacePredicateOperand
- Parameters:
arg
- - numberic value- Returns:
- conditional predicate
-
notEqual
public Predicate notEqual(java.lang.String arg)
Description copied from interface:PredicateOperand
Create a predicate for testing inequality with the specified argument.- Specified by:
notEqual
in interfacePredicateOperand
- Parameters:
arg
- - string value- Returns:
- conditional predicate
-
notEqual
public Predicate notEqual(boolean arg)
Description copied from interface:PredicateOperand
Create a predicate for testing inequality with the specified argument.- Specified by:
notEqual
in interfacePredicateOperand
- Parameters:
arg
- - boolean value- Returns:
- conditional predicate
-
notEqual
public Predicate notEqual(java.util.Date arg)
Description copied from interface:PredicateOperand
Create a predicate for testing inequality with the specified argument.- Specified by:
notEqual
in interfacePredicateOperand
- Parameters:
arg
- - date- Returns:
- conditional predicate
-
notEqual
public Predicate notEqual(java.util.Calendar arg)
Description copied from interface:PredicateOperand
Create a predicate for testing inequality with the specified argument.- Specified by:
notEqual
in interfacePredicateOperand
- Parameters:
arg
- - calendar- Returns:
- conditional predicate
-
notEqual
public Predicate notEqual(java.lang.Enum<?> e)
Description copied from interface:PredicateOperand
Create a predicate for testing inequality with the specified argument.- Specified by:
notEqual
in interfacePredicateOperand
- Parameters:
e
- - enum- Returns:
- conditional predicate
-
getAliasHint
public java.lang.String getAliasHint(org.apache.openjpa.persistence.query.AliasContext ctx)
Description copied from interface:Visitable
Gets the hint to be used while creating alias.- Specified by:
getAliasHint
in interfaceVisitable
-
asJoinable
public java.lang.String asJoinable(org.apache.openjpa.persistence.query.AliasContext ctx)
Description copied from interface:Visitable
Gets the string representation in FROM clause.- Specified by:
asJoinable
in interfaceVisitable
-
-