|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object org.apache.openjpa.persistence.query.AbstractVisitable org.apache.openjpa.persistence.query.ExpressionImpl org.apache.openjpa.persistence.query.AbstractPath org.apache.openjpa.persistence.query.AbstractDomainObject
public abstract class AbstractDomainObject
Domain Object is a path expression over which query is evaluated. Domain object acts as a proxy for a QueryDefinition via delegation.
Field Summary |
---|
Fields inherited from class org.apache.openjpa.persistence.query.AbstractPath |
---|
_operator, _owner, _parent, _part2 |
Fields inherited from class org.apache.openjpa.persistence.query.AbstractVisitable |
---|
CLOSE_BRACE, COMMA, EMPTY, OPEN_BRACE, SPACE |
Constructor Summary | |
---|---|
protected |
AbstractDomainObject(QueryDefinitionImpl owner,
AbstractPath parent,
PathOperator op,
Object part2)
|
Method Summary | |
---|---|
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. |
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 |
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. |
SelectItem |
entry()
Derives by ENTRY() operation on this path. |
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. |
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. |
Expression |
index()
Derives by INDEX() operation on this path. |
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 |
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. |
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. |
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. |
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. |
Subquery |
some()
Adds this path as SOME(subquery) to its owning query. |
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 org.apache.openjpa.persistence.query.AbstractPath |
---|
avg, count, getLastSegment, getOperator, getOwner, getParent, isEmpty, max, min, size, split, sum, type |
Methods inherited from class org.apache.openjpa.persistence.query.ExpressionImpl |
---|
abs, asc, between, between, between, between, between, between, between, between, between, between, between, between, between, concat, concat, desc, dividedBy, dividedBy, equal, equal, equal, equal, equal, equal, equal, equal, getAliasHint, greaterEqual, greaterEqual, greaterEqual, greaterEqual, greaterEqual, greaterThan, greaterThan, greaterThan, greaterThan, greaterThan, in, in, in, in, in, in, isNull, length, lessEqual, lessEqual, lessEqual, lessEqual, lessEqual, lessThan, lessThan, lessThan, lessThan, lessThan, like, like, like, like, like, like, locate, locate, locate, locate, locate, locate, lower, member, minus, minus, minus, mod, mod, notEqual, notEqual, notEqual, notEqual, notEqual, notEqual, notEqual, notEqual, plus, plus, sqrt, substring, substring, substring, substring, substring, substring, times, times, trim, trim, trim, trim, trim, trim, upper |
Methods inherited from class org.apache.openjpa.persistence.query.AbstractVisitable |
---|
asExpression, asJoinable, asProjection |
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 |
Constructor Detail |
---|
protected AbstractDomainObject(QueryDefinitionImpl owner, AbstractPath parent, PathOperator op, Object part2)
Method Detail |
---|
public DomainObject addRoot(Class cls)
addRoot
in interface QueryDefinition
cls
- -
an entity class
public DomainObject addSubqueryRoot(PathExpression path)
addSubqueryRoot
in interface QueryDefinition
path
- -
path expression corresponding to the domain object used to
derive the subquery root.
public PathExpression get(String attr)
get
in interface PathExpression
attr
- -
name of the referenced attribute
public DomainObject join(String attr)
join
in interface DomainObject
attr
- -
name of the attribute that references the target of the
join
public DomainObject leftJoin(String attr)
leftJoin
in interface DomainObject
attr
- -
name of the attribute that references the target of the
join
public FetchJoinObject joinFetch(String attr)
joinFetch
in interface DomainObject
attr
- -
name of the attribute that references the target of the
join
public FetchJoinObject leftJoinFetch(String attr)
leftJoinFetch
in interface DomainObject
attr
- -
name of the attribute that references the target of the
join
public PathExpression key()
key
in interface DomainObject
public SelectItem entry()
entry
in interface DomainObject
public Expression index()
index
in interface DomainObject
public PathExpression value()
value
in interface DomainObject
public Subquery all()
all
in interface QueryDefinition
public Subquery any()
any
in interface QueryDefinition
public Subquery some()
some
in interface QueryDefinition
public Predicate exists()
exists
in interface QueryDefinition
public Expression coalesce(Expression... exp)
QueryDefinition
coalesce
in interface QueryDefinition
exp
- -
expressions to be used for testing against null
public Expression coalesce(String... exp)
QueryDefinition
coalesce
in interface QueryDefinition
exp
- -
expressions to be used for testing against null
public Expression coalesce(Date... exp)
QueryDefinition
coalesce
in interface QueryDefinition
exp
- -
expressions to be used for testing against null
public Expression coalesce(Calendar... exp)
QueryDefinition
coalesce
in interface QueryDefinition
exp
- -
expressions to be used for testing against null
public Expression currentDate()
QueryDefinition
currentDate
in interface QueryDefinition
public Expression currentTime()
QueryDefinition
currentTime
in interface QueryDefinition
public Expression currentTimestamp()
QueryDefinition
currentTimestamp
in interface QueryDefinition
public CaseExpression generalCase()
QueryDefinition
generalCase
in interface QueryDefinition
public QueryDefinition groupBy(PathExpression... pathExprs)
QueryDefinition
groupBy
in interface QueryDefinition
public QueryDefinition groupBy(List<PathExpression> pathExprList)
QueryDefinition
groupBy
in interface QueryDefinition
public QueryDefinition having(Predicate predicate)
QueryDefinition
having
in interface QueryDefinition
public Expression literal(String s)
QueryDefinition
literal
in interface QueryDefinition
s
- -
string value
public Expression literal(Number n)
QueryDefinition
literal
in interface QueryDefinition
n
- -
numeric value
public Expression literal(boolean b)
QueryDefinition
literal
in interface QueryDefinition
b
- -
boolean value
public Expression literal(Calendar c)
QueryDefinition
literal
in interface QueryDefinition
c
- -
Calendar value
public Expression literal(Date d)
QueryDefinition
literal
in interface QueryDefinition
d
- -
Date value
public Expression literal(char c)
QueryDefinition
literal
in interface QueryDefinition
public Expression literal(Class cls)
QueryDefinition
literal
in interface QueryDefinition
cls
- -
entity class
public Expression literal(Enum<?> e)
QueryDefinition
literal
in interface QueryDefinition
e
- -
enum
public SelectItem newInstance(Class cls, SelectItem... args)
QueryDefinition
newInstance
in interface QueryDefinition
cls
- -
a class with the correponding constructorargs
- -
select items that correspond to result types that are valid
as arguments to the constructorpublic Expression nullLiteral()
QueryDefinition
nullLiteral
in interface QueryDefinition
public Expression nullif(Expression exp1, Expression exp2)
QueryDefinition
nullif
in interface QueryDefinition
public Expression nullif(Number arg1, Number arg2)
QueryDefinition
nullif
in interface QueryDefinition
public Expression nullif(String arg1, String arg2)
QueryDefinition
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.
public Expression nullif(Date arg1, Date arg2)
QueryDefinition
nullif
in interface QueryDefinition
public Expression nullif(Calendar arg1, Calendar arg2)
QueryDefinition
nullif
in interface QueryDefinition
public Expression nullif(Class arg1, Class arg2)
QueryDefinition
nullif
in interface QueryDefinition
public Expression nullif(Enum<?> arg1, Enum<?> arg2)
QueryDefinition
nullif
in interface QueryDefinition
public QueryDefinition orderBy(OrderByItem... orderByItems)
QueryDefinition
orderBy
in interface QueryDefinition
orderByItems
- -
one or more OrderByItem instances
public QueryDefinition orderBy(List<OrderByItem> orderByItemList)
QueryDefinition
orderBy
in interface QueryDefinition
orderByItemList
- -
a list containing one or more OrderByItem
instances
public Expression param(String name)
QueryDefinition
param
in interface QueryDefinition
public Predicate predicate(boolean b)
QueryDefinition
predicate
in interface QueryDefinition
b
- boolean value
public QueryDefinition select(SelectItem... selectItems)
QueryDefinition
select
in interface QueryDefinition
selectItems
- -
one or more SelectItem instances
public QueryDefinition select(List<SelectItem> selectItemList)
QueryDefinition
select
in interface QueryDefinition
selectItemList
- -
a list containing one or more SelectItem instances
public QueryDefinition selectDistinct(SelectItem... selectItems)
QueryDefinition
selectDistinct
in interface QueryDefinition
selectItems
- -
one or more SelectItem instances
public QueryDefinition selectDistinct(List<SelectItem> selectItemList)
QueryDefinition
selectDistinct
in interface QueryDefinition
selectItemList
- -
a list containing one or more SelectItem instances
public CaseExpression simpleCase(Expression caseOperand)
QueryDefinition
simpleCase
in interface QueryDefinition
caseOperand
- -
expression used for testing against the when scalar
expressions
public CaseExpression simpleCase(Number caseOperand)
QueryDefinition
simpleCase
in interface QueryDefinition
caseOperand
- -
numeric value used for testing against the when scalar
expressions
public CaseExpression simpleCase(String caseOperand)
QueryDefinition
simpleCase
in interface QueryDefinition
caseOperand
- -
value used for testing against the when scalar
expressions
public CaseExpression simpleCase(Date caseOperand)
QueryDefinition
simpleCase
in interface QueryDefinition
caseOperand
- -
value used for testing against the when scalar
expressions
public CaseExpression simpleCase(Calendar caseOperand)
QueryDefinition
simpleCase
in interface QueryDefinition
caseOperand
- -
value used for testing against the when scalar
expressions
public CaseExpression simpleCase(Class caseOperand)
QueryDefinition
simpleCase
in interface QueryDefinition
caseOperand
- -
value used for testing against the when scalar
expressions
public CaseExpression simpleCase(Enum<?> caseOperand)
QueryDefinition
simpleCase
in interface QueryDefinition
caseOperand
- -
value used for testing against the when scalar
expressions
public QueryDefinition where(Predicate predicate)
QueryDefinition
where
in interface QueryDefinition
predicate
- -
a simple or compound conditional predicate
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |