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 AbstractDomainObject

java.lang.Object
  extended by org.apache.openjpa.persistence.query.AbstractDomainObject
All Implemented Interfaces:
Serializable, DomainObject, Expression, OrderByItem, PathExpression, PredicateOperand, QueryDefinition, SelectItem, Subquery, Visitable
Direct Known Subclasses:
FetchPath, JoinPath, OperatorPath, RootPath
public abstract class AbstractDomainObject
extends Object
implements DomainObject

Domain Object is a path expression over which query is evaluated. Domain object acts as a proxy for a QueryDefinition via delegation.

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
           
 
Constructor Summary
protected AbstractDomainObject(QueryDefinitionImpl owner, org.apache.openjpa.persistence.query.AbstractPath parent, PathOperator op, Object part2)
           
 
Method Summary
 Expression abs()
          Absolute value.
 DomainObject addRoot(Class cls)
          Adding a root adds a root domain to the owning query.
 DomainObject addSubqueryRoot(PathExpression path)
          Adding a query root adds a subquery to the owning query.
 Subquery all()
          Derives this path as ALL(subquery) to its owning query.
 Subquery any()
          Adds this path as ANY(subquery) to its owning query.
 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 coalesce(Calendar... exp)
          coalesce This is equivalent to a case expression that returns null if all its arguments evaluate to null, and the value of its first non-null argument otherwise.
 Expression coalesce(Date... exp)
          coalesce This is equivalent to a case expression that returns null if all its arguments evaluate to null, and the value of its first non-null argument otherwise.
 Expression coalesce(Expression... exp)
          coalesce This is equivalent to a case expression that returns null if all its arguments evaluate to null, and the value of its first non-null argument otherwise.
 Expression coalesce(String... exp)
          coalesce This is equivalent to a case expression that returns null if all its arguments evaluate to null, and the value of its first non-null argument otherwise.
 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.
 Expression currentDate()
          Create an Expression corresponding to the current date on the database server at the time of query execution.
 Expression currentTime()
          Create an Expression corresponding to the current time on the database server at the time of query execution.
 Expression currentTimestamp()
          Create an Expression corresponding to the current timestamp on the database server at the time of query execution.
 OrderByItem desc()
          Return an OrderByItem referencing the SelectItem and specifying descending ordering.
 Expression dividedBy(Expression expr)
          Division.
 Expression dividedBy(Number num)
          Division.
 SelectItem entry()
          Derives by ENTRY() operation on this path.
 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.
 Predicate exists()
          Adds this path as EXISTS(subquery) to its owning query.
 CaseExpression generalCase()
          Create an empty general case expression.
 PathExpression get(String attr)
          Derives a path from this path by navigating through the given field.
 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.
 QueryDefinition groupBy(List<PathExpression> pathExprList)
          Specify the items that are used to form groups over the query results.
 QueryDefinition groupBy(PathExpression... pathExprs)
          Specify the items that are used to form groups over the query results.
 QueryDefinition having(Predicate predicate)
          Specify the restrictions over the groups of a query.
 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.
 Expression index()
          Derives by INDEX() operation on this path.
 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.
 DomainObject join(String attr)
          Derives a path from this path by joining the given field.
 FetchJoinObject joinFetch(String attr)
          Derives a path from this path by fetch joining the given field.
 PathExpression key()
          Derives by KEY() operation on this path.
 DomainObject leftJoin(String attr)
          Derives a path from this path by outer joining the given field.
 FetchJoinObject leftJoinFetch(String attr)
          Derives a path from this path by fetch joining the given field.
 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 literal(boolean b)
          Create an Expression corresponding to a boolean value.
 Expression literal(Calendar c)
          Create an Expression corresponding to a Calendar value.
 Expression literal(char c)
          Create an Expression corresponding to a character value.
 Expression literal(Class cls)
          Create an Expression corresponding to an entity class.
 Expression literal(Date d)
          Create an Expression corresponding to a Date value.
 Expression literal(Enum<?> e)
          Create an Expression corresponding to an enum.
 Expression literal(Number n)
          Create an Expression corresponding to a numeric value.
 Expression literal(String s)
          Create an Expression corresponding to a String value.
 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.
 SelectItem newInstance(Class cls, SelectItem... args)
          Specify that a constructor for the given class is to be applied to the corresponding query results after the query is executed.
 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 nullif(Calendar arg1, Calendar arg2)
          nullif This is equivalent to a case expression that tests whether its arguments are equal, returning null if they are and the value of the first expression if they are not.
 Expression nullif(Class arg1, Class arg2)
          nullif This is equivalent to a case expression that tests whether its arguments are equal, returning null if they are and the value of the first expression if they are not.
 Expression nullif(Date arg1, Date arg2)
          nullif This is equivalent to a case expression that tests whether its arguments are equal, returning null if they are and the value of the first expression if they are not.
 Expression nullif(Enum<?> arg1, Enum<?> arg2)
          nullif This is equivalent to a case expression that tests whether its arguments are equal, returning null if they are and the value of the first expression if they are not.
 Expression nullif(Expression exp1, Expression exp2)
          nullif This is equivalent to a case expression that tests whether its arguments are equal, returning null if they are and the value of the first expression if they are not.
 Expression nullif(Number arg1, Number arg2)
          nullif This is equivalent to a case expression that tests whether its arguments are equal, returning null if they are and the value of the first expression if they are not.
 Expression nullif(String arg1, String arg2)
          nullif This is equivalent to a case expression that tests whether its arguments are equal, returning null if they are and the value of the first expression if they are not.
 Expression nullLiteral()
          Create an Expression corresponding to a null value.
 QueryDefinition orderBy(List<OrderByItem> orderByItemList)
          Specify the items of the select list that are used in ordering the query results.
 QueryDefinition orderBy(OrderByItem... orderByItems)
          Specify the items of the select list that are used in ordering the query results.
 Expression param(String name)
          Specify use of a parameter of the given name.
 Expression plus(Expression expr)
          Addition.
 Expression plus(Number num)
          Addition.
 Predicate predicate(boolean b)
          Create a predicate value from the given boolean.
 QueryDefinition select(List<SelectItem> selectItemList)
          Specify the objects / values to be returned.
 QueryDefinition select(SelectItem... selectItems)
          Specify the objects / values to be returned.
 QueryDefinition selectDistinct(List<SelectItem> selectItemList)
          Specify the objects / values to be returned.
 QueryDefinition selectDistinct(SelectItem... selectItems)
          Specify the objects / values to be returned.
 CaseExpression simpleCase(Calendar caseOperand)
          Create a simple case expression with the given case operand.
 CaseExpression simpleCase(Class caseOperand)
          Create a simple case expression with the given case operand.
 CaseExpression simpleCase(Date caseOperand)
          Create a simple case expression with the given case operand.
 CaseExpression simpleCase(Enum<?> caseOperand)
          Create a simple case expression with the given case operand.
 CaseExpression simpleCase(Expression caseOperand)
          Create a simple case expression with the given case operand.
 CaseExpression simpleCase(Number caseOperand)
          Create a simple case expression with the given case operand.
 CaseExpression simpleCase(String caseOperand)
          Create a simple case expression with the given case operand.
 Expression size()
          Return an expression that corresponds to the number of elements association or element collection corresponding to the path expression.
 Subquery some()
          Adds this path as SOME(subquery) to its owning query.
 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.
 PathExpression value()
          Derives a path by VALUE() operation on this path.
 QueryDefinition where(Predicate predicate)
          Modifies the query definition to restrict the result of the query according to the specified predicate.
 
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.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.Visitable
asExpression, asJoinable, asProjection
 

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
Constructor Detail

AbstractDomainObject

protected AbstractDomainObject(QueryDefinitionImpl owner,
                               org.apache.openjpa.persistence.query.AbstractPath parent,
                               PathOperator op,
                               Object part2)
Method Detail

addRoot

public DomainObject addRoot(Class cls)
Adding a root adds a root domain to the owning query.

Specified by:
addRoot in interface QueryDefinition
Parameters:
cls - - an entity class
Returns:
DomainObject corresponding to the specified entity class.

addSubqueryRoot

public DomainObject addSubqueryRoot(PathExpression path)
Adding a query root adds a subquery to the owning query.

Specified by:
addSubqueryRoot in interface QueryDefinition
Parameters:
path - - path expression corresponding to the domain object used to derive the subquery root.
Returns:
the subquery DomainObject

get

public PathExpression get(String attr)
Derives a path from this path by navigating through the given field.

Specified by:
get in interface PathExpression
Parameters:
attr - - name of the referenced attribute
Returns:
path expression

join

public DomainObject join(String attr)
Derives a path from this path by joining the given field. Also the joined path becomes a domain of the owning query.

Specified by:
join in interface DomainObject
Parameters:
attr - - name of the attribute that references the target of the join
Returns:
the new DomainObject that is added for the target of the join

leftJoin

public DomainObject leftJoin(String attr)
Derives a path from this path by outer joining the given field. Also the joined path becomes a domain of the owning query.

Specified by:
leftJoin in interface DomainObject
Parameters:
attr - - name of the attribute that references the target of the join
Returns:
the new DomainObject that is added for the target of the join

joinFetch

public FetchJoinObject joinFetch(String attr)
Derives a path from this path by fetch joining the given field.

Specified by:
joinFetch in interface DomainObject
Parameters:
attr - - name of the attribute that references the target of the join
Returns:
the FetchJoinObject that is added for the target of the join

leftJoinFetch

public FetchJoinObject leftJoinFetch(String attr)
Derives a path from this path by fetch joining the given field.

Specified by:
leftJoinFetch in interface DomainObject
Parameters:
attr - - name of the attribute that references the target of the join
Returns:
the FetchJoinObject that is added for the target of the join

key

public PathExpression key()
Derives by KEY() operation on this path.

Specified by:
key in interface DomainObject
Returns:
PathExpression corresponding to the map key

entry

public SelectItem entry()
Derives by ENTRY() operation on this path.

Specified by:
entry in interface DomainObject
Returns:
SelectItem corresponding to the map entry

index

public Expression index()
Derives by INDEX() operation on this path.

Specified by:
index in interface DomainObject
Returns:
Expression denoting the index

value

public PathExpression value()
Derives a path by VALUE() operation on this path.

Specified by:
value in interface DomainObject
Returns:
PathExpression corresponding to the map value

all

public Subquery all()
Derives this path as ALL(subquery) to its owning query.

Specified by:
all in interface QueryDefinition
Returns:
the resulting Subquery

any

public Subquery any()
Adds this path as ANY(subquery) to its owning query.

Specified by:
any in interface QueryDefinition
Returns:
the resulting Subquery

some

public Subquery some()
Adds this path as SOME(subquery) to its owning query.

Specified by:
some in interface QueryDefinition
Returns:
the resulting Subquery

exists

public Predicate exists()
Adds this path as EXISTS(subquery) to its owning query.

Specified by:
exists in interface QueryDefinition
Returns:
the resulting predicate

coalesce

public Expression coalesce(Expression... exp)
Description copied from interface: QueryDefinition
coalesce This is equivalent to a case expression that returns null if all its arguments evaluate to null, and the value of its first non-null argument otherwise.

Specified by:
coalesce in interface QueryDefinition
Parameters:
exp - - expressions to be used for testing against null
Returns:
Expression corresponding to the given coalesce expression

coalesce

public Expression coalesce(String... exp)
Description copied from interface: QueryDefinition
coalesce This is equivalent to a case expression that returns null if all its arguments evaluate to null, and the value of its first non-null argument otherwise.

Specified by:
coalesce in interface QueryDefinition
Parameters:
exp - - expressions to be used for testing against null
Returns:
Expression corresponding to the given coalesce expression

coalesce

public Expression coalesce(Date... exp)
Description copied from interface: QueryDefinition
coalesce This is equivalent to a case expression that returns null if all its arguments evaluate to null, and the value of its first non-null argument otherwise.

Specified by:
coalesce in interface QueryDefinition
Parameters:
exp - - expressions to be used for testing against null
Returns:
Expression corresponding to the given coalesce expression

coalesce

public Expression coalesce(Calendar... exp)
Description copied from interface: QueryDefinition
coalesce This is equivalent to a case expression that returns null if all its arguments evaluate to null, and the value of its first non-null argument otherwise.

Specified by:
coalesce in interface QueryDefinition
Parameters:
exp - - expressions to be used for testing against null
Returns:
Expression corresponding to the given coalesce expression

currentDate

public Expression currentDate()
Description copied from interface: QueryDefinition
Create an Expression corresponding to the current date on the database server at the time of query execution.

Specified by:
currentDate in interface QueryDefinition
Returns:
the corresponding Expression

currentTime

public Expression currentTime()
Description copied from interface: QueryDefinition
Create an Expression corresponding to the current time on the database server at the time of query execution.

Specified by:
currentTime in interface QueryDefinition
Returns:
the corresponding Expression

currentTimestamp

public Expression currentTimestamp()
Description copied from interface: QueryDefinition
Create an Expression corresponding to the current timestamp on the database server at the time of query execution.

Specified by:
currentTimestamp in interface QueryDefinition
Returns:
the corresponding Expression

generalCase

public CaseExpression generalCase()
Description copied from interface: QueryDefinition
Create an empty general case expression. A general case expression is of the form:

generalCase() .when(conditional-predicate).then(scalar-expression) .when(conditional-predicate).then(scalar-expression) ... .elseCase(scalar-expression)

Specified by:
generalCase in interface QueryDefinition
Returns:
empty general case expression

groupBy

public QueryDefinition groupBy(PathExpression... pathExprs)
Description copied from interface: QueryDefinition
Specify the items that are used to form groups over the query results. Replaces the previous group-by list, if any.

Specified by:
groupBy in interface QueryDefinition
Returns:
the modified QueryDefinition instance

groupBy

public QueryDefinition groupBy(List<PathExpression> pathExprList)
Description copied from interface: QueryDefinition
Specify the items that are used to form groups over the query results. Replaces the previous group-by list, if any.

Specified by:
groupBy in interface QueryDefinition
Returns:
the modified QueryDefinition instance

having

public QueryDefinition having(Predicate predicate)
Description copied from interface: QueryDefinition
Specify the restrictions over the groups of a query. Replaces the previous having restriction(s), if any.

Specified by:
having in interface QueryDefinition
Returns:
the modified QueryDefinition Instance

literal

public Expression literal(String s)
Description copied from interface: QueryDefinition
Create an Expression corresponding to a String value.

Specified by:
literal in interface QueryDefinition
Parameters:
s - - string value
Returns:
the corresponding Expression literal

literal

public Expression literal(Number n)
Description copied from interface: QueryDefinition
Create an Expression corresponding to a numeric value.

Specified by:
literal in interface QueryDefinition
Parameters:
n - - numeric value
Returns:
the corresponding Expression literal

literal

public Expression literal(boolean b)
Description copied from interface: QueryDefinition
Create an Expression corresponding to a boolean value.

Specified by:
literal in interface QueryDefinition
Parameters:
b - - boolean value
Returns:
the corresponding Expression literal

literal

public Expression literal(Calendar c)
Description copied from interface: QueryDefinition
Create an Expression corresponding to a Calendar value.

Specified by:
literal in interface QueryDefinition
Parameters:
c - - Calendar value
Returns:
the corresponding Expression literal

literal

public Expression literal(Date d)
Description copied from interface: QueryDefinition
Create an Expression corresponding to a Date value.

Specified by:
literal in interface QueryDefinition
Parameters:
d - - Date value
Returns:
the corresponding Expression literal

literal

public Expression literal(char c)
Description copied from interface: QueryDefinition
Create an Expression corresponding to a character value.

Specified by:
literal in interface QueryDefinition
Returns:
the corresponding Expression literal

literal

public Expression literal(Class cls)
Description copied from interface: QueryDefinition
Create an Expression corresponding to an entity class.

Specified by:
literal in interface QueryDefinition
Parameters:
cls - - entity class
Returns:
the corresponding Expression literal

literal

public Expression literal(Enum<?> e)
Description copied from interface: QueryDefinition
Create an Expression corresponding to an enum.

Specified by:
literal in interface QueryDefinition
Parameters:
e - - enum
Returns:
the corresponding Expression literal

newInstance

public SelectItem newInstance(Class cls,
                              SelectItem... args)
Description copied from interface: QueryDefinition
Specify that a constructor for the given class is to be applied to the corresponding query results after the query is executed. The class must have a constructor that accepts the Java argument types corresponding to the given select items.

Specified by:
newInstance in interface QueryDefinition
Parameters:
cls - - a class with the correponding constructor
args - - select items that correspond to result types that are valid as arguments to the constructor

nullLiteral

public Expression nullLiteral()
Description copied from interface: QueryDefinition
Create an Expression corresponding to a null value.

Specified by:
nullLiteral in interface QueryDefinition
Returns:
the corresponding Expression literal

nullif

public Expression nullif(Expression exp1,
                         Expression exp2)
Description copied from interface: QueryDefinition
nullif This is equivalent to a case expression that tests whether its arguments are equal, returning null if they are and the value of the first expression if they are not.

Specified by:
nullif in interface QueryDefinition
Returns:
Expression corresponding to the given nullif expression

nullif

public Expression nullif(Number arg1,
                         Number arg2)
Description copied from interface: QueryDefinition
nullif This is equivalent to a case expression that tests whether its arguments are equal, returning null if they are and the value of the first expression if they are not.

Specified by:
nullif in interface QueryDefinition
Returns:
Expression corresponding to the given nullif expression

nullif

public Expression nullif(String arg1,
                         String arg2)
Description copied from interface: QueryDefinition
nullif This is equivalent to a case expression that tests whether its arguments are equal, returning null if they are and the value of the first expression if they are not.

Specified by:
nullif in interface QueryDefinition
arg2 - Criteria API Java Persistence 2.0, Public Review Draft Criteria API Interfaces 10/31/08 158 JSR-317 Public Review Draft Sun Microsystems, Inc.
Returns:
Expression corresponding to the given nullif expression

nullif

public Expression nullif(Date arg1,
                         Date arg2)
Description copied from interface: QueryDefinition
nullif This is equivalent to a case expression that tests whether its arguments are equal, returning null if they are and the value of the first expression if they are not.

Specified by:
nullif in interface QueryDefinition
Returns:
Expression corresponding to the given nullif expression

nullif

public Expression nullif(Calendar arg1,
                         Calendar arg2)
Description copied from interface: QueryDefinition
nullif This is equivalent to a case expression that tests whether its arguments are equal, returning null if they are and the value of the first expression if they are not.

Specified by:
nullif in interface QueryDefinition
Returns:
Expression corresponding to the given nullif expression

nullif

public Expression nullif(Class arg1,
                         Class arg2)
Description copied from interface: QueryDefinition
nullif This is equivalent to a case expression that tests whether its arguments are equal, returning null if they are and the value of the first expression if they are not.

Specified by:
nullif in interface QueryDefinition
Returns:
Expression corresponding to the given nullif expression

nullif

public Expression nullif(Enum<?> arg1,
                         Enum<?> arg2)
Description copied from interface: QueryDefinition
nullif This is equivalent to a case expression that tests whether its arguments are equal, returning null if they are and the value of the first expression if they are not.

Specified by:
nullif in interface QueryDefinition
Returns:
Expression corresponding to the given nullif expression

orderBy

public QueryDefinition orderBy(OrderByItem... orderByItems)
Description copied from interface: QueryDefinition
Specify the items of the select list that are used in ordering the query results. Replaces the previous order-by list, if any.

Specified by:
orderBy in interface QueryDefinition
Parameters:
orderByItems - - one or more OrderByItem instances
Returns:
the modified QueryDefinition instance

orderBy

public QueryDefinition orderBy(List<OrderByItem> orderByItemList)
Description copied from interface: QueryDefinition
Specify the items of the select list that are used in ordering the query results. Replaces the previous order-by list, if any.

Specified by:
orderBy in interface QueryDefinition
Parameters:
orderByItemList - - a list containing one or more OrderByItem instances
Returns:
the modified QueryDefinition instance

param

public Expression param(String name)
Description copied from interface: QueryDefinition
Specify use of a parameter of the given name.

Specified by:
param in interface QueryDefinition
Returns:
an Expression corresponding to a named parameter

predicate

public Predicate predicate(boolean b)
Description copied from interface: QueryDefinition
Create a predicate value from the given boolean.

Specified by:
predicate in interface QueryDefinition
Parameters:
b - boolean value
Returns:
a true or false predicate

select

public QueryDefinition select(SelectItem... selectItems)
Description copied from interface: QueryDefinition
Specify the objects / values to be returned. Replaces the previous select list, if any. If no select items are specified and there is only one query root, the root entity is assumed to be the result.

Specified by:
select in interface QueryDefinition
Parameters:
selectItems - - one or more SelectItem instances
Returns:
the modified query definition instance

select

public QueryDefinition select(List<SelectItem> selectItemList)
Description copied from interface: QueryDefinition
Specify the objects / values to be returned. Replaces the previous select list, if any. If no select items are specified and there is only one query root, the root entity is assumed to be the result.

Specified by:
select in interface QueryDefinition
Parameters:
selectItemList - - a list containing one or more SelectItem instances
Returns:
the modified query definition instance

selectDistinct

public QueryDefinition selectDistinct(SelectItem... selectItems)
Description copied from interface: QueryDefinition
Specify the objects / values to be returned. Duplicate results will be eliminated. Replaces the previous select list, if any. If no select items are specified and there is only one query root, the root entity is assumed to be the result.

Specified by:
selectDistinct in interface QueryDefinition
Parameters:
selectItems - - one or more SelectItem instances
Returns:
the modified query definition instance

selectDistinct

public QueryDefinition selectDistinct(List<SelectItem> selectItemList)
Description copied from interface: QueryDefinition
Specify the objects / values to be returned. Duplicate results will be eliminated. Replaces the previous select list, if any. If no select items are specified, and there is only one query root, the root entity is assumed to be the result. is assumed to be the result.

Specified by:
selectDistinct in interface QueryDefinition
Parameters:
selectItemList - - a list containing one or more SelectItem instances
Returns:
the modified query definition instance

simpleCase

public CaseExpression simpleCase(Expression caseOperand)
Description copied from interface: QueryDefinition
Create a simple case expression with the given case operand. A simple case expression is of the form:

simpleCase(case-operand) .when(scalar-expression).then(scalar-expression) .when(scalar-expression).then(scalar-expression) ... .elseCase(scalar-expression)

Specified by:
simpleCase in interface QueryDefinition
Parameters:
caseOperand - - expression used for testing against the when scalar expressions
Returns:
case expression with the given case operand

simpleCase

public CaseExpression simpleCase(Number caseOperand)
Description copied from interface: QueryDefinition
Create a simple case expression with the given case operand. A simple case expression is of the form:

simpleCase(case-operand) .when(scalar-expression).then(scalar-expression) .when(scalar-expression).then(scalar-expression) ... .elseCase(scalar-expression)

Specified by:
simpleCase in interface QueryDefinition
Parameters:
caseOperand - - numeric value used for testing against the when scalar expressions
Returns:
case expression with the given case operand

simpleCase

public CaseExpression simpleCase(String caseOperand)
Description copied from interface: QueryDefinition
Create a simple case expression with the given case operand. A simple case expression is of the form:

simpleCase(case-operand) .when(scalar-expression).then(scalar-expression) .when(scalar-expression).then(scalar-expression) ... .elseCase(scalar-expression)

Specified by:
simpleCase in interface QueryDefinition
Parameters:
caseOperand - - value used for testing against the when scalar expressions
Returns:
case expression with the given case operand

simpleCase

public CaseExpression simpleCase(Date caseOperand)
Description copied from interface: QueryDefinition
Create a simple case expression with the given case operand. A simple case expression is of the form:

simpleCase(case-operand) .when(scalar-expression).then(scalar-expression) .when(scalar-expression).then(scalar-expression) ... .elseCase(scalar-expression)

Specified by:
simpleCase in interface QueryDefinition
Parameters:
caseOperand - - value used for testing against the when scalar expressions
Returns:
case expression with the given case operand

simpleCase

public CaseExpression simpleCase(Calendar caseOperand)
Description copied from interface: QueryDefinition
Create a simple case expression with the given case operand. A simple case expression is of the form:

simpleCase(case-operand) .when(scalar-expression).then(scalar-expression) .when(scalar-expression).then(scalar-expression) ... .elseCase(scalar-expression)

Specified by:
simpleCase in interface QueryDefinition
Parameters:
caseOperand - - value used for testing against the when scalar expressions
Returns:
case expression with the given case operand

simpleCase

public CaseExpression simpleCase(Class caseOperand)
Description copied from interface: QueryDefinition
Create a simple case expression with the given case operand. A simple case expression is of the form:

simpleCase(case-operand) .when(scalar-expression).then(scalar-expression) .when(scalar-expression).then(scalar-expression) ... .elseCase(scalar-expression)

Specified by:
simpleCase in interface QueryDefinition
Parameters:
caseOperand - - value used for testing against the when scalar expressions
Returns:
case expression with the given case operand

simpleCase

public CaseExpression simpleCase(Enum<?> caseOperand)
Description copied from interface: QueryDefinition
Create a simple case expression with the given case operand. A simple case expression is of the form:

simpleCase(case-operand) .when(scalar-expression).then(scalar-expression) .when(scalar-expression).then(scalar-expression) ... .elseCase(scalar-expression)

Specified by:
simpleCase in interface QueryDefinition
Parameters:
caseOperand - - value used for testing against the when scalar expressions
Returns:
case expression with the given case operand

where

public QueryDefinition where(Predicate predicate)
Description copied from interface: QueryDefinition
Modifies the query definition to restrict the result of the query according to the specified predicate. Replaces the previously added restriction(s), if any.

Specified by:
where in interface QueryDefinition
Parameters:
predicate - - a simple or compound conditional predicate
Returns:
the modified QueryDefinition instance

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

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 interface PredicateOperand
Parameters:
arg1 - - PredicateOperand instance or parameter
arg2 - - PredicateOperand instance or parameter
Returns:
conditional predicate

between

public Predicate between(PredicateOperand arg1,
                         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 interface PredicateOperand
Parameters:
arg1 - - PredicateOperand instance or parameter
arg2 - - numeric
Returns:
conditional predicate

between

public Predicate between(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 interface PredicateOperand
Parameters:
arg1 - - numeric
arg2 - - PredicateOperand instance or parameter
Returns:
conditional predicate

between

public Predicate between(Number arg1,
                         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 interface PredicateOperand
Parameters:
arg1 - - numeric
arg2 - - numeric
Returns:
conditional predicate

between

public Predicate between(PredicateOperand arg1,
                         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 interface PredicateOperand
Parameters:
arg1 - - PredicateOperand instance or parameter
arg2 - - string
Returns:
conditional predicate

between

public Predicate between(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 interface PredicateOperand
Parameters:
arg1 - - string
arg2 - - PredicateOperand instance or parameter
Returns:
conditional predicate

between

public Predicate between(String arg1,
                         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 interface PredicateOperand
Parameters:
arg1 - - string
arg2 - - string
Returns:
conditional predicate

between

public Predicate between(PredicateOperand arg1,
                         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 interface PredicateOperand
Parameters:
arg1 - - PredicateOperand instance or parameter
arg2 - - date
Returns:
conditional predicate

between

public Predicate between(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 interface PredicateOperand
Parameters:
arg1 - - date
arg2 - - PredicateOperand instance or parameter
Returns:
conditional predicate

between

public Predicate between(Date arg1,
                         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 interface PredicateOperand
Parameters:
arg1 - - date
arg2 - - date
Returns:
conditional predicate

between

public Predicate between(PredicateOperand arg1,
                         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 interface PredicateOperand
Parameters:
arg1 - - PredicateOperand instance or parameter
arg2 - - calendar
Returns:
conditional predicate

between

public Predicate between(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 interface PredicateOperand
Parameters:
arg1 - - calendar
arg2 - - PredicateOperand instance or parameter
Returns:
conditional predicate

between

public Predicate between(Calendar arg1,
                         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 interface PredicateOperand
Parameters:
arg1 - - calendar
arg2 - - 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 interface PredicateOperand
Parameters:
arg - - PredicateOperand instance or parameter
Returns:
conditional predicate

equal

public Predicate equal(Class cls)
Description copied from interface: PredicateOperand
Create a predicate for testing equality with the specified argument.

Specified by:
equal in interface PredicateOperand
Parameters:
cls - - entity class
Returns:
conditional predicate

equal

public Predicate equal(Number arg)
Description copied from interface: PredicateOperand
Create a predicate for testing equality with the specified argument.

Specified by:
equal in interface PredicateOperand
Parameters:
arg - - numeric
Returns:
conditional predicate

equal

public Predicate equal(String arg)
Description copied from interface: PredicateOperand
Create a predicate for testing equality with the specified argument.

Specified by:
equal in interface PredicateOperand
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 interface PredicateOperand
Parameters:
arg - - boolean value
Returns:
conditional predicate

equal

public Predicate equal(Date arg)
Description copied from interface: PredicateOperand
Create a predicate for testing equality with the specified argument.

Specified by:
equal in interface PredicateOperand
Parameters:
arg - - date
Returns:
conditional predicate

equal

public Predicate equal(Calendar arg)
Description copied from interface: PredicateOperand
Create a predicate for testing equality with the specified argument.

Specified by:
equal in interface PredicateOperand
Parameters:
arg - - calendar
Returns:
conditional predicate

equal

public Predicate equal(Enum<?> e)
Description copied from interface: PredicateOperand
Create a predicate for testing equality with the specified argument.

Specified by:
equal in interface PredicateOperand
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 interface PredicateOperand
Parameters:
arg - - PredicateOperand instance or parameter
Returns:
conditional predicate

greaterEqual

public Predicate greaterEqual(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 interface PredicateOperand
Parameters:
arg - - numeric
Returns:
conditional predicate

greaterEqual

public Predicate greaterEqual(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 interface PredicateOperand
Parameters:
arg - - string
Returns:
conditional predicate

greaterEqual

public Predicate greaterEqual(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 interface PredicateOperand
Parameters:
arg - - date
Returns:
conditional predicate

greaterEqual

public Predicate greaterEqual(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 interface PredicateOperand
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 interface PredicateOperand
Parameters:
arg - - PredicateOperand instance or parameter
Returns:
conditional predicate

greaterThan

public Predicate greaterThan(Number arg)
Description copied from interface: PredicateOperand
Create a predicate for testing whether the PredicateOperand is greater than the argument.

Specified by:
greaterThan in interface PredicateOperand
Parameters:
arg - - numeric
Returns:
conditional predicate

greaterThan

public Predicate greaterThan(String arg)
Description copied from interface: PredicateOperand
Create a predicate for testing whether the PredicateOperand is greater than the argument.

Specified by:
greaterThan in interface PredicateOperand
Parameters:
arg - - string
Returns:
conditional predicate

greaterThan

public Predicate greaterThan(Date arg)
Description copied from interface: PredicateOperand
Create a predicate for testing whether the PredicateOperand is greater than the argument.

Specified by:
greaterThan in interface PredicateOperand
Parameters:
arg - - date
Returns:
conditional predicate

greaterThan

public Predicate greaterThan(Calendar arg)
Description copied from interface: PredicateOperand
Create a predicate for testing whether the PredicateOperand is greater than the argument.

Specified by:
greaterThan in interface PredicateOperand
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 interface PredicateOperand
Parameters:
arg - - PredicateOperand instance or parameter
Returns:
conditional predicate

lessEqual

public Predicate lessEqual(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 interface PredicateOperand
Parameters:
arg - - numeric
Returns:
conditional predicate

lessEqual

public Predicate lessEqual(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 interface PredicateOperand
Parameters:
arg - - string
Returns:
conditional predicate

lessEqual

public Predicate lessEqual(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 interface PredicateOperand
Parameters:
arg - - date
Returns:
conditional predicate

lessEqual

public Predicate lessEqual(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 interface PredicateOperand
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 interface PredicateOperand
Parameters:
arg - - PredicateOperand instance or parameter
Returns:
conditional predicate

lessThan

public Predicate lessThan(Number arg)
Description copied from interface: PredicateOperand
Create a predicate for testing whether the PredicateOperand is less than the argument.

Specified by:
lessThan in interface PredicateOperand
Parameters:
arg - - numeric
Returns:
conditional predicate

lessThan

public Predicate lessThan(String arg)
Description copied from interface: PredicateOperand
Create a predicate for testing whether the PredicateOperand is less than the argument.

Specified by:
lessThan in interface PredicateOperand
Parameters:
arg - - string
Returns:
conditional predicate

lessThan

public Predicate lessThan(Date arg)
Description copied from interface: PredicateOperand
Create a predicate for testing whether the PredicateOperand is less than the argument.

Specified by:
lessThan in interface PredicateOperand
Parameters:
arg - - date
Returns:
conditional predicate

lessThan

public Predicate lessThan(Calendar arg)
Description copied from interface: PredicateOperand
Create a predicate for testing whether the PredicateOperand is less than the argument.

Specified by:
lessThan in interface PredicateOperand
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 interface PredicateOperand
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 interface PredicateOperand
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 interface PredicateOperand
Returns:
conditional predicate

like

public Predicate like(String pattern)
Description copied from interface: PredicateOperand
Create a predicate for testing whether the PredicateOperand satisfies the given pattern.

Specified by:
like in interface PredicateOperand
Returns:
conditional predicate

like

public Predicate like(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 interface PredicateOperand
Returns:
conditional predicate

like

public Predicate like(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 interface PredicateOperand
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 interface PredicateOperand
Parameters:
arg - - PredicateOperand instance or parameter
Returns:
conditional predicate

notEqual

public Predicate notEqual(Class cls)
Description copied from interface: PredicateOperand
Create a predicate for testing inequality with the specified argument.

Specified by:
notEqual in interface PredicateOperand
Parameters:
cls - - entity class
Returns:
conditional predicate

notEqual

public Predicate notEqual(Number arg)
Description copied from interface: PredicateOperand
Create a predicate for testing inequality with the specified argument.

Specified by:
notEqual in interface PredicateOperand
Parameters:
arg - - numberic value
Returns:
conditional predicate

notEqual

public Predicate notEqual(String arg)
Description copied from interface: PredicateOperand
Create a predicate for testing inequality with the specified argument.

Specified by:
notEqual in interface PredicateOperand
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 interface PredicateOperand
Parameters:
arg - - boolean value
Returns:
conditional predicate

notEqual

public Predicate notEqual(Date arg)
Description copied from interface: PredicateOperand
Create a predicate for testing inequality with the specified argument.

Specified by:
notEqual in interface PredicateOperand
Parameters:
arg - - date
Returns:
conditional predicate

notEqual

public Predicate notEqual(Calendar arg)
Description copied from interface: PredicateOperand
Create a predicate for testing inequality with the specified argument.

Specified by:
notEqual in interface PredicateOperand
Parameters:
arg - - calendar
Returns:
conditional predicate

notEqual

public Predicate notEqual(Enum<?> e)
Description copied from interface: PredicateOperand
Create a predicate for testing inequality with the specified argument.

Specified by:
notEqual in interface PredicateOperand
Parameters:
e - - enum
Returns:
conditional predicate

getAliasHint

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

asExpression

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

asProjection

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

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
Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
 PREV CLASS   NEXT CLASS FRAMES    NO FRAMES    
SUMMARY: NESTED | FIELD | CONSTR | METHOD DETAIL: FIELD | CONSTR | METHOD
Copyright © 2006–2013 Apache Software Foundation. All rights reserved.