FetchPath (OpenJPA Parent POM 2.0.0 API)

Overview

Package

Class

Use

Tree

Deprecated

Index

Help

PREV CLASS NEXT CLASS

FRAMES NO FRAMES

SUMMARY: NESTED | FIELD | CONSTR | METHOD

DETAIL: FIELD | CONSTR | METHOD

org.apache.openjpa.persistence.query
Class FetchPath

java.lang.Object
  org.apache.openjpa.persistence.query.AbstractDomainObject
      org.apache.openjpa.persistence.query.FetchPath

All Implemented Interfaces:: Serializable, DomainObject, Expression, FetchJoinObject, OrderByItem, PathExpression, PredicateOperand, QueryDefinition, SelectItem, Subquery, Visitable

public class FetchPath
extends AbstractDomainObject
implements FetchJoinObject, Visitable
extends AbstractDomainObject
implements FetchJoinObject, Visitable

Denotes a path used in fetch join. Simply wraps a Navigation Path.

Author:: Pinaki Poddar
See Also:: Serialized Form

Field Summary
`protected PathOperator`	`_operator`
`protected QueryDefinitionImpl`	`_owner`
`protected org.apache.openjpa.persistence.query.AbstractPath`	`_parent`
`protected Object`	`_part2`
`static String`	`CLOSE_BRACE`
`static String`	`COMMA`
`static String`	`EMPTY`
`static String`	`OPEN_BRACE`
`static String`	`SPACE`

Method Summary
`Expression`	`abs()` Absolute value.
`OrderByItem`	`asc()` Return an OrderByItem referencing the SelectItem and specifying ascending ordering.
`String`	`asExpression(org.apache.openjpa.persistence.query.AliasContext ctx)` Get a JPQL fragment as used in WHERE clause.
`String`	`asJoinable(org.apache.openjpa.persistence.query.AliasContext ctx)` Gets the string representation in FROM clause.
`String`	`asProjection(org.apache.openjpa.persistence.query.AliasContext ctx)` Gets the string representation in SELECT projection.
`Aggregate`	`avg()` Specify that the avg operation is to be applied.
`Predicate`	`between(Calendar arg1, Calendar arg2)` Create a predicate for testing whether the PredicateOperand lies between (inclusive) the two arguments.
`Predicate`	`between(Calendar arg1, PredicateOperand arg2)` Create a predicate for testing whether the PredicateOperand lies between (inclusive) the two arguments.
`Predicate`	`between(Date arg1, Date arg2)` Create a predicate for testing whether the PredicateOperand lies between (inclusive) the two arguments.
`Predicate`	`between(Date arg1, PredicateOperand arg2)` Create a predicate for testing whether the PredicateOperand lies between (inclusive) the two arguments.
`Predicate`	`between(Number arg1, Number arg2)` Create a predicate for testing whether the PredicateOperand lies between (inclusive) the two arguments.
`Predicate`	`between(Number arg1, PredicateOperand arg2)` Create a predicate for testing whether the PredicateOperand lies between (inclusive) the two arguments.
`Predicate`	`between(PredicateOperand arg1, Calendar arg2)` Create a predicate for testing whether the PredicateOperand lies between (inclusive) the two arguments.
`Predicate`	`between(PredicateOperand arg1, Date arg2)` Create a predicate for testing whether the PredicateOperand lies between (inclusive) the two arguments.
`Predicate`	`between(PredicateOperand arg1, Number 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.
`Predicate`	`between(PredicateOperand arg1, String arg2)` Create a predicate for testing whether the PredicateOperand lies between (inclusive) the two arguments.
`Predicate`	`between(String arg1, PredicateOperand arg2)` Create a predicate for testing whether the PredicateOperand lies between (inclusive) the two arguments.
`Predicate`	`between(String arg1, String arg2)` Create a predicate for testing whether the PredicateOperand lies between (inclusive) the two arguments.
`Expression`	`concat(Expression... exprs)` Concatenate a string with other string(s).
`Expression`	`concat(String... str)` Concatenate a string with other string(s).
`Aggregate`	`count()` Specify that the count operation is to be applied.
`OrderByItem`	`desc()` Return an OrderByItem referencing the SelectItem and specifying descending ordering.
`Expression`	`dividedBy(Expression expr)` Division.
`Expression`	`dividedBy(Number num)` Division.
`Predicate`	`equal(boolean arg)` Create a predicate for testing equality with the specified argument.
`Predicate`	`equal(Calendar arg)` Create a predicate for testing equality with the specified argument.
`Predicate`	`equal(Class cls)` Create a predicate for testing equality with the specified argument.
`Predicate`	`equal(Date arg)` Create a predicate for testing equality with the specified argument.
`Predicate`	`equal(Enum<?> e)` Create a predicate for testing equality with the specified argument.
`Predicate`	`equal(Number 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.
`Predicate`	`equal(String arg)` Create a predicate for testing equality with the specified argument.
`String`	`getAliasHint(org.apache.openjpa.persistence.query.AliasContext ctx)` Gets the hint to be used while creating alias.
`Object`	`getLastSegment()` Gets the last segment of this path.
`PathOperator`	`getOperator()` Gets operator that derived this receiver from its parent.
`org.apache.openjpa.persistence.query.AbstractPath`	`getParent()` Gets the parent from which this receiver has been derived.
`Predicate`	`greaterEqual(Calendar arg)` Create a predicate for testing whether the PredicateOperand is greater than or equal to the argument.
`Predicate`	`greaterEqual(Date arg)` Create a predicate for testing whether the PredicateOperand is greater than or equal to the argument.
`Predicate`	`greaterEqual(Number 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`	`greaterEqual(String arg)` Create a predicate for testing whether the PredicateOperand is greater than or equal to the argument.
`Predicate`	`greaterThan(Calendar arg)` Create a predicate for testing whether the PredicateOperand is greater than the argument.
`Predicate`	`greaterThan(Date arg)` Create a predicate for testing whether the PredicateOperand is greater than the argument.
`Predicate`	`greaterThan(Number 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`	`greaterThan(String arg)` Create a predicate for testing whether the PredicateOperand is greater than the argument.
`Predicate`	`in(Class... classes)` Create a predicate for testing whether the expression value is a member of the argument list.
`Predicate`	`in(Enum<?>... enums)` 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(Number... nums)` Create a predicate for testing whether the expression value is a member of the argument list.
`Predicate`	`in(String... strings)` 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`	`isEmpty()` Add a restriction that the path expression must correspond to an association or element collection that is empty (has no elements).
`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(Calendar arg)` Create a predicate for testing whether the PredicateOperand is less than or equal to the argument.
`Predicate`	`lessEqual(Date arg)` Create a predicate for testing whether the PredicateOperand is less than or equal to the argument.
`Predicate`	`lessEqual(Number 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`	`lessEqual(String arg)` Create a predicate for testing whether the PredicateOperand is less than or equal to the argument.
`Predicate`	`lessThan(Calendar arg)` Create a predicate for testing whether the PredicateOperand is less than the argument.
`Predicate`	`lessThan(Date arg)` Create a predicate for testing whether the PredicateOperand is less than the argument.
`Predicate`	`lessThan(Number 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`	`lessThan(String arg)` Create a predicate for testing whether the PredicateOperand is less than the argument.
`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.
`Predicate`	`like(String pattern)` Create a predicate for testing whether the PredicateOperand satisfies the given pattern.
`Predicate`	`like(String pattern, char escChar)` Create a predicate for testing whether the PredicateOperand satisfies the given pattern.
`Predicate`	`like(String pattern, PredicateOperand escapeChar)` Create a predicate for testing whether the PredicateOperand satisfies the given pattern.
`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, 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 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(String str)` Locate a string contained within the string corresponding to the expression on which the method was invoked.
`Expression`	`locate(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(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`	`lower()` Convert string to lowercase.
`Aggregate`	`max()` Specify that the max operation is to be applied.
`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.
`Aggregate`	`min()` Specify that the min operation is to be applied.
`Expression`	`minus()` Unary minus.
`Expression`	`minus(Expression expr)` Subtraction.
`Expression`	`minus(Number num)` Subtraction.
`Expression`	`mod(Expression expr)` Modulo operation.
`Expression`	`mod(int num)` Modulo operation.
`Predicate`	`notEqual(boolean arg)` Create a predicate for testing inequality with the specified argument.
`Predicate`	`notEqual(Calendar arg)` Create a predicate for testing inequality with the specified argument.
`Predicate`	`notEqual(Class cls)` Create a predicate for testing inequality with the specified argument.
`Predicate`	`notEqual(Date arg)` Create a predicate for testing inequality with the specified argument.
`Predicate`	`notEqual(Enum<?> e)` Create a predicate for testing inequality with the specified argument.
`Predicate`	`notEqual(Number 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.
`Predicate`	`notEqual(String arg)` Create a predicate for testing inequality with the specified argument.
`Expression`	`plus(Expression expr)` Addition.
`Expression`	`plus(Number num)` Addition.
`Expression`	`size()` Return an expression that corresponds to the number of elements association or element collection corresponding to the path expression.
`Expression`	`sqrt()` Square root.
`Expression`	`substring(Expression start)` Extract a substring starting at specified position through to the end of the string.
`Expression`	`substring(Expression start, Expression len)` Extract a substring.
`Expression`	`substring(Expression start, int len)` Extract a substring.
`Expression`	`substring(int start)` Extract a substring starting at specified position through to the end of the string.
`Expression`	`substring(int start, Expression len)` Extract a substring.
`Expression`	`substring(int start, int len)` Extract a substring.
`Aggregate`	`sum()` Specify that the sum operation is to be applied.
`Expression`	`times(Expression expr)` Multiplication.
`Expression`	`times(Number num)` 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`	`type()` Return an expression that corresponds to the type of the entity.
`Expression`	`upper()` Convert string to uppercase.

Methods inherited from class org.apache.openjpa.persistence.query.AbstractDomainObject
addRoot, addSubqueryRoot, all, any, coalesce, coalesce, coalesce, coalesce, currentDate, currentTime, currentTimestamp, entry, exists, generalCase, get, groupBy, groupBy, having, index, join, joinFetch, key, leftJoin, leftJoinFetch, literal, literal, literal, literal, literal, literal, literal, literal, newInstance, nullif, nullif, nullif, nullif, nullif, nullif, nullif, nullLiteral, orderBy, orderBy, param, predicate, select, select, selectDistinct, selectDistinct, simpleCase, simpleCase, simpleCase, simpleCase, simpleCase, simpleCase, simpleCase, some, value, where

Methods inherited from class org.apache.openjpa.persistence.query.AbstractDomainObject

addRoot, addSubqueryRoot, all, any, coalesce, coalesce, coalesce, coalesce, currentDate, currentTime, currentTimestamp, entry, exists, generalCase, get, groupBy, groupBy, having, index, join, joinFetch, key, leftJoin, leftJoinFetch, literal, literal, literal, literal, literal, literal, literal, literal, newInstance, nullif, nullif, nullif, nullif, nullif, nullif, nullif, nullLiteral, orderBy, orderBy, param, predicate, select, select, selectDistinct, selectDistinct, simpleCase, simpleCase, simpleCase, simpleCase, simpleCase, simpleCase, simpleCase, some, value, where

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.Visitable
`asExpression, asProjection, getAliasHint`

Methods inherited from interface org.apache.openjpa.persistence.query.PathExpression
`avg, count, isEmpty, max, min, size, sum, type`

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.SelectItem
`asc, desc`

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

Field Detail

_parent

protected final org.apache.openjpa.persistence.query.AbstractPath _parent

_part2

protected final Object _part2

_operator

protected final PathOperator _operator

_owner

protected final QueryDefinitionImpl _owner

SPACE

public static final String SPACE

See Also:: Constant Field Values

OPEN_BRACE

public static final String OPEN_BRACE

See Also:: Constant Field Values

CLOSE_BRACE

public static final String CLOSE_BRACE

See Also:: Constant Field Values

COMMA

public static final String COMMA

See Also:: Constant Field Values

EMPTY

public static final String EMPTY

See Also:: Constant Field Values

Method Detail

asJoinable

public 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 interface Visitable

getParent

public org.apache.openjpa.persistence.query.AbstractPath getParent()

Gets the parent from which this receiver has been derived. Can be null for a root path.

getOperator

public PathOperator getOperator()

Gets operator that derived this receiver from its parent.

getLastSegment

public Object getLastSegment()

Gets the last segment of this path. Concrete implementation should return a covariant type.

avg

public Aggregate avg()

Description copied from interface: PathExpression

Specify that the avg operation is to be applied. The path expression must correspond to an attribute of a numeric type. It is not permitted to invoke this method on a path expression that corresponds to a multi-valued association or element collection.

Specified by:: avg in interface PathExpression

Returns:: the resulting aggregate

count

public Aggregate count()

Description copied from interface: PathExpression

Specify that the count operation is to be applied. It is not permitted to invoke this method on a path expression that corresponds to a multi-valued association or element collection.

Specified by:: count in interface PathExpression

Returns:: the resulting aggregate

isEmpty

public Predicate isEmpty()

Description copied from interface: PathExpression

Add a restriction that the path expression must correspond to an association or element collection that is empty (has no elements). This method can only be invoked on a path expression that corresponds to a multi-valued association or to an element collection.

Specified by:: isEmpty in interface PathExpression

Returns:: predicate corresponding to the restriction

max

public Aggregate max()

Description copied from interface: PathExpression

Specify that the max operation is to be applied. The path expression must correspond to an attribute of an orderable type. It is not permitted to invoke this method on a path expression that corresponds to a multi-valued association or element collection.

Specified by:: max in interface PathExpression

Returns:: the resulting aggregate

min

public Aggregate min()

Description copied from interface: PathExpression

Specify that the min operation is to be applied. The path expression must correspond to an attribute of an orderable type. It is not permitted to invoke this method on a path expression that corresponds to a multi-valued association or element collection.

Specified by:: min in interface PathExpression

Returns:: the resulting aggregate

size

public Expression size()

Description copied from interface: PathExpression

Return an expression that corresponds to the number of elements association or element collection corresponding to the path expression. This method can only be invoked on a path expression that corresponds to a multi-valued association or to an element collection.

Specified by:: size in interface PathExpression

Returns:: expression denoting the size

sum

public Aggregate sum()

Description copied from interface: PathExpression

Specify that the sum operation is to be applied. The path expression must correspond to an attribute of a numeric type. It is not permitted to invoke this method on a path expression that corresponds to a multi-valued association or element collection.

Specified by:: sum in interface PathExpression

Returns:: the resulting aggregate

type

public Expression type()

Description copied from interface: PathExpression

Return an expression that corresponds to the type of the entity. This method can only be invoked on a path expression corresponding to an entity. It is not permitted to invoke this method on a path expression that corresponds to a multi-valued association.

Specified by:: type in interface PathExpression

Returns:: expression denoting the entity's type

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 interface Expression

Returns:: expression corresponding to the absolute value

concat

public Expression concat(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 interface Expression

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 interface Expression

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(Number num)

Description copied from interface: Expression

Division. This method must be invoked on an expression corresponding to a number.

Specified by:: dividedBy in interface Expression

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 interface Expression

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(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 interface Expression

Returns:: conditional predicate

in

public Predicate in(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 interface Expression

Returns:: conditional predicate

in

public Predicate in(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 interface Expression

Returns:: conditional predicate

in

public Predicate in(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 interface Expression

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 interface Expression

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 interface Expression

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 interface Expression

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 interface Expression

Returns:: expression denoting the length of the string.

locate

public Expression locate(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 interface Expression

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

Specified by:: locate in interface Expression

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(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 interface Expression

Parameters:: str - - string to be located; position - - 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(String str,
                         Expression position)

Description copied from interface: Expression

Specified by:: locate in interface Expression

Parameters:: str - - string to be located; position - - 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

Specified by:: locate in interface Expression

Parameters:: str - - expression corresponding to the string to be located; position - - 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

Specified by:: locate in interface Expression

Parameters:: str - - expression corresponding to the string to be located; position - - 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 interface Expression

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 interface Expression

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 interface Expression

Returns:: expression denoting the unary minus of the expression

minus

public Expression minus(Number num)

Description copied from interface: Expression

Subtraction. This method must be invoked on an expression corresponding to a number.

Specified by:: minus in interface Expression

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 interface Expression

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 interface Expression

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 interface Expression

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(Number num)

Description copied from interface: Expression

Addition. This method must be invoked on an expression corresponding to a number.

Specified by:: plus in interface Expression

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 interface Expression

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 interface Expression

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 interface Expression

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 interface Expression

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 interface Expression

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 interface Expression

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 interface Expression

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 interface Expression

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(Number num)

Description copied from interface: Expression

Multiplication. This method must be invoked on an expression corresponding to a number.

Specified by:: times in interface Expression

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 interface Expression

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 interface Expression

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 interface Expression

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 interface Expression

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 interface Expression

Parameters:: c - - character to be trimmed; spec - - 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 interface Expression

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 interface Expression

Parameters:: expr - - expression corresponding to the character to be trimmed; spec - - 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 interface Expression

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 interface SelectItem

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 interface SelectItem

Returns:: order-by item