blob: 79ec70a39bd56f7777023f979d2e5edd241ee7e9 [file] [log] [blame]
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<!--NewPage-->
<HTML>
<HEAD>
<!-- Generated by javadoc (build 1.6.0_29) on Thu Nov 21 14:32:47 CET 2013 -->
<META http-equiv="Content-Type" content="text/html; charset=UTF-8">
<TITLE>
DomainObject (OpenJPA Parent POM 2.3.0 API)
</TITLE>
<META NAME="date" CONTENT="2013-11-21">
<LINK REL ="stylesheet" TYPE="text/css" HREF="../../../../../stylesheet.css" TITLE="Style">
<SCRIPT type="text/javascript">
function windowTitle()
{
if (location.href.indexOf('is-external=true') == -1) {
parent.document.title="DomainObject (OpenJPA Parent POM 2.3.0 API)";
}
}
</SCRIPT>
<NOSCRIPT>
</NOSCRIPT>
</HEAD>
<BODY BGCOLOR="white" onload="windowTitle();">
<HR>
<!-- ========= START OF TOP NAVBAR ======= -->
<A NAME="navbar_top"><!-- --></A>
<A HREF="#skip-navbar_top" title="Skip navigation links"></A>
<TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY="">
<TR>
<TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">
<A NAME="navbar_top_firstrow"><!-- --></A>
<TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY="">
<TR ALIGN="center" VALIGN="top">
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A>&nbsp;</TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A>&nbsp;</TD>
<TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> &nbsp;<FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT>&nbsp;</TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="class-use/DomainObject.html"><FONT CLASS="NavBarFont1"><B>Use</B></FONT></A>&nbsp;</TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A>&nbsp;</TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A>&nbsp;</TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A>&nbsp;</TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A>&nbsp;</TD>
</TR>
</TABLE>
</TD>
<TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
</EM>
</TD>
</TR>
<TR>
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
&nbsp;<A HREF="../../../../../org/apache/openjpa/persistence/query/DividedByExpression.html" title="class in org.apache.openjpa.persistence.query"><B>PREV CLASS</B></A>&nbsp;
&nbsp;<A HREF="../../../../../org/apache/openjpa/persistence/query/ElseExpression.html" title="class in org.apache.openjpa.persistence.query"><B>NEXT CLASS</B></A></FONT></TD>
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
<A HREF="../../../../../index.html?org/apache/openjpa/persistence/query/DomainObject.html" target="_top"><B>FRAMES</B></A> &nbsp;
&nbsp;<A HREF="DomainObject.html" target="_top"><B>NO FRAMES</B></A> &nbsp;
&nbsp;<SCRIPT type="text/javascript">
<!--
if(window==top) {
document.writeln('<A HREF="../../../../../allclasses-noframe.html"><B>All Classes</B></A>');
}
//-->
</SCRIPT>
<NOSCRIPT>
<A HREF="../../../../../allclasses-noframe.html"><B>All Classes</B></A>
</NOSCRIPT>
</FONT></TD>
</TR>
<TR>
<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
SUMMARY:&nbsp;NESTED&nbsp;|&nbsp;FIELD&nbsp;|&nbsp;CONSTR&nbsp;|&nbsp;<A HREF="#method_summary">METHOD</A></FONT></TD>
<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
DETAIL:&nbsp;FIELD&nbsp;|&nbsp;CONSTR&nbsp;|&nbsp;<A HREF="#method_detail">METHOD</A></FONT></TD>
</TR>
</TABLE>
<A NAME="skip-navbar_top"></A>
<!-- ========= END OF TOP NAVBAR ========= -->
<HR>
<!-- ======== START OF CLASS DATA ======== -->
<H2>
<FONT SIZE="-1">
org.apache.openjpa.persistence.query</FONT>
<BR>
Interface DomainObject</H2>
<DL>
<DT><B>All Superinterfaces:</B> <DD><A HREF="../../../../../org/apache/openjpa/persistence/query/Expression.html" title="interface in org.apache.openjpa.persistence.query">Expression</A>, <A HREF="../../../../../org/apache/openjpa/persistence/query/OrderByItem.html" title="interface in org.apache.openjpa.persistence.query">OrderByItem</A>, <A HREF="../../../../../org/apache/openjpa/persistence/query/PathExpression.html" title="interface in org.apache.openjpa.persistence.query">PathExpression</A>, <A HREF="../../../../../org/apache/openjpa/persistence/query/PredicateOperand.html" title="interface in org.apache.openjpa.persistence.query">PredicateOperand</A>, <A HREF="../../../../../org/apache/openjpa/persistence/query/QueryDefinition.html" title="interface in org.apache.openjpa.persistence.query">QueryDefinition</A>, <A HREF="../../../../../org/apache/openjpa/persistence/query/SelectItem.html" title="interface in org.apache.openjpa.persistence.query">SelectItem</A>, <A HREF="../../../../../org/apache/openjpa/persistence/query/Subquery.html" title="interface in org.apache.openjpa.persistence.query">Subquery</A></DD>
</DL>
<DL>
<DT><B>All Known Implementing Classes:</B> <DD><A HREF="../../../../../org/apache/openjpa/persistence/query/AbstractDomainObject.html" title="class in org.apache.openjpa.persistence.query">AbstractDomainObject</A>, <A HREF="../../../../../org/apache/openjpa/persistence/query/EntryExpression.html" title="class in org.apache.openjpa.persistence.query">EntryExpression</A>, <A HREF="../../../../../org/apache/openjpa/persistence/query/FetchPath.html" title="class in org.apache.openjpa.persistence.query">FetchPath</A>, <A HREF="../../../../../org/apache/openjpa/persistence/query/JoinPath.html" title="class in org.apache.openjpa.persistence.query">JoinPath</A>, <A HREF="../../../../../org/apache/openjpa/persistence/query/KeyExpression.html" title="class in org.apache.openjpa.persistence.query">KeyExpression</A>, <A HREF="../../../../../org/apache/openjpa/persistence/query/OperatorPath.html" title="class in org.apache.openjpa.persistence.query">OperatorPath</A>, <A HREF="../../../../../org/apache/openjpa/persistence/query/RootPath.html" title="class in org.apache.openjpa.persistence.query">RootPath</A>, <A HREF="../../../../../org/apache/openjpa/persistence/query/ValueExpression.html" title="class in org.apache.openjpa.persistence.query">ValueExpression</A></DD>
</DL>
<HR>
<DL>
<DT><PRE>public interface <B>DomainObject</B><DT>extends <A HREF="../../../../../org/apache/openjpa/persistence/query/PathExpression.html" title="interface in org.apache.openjpa.persistence.query">PathExpression</A>, <A HREF="../../../../../org/apache/openjpa/persistence/query/QueryDefinition.html" title="interface in org.apache.openjpa.persistence.query">QueryDefinition</A></DL>
</PRE>
<P>
Domain objects define the domain over which a query operates. A domain object
plays a role analogous to that of a Java Persistence query language
identification variable.
<P>
<P>
<HR>
<P>
<!-- ========== METHOD SUMMARY =========== -->
<A NAME="method_summary"><!-- --></A>
<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
<TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2">
<B>Method Summary</B></FONT></TH>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>&nbsp;<A HREF="../../../../../org/apache/openjpa/persistence/query/SelectItem.html" title="interface in org.apache.openjpa.persistence.query">SelectItem</A></CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../../org/apache/openjpa/persistence/query/DomainObject.html#entry()">entry</A></B>()</CODE>
<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Return a select item corresponding to the map entry of a map-valued
association or element collection.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>&nbsp;<A HREF="../../../../../org/apache/openjpa/persistence/query/Expression.html" title="interface in org.apache.openjpa.persistence.query">Expression</A></CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../../org/apache/openjpa/persistence/query/DomainObject.html#index()">index</A></B>()</CODE>
<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Return an expression that corresponds to the index. of the domain object
in the referenced association or element collection.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>&nbsp;<A HREF="../../../../../org/apache/openjpa/persistence/query/DomainObject.html" title="interface in org.apache.openjpa.persistence.query">DomainObject</A></CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../../org/apache/openjpa/persistence/query/DomainObject.html#join(java.lang.String)">join</A></B>(<A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A>&nbsp;attribute)</CODE>
<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Extend the query domain by joining with a class that can be navigated to
or that is embedded in the class corresponding to the domain object on
which the method is invoked.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>&nbsp;<A HREF="../../../../../org/apache/openjpa/persistence/query/FetchJoinObject.html" title="interface in org.apache.openjpa.persistence.query">FetchJoinObject</A></CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../../org/apache/openjpa/persistence/query/DomainObject.html#joinFetch(java.lang.String)">joinFetch</A></B>(<A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A>&nbsp;attribute)</CODE>
<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Specify that the association or element collection that is referenced by
the attribute be eagerly fetched through use of an inner join.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>&nbsp;<A HREF="../../../../../org/apache/openjpa/persistence/query/PathExpression.html" title="interface in org.apache.openjpa.persistence.query">PathExpression</A></CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../../org/apache/openjpa/persistence/query/DomainObject.html#key()">key</A></B>()</CODE>
<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Return a path expression corresponding to the key of a map-valued
association or element collection.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>&nbsp;<A HREF="../../../../../org/apache/openjpa/persistence/query/DomainObject.html" title="interface in org.apache.openjpa.persistence.query">DomainObject</A></CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../../org/apache/openjpa/persistence/query/DomainObject.html#leftJoin(java.lang.String)">leftJoin</A></B>(<A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A>&nbsp;attribute)</CODE>
<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Extend the query domain by left outer joining with a class that can be
navigated to or that is embedded in the class corresponding to the domain
object on which the method is invoked.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>&nbsp;<A HREF="../../../../../org/apache/openjpa/persistence/query/FetchJoinObject.html" title="interface in org.apache.openjpa.persistence.query">FetchJoinObject</A></CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../../org/apache/openjpa/persistence/query/DomainObject.html#leftJoinFetch(java.lang.String)">leftJoinFetch</A></B>(<A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A>&nbsp;attribute)</CODE>
<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Specify that the association or element collection that is referenced by
the attribute be eagerly fetched through use of a left outer join.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>&nbsp;<A HREF="../../../../../org/apache/openjpa/persistence/query/PathExpression.html" title="interface in org.apache.openjpa.persistence.query">PathExpression</A></CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../../org/apache/openjpa/persistence/query/DomainObject.html#value()">value</A></B>()</CODE>
<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Return a path expression corresponding to the value of a map-valued
association or element collection.</TD>
</TR>
</TABLE>
&nbsp;<A NAME="methods_inherited_from_class_org.apache.openjpa.persistence.query.PathExpression"><!-- --></A>
<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
<TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
<TH ALIGN="left"><B>Methods inherited from interface org.apache.openjpa.persistence.query.<A HREF="../../../../../org/apache/openjpa/persistence/query/PathExpression.html" title="interface in org.apache.openjpa.persistence.query">PathExpression</A></B></TH>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD><CODE><A HREF="../../../../../org/apache/openjpa/persistence/query/PathExpression.html#avg()">avg</A>, <A HREF="../../../../../org/apache/openjpa/persistence/query/PathExpression.html#count()">count</A>, <A HREF="../../../../../org/apache/openjpa/persistence/query/PathExpression.html#get(java.lang.String)">get</A>, <A HREF="../../../../../org/apache/openjpa/persistence/query/PathExpression.html#isEmpty()">isEmpty</A>, <A HREF="../../../../../org/apache/openjpa/persistence/query/PathExpression.html#max()">max</A>, <A HREF="../../../../../org/apache/openjpa/persistence/query/PathExpression.html#min()">min</A>, <A HREF="../../../../../org/apache/openjpa/persistence/query/PathExpression.html#size()">size</A>, <A HREF="../../../../../org/apache/openjpa/persistence/query/PathExpression.html#sum()">sum</A>, <A HREF="../../../../../org/apache/openjpa/persistence/query/PathExpression.html#type()">type</A></CODE></TD>
</TR>
</TABLE>
&nbsp;<A NAME="methods_inherited_from_class_org.apache.openjpa.persistence.query.Expression"><!-- --></A>
<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
<TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
<TH ALIGN="left"><B>Methods inherited from interface org.apache.openjpa.persistence.query.<A HREF="../../../../../org/apache/openjpa/persistence/query/Expression.html" title="interface in org.apache.openjpa.persistence.query">Expression</A></B></TH>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD><CODE><A HREF="../../../../../org/apache/openjpa/persistence/query/Expression.html#abs()">abs</A>, <A HREF="../../../../../org/apache/openjpa/persistence/query/Expression.html#concat(org.apache.openjpa.persistence.query.Expression...)">concat</A>, <A HREF="../../../../../org/apache/openjpa/persistence/query/Expression.html#concat(java.lang.String...)">concat</A>, <A HREF="../../../../../org/apache/openjpa/persistence/query/Expression.html#dividedBy(org.apache.openjpa.persistence.query.Expression)">dividedBy</A>, <A HREF="../../../../../org/apache/openjpa/persistence/query/Expression.html#dividedBy(java.lang.Number)">dividedBy</A>, <A HREF="../../../../../org/apache/openjpa/persistence/query/Expression.html#in(java.lang.Class...)">in</A>, <A HREF="../../../../../org/apache/openjpa/persistence/query/Expression.html#in(java.lang.Enum...)">in</A>, <A HREF="../../../../../org/apache/openjpa/persistence/query/Expression.html#in(org.apache.openjpa.persistence.query.Expression...)">in</A>, <A HREF="../../../../../org/apache/openjpa/persistence/query/Expression.html#in(java.lang.Number...)">in</A>, <A HREF="../../../../../org/apache/openjpa/persistence/query/Expression.html#in(java.lang.String...)">in</A>, <A HREF="../../../../../org/apache/openjpa/persistence/query/Expression.html#in(org.apache.openjpa.persistence.query.Subquery)">in</A>, <A HREF="../../../../../org/apache/openjpa/persistence/query/Expression.html#isNull()">isNull</A>, <A HREF="../../../../../org/apache/openjpa/persistence/query/Expression.html#length()">length</A>, <A HREF="../../../../../org/apache/openjpa/persistence/query/Expression.html#locate(org.apache.openjpa.persistence.query.Expression)">locate</A>, <A HREF="../../../../../org/apache/openjpa/persistence/query/Expression.html#locate(org.apache.openjpa.persistence.query.Expression, org.apache.openjpa.persistence.query.Expression)">locate</A>, <A HREF="../../../../../org/apache/openjpa/persistence/query/Expression.html#locate(org.apache.openjpa.persistence.query.Expression, int)">locate</A>, <A HREF="../../../../../org/apache/openjpa/persistence/query/Expression.html#locate(java.lang.String)">locate</A>, <A HREF="../../../../../org/apache/openjpa/persistence/query/Expression.html#locate(java.lang.String, org.apache.openjpa.persistence.query.Expression)">locate</A>, <A HREF="../../../../../org/apache/openjpa/persistence/query/Expression.html#locate(java.lang.String, int)">locate</A>, <A HREF="../../../../../org/apache/openjpa/persistence/query/Expression.html#lower()">lower</A>, <A HREF="../../../../../org/apache/openjpa/persistence/query/Expression.html#member(org.apache.openjpa.persistence.query.PathExpression)">member</A>, <A HREF="../../../../../org/apache/openjpa/persistence/query/Expression.html#minus()">minus</A>, <A HREF="../../../../../org/apache/openjpa/persistence/query/Expression.html#minus(org.apache.openjpa.persistence.query.Expression)">minus</A>, <A HREF="../../../../../org/apache/openjpa/persistence/query/Expression.html#minus(java.lang.Number)">minus</A>, <A HREF="../../../../../org/apache/openjpa/persistence/query/Expression.html#mod(org.apache.openjpa.persistence.query.Expression)">mod</A>, <A HREF="../../../../../org/apache/openjpa/persistence/query/Expression.html#mod(int)">mod</A>, <A HREF="../../../../../org/apache/openjpa/persistence/query/Expression.html#plus(org.apache.openjpa.persistence.query.Expression)">plus</A>, <A HREF="../../../../../org/apache/openjpa/persistence/query/Expression.html#plus(java.lang.Number)">plus</A>, <A HREF="../../../../../org/apache/openjpa/persistence/query/Expression.html#sqrt()">sqrt</A>, <A HREF="../../../../../org/apache/openjpa/persistence/query/Expression.html#substring(org.apache.openjpa.persistence.query.Expression)">substring</A>, <A HREF="../../../../../org/apache/openjpa/persistence/query/Expression.html#substring(org.apache.openjpa.persistence.query.Expression, org.apache.openjpa.persistence.query.Expression)">substring</A>, <A HREF="../../../../../org/apache/openjpa/persistence/query/Expression.html#substring(org.apache.openjpa.persistence.query.Expression, int)">substring</A>, <A HREF="../../../../../org/apache/openjpa/persistence/query/Expression.html#substring(int)">substring</A>, <A HREF="../../../../../org/apache/openjpa/persistence/query/Expression.html#substring(int, org.apache.openjpa.persistence.query.Expression)">substring</A>, <A HREF="../../../../../org/apache/openjpa/persistence/query/Expression.html#substring(int, int)">substring</A>, <A HREF="../../../../../org/apache/openjpa/persistence/query/Expression.html#times(org.apache.openjpa.persistence.query.Expression)">times</A>, <A HREF="../../../../../org/apache/openjpa/persistence/query/Expression.html#times(java.lang.Number)">times</A>, <A HREF="../../../../../org/apache/openjpa/persistence/query/Expression.html#trim()">trim</A>, <A HREF="../../../../../org/apache/openjpa/persistence/query/Expression.html#trim(char)">trim</A>, <A HREF="../../../../../org/apache/openjpa/persistence/query/Expression.html#trim(char, org.apache.openjpa.persistence.query.TrimSpec)">trim</A>, <A HREF="../../../../../org/apache/openjpa/persistence/query/Expression.html#trim(org.apache.openjpa.persistence.query.Expression)">trim</A>, <A HREF="../../../../../org/apache/openjpa/persistence/query/Expression.html#trim(org.apache.openjpa.persistence.query.Expression, org.apache.openjpa.persistence.query.TrimSpec)">trim</A>, <A HREF="../../../../../org/apache/openjpa/persistence/query/Expression.html#trim(org.apache.openjpa.persistence.query.TrimSpec)">trim</A>, <A HREF="../../../../../org/apache/openjpa/persistence/query/Expression.html#upper()">upper</A></CODE></TD>
</TR>
</TABLE>
&nbsp;<A NAME="methods_inherited_from_class_org.apache.openjpa.persistence.query.SelectItem"><!-- --></A>
<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
<TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
<TH ALIGN="left"><B>Methods inherited from interface org.apache.openjpa.persistence.query.<A HREF="../../../../../org/apache/openjpa/persistence/query/SelectItem.html" title="interface in org.apache.openjpa.persistence.query">SelectItem</A></B></TH>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD><CODE><A HREF="../../../../../org/apache/openjpa/persistence/query/SelectItem.html#asc()">asc</A>, <A HREF="../../../../../org/apache/openjpa/persistence/query/SelectItem.html#desc()">desc</A></CODE></TD>
</TR>
</TABLE>
&nbsp;<A NAME="methods_inherited_from_class_org.apache.openjpa.persistence.query.QueryDefinition"><!-- --></A>
<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
<TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
<TH ALIGN="left"><B>Methods inherited from interface org.apache.openjpa.persistence.query.<A HREF="../../../../../org/apache/openjpa/persistence/query/QueryDefinition.html" title="interface in org.apache.openjpa.persistence.query">QueryDefinition</A></B></TH>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD><CODE><A HREF="../../../../../org/apache/openjpa/persistence/query/QueryDefinition.html#addRoot(java.lang.Class)">addRoot</A>, <A HREF="../../../../../org/apache/openjpa/persistence/query/QueryDefinition.html#addSubqueryRoot(org.apache.openjpa.persistence.query.PathExpression)">addSubqueryRoot</A>, <A HREF="../../../../../org/apache/openjpa/persistence/query/QueryDefinition.html#all()">all</A>, <A HREF="../../../../../org/apache/openjpa/persistence/query/QueryDefinition.html#any()">any</A>, <A HREF="../../../../../org/apache/openjpa/persistence/query/QueryDefinition.html#coalesce(java.util.Calendar...)">coalesce</A>, <A HREF="../../../../../org/apache/openjpa/persistence/query/QueryDefinition.html#coalesce(java.util.Date...)">coalesce</A>, <A HREF="../../../../../org/apache/openjpa/persistence/query/QueryDefinition.html#coalesce(org.apache.openjpa.persistence.query.Expression...)">coalesce</A>, <A HREF="../../../../../org/apache/openjpa/persistence/query/QueryDefinition.html#coalesce(java.lang.String...)">coalesce</A>, <A HREF="../../../../../org/apache/openjpa/persistence/query/QueryDefinition.html#currentDate()">currentDate</A>, <A HREF="../../../../../org/apache/openjpa/persistence/query/QueryDefinition.html#currentTime()">currentTime</A>, <A HREF="../../../../../org/apache/openjpa/persistence/query/QueryDefinition.html#currentTimestamp()">currentTimestamp</A>, <A HREF="../../../../../org/apache/openjpa/persistence/query/QueryDefinition.html#exists()">exists</A>, <A HREF="../../../../../org/apache/openjpa/persistence/query/QueryDefinition.html#generalCase()">generalCase</A>, <A HREF="../../../../../org/apache/openjpa/persistence/query/QueryDefinition.html#groupBy(java.util.List)">groupBy</A>, <A HREF="../../../../../org/apache/openjpa/persistence/query/QueryDefinition.html#groupBy(org.apache.openjpa.persistence.query.PathExpression...)">groupBy</A>, <A HREF="../../../../../org/apache/openjpa/persistence/query/QueryDefinition.html#having(org.apache.openjpa.persistence.query.Predicate)">having</A>, <A HREF="../../../../../org/apache/openjpa/persistence/query/QueryDefinition.html#literal(boolean)">literal</A>, <A HREF="../../../../../org/apache/openjpa/persistence/query/QueryDefinition.html#literal(java.util.Calendar)">literal</A>, <A HREF="../../../../../org/apache/openjpa/persistence/query/QueryDefinition.html#literal(char)">literal</A>, <A HREF="../../../../../org/apache/openjpa/persistence/query/QueryDefinition.html#literal(java.lang.Class)">literal</A>, <A HREF="../../../../../org/apache/openjpa/persistence/query/QueryDefinition.html#literal(java.util.Date)">literal</A>, <A HREF="../../../../../org/apache/openjpa/persistence/query/QueryDefinition.html#literal(java.lang.Enum)">literal</A>, <A HREF="../../../../../org/apache/openjpa/persistence/query/QueryDefinition.html#literal(java.lang.Number)">literal</A>, <A HREF="../../../../../org/apache/openjpa/persistence/query/QueryDefinition.html#literal(java.lang.String)">literal</A>, <A HREF="../../../../../org/apache/openjpa/persistence/query/QueryDefinition.html#newInstance(java.lang.Class, org.apache.openjpa.persistence.query.SelectItem...)">newInstance</A>, <A HREF="../../../../../org/apache/openjpa/persistence/query/QueryDefinition.html#nullif(java.util.Calendar, java.util.Calendar)">nullif</A>, <A HREF="../../../../../org/apache/openjpa/persistence/query/QueryDefinition.html#nullif(java.lang.Class, java.lang.Class)">nullif</A>, <A HREF="../../../../../org/apache/openjpa/persistence/query/QueryDefinition.html#nullif(java.util.Date, java.util.Date)">nullif</A>, <A HREF="../../../../../org/apache/openjpa/persistence/query/QueryDefinition.html#nullif(java.lang.Enum, java.lang.Enum)">nullif</A>, <A HREF="../../../../../org/apache/openjpa/persistence/query/QueryDefinition.html#nullif(org.apache.openjpa.persistence.query.Expression, org.apache.openjpa.persistence.query.Expression)">nullif</A>, <A HREF="../../../../../org/apache/openjpa/persistence/query/QueryDefinition.html#nullif(java.lang.Number, java.lang.Number)">nullif</A>, <A HREF="../../../../../org/apache/openjpa/persistence/query/QueryDefinition.html#nullif(java.lang.String, java.lang.String)">nullif</A>, <A HREF="../../../../../org/apache/openjpa/persistence/query/QueryDefinition.html#nullLiteral()">nullLiteral</A>, <A HREF="../../../../../org/apache/openjpa/persistence/query/QueryDefinition.html#orderBy(java.util.List)">orderBy</A>, <A HREF="../../../../../org/apache/openjpa/persistence/query/QueryDefinition.html#orderBy(org.apache.openjpa.persistence.query.OrderByItem...)">orderBy</A>, <A HREF="../../../../../org/apache/openjpa/persistence/query/QueryDefinition.html#param(java.lang.String)">param</A>, <A HREF="../../../../../org/apache/openjpa/persistence/query/QueryDefinition.html#predicate(boolean)">predicate</A>, <A HREF="../../../../../org/apache/openjpa/persistence/query/QueryDefinition.html#select(java.util.List)">select</A>, <A HREF="../../../../../org/apache/openjpa/persistence/query/QueryDefinition.html#select(org.apache.openjpa.persistence.query.SelectItem...)">select</A>, <A HREF="../../../../../org/apache/openjpa/persistence/query/QueryDefinition.html#selectDistinct(java.util.List)">selectDistinct</A>, <A HREF="../../../../../org/apache/openjpa/persistence/query/QueryDefinition.html#selectDistinct(org.apache.openjpa.persistence.query.SelectItem...)">selectDistinct</A>, <A HREF="../../../../../org/apache/openjpa/persistence/query/QueryDefinition.html#simpleCase(java.util.Calendar)">simpleCase</A>, <A HREF="../../../../../org/apache/openjpa/persistence/query/QueryDefinition.html#simpleCase(java.lang.Class)">simpleCase</A>, <A HREF="../../../../../org/apache/openjpa/persistence/query/QueryDefinition.html#simpleCase(java.util.Date)">simpleCase</A>, <A HREF="../../../../../org/apache/openjpa/persistence/query/QueryDefinition.html#simpleCase(java.lang.Enum)">simpleCase</A>, <A HREF="../../../../../org/apache/openjpa/persistence/query/QueryDefinition.html#simpleCase(org.apache.openjpa.persistence.query.Expression)">simpleCase</A>, <A HREF="../../../../../org/apache/openjpa/persistence/query/QueryDefinition.html#simpleCase(java.lang.Number)">simpleCase</A>, <A HREF="../../../../../org/apache/openjpa/persistence/query/QueryDefinition.html#simpleCase(java.lang.String)">simpleCase</A>, <A HREF="../../../../../org/apache/openjpa/persistence/query/QueryDefinition.html#some()">some</A>, <A HREF="../../../../../org/apache/openjpa/persistence/query/QueryDefinition.html#where(org.apache.openjpa.persistence.query.Predicate)">where</A></CODE></TD>
</TR>
</TABLE>
&nbsp;<A NAME="methods_inherited_from_class_org.apache.openjpa.persistence.query.PredicateOperand"><!-- --></A>
<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
<TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
<TH ALIGN="left"><B>Methods inherited from interface org.apache.openjpa.persistence.query.<A HREF="../../../../../org/apache/openjpa/persistence/query/PredicateOperand.html" title="interface in org.apache.openjpa.persistence.query">PredicateOperand</A></B></TH>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD><CODE><A HREF="../../../../../org/apache/openjpa/persistence/query/PredicateOperand.html#between(java.util.Calendar, java.util.Calendar)">between</A>, <A HREF="../../../../../org/apache/openjpa/persistence/query/PredicateOperand.html#between(java.util.Calendar, org.apache.openjpa.persistence.query.PredicateOperand)">between</A>, <A HREF="../../../../../org/apache/openjpa/persistence/query/PredicateOperand.html#between(java.util.Date, java.util.Date)">between</A>, <A HREF="../../../../../org/apache/openjpa/persistence/query/PredicateOperand.html#between(java.util.Date, org.apache.openjpa.persistence.query.PredicateOperand)">between</A>, <A HREF="../../../../../org/apache/openjpa/persistence/query/PredicateOperand.html#between(java.lang.Number, java.lang.Number)">between</A>, <A HREF="../../../../../org/apache/openjpa/persistence/query/PredicateOperand.html#between(java.lang.Number, org.apache.openjpa.persistence.query.PredicateOperand)">between</A>, <A HREF="../../../../../org/apache/openjpa/persistence/query/PredicateOperand.html#between(org.apache.openjpa.persistence.query.PredicateOperand, java.util.Calendar)">between</A>, <A HREF="../../../../../org/apache/openjpa/persistence/query/PredicateOperand.html#between(org.apache.openjpa.persistence.query.PredicateOperand, java.util.Date)">between</A>, <A HREF="../../../../../org/apache/openjpa/persistence/query/PredicateOperand.html#between(org.apache.openjpa.persistence.query.PredicateOperand, java.lang.Number)">between</A>, <A HREF="../../../../../org/apache/openjpa/persistence/query/PredicateOperand.html#between(org.apache.openjpa.persistence.query.PredicateOperand, org.apache.openjpa.persistence.query.PredicateOperand)">between</A>, <A HREF="../../../../../org/apache/openjpa/persistence/query/PredicateOperand.html#between(org.apache.openjpa.persistence.query.PredicateOperand, java.lang.String)">between</A>, <A HREF="../../../../../org/apache/openjpa/persistence/query/PredicateOperand.html#between(java.lang.String, org.apache.openjpa.persistence.query.PredicateOperand)">between</A>, <A HREF="../../../../../org/apache/openjpa/persistence/query/PredicateOperand.html#between(java.lang.String, java.lang.String)">between</A>, <A HREF="../../../../../org/apache/openjpa/persistence/query/PredicateOperand.html#equal(boolean)">equal</A>, <A HREF="../../../../../org/apache/openjpa/persistence/query/PredicateOperand.html#equal(java.util.Calendar)">equal</A>, <A HREF="../../../../../org/apache/openjpa/persistence/query/PredicateOperand.html#equal(java.lang.Class)">equal</A>, <A HREF="../../../../../org/apache/openjpa/persistence/query/PredicateOperand.html#equal(java.util.Date)">equal</A>, <A HREF="../../../../../org/apache/openjpa/persistence/query/PredicateOperand.html#equal(java.lang.Enum)">equal</A>, <A HREF="../../../../../org/apache/openjpa/persistence/query/PredicateOperand.html#equal(java.lang.Number)">equal</A>, <A HREF="../../../../../org/apache/openjpa/persistence/query/PredicateOperand.html#equal(org.apache.openjpa.persistence.query.PredicateOperand)">equal</A>, <A HREF="../../../../../org/apache/openjpa/persistence/query/PredicateOperand.html#equal(java.lang.String)">equal</A>, <A HREF="../../../../../org/apache/openjpa/persistence/query/PredicateOperand.html#greaterEqual(java.util.Calendar)">greaterEqual</A>, <A HREF="../../../../../org/apache/openjpa/persistence/query/PredicateOperand.html#greaterEqual(java.util.Date)">greaterEqual</A>, <A HREF="../../../../../org/apache/openjpa/persistence/query/PredicateOperand.html#greaterEqual(java.lang.Number)">greaterEqual</A>, <A HREF="../../../../../org/apache/openjpa/persistence/query/PredicateOperand.html#greaterEqual(org.apache.openjpa.persistence.query.PredicateOperand)">greaterEqual</A>, <A HREF="../../../../../org/apache/openjpa/persistence/query/PredicateOperand.html#greaterEqual(java.lang.String)">greaterEqual</A>, <A HREF="../../../../../org/apache/openjpa/persistence/query/PredicateOperand.html#greaterThan(java.util.Calendar)">greaterThan</A>, <A HREF="../../../../../org/apache/openjpa/persistence/query/PredicateOperand.html#greaterThan(java.util.Date)">greaterThan</A>, <A HREF="../../../../../org/apache/openjpa/persistence/query/PredicateOperand.html#greaterThan(java.lang.Number)">greaterThan</A>, <A HREF="../../../../../org/apache/openjpa/persistence/query/PredicateOperand.html#greaterThan(org.apache.openjpa.persistence.query.PredicateOperand)">greaterThan</A>, <A HREF="../../../../../org/apache/openjpa/persistence/query/PredicateOperand.html#greaterThan(java.lang.String)">greaterThan</A>, <A HREF="../../../../../org/apache/openjpa/persistence/query/PredicateOperand.html#lessEqual(java.util.Calendar)">lessEqual</A>, <A HREF="../../../../../org/apache/openjpa/persistence/query/PredicateOperand.html#lessEqual(java.util.Date)">lessEqual</A>, <A HREF="../../../../../org/apache/openjpa/persistence/query/PredicateOperand.html#lessEqual(java.lang.Number)">lessEqual</A>, <A HREF="../../../../../org/apache/openjpa/persistence/query/PredicateOperand.html#lessEqual(org.apache.openjpa.persistence.query.PredicateOperand)">lessEqual</A>, <A HREF="../../../../../org/apache/openjpa/persistence/query/PredicateOperand.html#lessEqual(java.lang.String)">lessEqual</A>, <A HREF="../../../../../org/apache/openjpa/persistence/query/PredicateOperand.html#lessThan(java.util.Calendar)">lessThan</A>, <A HREF="../../../../../org/apache/openjpa/persistence/query/PredicateOperand.html#lessThan(java.util.Date)">lessThan</A>, <A HREF="../../../../../org/apache/openjpa/persistence/query/PredicateOperand.html#lessThan(java.lang.Number)">lessThan</A>, <A HREF="../../../../../org/apache/openjpa/persistence/query/PredicateOperand.html#lessThan(org.apache.openjpa.persistence.query.PredicateOperand)">lessThan</A>, <A HREF="../../../../../org/apache/openjpa/persistence/query/PredicateOperand.html#lessThan(java.lang.String)">lessThan</A>, <A HREF="../../../../../org/apache/openjpa/persistence/query/PredicateOperand.html#like(org.apache.openjpa.persistence.query.PredicateOperand)">like</A>, <A HREF="../../../../../org/apache/openjpa/persistence/query/PredicateOperand.html#like(org.apache.openjpa.persistence.query.PredicateOperand, char)">like</A>, <A HREF="../../../../../org/apache/openjpa/persistence/query/PredicateOperand.html#like(org.apache.openjpa.persistence.query.PredicateOperand, org.apache.openjpa.persistence.query.PredicateOperand)">like</A>, <A HREF="../../../../../org/apache/openjpa/persistence/query/PredicateOperand.html#like(java.lang.String)">like</A>, <A HREF="../../../../../org/apache/openjpa/persistence/query/PredicateOperand.html#like(java.lang.String, char)">like</A>, <A HREF="../../../../../org/apache/openjpa/persistence/query/PredicateOperand.html#like(java.lang.String, org.apache.openjpa.persistence.query.PredicateOperand)">like</A>, <A HREF="../../../../../org/apache/openjpa/persistence/query/PredicateOperand.html#notEqual(boolean)">notEqual</A>, <A HREF="../../../../../org/apache/openjpa/persistence/query/PredicateOperand.html#notEqual(java.util.Calendar)">notEqual</A>, <A HREF="../../../../../org/apache/openjpa/persistence/query/PredicateOperand.html#notEqual(java.lang.Class)">notEqual</A>, <A HREF="../../../../../org/apache/openjpa/persistence/query/PredicateOperand.html#notEqual(java.util.Date)">notEqual</A>, <A HREF="../../../../../org/apache/openjpa/persistence/query/PredicateOperand.html#notEqual(java.lang.Enum)">notEqual</A>, <A HREF="../../../../../org/apache/openjpa/persistence/query/PredicateOperand.html#notEqual(java.lang.Number)">notEqual</A>, <A HREF="../../../../../org/apache/openjpa/persistence/query/PredicateOperand.html#notEqual(org.apache.openjpa.persistence.query.PredicateOperand)">notEqual</A>, <A HREF="../../../../../org/apache/openjpa/persistence/query/PredicateOperand.html#notEqual(java.lang.String)">notEqual</A></CODE></TD>
</TR>
</TABLE>
&nbsp;
<P>
<!-- ============ METHOD DETAIL ========== -->
<A NAME="method_detail"><!-- --></A>
<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
<TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2">
<B>Method Detail</B></FONT></TH>
</TR>
</TABLE>
<A NAME="join(java.lang.String)"><!-- --></A><H3>
join</H3>
<PRE>
<A HREF="../../../../../org/apache/openjpa/persistence/query/DomainObject.html" title="interface in org.apache.openjpa.persistence.query">DomainObject</A> <B>join</B>(<A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A>&nbsp;attribute)</PRE>
<DL>
<DD>Extend the query domain by joining with a class that can be navigated to
or that is embedded in the class corresponding to the domain object on
which the method is invoked. This method is permitted to be invoked only
when defining the domain of the query. It must not be invoked within the
context of the select, where, groupBy, or having operations. The domain
object must correspond to a class that contains the referenced attribute.
The query definition is modified to include the newly joined domain
object.
<P>
<DD><DL>
</DL>
</DD>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>attribute</CODE> - -
name of the attribute that references the target of the
join
<DT><B>Returns:</B><DD>the new DomainObject that is added for the target of the join</DL>
</DD>
</DL>
<HR>
<A NAME="leftJoin(java.lang.String)"><!-- --></A><H3>
leftJoin</H3>
<PRE>
<A HREF="../../../../../org/apache/openjpa/persistence/query/DomainObject.html" title="interface in org.apache.openjpa.persistence.query">DomainObject</A> <B>leftJoin</B>(<A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A>&nbsp;attribute)</PRE>
<DL>
<DD>Extend the query domain by left outer joining with a class that can be
navigated to or that is embedded in the class corresponding to the domain
object on which the method is invoked. This method is permitted to be
invoked only when defining the domain of the query. It must not be
invoked within the context of the select, where, groupBy, or having
operations. The domain object must correspond to a class that contains
the referenced attribute. The query definition is modified to include the
newly joined domain object.
<P>
<DD><DL>
</DL>
</DD>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>attribute</CODE> - -
name of the attribute that references the target of the
join
<DT><B>Returns:</B><DD>the new DomainObject that is added for the target of the join</DL>
</DD>
</DL>
<HR>
<A NAME="joinFetch(java.lang.String)"><!-- --></A><H3>
joinFetch</H3>
<PRE>
<A HREF="../../../../../org/apache/openjpa/persistence/query/FetchJoinObject.html" title="interface in org.apache.openjpa.persistence.query">FetchJoinObject</A> <B>joinFetch</B>(<A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A>&nbsp;attribute)</PRE>
<DL>
<DD>Specify that the association or element collection that is referenced by
the attribute be eagerly fetched through use of an inner join. The domain
object must correspond to a class that contains the referenced attribute.
The query is modified to include the joined domain object.
<P>
<DD><DL>
</DL>
</DD>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>attribute</CODE> - -
name of the attribute that references the target of the
join
<DT><B>Returns:</B><DD>the FetchJoinObject that is added for the target of the join</DL>
</DD>
</DL>
<HR>
<A NAME="leftJoinFetch(java.lang.String)"><!-- --></A><H3>
leftJoinFetch</H3>
<PRE>
<A HREF="../../../../../org/apache/openjpa/persistence/query/FetchJoinObject.html" title="interface in org.apache.openjpa.persistence.query">FetchJoinObject</A> <B>leftJoinFetch</B>(<A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A>&nbsp;attribute)</PRE>
<DL>
<DD>Specify that the association or element collection that is referenced by
the attribute be eagerly fetched through use of a left outer join. The
domain object must correspond to a class that contains the referenced
attribute. The query is modified to include the joined domain object.
<P>
<DD><DL>
</DL>
</DD>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>attribute</CODE> - -
name of the attribute that references the target of the
join
<DT><B>Returns:</B><DD>the FetchJoinObject that is added for the target of the join</DL>
</DD>
</DL>
<HR>
<A NAME="value()"><!-- --></A><H3>
value</H3>
<PRE>
<A HREF="../../../../../org/apache/openjpa/persistence/query/PathExpression.html" title="interface in org.apache.openjpa.persistence.query">PathExpression</A> <B>value</B>()</PRE>
<DL>
<DD>Return a path expression corresponding to the value of a map-valued
association or element collection. This method is only permitted to be
invoked upon a domain object that corresponds to a map-valued association
or element collection.
<P>
<DD><DL>
</DL>
</DD>
<DD><DL>
<DT><B>Returns:</B><DD>PathExpression corresponding to the map value</DL>
</DD>
</DL>
<HR>
<A NAME="key()"><!-- --></A><H3>
key</H3>
<PRE>
<A HREF="../../../../../org/apache/openjpa/persistence/query/PathExpression.html" title="interface in org.apache.openjpa.persistence.query">PathExpression</A> <B>key</B>()</PRE>
<DL>
<DD>Return a path expression corresponding to the key of a map-valued
association or element collection. This method is only permitted to be
invoked upon a domain object that corresponds to a map-valued association
or element collection.
<P>
<DD><DL>
</DL>
</DD>
<DD><DL>
<DT><B>Returns:</B><DD>PathExpression corresponding to the map key</DL>
</DD>
</DL>
<HR>
<A NAME="entry()"><!-- --></A><H3>
entry</H3>
<PRE>
<A HREF="../../../../../org/apache/openjpa/persistence/query/SelectItem.html" title="interface in org.apache.openjpa.persistence.query">SelectItem</A> <B>entry</B>()</PRE>
<DL>
<DD>Return a select item corresponding to the map entry of a map-valued
association or element collection. This method is only permitted to be
invoked upon a domain object that corresponds to a map-valued association
or element collection.
<P>
<DD><DL>
</DL>
</DD>
<DD><DL>
<DT><B>Returns:</B><DD>SelectItem corresponding to the map entry</DL>
</DD>
</DL>
<HR>
<A NAME="index()"><!-- --></A><H3>
index</H3>
<PRE>
<A HREF="../../../../../org/apache/openjpa/persistence/query/Expression.html" title="interface in org.apache.openjpa.persistence.query">Expression</A> <B>index</B>()</PRE>
<DL>
<DD>Return an expression that corresponds to the index. of the domain object
in the referenced association or element collection. This method is only
permitted to be invoked upon a domain object that corresponds to a
multi-valued association or element collection for which an order column
has been defined.
<P>
<DD><DL>
</DL>
</DD>
<DD><DL>
<DT><B>Returns:</B><DD>Expression denoting the index</DL>
</DD>
</DL>
<!-- ========= END OF CLASS DATA ========= -->
<HR>
<!-- ======= START OF BOTTOM NAVBAR ====== -->
<A NAME="navbar_bottom"><!-- --></A>
<A HREF="#skip-navbar_bottom" title="Skip navigation links"></A>
<TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY="">
<TR>
<TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">
<A NAME="navbar_bottom_firstrow"><!-- --></A>
<TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY="">
<TR ALIGN="center" VALIGN="top">
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A>&nbsp;</TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A>&nbsp;</TD>
<TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> &nbsp;<FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT>&nbsp;</TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="class-use/DomainObject.html"><FONT CLASS="NavBarFont1"><B>Use</B></FONT></A>&nbsp;</TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A>&nbsp;</TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A>&nbsp;</TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A>&nbsp;</TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A>&nbsp;</TD>
</TR>
</TABLE>
</TD>
<TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
</EM>
</TD>
</TR>
<TR>
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
&nbsp;<A HREF="../../../../../org/apache/openjpa/persistence/query/DividedByExpression.html" title="class in org.apache.openjpa.persistence.query"><B>PREV CLASS</B></A>&nbsp;
&nbsp;<A HREF="../../../../../org/apache/openjpa/persistence/query/ElseExpression.html" title="class in org.apache.openjpa.persistence.query"><B>NEXT CLASS</B></A></FONT></TD>
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
<A HREF="../../../../../index.html?org/apache/openjpa/persistence/query/DomainObject.html" target="_top"><B>FRAMES</B></A> &nbsp;
&nbsp;<A HREF="DomainObject.html" target="_top"><B>NO FRAMES</B></A> &nbsp;
&nbsp;<SCRIPT type="text/javascript">
<!--
if(window==top) {
document.writeln('<A HREF="../../../../../allclasses-noframe.html"><B>All Classes</B></A>');
}
//-->
</SCRIPT>
<NOSCRIPT>
<A HREF="../../../../../allclasses-noframe.html"><B>All Classes</B></A>
</NOSCRIPT>
</FONT></TD>
</TR>
<TR>
<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
SUMMARY:&nbsp;NESTED&nbsp;|&nbsp;FIELD&nbsp;|&nbsp;CONSTR&nbsp;|&nbsp;<A HREF="#method_summary">METHOD</A></FONT></TD>
<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
DETAIL:&nbsp;FIELD&nbsp;|&nbsp;CONSTR&nbsp;|&nbsp;<A HREF="#method_detail">METHOD</A></FONT></TD>
</TR>
</TABLE>
<A NAME="skip-navbar_bottom"></A>
<!-- ======== END OF BOTTOM NAVBAR ======= -->
<HR>
Copyright &#169; 2006&#x2013;2013 <a href="http://www.apache.org">Apache Software Foundation</a>. All rights reserved.
</BODY>
</HTML>