| <!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.5.0_06) on Wed Jul 19 14:45:52 EDT 2006 --> |
| <TITLE> |
| SelectQuery (Apache Cayenne API Documentation - v.2.0-incubating-SNAPSHOT) |
| </TITLE> |
| |
| <META NAME="keywords" CONTENT="org.apache.cayenne.query.SelectQuery class"> |
| |
| <LINK REL ="stylesheet" TYPE="text/css" HREF="../../../../apache-javadoc.css" TITLE="Style"> |
| |
| <SCRIPT type="text/javascript"> |
| function windowTitle() |
| { |
| parent.document.title="SelectQuery (Apache Cayenne API Documentation - v.2.0-incubating-SNAPSHOT)"; |
| } |
| </SCRIPT> |
| <NOSCRIPT> |
| </NOSCRIPT> |
| |
| </HEAD> |
| |
| <BODY BGCOLOR="white" onload="windowTitle();"> |
| |
| |
| <!-- ========= 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> </TD> |
| <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A> </TD> |
| <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> <FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT> </TD> |
| <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A> </TD> |
| <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A> </TD> |
| <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../index-files/index-1.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A> </TD> |
| <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A> </TD> |
| </TR> |
| </TABLE> |
| </TD> |
| <TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM> |
| </EM> |
| </TD> |
| </TR> |
| |
| <TR> |
| <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2"> |
| <A HREF="../../../../org/apache/cayenne/query/RelationshipQuery.html" title="class in org.apache.cayenne.query"><B>PREV CLASS</B></A> |
| <A HREF="../../../../org/apache/cayenne/query/SQLAction.html" title="interface in org.apache.cayenne.query"><B>NEXT CLASS</B></A></FONT></TD> |
| <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2"> |
| <A HREF="../../../../index.html?org/apache/cayenne/query/SelectQuery.html" target="_top"><B>FRAMES</B></A> |
| <A HREF="SelectQuery.html" target="_top"><B>NO FRAMES</B></A> |
| <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: NESTED | <A HREF="#field_summary">FIELD</A> | <A HREF="#constructor_summary">CONSTR</A> | <A HREF="#method_summary">METHOD</A></FONT></TD> |
| <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2"> |
| DETAIL: <A HREF="#field_detail">FIELD</A> | <A HREF="#constructor_detail">CONSTR</A> | <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.cayenne.query</FONT> |
| <BR> |
| Class SelectQuery</H2> |
| <PRE> |
| java.lang.Object |
| <IMG SRC="../../../../resources/inherit.gif" ALT="extended by "><A HREF="../../../../org/apache/cayenne/query/AbstractQuery.html" title="class in org.apache.cayenne.query">org.apache.cayenne.query.AbstractQuery</A> |
| <IMG SRC="../../../../resources/inherit.gif" ALT="extended by "><A HREF="../../../../org/apache/cayenne/query/QualifiedQuery.html" title="class in org.apache.cayenne.query">org.apache.cayenne.query.QualifiedQuery</A> |
| <IMG SRC="../../../../resources/inherit.gif" ALT="extended by "><B>org.apache.cayenne.query.SelectQuery</B> |
| </PRE> |
| <DL> |
| <DT><B>All Implemented Interfaces:</B> <DD>java.io.Serializable, <A HREF="../../../../org/apache/cayenne/query/GenericSelectQuery.html" title="interface in org.apache.cayenne.query">GenericSelectQuery</A>, <A HREF="../../../../org/apache/cayenne/query/ParameterizedQuery.html" title="interface in org.apache.cayenne.query">ParameterizedQuery</A>, <A HREF="../../../../org/apache/cayenne/query/Query.html" title="interface in org.apache.cayenne.query">Query</A>, <A HREF="../../../../org/apache/cayenne/util/XMLSerializable.html" title="interface in org.apache.cayenne.util">XMLSerializable</A></DD> |
| </DL> |
| <DL> |
| <DT><B>Direct Known Subclasses:</B> <DD><A HREF="../../../../org/apache/cayenne/wocompat/EOQuery.html" title="class in org.apache.cayenne.wocompat">EOQuery</A>, <A HREF="../../../../org/apache/cayenne/query/PrefetchSelectQuery.html" title="class in org.apache.cayenne.query">PrefetchSelectQuery</A></DD> |
| </DL> |
| <HR> |
| <DL> |
| <DT><PRE>public class <B>SelectQuery</B><DT>extends <A HREF="../../../../org/apache/cayenne/query/QualifiedQuery.html" title="class in org.apache.cayenne.query">QualifiedQuery</A><DT>implements <A HREF="../../../../org/apache/cayenne/query/GenericSelectQuery.html" title="interface in org.apache.cayenne.query">GenericSelectQuery</A>, <A HREF="../../../../org/apache/cayenne/query/ParameterizedQuery.html" title="interface in org.apache.cayenne.query">ParameterizedQuery</A>, <A HREF="../../../../org/apache/cayenne/util/XMLSerializable.html" title="interface in org.apache.cayenne.util">XMLSerializable</A></DL> |
| </PRE> |
| |
| <P> |
| A query that selects persistent objects of a certain type or "raw data" (aka DataRows). |
| Supports expression qualifier, multiple orderings and a number of other parameters that |
| serve as runtime hints to Cayenne on how to optimize the fetch and result processing. |
| <P> |
| |
| <P> |
| <DL> |
| <DT><B>Author:</B></DT> |
| <DD>Andrei Adamchik</DD> |
| <DT><B>See Also:</B><DD><A HREF="../../../../serialized-form.html#org.apache.cayenne.query.SelectQuery">Serialized Form</A></DL> |
| <HR> |
| |
| <P> |
| <!-- =========== FIELD SUMMARY =========== --> |
| |
| <A NAME="field_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>Field Summary</B></FONT></TH> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE>protected java.util.List</CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../org/apache/cayenne/query/SelectQuery.html#customDbAttributes">customDbAttributes</A></B></CODE> |
| |
| <BR> |
| </TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE>protected boolean</CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../org/apache/cayenne/query/SelectQuery.html#distinct">distinct</A></B></CODE> |
| |
| <BR> |
| </TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE>static boolean</CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../org/apache/cayenne/query/SelectQuery.html#DISTINCT_DEFAULT">DISTINCT_DEFAULT</A></B></CODE> |
| |
| <BR> |
| </TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE>static java.lang.String</CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../org/apache/cayenne/query/SelectQuery.html#DISTINCT_PROPERTY">DISTINCT_PROPERTY</A></B></CODE> |
| |
| <BR> |
| </TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE>protected java.util.List</CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../org/apache/cayenne/query/SelectQuery.html#orderings">orderings</A></B></CODE> |
| |
| <BR> |
| </TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE>protected java.lang.String</CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../org/apache/cayenne/query/SelectQuery.html#parentObjEntityName">parentObjEntityName</A></B></CODE> |
| |
| <BR> |
| </TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE>protected <A HREF="../../../../org/apache/cayenne/exp/Expression.html" title="class in org.apache.cayenne.exp">Expression</A></CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../org/apache/cayenne/query/SelectQuery.html#parentQualifier">parentQualifier</A></B></CODE> |
| |
| <BR> |
| </TD> |
| </TR> |
| </TABLE> |
| <A NAME="fields_inherited_from_class_org.apache.cayenne.query.QualifiedQuery"><!-- --></A> |
| <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY=""> |
| <TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor"> |
| <TH ALIGN="left"><B>Fields inherited from class org.apache.cayenne.query.<A HREF="../../../../org/apache/cayenne/query/QualifiedQuery.html" title="class in org.apache.cayenne.query">QualifiedQuery</A></B></TH> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD><CODE><A HREF="../../../../org/apache/cayenne/query/QualifiedQuery.html#qualifier">qualifier</A></CODE></TD> |
| </TR> |
| </TABLE> |
| <A NAME="fields_inherited_from_class_org.apache.cayenne.query.AbstractQuery"><!-- --></A> |
| <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY=""> |
| <TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor"> |
| <TH ALIGN="left"><B>Fields inherited from class org.apache.cayenne.query.<A HREF="../../../../org/apache/cayenne/query/AbstractQuery.html" title="class in org.apache.cayenne.query">AbstractQuery</A></B></TH> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD><CODE><A HREF="../../../../org/apache/cayenne/query/AbstractQuery.html#name">name</A>, <A HREF="../../../../org/apache/cayenne/query/AbstractQuery.html#root">root</A></CODE></TD> |
| </TR> |
| </TABLE> |
| <A NAME="fields_inherited_from_class_org.apache.cayenne.query.GenericSelectQuery"><!-- --></A> |
| <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY=""> |
| <TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor"> |
| <TH ALIGN="left"><B>Fields inherited from interface org.apache.cayenne.query.<A HREF="../../../../org/apache/cayenne/query/GenericSelectQuery.html" title="interface in org.apache.cayenne.query">GenericSelectQuery</A></B></TH> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD><CODE><A HREF="../../../../org/apache/cayenne/query/GenericSelectQuery.html#CACHE_POLICY_DEFAULT">CACHE_POLICY_DEFAULT</A>, <A HREF="../../../../org/apache/cayenne/query/GenericSelectQuery.html#CACHE_POLICY_PROPERTY">CACHE_POLICY_PROPERTY</A>, <A HREF="../../../../org/apache/cayenne/query/GenericSelectQuery.html#FETCH_LIMIT_DEFAULT">FETCH_LIMIT_DEFAULT</A>, <A HREF="../../../../org/apache/cayenne/query/GenericSelectQuery.html#FETCH_LIMIT_PROPERTY">FETCH_LIMIT_PROPERTY</A>, <A HREF="../../../../org/apache/cayenne/query/GenericSelectQuery.html#FETCHING_DATA_ROWS_DEFAULT">FETCHING_DATA_ROWS_DEFAULT</A>, <A HREF="../../../../org/apache/cayenne/query/GenericSelectQuery.html#FETCHING_DATA_ROWS_PROPERTY">FETCHING_DATA_ROWS_PROPERTY</A>, <A HREF="../../../../org/apache/cayenne/query/GenericSelectQuery.html#LOCAL_CACHE">LOCAL_CACHE</A>, <A HREF="../../../../org/apache/cayenne/query/GenericSelectQuery.html#NO_CACHE">NO_CACHE</A>, <A HREF="../../../../org/apache/cayenne/query/GenericSelectQuery.html#PAGE_SIZE_DEFAULT">PAGE_SIZE_DEFAULT</A>, <A HREF="../../../../org/apache/cayenne/query/GenericSelectQuery.html#PAGE_SIZE_PROPERTY">PAGE_SIZE_PROPERTY</A>, <A HREF="../../../../org/apache/cayenne/query/GenericSelectQuery.html#REFRESHING_OBJECTS_DEFAULT">REFRESHING_OBJECTS_DEFAULT</A>, <A HREF="../../../../org/apache/cayenne/query/GenericSelectQuery.html#REFRESHING_OBJECTS_PROPERTY">REFRESHING_OBJECTS_PROPERTY</A>, <A HREF="../../../../org/apache/cayenne/query/GenericSelectQuery.html#RESOLVING_INHERITED_DEFAULT">RESOLVING_INHERITED_DEFAULT</A>, <A HREF="../../../../org/apache/cayenne/query/GenericSelectQuery.html#RESOLVING_INHERITED_PROPERTY">RESOLVING_INHERITED_PROPERTY</A>, <A HREF="../../../../org/apache/cayenne/query/GenericSelectQuery.html#SHARED_CACHE">SHARED_CACHE</A></CODE></TD> |
| </TR> |
| </TABLE> |
| |
| <!-- ======== CONSTRUCTOR SUMMARY ======== --> |
| |
| <A NAME="constructor_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>Constructor Summary</B></FONT></TH> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD><CODE><B><A HREF="../../../../org/apache/cayenne/query/SelectQuery.html#SelectQuery()">SelectQuery</A></B>()</CODE> |
| |
| <BR> |
| Creates an empty SelectQuery.</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD><CODE><B><A HREF="../../../../org/apache/cayenne/query/SelectQuery.html#SelectQuery(java.lang.Class)">SelectQuery</A></B>(java.lang.Class rootClass)</CODE> |
| |
| <BR> |
| Creates a SelectQuery that selects all objects of a given persistent class.</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD><CODE><B><A HREF="../../../../org/apache/cayenne/query/SelectQuery.html#SelectQuery(java.lang.Class, org.apache.cayenne.exp.Expression)">SelectQuery</A></B>(java.lang.Class rootClass, |
| <A HREF="../../../../org/apache/cayenne/exp/Expression.html" title="class in org.apache.cayenne.exp">Expression</A> qualifier)</CODE> |
| |
| <BR> |
| Creates a SelectQuery that selects objects of a given persistent class that match |
| supplied qualifier.</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD><CODE><B><A HREF="../../../../org/apache/cayenne/query/SelectQuery.html#SelectQuery(org.apache.cayenne.map.DbEntity)">SelectQuery</A></B>(<A HREF="../../../../org/apache/cayenne/map/DbEntity.html" title="class in org.apache.cayenne.map">DbEntity</A> root)</CODE> |
| |
| <BR> |
| Creates a SelectQuery for the specifed DbEntity.</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD><CODE><B><A HREF="../../../../org/apache/cayenne/query/SelectQuery.html#SelectQuery(org.apache.cayenne.map.DbEntity, org.apache.cayenne.exp.Expression)">SelectQuery</A></B>(<A HREF="../../../../org/apache/cayenne/map/DbEntity.html" title="class in org.apache.cayenne.map">DbEntity</A> root, |
| <A HREF="../../../../org/apache/cayenne/exp/Expression.html" title="class in org.apache.cayenne.exp">Expression</A> qualifier)</CODE> |
| |
| <BR> |
| Creates a SelectQuery for the specifed DbEntity with the given qualifier.</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD><CODE><B><A HREF="../../../../org/apache/cayenne/query/SelectQuery.html#SelectQuery(org.apache.cayenne.map.ObjEntity)">SelectQuery</A></B>(<A HREF="../../../../org/apache/cayenne/map/ObjEntity.html" title="class in org.apache.cayenne.map">ObjEntity</A> root)</CODE> |
| |
| <BR> |
| Creates a SelectQuery with null qualifier, for the specifed ObjEntity</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD><CODE><B><A HREF="../../../../org/apache/cayenne/query/SelectQuery.html#SelectQuery(org.apache.cayenne.map.ObjEntity, org.apache.cayenne.exp.Expression)">SelectQuery</A></B>(<A HREF="../../../../org/apache/cayenne/map/ObjEntity.html" title="class in org.apache.cayenne.map">ObjEntity</A> root, |
| <A HREF="../../../../org/apache/cayenne/exp/Expression.html" title="class in org.apache.cayenne.exp">Expression</A> qualifier)</CODE> |
| |
| <BR> |
| Creates a SelectQuery for the specifed ObjEntity with the given qualifier</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD><CODE><B><A HREF="../../../../org/apache/cayenne/query/SelectQuery.html#SelectQuery(java.lang.String)">SelectQuery</A></B>(java.lang.String objEntityName)</CODE> |
| |
| <BR> |
| Creates SelectQuery with <code>objEntityName</code> parameter.</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD><CODE><B><A HREF="../../../../org/apache/cayenne/query/SelectQuery.html#SelectQuery(java.lang.String, org.apache.cayenne.exp.Expression)">SelectQuery</A></B>(java.lang.String objEntityName, |
| <A HREF="../../../../org/apache/cayenne/exp/Expression.html" title="class in org.apache.cayenne.exp">Expression</A> qualifier)</CODE> |
| |
| <BR> |
| Creates SelectQuery with <code>objEntityName</code> and <code>qualifier</code> |
| parameters.</TD> |
| </TR> |
| </TABLE> |
| |
| <!-- ========== 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> void</CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../org/apache/cayenne/query/SelectQuery.html#addCustomDbAttribute(java.lang.String)">addCustomDbAttribute</A></B>(java.lang.String attributePath)</CODE> |
| |
| <BR> |
| Adds a path to the DbAttribute that should be included in the results of this |
| query.</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE> void</CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../org/apache/cayenne/query/SelectQuery.html#addCustomDbAttributes(java.util.List)">addCustomDbAttributes</A></B>(java.util.List attrPaths)</CODE> |
| |
| <BR> |
| </TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE> void</CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../org/apache/cayenne/query/SelectQuery.html#addOrdering(org.apache.cayenne.query.Ordering)">addOrdering</A></B>(<A HREF="../../../../org/apache/cayenne/query/Ordering.html" title="class in org.apache.cayenne.query">Ordering</A> ordering)</CODE> |
| |
| <BR> |
| Adds ordering specification to this query orderings.</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE> void</CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../org/apache/cayenne/query/SelectQuery.html#addOrdering(java.lang.String, boolean)">addOrdering</A></B>(java.lang.String sortPathSpec, |
| boolean isAscending)</CODE> |
| |
| <BR> |
| Adds ordering specification to this query orderings.</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE> void</CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../org/apache/cayenne/query/SelectQuery.html#addOrdering(java.lang.String, boolean, boolean)">addOrdering</A></B>(java.lang.String sortPathSpec, |
| boolean isAscending, |
| boolean ignoreCase)</CODE> |
| |
| <BR> |
| Adds ordering specification to this query orderings.</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE> void</CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../org/apache/cayenne/query/SelectQuery.html#addOrderings(java.util.List)">addOrderings</A></B>(java.util.List orderings)</CODE> |
| |
| <BR> |
| Adds a list of orderings.</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE> <A HREF="../../../../org/apache/cayenne/query/PrefetchTreeNode.html" title="class in org.apache.cayenne.query">PrefetchTreeNode</A></CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../org/apache/cayenne/query/SelectQuery.html#addPrefetch(java.lang.String)">addPrefetch</A></B>(java.lang.String prefetchPath)</CODE> |
| |
| <BR> |
| Adds a prefetch with specified relationship path to the query.</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE> void</CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../org/apache/cayenne/query/SelectQuery.html#addPrefetches(java.util.Collection)">addPrefetches</A></B>(java.util.Collection prefetches)</CODE> |
| |
| <BR> |
| <B>Deprecated.</B> <I>since 1.2</I></TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE> void</CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../org/apache/cayenne/query/SelectQuery.html#andParentQualifier(org.apache.cayenne.exp.Expression)">andParentQualifier</A></B>(<A HREF="../../../../org/apache/cayenne/exp/Expression.html" title="class in org.apache.cayenne.exp">Expression</A> e)</CODE> |
| |
| <BR> |
| Adds specified parent entity qualifier to the existing parent entity qualifier |
| joining it using "AND".</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE> void</CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../org/apache/cayenne/query/SelectQuery.html#clearOrderings()">clearOrderings</A></B>()</CODE> |
| |
| <BR> |
| Clears all configured orderings.</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE> void</CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../org/apache/cayenne/query/SelectQuery.html#clearPrefetches()">clearPrefetches</A></B>()</CODE> |
| |
| <BR> |
| Clears all stored prefetch paths.</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE> <A HREF="../../../../org/apache/cayenne/query/Query.html" title="interface in org.apache.cayenne.query">Query</A></CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../org/apache/cayenne/query/SelectQuery.html#createQuery(java.util.Map)">createQuery</A></B>(java.util.Map parameters)</CODE> |
| |
| <BR> |
| Creates and returns a new SelectQuery built using this query as a prototype and |
| substituting qualifier parameters with the values from the map.</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE> <A HREF="../../../../org/apache/cayenne/query/SQLAction.html" title="interface in org.apache.cayenne.query">SQLAction</A></CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../org/apache/cayenne/query/SelectQuery.html#createSQLAction(org.apache.cayenne.query.SQLActionVisitor)">createSQLAction</A></B>(<A HREF="../../../../org/apache/cayenne/query/SQLActionVisitor.html" title="interface in org.apache.cayenne.query">SQLActionVisitor</A> visitor)</CODE> |
| |
| <BR> |
| Calls "makeSelect" on the visitor.</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE> void</CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../org/apache/cayenne/query/SelectQuery.html#encodeAsXML(org.apache.cayenne.util.XMLEncoder)">encodeAsXML</A></B>(<A HREF="../../../../org/apache/cayenne/util/XMLEncoder.html" title="class in org.apache.cayenne.util">XMLEncoder</A> encoder)</CODE> |
| |
| <BR> |
| Prints itself as XML to the provided PrintWriter.</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE> java.lang.String</CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../org/apache/cayenne/query/SelectQuery.html#getCachePolicy()">getCachePolicy</A></B>()</CODE> |
| |
| <BR> |
| Returns query cache policy, which can be one of <A HREF="../../../../org/apache/cayenne/query/GenericSelectQuery.html#NO_CACHE"><CODE>GenericSelectQuery.NO_CACHE</CODE></A>, |
| <A HREF="../../../../org/apache/cayenne/query/GenericSelectQuery.html#LOCAL_CACHE"><CODE>GenericSelectQuery.LOCAL_CACHE</CODE></A>, or <A HREF="../../../../org/apache/cayenne/query/GenericSelectQuery.html#SHARED_CACHE"><CODE>GenericSelectQuery.SHARED_CACHE</CODE></A>.</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE> java.util.List</CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../org/apache/cayenne/query/SelectQuery.html#getCustomDbAttributes()">getCustomDbAttributes</A></B>()</CODE> |
| |
| <BR> |
| Returns a list of attributes that will be included in the results of this query.</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE> int</CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../org/apache/cayenne/query/SelectQuery.html#getFetchLimit()">getFetchLimit</A></B>()</CODE> |
| |
| <BR> |
| Returns the fetchLimit.</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE> <A HREF="../../../../org/apache/cayenne/query/QueryMetadata.html" title="interface in org.apache.cayenne.query">QueryMetadata</A></CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../org/apache/cayenne/query/SelectQuery.html#getMetaData(org.apache.cayenne.map.EntityResolver)">getMetaData</A></B>(<A HREF="../../../../org/apache/cayenne/map/EntityResolver.html" title="class in org.apache.cayenne.map">EntityResolver</A> resolver)</CODE> |
| |
| <BR> |
| Returns default select parameters.</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE> java.util.List</CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../org/apache/cayenne/query/SelectQuery.html#getOrderings()">getOrderings</A></B>()</CODE> |
| |
| <BR> |
| Returns a list of orderings used by this query.</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE> int</CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../org/apache/cayenne/query/SelectQuery.html#getPageSize()">getPageSize</A></B>()</CODE> |
| |
| <BR> |
| Returns <code>pageSize</code> property.</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE> java.lang.String</CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../org/apache/cayenne/query/SelectQuery.html#getParentObjEntityName()">getParentObjEntityName</A></B>()</CODE> |
| |
| <BR> |
| Returns the name of parent ObjEntity.</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE> <A HREF="../../../../org/apache/cayenne/exp/Expression.html" title="class in org.apache.cayenne.exp">Expression</A></CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../org/apache/cayenne/query/SelectQuery.html#getParentQualifier()">getParentQualifier</A></B>()</CODE> |
| |
| <BR> |
| Getter for query parent entity qualifier.</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE> java.util.Collection</CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../org/apache/cayenne/query/SelectQuery.html#getPrefetches()">getPrefetches</A></B>()</CODE> |
| |
| <BR> |
| <B>Deprecated.</B> <I>since 1.2 use 'getPrefetchTree' to explore prefetches.</I></TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE> <A HREF="../../../../org/apache/cayenne/query/PrefetchTreeNode.html" title="class in org.apache.cayenne.query">PrefetchTreeNode</A></CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../org/apache/cayenne/query/SelectQuery.html#getPrefetchTree()">getPrefetchTree</A></B>()</CODE> |
| |
| <BR> |
| Returns a root node of prefetch tree used by this query, or null of no prefetches |
| are configured.</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE> void</CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../org/apache/cayenne/query/SelectQuery.html#initWithProperties(java.util.Map)">initWithProperties</A></B>(java.util.Map properties)</CODE> |
| |
| <BR> |
| Initializes query parameters using a set of properties.</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE> boolean</CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../org/apache/cayenne/query/SelectQuery.html#isDistinct()">isDistinct</A></B>()</CODE> |
| |
| <BR> |
| Returns true if this query returns distinct rows.</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE> boolean</CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../org/apache/cayenne/query/SelectQuery.html#isFetchingCustomAttributes()">isFetchingCustomAttributes</A></B>()</CODE> |
| |
| <BR> |
| Returns <code>true</code> if there is at least one custom query attribute |
| specified, otherwise returns <code>false</code> for the case when the query |
| results will contain only the root entity attributes.</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE> boolean</CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../org/apache/cayenne/query/SelectQuery.html#isFetchingDataRows()">isFetchingDataRows</A></B>()</CODE> |
| |
| <BR> |
| Returns <code>true</code> if this query should produce a list of data rows as |
| opposed to DataObjects, <code>false</code> for DataObjects.</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE> boolean</CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../org/apache/cayenne/query/SelectQuery.html#isQualifiedOnParent()">isQualifiedOnParent</A></B>()</CODE> |
| |
| <BR> |
| Returns <code>true</code> if this query has an extra qualifier that uses a parent |
| entity of the query root entity for additional result filtering.</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE> boolean</CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../org/apache/cayenne/query/SelectQuery.html#isRefreshingObjects()">isRefreshingObjects</A></B>()</CODE> |
| |
| <BR> |
| Returns refresh policy of this query.</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE> boolean</CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../org/apache/cayenne/query/SelectQuery.html#isResolvingInherited()">isResolvingInherited</A></B>()</CODE> |
| |
| <BR> |
| Returns true if objects fetched via this query should be fully resolved according |
| to the inheritance hierarchy.</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE> void</CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../org/apache/cayenne/query/SelectQuery.html#orParentQualifier(org.apache.cayenne.exp.Expression)">orParentQualifier</A></B>(<A HREF="../../../../org/apache/cayenne/exp/Expression.html" title="class in org.apache.cayenne.exp">Expression</A> e)</CODE> |
| |
| <BR> |
| Adds specified parent entity qualifier to the existing qualifier joining it using |
| "OR".</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE> <A HREF="../../../../org/apache/cayenne/query/SelectQuery.html" title="class in org.apache.cayenne.query">SelectQuery</A></CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../org/apache/cayenne/query/SelectQuery.html#queryWithParameters(java.util.Map)">queryWithParameters</A></B>(java.util.Map parameters)</CODE> |
| |
| <BR> |
| A shortcut for <A HREF="../../../../org/apache/cayenne/query/SelectQuery.html#queryWithParameters(java.util.Map, boolean)"><CODE>queryWithParameters(Map, boolean)</CODE></A>that prunes parts of |
| qualifier that have no parameter value set.</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE> <A HREF="../../../../org/apache/cayenne/query/SelectQuery.html" title="class in org.apache.cayenne.query">SelectQuery</A></CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../org/apache/cayenne/query/SelectQuery.html#queryWithParameters(java.util.Map, boolean)">queryWithParameters</A></B>(java.util.Map parameters, |
| boolean pruneMissing)</CODE> |
| |
| <BR> |
| Returns a query built using this query as a prototype, using a set of parameters to |
| build the qualifier.</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE> void</CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../org/apache/cayenne/query/SelectQuery.html#removeOrdering(org.apache.cayenne.query.Ordering)">removeOrdering</A></B>(<A HREF="../../../../org/apache/cayenne/query/Ordering.html" title="class in org.apache.cayenne.query">Ordering</A> ordering)</CODE> |
| |
| <BR> |
| Removes ordering.</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE> void</CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../org/apache/cayenne/query/SelectQuery.html#removePrefetch(java.lang.String)">removePrefetch</A></B>(java.lang.String prefetchPath)</CODE> |
| |
| <BR> |
| Removes prefetch.</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE> void</CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../org/apache/cayenne/query/SelectQuery.html#route(org.apache.cayenne.query.QueryRouter, org.apache.cayenne.map.EntityResolver, org.apache.cayenne.query.Query)">route</A></B>(<A HREF="../../../../org/apache/cayenne/query/QueryRouter.html" title="interface in org.apache.cayenne.query">QueryRouter</A> router, |
| <A HREF="../../../../org/apache/cayenne/map/EntityResolver.html" title="class in org.apache.cayenne.map">EntityResolver</A> resolver, |
| <A HREF="../../../../org/apache/cayenne/query/Query.html" title="interface in org.apache.cayenne.query">Query</A> substitutedQuery)</CODE> |
| |
| <BR> |
| Routes itself and if there are any prefetches configured, creates prefetch queries |
| and routes them as well.</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE> void</CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../org/apache/cayenne/query/SelectQuery.html#setCachePolicy(java.lang.String)">setCachePolicy</A></B>(java.lang.String policy)</CODE> |
| |
| <BR> |
| </TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE> void</CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../org/apache/cayenne/query/SelectQuery.html#setDistinct(boolean)">setDistinct</A></B>(boolean distinct)</CODE> |
| |
| <BR> |
| Sets <code>distinct</code> property that determines whether this query returns |
| distinct row.</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE> void</CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../org/apache/cayenne/query/SelectQuery.html#setFetchingDataRows(boolean)">setFetchingDataRows</A></B>(boolean flag)</CODE> |
| |
| <BR> |
| Sets query result type.</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE> void</CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../org/apache/cayenne/query/SelectQuery.html#setFetchLimit(int)">setFetchLimit</A></B>(int fetchLimit)</CODE> |
| |
| <BR> |
| Sets the fetchLimit.</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE> void</CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../org/apache/cayenne/query/SelectQuery.html#setPageSize(int)">setPageSize</A></B>(int pageSize)</CODE> |
| |
| <BR> |
| Sets <code>pageSize</code> property.</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE> void</CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../org/apache/cayenne/query/SelectQuery.html#setParentObjEntityName(java.lang.String)">setParentObjEntityName</A></B>(java.lang.String parentObjEntityName)</CODE> |
| |
| <BR> |
| Sets the name of parent ObjEntity.</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE> void</CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../org/apache/cayenne/query/SelectQuery.html#setParentQualifier(org.apache.cayenne.exp.Expression)">setParentQualifier</A></B>(<A HREF="../../../../org/apache/cayenne/exp/Expression.html" title="class in org.apache.cayenne.exp">Expression</A> parentQualifier)</CODE> |
| |
| <BR> |
| Setter for query's parent entity qualifier.</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE> void</CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../org/apache/cayenne/query/SelectQuery.html#setPrefetchTree(org.apache.cayenne.query.PrefetchTreeNode)">setPrefetchTree</A></B>(<A HREF="../../../../org/apache/cayenne/query/PrefetchTreeNode.html" title="class in org.apache.cayenne.query">PrefetchTreeNode</A> prefetchTree)</CODE> |
| |
| <BR> |
| </TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE> void</CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../org/apache/cayenne/query/SelectQuery.html#setRefreshingObjects(boolean)">setRefreshingObjects</A></B>(boolean flag)</CODE> |
| |
| <BR> |
| </TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE> void</CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../org/apache/cayenne/query/SelectQuery.html#setResolvingInherited(boolean)">setResolvingInherited</A></B>(boolean b)</CODE> |
| |
| <BR> |
| Sets whether the objects fetched via this query should be fully resolved according |
| to the inheritance hierarchy.</TD> |
| </TR> |
| </TABLE> |
| <A NAME="methods_inherited_from_class_org.apache.cayenne.query.QualifiedQuery"><!-- --></A> |
| <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY=""> |
| <TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor"> |
| <TH ALIGN="left"><B>Methods inherited from class org.apache.cayenne.query.<A HREF="../../../../org/apache/cayenne/query/QualifiedQuery.html" title="class in org.apache.cayenne.query">QualifiedQuery</A></B></TH> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD><CODE><A HREF="../../../../org/apache/cayenne/query/QualifiedQuery.html#andQualifier(org.apache.cayenne.exp.Expression)">andQualifier</A>, <A HREF="../../../../org/apache/cayenne/query/QualifiedQuery.html#getQualifier()">getQualifier</A>, <A HREF="../../../../org/apache/cayenne/query/QualifiedQuery.html#orQualifier(org.apache.cayenne.exp.Expression)">orQualifier</A>, <A HREF="../../../../org/apache/cayenne/query/QualifiedQuery.html#setQualifier(org.apache.cayenne.exp.Expression)">setQualifier</A></CODE></TD> |
| </TR> |
| </TABLE> |
| <A NAME="methods_inherited_from_class_org.apache.cayenne.query.AbstractQuery"><!-- --></A> |
| <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY=""> |
| <TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor"> |
| <TH ALIGN="left"><B>Methods inherited from class org.apache.cayenne.query.<A HREF="../../../../org/apache/cayenne/query/AbstractQuery.html" title="class in org.apache.cayenne.query">AbstractQuery</A></B></TH> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD><CODE><A HREF="../../../../org/apache/cayenne/query/AbstractQuery.html#getName()">getName</A>, <A HREF="../../../../org/apache/cayenne/query/AbstractQuery.html#getRoot()">getRoot</A>, <A HREF="../../../../org/apache/cayenne/query/AbstractQuery.html#setName(java.lang.String)">setName</A>, <A HREF="../../../../org/apache/cayenne/query/AbstractQuery.html#setRoot(java.lang.Object)">setRoot</A>, <A HREF="../../../../org/apache/cayenne/query/AbstractQuery.html#toString()">toString</A></CODE></TD> |
| </TR> |
| </TABLE> |
| <A NAME="methods_inherited_from_class_java.lang.Object"><!-- --></A> |
| <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY=""> |
| <TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor"> |
| <TH ALIGN="left"><B>Methods inherited from class java.lang.Object</B></TH> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD><CODE>clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait</CODE></TD> |
| </TR> |
| </TABLE> |
| <A NAME="methods_inherited_from_class_org.apache.cayenne.query.Query"><!-- --></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.cayenne.query.<A HREF="../../../../org/apache/cayenne/query/Query.html" title="interface in org.apache.cayenne.query">Query</A></B></TH> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD><CODE><A HREF="../../../../org/apache/cayenne/query/Query.html#getName()">getName</A>, <A HREF="../../../../org/apache/cayenne/query/Query.html#getRoot()">getRoot</A>, <A HREF="../../../../org/apache/cayenne/query/Query.html#setName(java.lang.String)">setName</A>, <A HREF="../../../../org/apache/cayenne/query/Query.html#setRoot(java.lang.Object)">setRoot</A></CODE></TD> |
| </TR> |
| </TABLE> |
| <A NAME="methods_inherited_from_class_org.apache.cayenne.query.Query"><!-- --></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.cayenne.query.<A HREF="../../../../org/apache/cayenne/query/Query.html" title="interface in org.apache.cayenne.query">Query</A></B></TH> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD><CODE><A HREF="../../../../org/apache/cayenne/query/Query.html#getName()">getName</A>, <A HREF="../../../../org/apache/cayenne/query/Query.html#getRoot()">getRoot</A>, <A HREF="../../../../org/apache/cayenne/query/Query.html#setName(java.lang.String)">setName</A>, <A HREF="../../../../org/apache/cayenne/query/Query.html#setRoot(java.lang.Object)">setRoot</A></CODE></TD> |
| </TR> |
| </TABLE> |
| |
| <P> |
| |
| <!-- ============ FIELD DETAIL =========== --> |
| |
| <A NAME="field_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>Field Detail</B></FONT></TH> |
| </TR> |
| </TABLE> |
| |
| <A NAME="DISTINCT_PROPERTY"><!-- --></A><H3> |
| DISTINCT_PROPERTY</H3> |
| <PRE> |
| public static final java.lang.String <B>DISTINCT_PROPERTY</B></PRE> |
| <DL> |
| <DL> |
| <DT><B>See Also:</B><DD><A HREF="../../../../constant-values.html#org.apache.cayenne.query.SelectQuery.DISTINCT_PROPERTY">Constant Field Values</A></DL> |
| </DL> |
| <HR> |
| |
| <A NAME="DISTINCT_DEFAULT"><!-- --></A><H3> |
| DISTINCT_DEFAULT</H3> |
| <PRE> |
| public static final boolean <B>DISTINCT_DEFAULT</B></PRE> |
| <DL> |
| <DL> |
| <DT><B>See Also:</B><DD><A HREF="../../../../constant-values.html#org.apache.cayenne.query.SelectQuery.DISTINCT_DEFAULT">Constant Field Values</A></DL> |
| </DL> |
| <HR> |
| |
| <A NAME="customDbAttributes"><!-- --></A><H3> |
| customDbAttributes</H3> |
| <PRE> |
| protected java.util.List <B>customDbAttributes</B></PRE> |
| <DL> |
| <DL> |
| </DL> |
| </DL> |
| <HR> |
| |
| <A NAME="orderings"><!-- --></A><H3> |
| orderings</H3> |
| <PRE> |
| protected java.util.List <B>orderings</B></PRE> |
| <DL> |
| <DL> |
| </DL> |
| </DL> |
| <HR> |
| |
| <A NAME="distinct"><!-- --></A><H3> |
| distinct</H3> |
| <PRE> |
| protected boolean <B>distinct</B></PRE> |
| <DL> |
| <DL> |
| </DL> |
| </DL> |
| <HR> |
| |
| <A NAME="parentQualifier"><!-- --></A><H3> |
| parentQualifier</H3> |
| <PRE> |
| protected <A HREF="../../../../org/apache/cayenne/exp/Expression.html" title="class in org.apache.cayenne.exp">Expression</A> <B>parentQualifier</B></PRE> |
| <DL> |
| <DL> |
| </DL> |
| </DL> |
| <HR> |
| |
| <A NAME="parentObjEntityName"><!-- --></A><H3> |
| parentObjEntityName</H3> |
| <PRE> |
| protected java.lang.String <B>parentObjEntityName</B></PRE> |
| <DL> |
| <DL> |
| </DL> |
| </DL> |
| |
| <!-- ========= CONSTRUCTOR DETAIL ======== --> |
| |
| <A NAME="constructor_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>Constructor Detail</B></FONT></TH> |
| </TR> |
| </TABLE> |
| |
| <A NAME="SelectQuery()"><!-- --></A><H3> |
| SelectQuery</H3> |
| <PRE> |
| public <B>SelectQuery</B>()</PRE> |
| <DL> |
| <DD>Creates an empty SelectQuery. |
| <P> |
| </DL> |
| <HR> |
| |
| <A NAME="SelectQuery(org.apache.cayenne.map.ObjEntity)"><!-- --></A><H3> |
| SelectQuery</H3> |
| <PRE> |
| public <B>SelectQuery</B>(<A HREF="../../../../org/apache/cayenne/map/ObjEntity.html" title="class in org.apache.cayenne.map">ObjEntity</A> root)</PRE> |
| <DL> |
| <DD>Creates a SelectQuery with null qualifier, for the specifed ObjEntity |
| <P> |
| <DL> |
| <DT><B>Parameters:</B><DD><CODE>root</CODE> - the ObjEntity this SelectQuery is for.</DL> |
| </DL> |
| <HR> |
| |
| <A NAME="SelectQuery(org.apache.cayenne.map.ObjEntity, org.apache.cayenne.exp.Expression)"><!-- --></A><H3> |
| SelectQuery</H3> |
| <PRE> |
| public <B>SelectQuery</B>(<A HREF="../../../../org/apache/cayenne/map/ObjEntity.html" title="class in org.apache.cayenne.map">ObjEntity</A> root, |
| <A HREF="../../../../org/apache/cayenne/exp/Expression.html" title="class in org.apache.cayenne.exp">Expression</A> qualifier)</PRE> |
| <DL> |
| <DD>Creates a SelectQuery for the specifed ObjEntity with the given qualifier |
| <P> |
| <DL> |
| <DT><B>Parameters:</B><DD><CODE>root</CODE> - the ObjEntity this SelectQuery is for.<DD><CODE>qualifier</CODE> - an Expression indicating which objects should be fetched</DL> |
| </DL> |
| <HR> |
| |
| <A NAME="SelectQuery(java.lang.Class)"><!-- --></A><H3> |
| SelectQuery</H3> |
| <PRE> |
| public <B>SelectQuery</B>(java.lang.Class rootClass)</PRE> |
| <DL> |
| <DD>Creates a SelectQuery that selects all objects of a given persistent class. |
| <P> |
| <DL> |
| <DT><B>Parameters:</B><DD><CODE>rootClass</CODE> - the Class of objects fetched by this query.</DL> |
| </DL> |
| <HR> |
| |
| <A NAME="SelectQuery(java.lang.Class, org.apache.cayenne.exp.Expression)"><!-- --></A><H3> |
| SelectQuery</H3> |
| <PRE> |
| public <B>SelectQuery</B>(java.lang.Class rootClass, |
| <A HREF="../../../../org/apache/cayenne/exp/Expression.html" title="class in org.apache.cayenne.exp">Expression</A> qualifier)</PRE> |
| <DL> |
| <DD>Creates a SelectQuery that selects objects of a given persistent class that match |
| supplied qualifier. |
| <P> |
| <DL> |
| <DT><B>Parameters:</B><DD><CODE>rootClass</CODE> - the Class of objects fetched by this query.</DL> |
| </DL> |
| <HR> |
| |
| <A NAME="SelectQuery(org.apache.cayenne.map.DbEntity)"><!-- --></A><H3> |
| SelectQuery</H3> |
| <PRE> |
| public <B>SelectQuery</B>(<A HREF="../../../../org/apache/cayenne/map/DbEntity.html" title="class in org.apache.cayenne.map">DbEntity</A> root)</PRE> |
| <DL> |
| <DD>Creates a SelectQuery for the specifed DbEntity. |
| <P> |
| <DL> |
| <DT><B>Parameters:</B><DD><CODE>root</CODE> - the DbEntity this SelectQuery is for.<DT><B>Since:</B></DT> |
| <DD>1.1</DD> |
| </DL> |
| </DL> |
| <HR> |
| |
| <A NAME="SelectQuery(org.apache.cayenne.map.DbEntity, org.apache.cayenne.exp.Expression)"><!-- --></A><H3> |
| SelectQuery</H3> |
| <PRE> |
| public <B>SelectQuery</B>(<A HREF="../../../../org/apache/cayenne/map/DbEntity.html" title="class in org.apache.cayenne.map">DbEntity</A> root, |
| <A HREF="../../../../org/apache/cayenne/exp/Expression.html" title="class in org.apache.cayenne.exp">Expression</A> qualifier)</PRE> |
| <DL> |
| <DD>Creates a SelectQuery for the specifed DbEntity with the given qualifier. |
| <P> |
| <DL> |
| <DT><B>Parameters:</B><DD><CODE>root</CODE> - the DbEntity this SelectQuery is for.<DD><CODE>qualifier</CODE> - an Expression indicating which objects should be fetched<DT><B>Since:</B></DT> |
| <DD>1.1</DD> |
| </DL> |
| </DL> |
| <HR> |
| |
| <A NAME="SelectQuery(java.lang.String)"><!-- --></A><H3> |
| SelectQuery</H3> |
| <PRE> |
| public <B>SelectQuery</B>(java.lang.String objEntityName)</PRE> |
| <DL> |
| <DD>Creates SelectQuery with <code>objEntityName</code> parameter. |
| <P> |
| </DL> |
| <HR> |
| |
| <A NAME="SelectQuery(java.lang.String, org.apache.cayenne.exp.Expression)"><!-- --></A><H3> |
| SelectQuery</H3> |
| <PRE> |
| public <B>SelectQuery</B>(java.lang.String objEntityName, |
| <A HREF="../../../../org/apache/cayenne/exp/Expression.html" title="class in org.apache.cayenne.exp">Expression</A> qualifier)</PRE> |
| <DL> |
| <DD>Creates SelectQuery with <code>objEntityName</code> and <code>qualifier</code> |
| parameters. |
| <P> |
| </DL> |
| |
| <!-- ============ 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="getMetaData(org.apache.cayenne.map.EntityResolver)"><!-- --></A><H3> |
| getMetaData</H3> |
| <PRE> |
| public <A HREF="../../../../org/apache/cayenne/query/QueryMetadata.html" title="interface in org.apache.cayenne.query">QueryMetadata</A> <B>getMetaData</B>(<A HREF="../../../../org/apache/cayenne/map/EntityResolver.html" title="class in org.apache.cayenne.map">EntityResolver</A> resolver)</PRE> |
| <DL> |
| <DD><B>Description copied from class: <CODE><A HREF="../../../../org/apache/cayenne/query/AbstractQuery.html#getMetaData(org.apache.cayenne.map.EntityResolver)">AbstractQuery</A></CODE></B></DD> |
| <DD>Returns default select parameters. |
| <P> |
| <DD><DL> |
| <DT><B>Specified by:</B><DD><CODE><A HREF="../../../../org/apache/cayenne/query/Query.html#getMetaData(org.apache.cayenne.map.EntityResolver)">getMetaData</A></CODE> in interface <CODE><A HREF="../../../../org/apache/cayenne/query/Query.html" title="interface in org.apache.cayenne.query">Query</A></CODE><DT><B>Overrides:</B><DD><CODE><A HREF="../../../../org/apache/cayenne/query/AbstractQuery.html#getMetaData(org.apache.cayenne.map.EntityResolver)">getMetaData</A></CODE> in class <CODE><A HREF="../../../../org/apache/cayenne/query/AbstractQuery.html" title="class in org.apache.cayenne.query">AbstractQuery</A></CODE></DL> |
| </DD> |
| <DD><DL> |
| <DT><B>Since:</B></DT> |
| <DD>1.2</DD> |
| </DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="route(org.apache.cayenne.query.QueryRouter, org.apache.cayenne.map.EntityResolver, org.apache.cayenne.query.Query)"><!-- --></A><H3> |
| route</H3> |
| <PRE> |
| public void <B>route</B>(<A HREF="../../../../org/apache/cayenne/query/QueryRouter.html" title="interface in org.apache.cayenne.query">QueryRouter</A> router, |
| <A HREF="../../../../org/apache/cayenne/map/EntityResolver.html" title="class in org.apache.cayenne.map">EntityResolver</A> resolver, |
| <A HREF="../../../../org/apache/cayenne/query/Query.html" title="interface in org.apache.cayenne.query">Query</A> substitutedQuery)</PRE> |
| <DL> |
| <DD>Routes itself and if there are any prefetches configured, creates prefetch queries |
| and routes them as well. |
| <P> |
| <DD><DL> |
| <DT><B>Specified by:</B><DD><CODE><A HREF="../../../../org/apache/cayenne/query/Query.html#route(org.apache.cayenne.query.QueryRouter, org.apache.cayenne.map.EntityResolver, org.apache.cayenne.query.Query)">route</A></CODE> in interface <CODE><A HREF="../../../../org/apache/cayenne/query/Query.html" title="interface in org.apache.cayenne.query">Query</A></CODE><DT><B>Overrides:</B><DD><CODE><A HREF="../../../../org/apache/cayenne/query/AbstractQuery.html#route(org.apache.cayenne.query.QueryRouter, org.apache.cayenne.map.EntityResolver, org.apache.cayenne.query.Query)">route</A></CODE> in class <CODE><A HREF="../../../../org/apache/cayenne/query/AbstractQuery.html" title="class in org.apache.cayenne.query">AbstractQuery</A></CODE></DL> |
| </DD> |
| <DD><DL> |
| <DT><B>Since:</B></DT> |
| <DD>1.2</DD> |
| </DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="createSQLAction(org.apache.cayenne.query.SQLActionVisitor)"><!-- --></A><H3> |
| createSQLAction</H3> |
| <PRE> |
| public <A HREF="../../../../org/apache/cayenne/query/SQLAction.html" title="interface in org.apache.cayenne.query">SQLAction</A> <B>createSQLAction</B>(<A HREF="../../../../org/apache/cayenne/query/SQLActionVisitor.html" title="interface in org.apache.cayenne.query">SQLActionVisitor</A> visitor)</PRE> |
| <DL> |
| <DD>Calls "makeSelect" on the visitor. |
| <P> |
| <DD><DL> |
| <DT><B>Specified by:</B><DD><CODE><A HREF="../../../../org/apache/cayenne/query/Query.html#createSQLAction(org.apache.cayenne.query.SQLActionVisitor)">createSQLAction</A></CODE> in interface <CODE><A HREF="../../../../org/apache/cayenne/query/Query.html" title="interface in org.apache.cayenne.query">Query</A></CODE><DT><B>Specified by:</B><DD><CODE><A HREF="../../../../org/apache/cayenne/query/AbstractQuery.html#createSQLAction(org.apache.cayenne.query.SQLActionVisitor)">createSQLAction</A></CODE> in class <CODE><A HREF="../../../../org/apache/cayenne/query/AbstractQuery.html" title="class in org.apache.cayenne.query">AbstractQuery</A></CODE></DL> |
| </DD> |
| <DD><DL> |
| <DT><B>Since:</B></DT> |
| <DD>1.2</DD> |
| </DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="initWithProperties(java.util.Map)"><!-- --></A><H3> |
| initWithProperties</H3> |
| <PRE> |
| public void <B>initWithProperties</B>(java.util.Map properties)</PRE> |
| <DL> |
| <DD>Initializes query parameters using a set of properties. |
| <P> |
| <DD><DL> |
| </DL> |
| </DD> |
| <DD><DL> |
| <DT><B>Since:</B></DT> |
| <DD>1.1</DD> |
| </DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="encodeAsXML(org.apache.cayenne.util.XMLEncoder)"><!-- --></A><H3> |
| encodeAsXML</H3> |
| <PRE> |
| public void <B>encodeAsXML</B>(<A HREF="../../../../org/apache/cayenne/util/XMLEncoder.html" title="class in org.apache.cayenne.util">XMLEncoder</A> encoder)</PRE> |
| <DL> |
| <DD>Prints itself as XML to the provided PrintWriter. |
| <P> |
| <DD><DL> |
| <DT><B>Specified by:</B><DD><CODE><A HREF="../../../../org/apache/cayenne/util/XMLSerializable.html#encodeAsXML(org.apache.cayenne.util.XMLEncoder)">encodeAsXML</A></CODE> in interface <CODE><A HREF="../../../../org/apache/cayenne/util/XMLSerializable.html" title="interface in org.apache.cayenne.util">XMLSerializable</A></CODE></DL> |
| </DD> |
| <DD><DL> |
| <DT><B>Since:</B></DT> |
| <DD>1.1</DD> |
| </DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="queryWithParameters(java.util.Map)"><!-- --></A><H3> |
| queryWithParameters</H3> |
| <PRE> |
| public <A HREF="../../../../org/apache/cayenne/query/SelectQuery.html" title="class in org.apache.cayenne.query">SelectQuery</A> <B>queryWithParameters</B>(java.util.Map parameters)</PRE> |
| <DL> |
| <DD>A shortcut for <A HREF="../../../../org/apache/cayenne/query/SelectQuery.html#queryWithParameters(java.util.Map, boolean)"><CODE>queryWithParameters(Map, boolean)</CODE></A>that prunes parts of |
| qualifier that have no parameter value set. |
| <P> |
| <DD><DL> |
| </DL> |
| </DD> |
| <DD><DL> |
| </DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="queryWithParameters(java.util.Map, boolean)"><!-- --></A><H3> |
| queryWithParameters</H3> |
| <PRE> |
| public <A HREF="../../../../org/apache/cayenne/query/SelectQuery.html" title="class in org.apache.cayenne.query">SelectQuery</A> <B>queryWithParameters</B>(java.util.Map parameters, |
| boolean pruneMissing)</PRE> |
| <DL> |
| <DD>Returns a query built using this query as a prototype, using a set of parameters to |
| build the qualifier. |
| <P> |
| <DD><DL> |
| </DL> |
| </DD> |
| <DD><DL> |
| <DT><B>See Also:</B><DD><A HREF="../../../../org/apache/cayenne/exp/Expression.html#expWithParameters(java.util.Map, boolean)"><CODE>parameter substitution.</CODE></A></DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="createQuery(java.util.Map)"><!-- --></A><H3> |
| createQuery</H3> |
| <PRE> |
| public <A HREF="../../../../org/apache/cayenne/query/Query.html" title="interface in org.apache.cayenne.query">Query</A> <B>createQuery</B>(java.util.Map parameters)</PRE> |
| <DL> |
| <DD>Creates and returns a new SelectQuery built using this query as a prototype and |
| substituting qualifier parameters with the values from the map. |
| <P> |
| <DD><DL> |
| <DT><B>Specified by:</B><DD><CODE><A HREF="../../../../org/apache/cayenne/query/ParameterizedQuery.html#createQuery(java.util.Map)">createQuery</A></CODE> in interface <CODE><A HREF="../../../../org/apache/cayenne/query/ParameterizedQuery.html" title="interface in org.apache.cayenne.query">ParameterizedQuery</A></CODE></DL> |
| </DD> |
| <DD><DL> |
| <DT><B>Since:</B></DT> |
| <DD>1.1</DD> |
| </DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="addOrdering(org.apache.cayenne.query.Ordering)"><!-- --></A><H3> |
| addOrdering</H3> |
| <PRE> |
| public void <B>addOrdering</B>(<A HREF="../../../../org/apache/cayenne/query/Ordering.html" title="class in org.apache.cayenne.query">Ordering</A> ordering)</PRE> |
| <DL> |
| <DD>Adds ordering specification to this query orderings. |
| <P> |
| <DD><DL> |
| </DL> |
| </DD> |
| <DD><DL> |
| </DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="addOrderings(java.util.List)"><!-- --></A><H3> |
| addOrderings</H3> |
| <PRE> |
| public void <B>addOrderings</B>(java.util.List orderings)</PRE> |
| <DL> |
| <DD>Adds a list of orderings. |
| <P> |
| <DD><DL> |
| </DL> |
| </DD> |
| <DD><DL> |
| </DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="addOrdering(java.lang.String, boolean)"><!-- --></A><H3> |
| addOrdering</H3> |
| <PRE> |
| public void <B>addOrdering</B>(java.lang.String sortPathSpec, |
| boolean isAscending)</PRE> |
| <DL> |
| <DD>Adds ordering specification to this query orderings. |
| <P> |
| <DD><DL> |
| </DL> |
| </DD> |
| <DD><DL> |
| </DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="addOrdering(java.lang.String, boolean, boolean)"><!-- --></A><H3> |
| addOrdering</H3> |
| <PRE> |
| public void <B>addOrdering</B>(java.lang.String sortPathSpec, |
| boolean isAscending, |
| boolean ignoreCase)</PRE> |
| <DL> |
| <DD>Adds ordering specification to this query orderings. |
| <P> |
| <DD><DL> |
| </DL> |
| </DD> |
| <DD><DL> |
| </DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="removeOrdering(org.apache.cayenne.query.Ordering)"><!-- --></A><H3> |
| removeOrdering</H3> |
| <PRE> |
| public void <B>removeOrdering</B>(<A HREF="../../../../org/apache/cayenne/query/Ordering.html" title="class in org.apache.cayenne.query">Ordering</A> ordering)</PRE> |
| <DL> |
| <DD>Removes ordering. |
| <P> |
| <DD><DL> |
| </DL> |
| </DD> |
| <DD><DL> |
| <DT><B>Since:</B></DT> |
| <DD>1.1</DD> |
| </DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="getOrderings()"><!-- --></A><H3> |
| getOrderings</H3> |
| <PRE> |
| public java.util.List <B>getOrderings</B>()</PRE> |
| <DL> |
| <DD>Returns a list of orderings used by this query. |
| <P> |
| <DD><DL> |
| </DL> |
| </DD> |
| <DD><DL> |
| </DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="clearOrderings()"><!-- --></A><H3> |
| clearOrderings</H3> |
| <PRE> |
| public void <B>clearOrderings</B>()</PRE> |
| <DL> |
| <DD>Clears all configured orderings. |
| <P> |
| <DD><DL> |
| </DL> |
| </DD> |
| <DD><DL> |
| </DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="isDistinct()"><!-- --></A><H3> |
| isDistinct</H3> |
| <PRE> |
| public boolean <B>isDistinct</B>()</PRE> |
| <DL> |
| <DD>Returns true if this query returns distinct rows. |
| <P> |
| <DD><DL> |
| </DL> |
| </DD> |
| <DD><DL> |
| </DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="setDistinct(boolean)"><!-- --></A><H3> |
| setDistinct</H3> |
| <PRE> |
| public void <B>setDistinct</B>(boolean distinct)</PRE> |
| <DL> |
| <DD>Sets <code>distinct</code> property that determines whether this query returns |
| distinct row. |
| <P> |
| <DD><DL> |
| </DL> |
| </DD> |
| <DD><DL> |
| </DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="getCustomDbAttributes()"><!-- --></A><H3> |
| getCustomDbAttributes</H3> |
| <PRE> |
| public java.util.List <B>getCustomDbAttributes</B>()</PRE> |
| <DL> |
| <DD>Returns a list of attributes that will be included in the results of this query. |
| <P> |
| <DD><DL> |
| </DL> |
| </DD> |
| <DD><DL> |
| </DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="addCustomDbAttribute(java.lang.String)"><!-- --></A><H3> |
| addCustomDbAttribute</H3> |
| <PRE> |
| public void <B>addCustomDbAttribute</B>(java.lang.String attributePath)</PRE> |
| <DL> |
| <DD>Adds a path to the DbAttribute that should be included in the results of this |
| query. Valid paths would look like <code>ARTIST_NAME</code>, |
| <code>PAINTING_ARRAY.PAINTING_ID</code>, etc. |
| <P> |
| <DD><DL> |
| </DL> |
| </DD> |
| <DD><DL> |
| </DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="addCustomDbAttributes(java.util.List)"><!-- --></A><H3> |
| addCustomDbAttributes</H3> |
| <PRE> |
| public void <B>addCustomDbAttributes</B>(java.util.List attrPaths)</PRE> |
| <DL> |
| <DD><DL> |
| </DL> |
| </DD> |
| <DD><DL> |
| </DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="isFetchingCustomAttributes()"><!-- --></A><H3> |
| isFetchingCustomAttributes</H3> |
| <PRE> |
| public boolean <B>isFetchingCustomAttributes</B>()</PRE> |
| <DL> |
| <DD>Returns <code>true</code> if there is at least one custom query attribute |
| specified, otherwise returns <code>false</code> for the case when the query |
| results will contain only the root entity attributes. |
| <p> |
| Note that queries that are fetching custom attributes always return data rows |
| instead of DataObjects. |
| </p> |
| <P> |
| <DD><DL> |
| </DL> |
| </DD> |
| <DD><DL> |
| </DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="getPrefetches()"><!-- --></A><H3> |
| getPrefetches</H3> |
| <PRE> |
| public java.util.Collection <B>getPrefetches</B>()</PRE> |
| <DL> |
| <DD><B>Deprecated.</B> <I>since 1.2 use 'getPrefetchTree' to explore prefetches.</I> |
| <P> |
| <DD>Returns a collection of String paths indicating relationships to objects that are |
| prefetched together with this query. |
| <P> |
| <DD><DL> |
| </DL> |
| </DD> |
| <DD><DL> |
| </DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="getPrefetchTree()"><!-- --></A><H3> |
| getPrefetchTree</H3> |
| <PRE> |
| public <A HREF="../../../../org/apache/cayenne/query/PrefetchTreeNode.html" title="class in org.apache.cayenne.query">PrefetchTreeNode</A> <B>getPrefetchTree</B>()</PRE> |
| <DL> |
| <DD><B>Description copied from interface: <CODE><A HREF="../../../../org/apache/cayenne/query/GenericSelectQuery.html#getPrefetchTree()">GenericSelectQuery</A></CODE></B></DD> |
| <DD>Returns a root node of prefetch tree used by this query, or null of no prefetches |
| are configured. |
| <P> |
| <DD><DL> |
| <DT><B>Specified by:</B><DD><CODE><A HREF="../../../../org/apache/cayenne/query/GenericSelectQuery.html#getPrefetchTree()">getPrefetchTree</A></CODE> in interface <CODE><A HREF="../../../../org/apache/cayenne/query/GenericSelectQuery.html" title="interface in org.apache.cayenne.query">GenericSelectQuery</A></CODE></DL> |
| </DD> |
| <DD><DL> |
| <DT><B>Since:</B></DT> |
| <DD>1.2</DD> |
| </DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="setPrefetchTree(org.apache.cayenne.query.PrefetchTreeNode)"><!-- --></A><H3> |
| setPrefetchTree</H3> |
| <PRE> |
| public void <B>setPrefetchTree</B>(<A HREF="../../../../org/apache/cayenne/query/PrefetchTreeNode.html" title="class in org.apache.cayenne.query">PrefetchTreeNode</A> prefetchTree)</PRE> |
| <DL> |
| <DD><DL> |
| </DL> |
| </DD> |
| <DD><DL> |
| <DT><B>Since:</B></DT> |
| <DD>1.2</DD> |
| </DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="addPrefetch(java.lang.String)"><!-- --></A><H3> |
| addPrefetch</H3> |
| <PRE> |
| public <A HREF="../../../../org/apache/cayenne/query/PrefetchTreeNode.html" title="class in org.apache.cayenne.query">PrefetchTreeNode</A> <B>addPrefetch</B>(java.lang.String prefetchPath)</PRE> |
| <DL> |
| <DD>Adds a prefetch with specified relationship path to the query. |
| <P> |
| <DD><DL> |
| </DL> |
| </DD> |
| <DD><DL> |
| <DT><B>Since:</B></DT> |
| <DD>1.2 signature changed to return created PrefetchTreeNode.</DD> |
| </DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="addPrefetches(java.util.Collection)"><!-- --></A><H3> |
| addPrefetches</H3> |
| <PRE> |
| public void <B>addPrefetches</B>(java.util.Collection prefetches)</PRE> |
| <DL> |
| <DD><B>Deprecated.</B> <I>since 1.2</I> |
| <P> |
| <DD>Adds all prefetches to the internal prefetch set. |
| <P> |
| <DD><DL> |
| </DL> |
| </DD> |
| <DD><DL> |
| </DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="clearPrefetches()"><!-- --></A><H3> |
| clearPrefetches</H3> |
| <PRE> |
| public void <B>clearPrefetches</B>()</PRE> |
| <DL> |
| <DD>Clears all stored prefetch paths. |
| <P> |
| <DD><DL> |
| </DL> |
| </DD> |
| <DD><DL> |
| </DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="removePrefetch(java.lang.String)"><!-- --></A><H3> |
| removePrefetch</H3> |
| <PRE> |
| public void <B>removePrefetch</B>(java.lang.String prefetchPath)</PRE> |
| <DL> |
| <DD>Removes prefetch. |
| <P> |
| <DD><DL> |
| </DL> |
| </DD> |
| <DD><DL> |
| <DT><B>Since:</B></DT> |
| <DD>1.1</DD> |
| </DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="isFetchingDataRows()"><!-- --></A><H3> |
| isFetchingDataRows</H3> |
| <PRE> |
| public boolean <B>isFetchingDataRows</B>()</PRE> |
| <DL> |
| <DD>Returns <code>true</code> if this query should produce a list of data rows as |
| opposed to DataObjects, <code>false</code> for DataObjects. This is a hint to |
| QueryEngine executing this query. |
| <P> |
| <DD><DL> |
| <DT><B>Specified by:</B><DD><CODE><A HREF="../../../../org/apache/cayenne/query/GenericSelectQuery.html#isFetchingDataRows()">isFetchingDataRows</A></CODE> in interface <CODE><A HREF="../../../../org/apache/cayenne/query/GenericSelectQuery.html" title="interface in org.apache.cayenne.query">GenericSelectQuery</A></CODE></DL> |
| </DD> |
| <DD><DL> |
| </DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="setFetchingDataRows(boolean)"><!-- --></A><H3> |
| setFetchingDataRows</H3> |
| <PRE> |
| public void <B>setFetchingDataRows</B>(boolean flag)</PRE> |
| <DL> |
| <DD>Sets query result type. If <code>flag</code> parameter is <code>true</code>, |
| then results will be in the form of data rows. |
| <p> |
| <i>Note that if <code>isFetchingCustAttributes()</code> returns <code>true</code>, |
| this setting has no effect, and data rows are always fetched. </i> |
| </p> |
| <P> |
| <DD><DL> |
| </DL> |
| </DD> |
| <DD><DL> |
| </DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="isRefreshingObjects()"><!-- --></A><H3> |
| isRefreshingObjects</H3> |
| <PRE> |
| public boolean <B>isRefreshingObjects</B>()</PRE> |
| <DL> |
| <DD>Returns refresh policy of this query. Default is <code>true</code>. |
| <P> |
| <DD><DL> |
| <DT><B>Specified by:</B><DD><CODE><A HREF="../../../../org/apache/cayenne/query/GenericSelectQuery.html#isRefreshingObjects()">isRefreshingObjects</A></CODE> in interface <CODE><A HREF="../../../../org/apache/cayenne/query/GenericSelectQuery.html" title="interface in org.apache.cayenne.query">GenericSelectQuery</A></CODE></DL> |
| </DD> |
| <DD><DL> |
| <DT><B>Since:</B></DT> |
| <DD>1.1</DD> |
| </DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="setRefreshingObjects(boolean)"><!-- --></A><H3> |
| setRefreshingObjects</H3> |
| <PRE> |
| public void <B>setRefreshingObjects</B>(boolean flag)</PRE> |
| <DL> |
| <DD><DL> |
| </DL> |
| </DD> |
| <DD><DL> |
| <DT><B>Since:</B></DT> |
| <DD>1.1</DD> |
| </DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="getCachePolicy()"><!-- --></A><H3> |
| getCachePolicy</H3> |
| <PRE> |
| public java.lang.String <B>getCachePolicy</B>()</PRE> |
| <DL> |
| <DD><B>Description copied from interface: <CODE><A HREF="../../../../org/apache/cayenne/query/GenericSelectQuery.html#getCachePolicy()">GenericSelectQuery</A></CODE></B></DD> |
| <DD>Returns query cache policy, which can be one of <A HREF="../../../../org/apache/cayenne/query/GenericSelectQuery.html#NO_CACHE"><CODE>GenericSelectQuery.NO_CACHE</CODE></A>, |
| <A HREF="../../../../org/apache/cayenne/query/GenericSelectQuery.html#LOCAL_CACHE"><CODE>GenericSelectQuery.LOCAL_CACHE</CODE></A>, or <A HREF="../../../../org/apache/cayenne/query/GenericSelectQuery.html#SHARED_CACHE"><CODE>GenericSelectQuery.SHARED_CACHE</CODE></A>. NO_CACHE is generally a default |
| policy. |
| <P> |
| <DD><DL> |
| <DT><B>Specified by:</B><DD><CODE><A HREF="../../../../org/apache/cayenne/query/GenericSelectQuery.html#getCachePolicy()">getCachePolicy</A></CODE> in interface <CODE><A HREF="../../../../org/apache/cayenne/query/GenericSelectQuery.html" title="interface in org.apache.cayenne.query">GenericSelectQuery</A></CODE></DL> |
| </DD> |
| <DD><DL> |
| <DT><B>Since:</B></DT> |
| <DD>1.1</DD> |
| </DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="setCachePolicy(java.lang.String)"><!-- --></A><H3> |
| setCachePolicy</H3> |
| <PRE> |
| public void <B>setCachePolicy</B>(java.lang.String policy)</PRE> |
| <DL> |
| <DD><DL> |
| </DL> |
| </DD> |
| <DD><DL> |
| <DT><B>Since:</B></DT> |
| <DD>1.1</DD> |
| </DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="getFetchLimit()"><!-- --></A><H3> |
| getFetchLimit</H3> |
| <PRE> |
| public int <B>getFetchLimit</B>()</PRE> |
| <DL> |
| <DD>Returns the fetchLimit. |
| <P> |
| <DD><DL> |
| <DT><B>Specified by:</B><DD><CODE><A HREF="../../../../org/apache/cayenne/query/GenericSelectQuery.html#getFetchLimit()">getFetchLimit</A></CODE> in interface <CODE><A HREF="../../../../org/apache/cayenne/query/GenericSelectQuery.html" title="interface in org.apache.cayenne.query">GenericSelectQuery</A></CODE></DL> |
| </DD> |
| <DD><DL> |
| |
| <DT><B>Returns:</B><DD>int</DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="setFetchLimit(int)"><!-- --></A><H3> |
| setFetchLimit</H3> |
| <PRE> |
| public void <B>setFetchLimit</B>(int fetchLimit)</PRE> |
| <DL> |
| <DD>Sets the fetchLimit. |
| <P> |
| <DD><DL> |
| </DL> |
| </DD> |
| <DD><DL> |
| <DT><B>Parameters:</B><DD><CODE>fetchLimit</CODE> - The fetchLimit to set</DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="setParentQualifier(org.apache.cayenne.exp.Expression)"><!-- --></A><H3> |
| setParentQualifier</H3> |
| <PRE> |
| public void <B>setParentQualifier</B>(<A HREF="../../../../org/apache/cayenne/exp/Expression.html" title="class in org.apache.cayenne.exp">Expression</A> parentQualifier)</PRE> |
| <DL> |
| <DD>Setter for query's parent entity qualifier. |
| <P> |
| <DD><DL> |
| </DL> |
| </DD> |
| <DD><DL> |
| </DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="getParentQualifier()"><!-- --></A><H3> |
| getParentQualifier</H3> |
| <PRE> |
| public <A HREF="../../../../org/apache/cayenne/exp/Expression.html" title="class in org.apache.cayenne.exp">Expression</A> <B>getParentQualifier</B>()</PRE> |
| <DL> |
| <DD>Getter for query parent entity qualifier. |
| <P> |
| <DD><DL> |
| </DL> |
| </DD> |
| <DD><DL> |
| </DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="andParentQualifier(org.apache.cayenne.exp.Expression)"><!-- --></A><H3> |
| andParentQualifier</H3> |
| <PRE> |
| public void <B>andParentQualifier</B>(<A HREF="../../../../org/apache/cayenne/exp/Expression.html" title="class in org.apache.cayenne.exp">Expression</A> e)</PRE> |
| <DL> |
| <DD>Adds specified parent entity qualifier to the existing parent entity qualifier |
| joining it using "AND". |
| <P> |
| <DD><DL> |
| </DL> |
| </DD> |
| <DD><DL> |
| </DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="orParentQualifier(org.apache.cayenne.exp.Expression)"><!-- --></A><H3> |
| orParentQualifier</H3> |
| <PRE> |
| public void <B>orParentQualifier</B>(<A HREF="../../../../org/apache/cayenne/exp/Expression.html" title="class in org.apache.cayenne.exp">Expression</A> e)</PRE> |
| <DL> |
| <DD>Adds specified parent entity qualifier to the existing qualifier joining it using |
| "OR". |
| <P> |
| <DD><DL> |
| </DL> |
| </DD> |
| <DD><DL> |
| </DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="getParentObjEntityName()"><!-- --></A><H3> |
| getParentObjEntityName</H3> |
| <PRE> |
| public java.lang.String <B>getParentObjEntityName</B>()</PRE> |
| <DL> |
| <DD>Returns the name of parent ObjEntity. |
| <P> |
| <DD><DL> |
| </DL> |
| </DD> |
| <DD><DL> |
| |
| <DT><B>Returns:</B><DD>String</DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="setParentObjEntityName(java.lang.String)"><!-- --></A><H3> |
| setParentObjEntityName</H3> |
| <PRE> |
| public void <B>setParentObjEntityName</B>(java.lang.String parentObjEntityName)</PRE> |
| <DL> |
| <DD>Sets the name of parent ObjEntity. If query's root ObjEntity maps to a derived |
| entity in the DataMap, this query qualifier will resolve to a HAVING clause of an |
| SQL statement. To allow fine tuning the query before applying GROUP BY and HAVING, |
| callers can setup the name of parent ObjEntity and parent qualifier that will be |
| used to create WHERE clause preceeding GROUP BY. |
| <p> |
| For instance this is helpful to qualify the fetch on a related entity attributes, |
| since HAVING does not allow joins. |
| </p> |
| <P> |
| <DD><DL> |
| </DL> |
| </DD> |
| <DD><DL> |
| <DT><B>Parameters:</B><DD><CODE>parentObjEntityName</CODE> - The parentObjEntityName to set</DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="isQualifiedOnParent()"><!-- --></A><H3> |
| isQualifiedOnParent</H3> |
| <PRE> |
| public boolean <B>isQualifiedOnParent</B>()</PRE> |
| <DL> |
| <DD>Returns <code>true</code> if this query has an extra qualifier that uses a parent |
| entity of the query root entity for additional result filtering. |
| <P> |
| <DD><DL> |
| </DL> |
| </DD> |
| <DD><DL> |
| </DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="getPageSize()"><!-- --></A><H3> |
| getPageSize</H3> |
| <PRE> |
| public int <B>getPageSize</B>()</PRE> |
| <DL> |
| <DD>Returns <code>pageSize</code> property. Page size is a hint telling Cayenne |
| QueryEngine that query result should use paging instead of reading the whole result |
| in the memory. |
| <P> |
| <DD><DL> |
| <DT><B>Specified by:</B><DD><CODE><A HREF="../../../../org/apache/cayenne/query/GenericSelectQuery.html#getPageSize()">getPageSize</A></CODE> in interface <CODE><A HREF="../../../../org/apache/cayenne/query/GenericSelectQuery.html" title="interface in org.apache.cayenne.query">GenericSelectQuery</A></CODE></DL> |
| </DD> |
| <DD><DL> |
| |
| <DT><B>Returns:</B><DD>int</DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="setPageSize(int)"><!-- --></A><H3> |
| setPageSize</H3> |
| <PRE> |
| public void <B>setPageSize</B>(int pageSize)</PRE> |
| <DL> |
| <DD>Sets <code>pageSize</code> property. |
| <P> |
| <DD><DL> |
| </DL> |
| </DD> |
| <DD><DL> |
| <DT><B>Parameters:</B><DD><CODE>pageSize</CODE> - The pageSize to set</DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="isResolvingInherited()"><!-- --></A><H3> |
| isResolvingInherited</H3> |
| <PRE> |
| public boolean <B>isResolvingInherited</B>()</PRE> |
| <DL> |
| <DD>Returns true if objects fetched via this query should be fully resolved according |
| to the inheritance hierarchy. |
| <P> |
| <DD><DL> |
| <DT><B>Specified by:</B><DD><CODE><A HREF="../../../../org/apache/cayenne/query/GenericSelectQuery.html#isResolvingInherited()">isResolvingInherited</A></CODE> in interface <CODE><A HREF="../../../../org/apache/cayenne/query/GenericSelectQuery.html" title="interface in org.apache.cayenne.query">GenericSelectQuery</A></CODE></DL> |
| </DD> |
| <DD><DL> |
| <DT><B>Since:</B></DT> |
| <DD>1.1</DD> |
| </DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="setResolvingInherited(boolean)"><!-- --></A><H3> |
| setResolvingInherited</H3> |
| <PRE> |
| public void <B>setResolvingInherited</B>(boolean b)</PRE> |
| <DL> |
| <DD>Sets whether the objects fetched via this query should be fully resolved according |
| to the inheritance hierarchy. |
| <P> |
| <DD><DL> |
| </DL> |
| </DD> |
| <DD><DL> |
| <DT><B>Since:</B></DT> |
| <DD>1.1</DD> |
| </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> </TD> |
| <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A> </TD> |
| <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> <FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT> </TD> |
| <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A> </TD> |
| <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A> </TD> |
| <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../index-files/index-1.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A> </TD> |
| <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A> </TD> |
| </TR> |
| </TABLE> |
| </TD> |
| <TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM> |
| </EM> |
| </TD> |
| </TR> |
| |
| <TR> |
| <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2"> |
| <A HREF="../../../../org/apache/cayenne/query/RelationshipQuery.html" title="class in org.apache.cayenne.query"><B>PREV CLASS</B></A> |
| <A HREF="../../../../org/apache/cayenne/query/SQLAction.html" title="interface in org.apache.cayenne.query"><B>NEXT CLASS</B></A></FONT></TD> |
| <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2"> |
| <A HREF="../../../../index.html?org/apache/cayenne/query/SelectQuery.html" target="_top"><B>FRAMES</B></A> |
| <A HREF="SelectQuery.html" target="_top"><B>NO FRAMES</B></A> |
| <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: NESTED | <A HREF="#field_summary">FIELD</A> | <A HREF="#constructor_summary">CONSTR</A> | <A HREF="#method_summary">METHOD</A></FONT></TD> |
| <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2"> |
| DETAIL: <A HREF="#field_detail">FIELD</A> | <A HREF="#constructor_detail">CONSTR</A> | <A HREF="#method_detail">METHOD</A></FONT></TD> |
| </TR> |
| </TABLE> |
| <A NAME="skip-navbar_bottom"></A> |
| <!-- ======== END OF BOTTOM NAVBAR ======= --> |
| |
| <HR> |
| |
| <i>Copyright © 2001-2006 <a href= |
| "http://apache.org" target="_top">Apache.org</a> All Rights Reserved.</i> |
| |
| </BODY> |
| </HTML> |
