| <!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> |
| QueryMetadata (Apache Cayenne API Documentation - v.2.0-incubating-SNAPSHOT) |
| </TITLE> |
| |
| <META NAME="keywords" CONTENT="org.apache.cayenne.query.QueryMetadata interface"> |
| |
| <LINK REL ="stylesheet" TYPE="text/css" HREF="../../../../apache-javadoc.css" TITLE="Style"> |
| |
| <SCRIPT type="text/javascript"> |
| function windowTitle() |
| { |
| parent.document.title="QueryMetadata (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/QueryChain.html" title="class in org.apache.cayenne.query"><B>PREV CLASS</B></A> |
| <A HREF="../../../../org/apache/cayenne/query/QueryRouter.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/QueryMetadata.html" target="_top"><B>FRAMES</B></A> |
| <A HREF="QueryMetadata.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> | CONSTR | <A HREF="#method_summary">METHOD</A></FONT></TD> |
| <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2"> |
| DETAIL: <A HREF="#field_detail">FIELD</A> | CONSTR | <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> |
| Interface QueryMetadata</H2> |
| <HR> |
| <DL> |
| <DT><PRE>public interface <B>QueryMetadata</B></DL> |
| </PRE> |
| |
| <P> |
| Provides a common interface for accessing query metadata. |
| <P> |
| |
| <P> |
| <DL> |
| <DT><B>Since:</B></DT> |
| <DD>1.2</DD> |
| <DT><B>Author:</B></DT> |
| <DD>Andrus Adamchik</DD> |
| </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>static java.lang.String</CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../org/apache/cayenne/query/QueryMetadata.html#CACHE_POLICY_DEFAULT">CACHE_POLICY_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/QueryMetadata.html#CACHE_POLICY_PROPERTY">CACHE_POLICY_PROPERTY</A></B></CODE> |
| |
| <BR> |
| </TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE>static int</CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../org/apache/cayenne/query/QueryMetadata.html#FETCH_LIMIT_DEFAULT">FETCH_LIMIT_DEFAULT</A></B></CODE> |
| |
| <BR> |
| Defines default query fetch limit, which is zero, meaning that all matching rows |
| should be fetched.</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/QueryMetadata.html#FETCH_LIMIT_PROPERTY">FETCH_LIMIT_PROPERTY</A></B></CODE> |
| |
| <BR> |
| Defines the name of the property for the query <A HREF="../../../../org/apache/cayenne/query/QueryMetadata.html#getFetchLimit()"><CODE>fetch limit</CODE></A>.</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/QueryMetadata.html#FETCHING_DATA_ROWS_DEFAULT">FETCHING_DATA_ROWS_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/QueryMetadata.html#FETCHING_DATA_ROWS_PROPERTY">FETCHING_DATA_ROWS_PROPERTY</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/QueryMetadata.html#LOCAL_CACHE">LOCAL_CACHE</A></B></CODE> |
| |
| <BR> |
| A cache policy ruling that query results shall be cached separately for each |
| DataContext.</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/QueryMetadata.html#LOCAL_CACHE_REFRESH">LOCAL_CACHE_REFRESH</A></B></CODE> |
| |
| <BR> |
| Same as <A HREF="../../../../org/apache/cayenne/query/QueryMetadata.html#LOCAL_CACHE"><CODE>LOCAL_CACHE</CODE></A>, only forcing any current cache expiration.</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/QueryMetadata.html#NO_CACHE">NO_CACHE</A></B></CODE> |
| |
| <BR> |
| A cache policy that disables caching of query results.</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE>static int</CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../org/apache/cayenne/query/QueryMetadata.html#PAGE_SIZE_DEFAULT">PAGE_SIZE_DEFAULT</A></B></CODE> |
| |
| <BR> |
| Defines default query page size, which is zero for no pagination.</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/QueryMetadata.html#PAGE_SIZE_PROPERTY">PAGE_SIZE_PROPERTY</A></B></CODE> |
| |
| <BR> |
| Defines the name of the property for the query <A HREF="../../../../org/apache/cayenne/query/QueryMetadata.html#getPageSize()"><CODE>page size</CODE></A>.</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/QueryMetadata.html#REFRESHING_OBJECTS_DEFAULT">REFRESHING_OBJECTS_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/QueryMetadata.html#REFRESHING_OBJECTS_PROPERTY">REFRESHING_OBJECTS_PROPERTY</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/QueryMetadata.html#RESOLVING_INHERITED_DEFAULT">RESOLVING_INHERITED_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/QueryMetadata.html#RESOLVING_INHERITED_PROPERTY">RESOLVING_INHERITED_PROPERTY</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/QueryMetadata.html#SHARED_CACHE">SHARED_CACHE</A></B></CODE> |
| |
| <BR> |
| A cache policy ruling that query results shall be stored in a shared cache |
| accessible by all DataContexts.</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/QueryMetadata.html#SHARED_CACHE_REFRESH">SHARED_CACHE_REFRESH</A></B></CODE> |
| |
| <BR> |
| Same as <A HREF="../../../../org/apache/cayenne/query/QueryMetadata.html#SHARED_CACHE"><CODE>SHARED_CACHE</CODE></A>, only forcing any current cache expiration.</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> java.lang.String</CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../org/apache/cayenne/query/QueryMetadata.html#getCacheKey()">getCacheKey</A></B>()</CODE> |
| |
| <BR> |
| Returns a String that uniquely identifies this query for the purposes of result |
| caching.</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/QueryMetadata.html#getCachePolicy()">getCachePolicy</A></B>()</CODE> |
| |
| <BR> |
| Returns query cache policy, which can be one of <A HREF="../../../../org/apache/cayenne/query/QueryMetadata.html#NO_CACHE"><CODE>NO_CACHE</CODE></A>, |
| <A HREF="../../../../org/apache/cayenne/query/QueryMetadata.html#LOCAL_CACHE"><CODE>LOCAL_CACHE</CODE></A>, or <A HREF="../../../../org/apache/cayenne/query/QueryMetadata.html#SHARED_CACHE"><CODE>SHARED_CACHE</CODE></A>.</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE> <A HREF="../../../../org/apache/cayenne/map/DataMap.html" title="class in org.apache.cayenne.map">DataMap</A></CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../org/apache/cayenne/query/QueryMetadata.html#getDataMap()">getDataMap</A></B>()</CODE> |
| |
| <BR> |
| Returns a DataMap associated with a query or null if no such DataMap exists.</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE> <A HREF="../../../../org/apache/cayenne/map/DbEntity.html" title="class in org.apache.cayenne.map">DbEntity</A></CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../org/apache/cayenne/query/QueryMetadata.html#getDbEntity()">getDbEntity</A></B>()</CODE> |
| |
| <BR> |
| Returns a DbEntity associated with a query or null if no such entity exists.</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/QueryMetadata.html#getFetchLimit()">getFetchLimit</A></B>()</CODE> |
| |
| <BR> |
| Returns the limit on the maximium number of records that can be returned 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/QueryMetadata.html#getFetchStartIndex()">getFetchStartIndex</A></B>()</CODE> |
| |
| <BR> |
| Specifies a start of a range when fetching a subset of records.</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE> <A HREF="../../../../org/apache/cayenne/map/ObjEntity.html" title="class in org.apache.cayenne.map">ObjEntity</A></CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../org/apache/cayenne/query/QueryMetadata.html#getObjEntity()">getObjEntity</A></B>()</CODE> |
| |
| <BR> |
| Returns an ObjEntity associated with a query or null if no such entity exists.</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/QueryMetadata.html#getPageSize()">getPageSize</A></B>()</CODE> |
| |
| <BR> |
| Returns query page size.</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/QueryMetadata.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> <A HREF="../../../../org/apache/cayenne/map/Procedure.html" title="class in org.apache.cayenne.map">Procedure</A></CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../org/apache/cayenne/query/QueryMetadata.html#getProcedure()">getProcedure</A></B>()</CODE> |
| |
| <BR> |
| Returns a Procedure associated with a query or null if no such procedure exists.</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/QueryMetadata.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/QueryMetadata.html#isRefreshingObjects()">isRefreshingObjects</A></B>()</CODE> |
| |
| <BR> |
| Returns <code>true</code> if the query results should replace any currently |
| cached values, returns <code>false</code> otherwise.</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/QueryMetadata.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> |
| </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="NO_CACHE"><!-- --></A><H3> |
| NO_CACHE</H3> |
| <PRE> |
| static final java.lang.String <B>NO_CACHE</B></PRE> |
| <DL> |
| <DD>A cache policy that disables caching of query results. |
| <P> |
| <DL> |
| <DT><B>See Also:</B><DD><A HREF="../../../../constant-values.html#org.apache.cayenne.query.QueryMetadata.NO_CACHE">Constant Field Values</A></DL> |
| </DL> |
| <HR> |
| |
| <A NAME="LOCAL_CACHE"><!-- --></A><H3> |
| LOCAL_CACHE</H3> |
| <PRE> |
| static final java.lang.String <B>LOCAL_CACHE</B></PRE> |
| <DL> |
| <DD>A cache policy ruling that query results shall be cached separately for each |
| DataContext. |
| <P> |
| <DL> |
| <DT><B>See Also:</B><DD><A HREF="../../../../constant-values.html#org.apache.cayenne.query.QueryMetadata.LOCAL_CACHE">Constant Field Values</A></DL> |
| </DL> |
| <HR> |
| |
| <A NAME="LOCAL_CACHE_REFRESH"><!-- --></A><H3> |
| LOCAL_CACHE_REFRESH</H3> |
| <PRE> |
| static final java.lang.String <B>LOCAL_CACHE_REFRESH</B></PRE> |
| <DL> |
| <DD>Same as <A HREF="../../../../org/apache/cayenne/query/QueryMetadata.html#LOCAL_CACHE"><CODE>LOCAL_CACHE</CODE></A>, only forcing any current cache expiration. |
| <P> |
| <DL> |
| <DT><B>See Also:</B><DD><A HREF="../../../../constant-values.html#org.apache.cayenne.query.QueryMetadata.LOCAL_CACHE_REFRESH">Constant Field Values</A></DL> |
| </DL> |
| <HR> |
| |
| <A NAME="SHARED_CACHE"><!-- --></A><H3> |
| SHARED_CACHE</H3> |
| <PRE> |
| static final java.lang.String <B>SHARED_CACHE</B></PRE> |
| <DL> |
| <DD>A cache policy ruling that query results shall be stored in a shared cache |
| accessible by all DataContexts. |
| <P> |
| <DL> |
| <DT><B>See Also:</B><DD><A HREF="../../../../constant-values.html#org.apache.cayenne.query.QueryMetadata.SHARED_CACHE">Constant Field Values</A></DL> |
| </DL> |
| <HR> |
| |
| <A NAME="SHARED_CACHE_REFRESH"><!-- --></A><H3> |
| SHARED_CACHE_REFRESH</H3> |
| <PRE> |
| static final java.lang.String <B>SHARED_CACHE_REFRESH</B></PRE> |
| <DL> |
| <DD>Same as <A HREF="../../../../org/apache/cayenne/query/QueryMetadata.html#SHARED_CACHE"><CODE>SHARED_CACHE</CODE></A>, only forcing any current cache expiration. |
| <P> |
| <DL> |
| <DT><B>See Also:</B><DD><A HREF="../../../../constant-values.html#org.apache.cayenne.query.QueryMetadata.SHARED_CACHE_REFRESH">Constant Field Values</A></DL> |
| </DL> |
| <HR> |
| |
| <A NAME="FETCH_LIMIT_PROPERTY"><!-- --></A><H3> |
| FETCH_LIMIT_PROPERTY</H3> |
| <PRE> |
| static final java.lang.String <B>FETCH_LIMIT_PROPERTY</B></PRE> |
| <DL> |
| <DD>Defines the name of the property for the query <A HREF="../../../../org/apache/cayenne/query/QueryMetadata.html#getFetchLimit()"><CODE>fetch limit</CODE></A>. |
| <P> |
| <DL> |
| <DT><B>See Also:</B><DD><A HREF="../../../../constant-values.html#org.apache.cayenne.query.QueryMetadata.FETCH_LIMIT_PROPERTY">Constant Field Values</A></DL> |
| </DL> |
| <HR> |
| |
| <A NAME="FETCH_LIMIT_DEFAULT"><!-- --></A><H3> |
| FETCH_LIMIT_DEFAULT</H3> |
| <PRE> |
| static final int <B>FETCH_LIMIT_DEFAULT</B></PRE> |
| <DL> |
| <DD>Defines default query fetch limit, which is zero, meaning that all matching rows |
| should be fetched. |
| <P> |
| <DL> |
| <DT><B>See Also:</B><DD><A HREF="../../../../constant-values.html#org.apache.cayenne.query.QueryMetadata.FETCH_LIMIT_DEFAULT">Constant Field Values</A></DL> |
| </DL> |
| <HR> |
| |
| <A NAME="PAGE_SIZE_PROPERTY"><!-- --></A><H3> |
| PAGE_SIZE_PROPERTY</H3> |
| <PRE> |
| static final java.lang.String <B>PAGE_SIZE_PROPERTY</B></PRE> |
| <DL> |
| <DD>Defines the name of the property for the query <A HREF="../../../../org/apache/cayenne/query/QueryMetadata.html#getPageSize()"><CODE>page size</CODE></A>. |
| <P> |
| <DL> |
| <DT><B>See Also:</B><DD><A HREF="../../../../constant-values.html#org.apache.cayenne.query.QueryMetadata.PAGE_SIZE_PROPERTY">Constant Field Values</A></DL> |
| </DL> |
| <HR> |
| |
| <A NAME="PAGE_SIZE_DEFAULT"><!-- --></A><H3> |
| PAGE_SIZE_DEFAULT</H3> |
| <PRE> |
| static final int <B>PAGE_SIZE_DEFAULT</B></PRE> |
| <DL> |
| <DD>Defines default query page size, which is zero for no pagination. |
| <P> |
| <DL> |
| <DT><B>See Also:</B><DD><A HREF="../../../../constant-values.html#org.apache.cayenne.query.QueryMetadata.PAGE_SIZE_DEFAULT">Constant Field Values</A></DL> |
| </DL> |
| <HR> |
| |
| <A NAME="FETCHING_DATA_ROWS_PROPERTY"><!-- --></A><H3> |
| FETCHING_DATA_ROWS_PROPERTY</H3> |
| <PRE> |
| static final java.lang.String <B>FETCHING_DATA_ROWS_PROPERTY</B></PRE> |
| <DL> |
| <DL> |
| <DT><B>See Also:</B><DD><A HREF="../../../../constant-values.html#org.apache.cayenne.query.QueryMetadata.FETCHING_DATA_ROWS_PROPERTY">Constant Field Values</A></DL> |
| </DL> |
| <HR> |
| |
| <A NAME="FETCHING_DATA_ROWS_DEFAULT"><!-- --></A><H3> |
| FETCHING_DATA_ROWS_DEFAULT</H3> |
| <PRE> |
| static final boolean <B>FETCHING_DATA_ROWS_DEFAULT</B></PRE> |
| <DL> |
| <DL> |
| <DT><B>See Also:</B><DD><A HREF="../../../../constant-values.html#org.apache.cayenne.query.QueryMetadata.FETCHING_DATA_ROWS_DEFAULT">Constant Field Values</A></DL> |
| </DL> |
| <HR> |
| |
| <A NAME="REFRESHING_OBJECTS_PROPERTY"><!-- --></A><H3> |
| REFRESHING_OBJECTS_PROPERTY</H3> |
| <PRE> |
| static final java.lang.String <B>REFRESHING_OBJECTS_PROPERTY</B></PRE> |
| <DL> |
| <DL> |
| <DT><B>See Also:</B><DD><A HREF="../../../../constant-values.html#org.apache.cayenne.query.QueryMetadata.REFRESHING_OBJECTS_PROPERTY">Constant Field Values</A></DL> |
| </DL> |
| <HR> |
| |
| <A NAME="REFRESHING_OBJECTS_DEFAULT"><!-- --></A><H3> |
| REFRESHING_OBJECTS_DEFAULT</H3> |
| <PRE> |
| static final boolean <B>REFRESHING_OBJECTS_DEFAULT</B></PRE> |
| <DL> |
| <DL> |
| <DT><B>See Also:</B><DD><A HREF="../../../../constant-values.html#org.apache.cayenne.query.QueryMetadata.REFRESHING_OBJECTS_DEFAULT">Constant Field Values</A></DL> |
| </DL> |
| <HR> |
| |
| <A NAME="RESOLVING_INHERITED_PROPERTY"><!-- --></A><H3> |
| RESOLVING_INHERITED_PROPERTY</H3> |
| <PRE> |
| static final java.lang.String <B>RESOLVING_INHERITED_PROPERTY</B></PRE> |
| <DL> |
| <DL> |
| <DT><B>See Also:</B><DD><A HREF="../../../../constant-values.html#org.apache.cayenne.query.QueryMetadata.RESOLVING_INHERITED_PROPERTY">Constant Field Values</A></DL> |
| </DL> |
| <HR> |
| |
| <A NAME="RESOLVING_INHERITED_DEFAULT"><!-- --></A><H3> |
| RESOLVING_INHERITED_DEFAULT</H3> |
| <PRE> |
| static final boolean <B>RESOLVING_INHERITED_DEFAULT</B></PRE> |
| <DL> |
| <DL> |
| <DT><B>See Also:</B><DD><A HREF="../../../../constant-values.html#org.apache.cayenne.query.QueryMetadata.RESOLVING_INHERITED_DEFAULT">Constant Field Values</A></DL> |
| </DL> |
| <HR> |
| |
| <A NAME="CACHE_POLICY_PROPERTY"><!-- --></A><H3> |
| CACHE_POLICY_PROPERTY</H3> |
| <PRE> |
| static final java.lang.String <B>CACHE_POLICY_PROPERTY</B></PRE> |
| <DL> |
| <DL> |
| <DT><B>See Also:</B><DD><A HREF="../../../../constant-values.html#org.apache.cayenne.query.QueryMetadata.CACHE_POLICY_PROPERTY">Constant Field Values</A></DL> |
| </DL> |
| <HR> |
| |
| <A NAME="CACHE_POLICY_DEFAULT"><!-- --></A><H3> |
| CACHE_POLICY_DEFAULT</H3> |
| <PRE> |
| static final java.lang.String <B>CACHE_POLICY_DEFAULT</B></PRE> |
| <DL> |
| <DL> |
| <DT><B>See Also:</B><DD><A HREF="../../../../constant-values.html#org.apache.cayenne.query.QueryMetadata.CACHE_POLICY_DEFAULT">Constant Field Values</A></DL> |
| </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="getObjEntity()"><!-- --></A><H3> |
| getObjEntity</H3> |
| <PRE> |
| <A HREF="../../../../org/apache/cayenne/map/ObjEntity.html" title="class in org.apache.cayenne.map">ObjEntity</A> <B>getObjEntity</B>()</PRE> |
| <DL> |
| <DD>Returns an ObjEntity associated with a query or null if no such entity exists. |
| <P> |
| <DD><DL> |
| </DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="getDbEntity()"><!-- --></A><H3> |
| getDbEntity</H3> |
| <PRE> |
| <A HREF="../../../../org/apache/cayenne/map/DbEntity.html" title="class in org.apache.cayenne.map">DbEntity</A> <B>getDbEntity</B>()</PRE> |
| <DL> |
| <DD>Returns a DbEntity associated with a query or null if no such entity exists. |
| <P> |
| <DD><DL> |
| </DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="getProcedure()"><!-- --></A><H3> |
| getProcedure</H3> |
| <PRE> |
| <A HREF="../../../../org/apache/cayenne/map/Procedure.html" title="class in org.apache.cayenne.map">Procedure</A> <B>getProcedure</B>()</PRE> |
| <DL> |
| <DD>Returns a Procedure associated with a query or null if no such procedure exists. |
| <P> |
| <DD><DL> |
| </DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="getDataMap()"><!-- --></A><H3> |
| getDataMap</H3> |
| <PRE> |
| <A HREF="../../../../org/apache/cayenne/map/DataMap.html" title="class in org.apache.cayenne.map">DataMap</A> <B>getDataMap</B>()</PRE> |
| <DL> |
| <DD>Returns a DataMap associated with a query or null if no such DataMap exists. |
| <P> |
| <DD><DL> |
| </DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="getCachePolicy()"><!-- --></A><H3> |
| getCachePolicy</H3> |
| <PRE> |
| java.lang.String <B>getCachePolicy</B>()</PRE> |
| <DL> |
| <DD>Returns query cache policy, which can be one of <A HREF="../../../../org/apache/cayenne/query/QueryMetadata.html#NO_CACHE"><CODE>NO_CACHE</CODE></A>, |
| <A HREF="../../../../org/apache/cayenne/query/QueryMetadata.html#LOCAL_CACHE"><CODE>LOCAL_CACHE</CODE></A>, or <A HREF="../../../../org/apache/cayenne/query/QueryMetadata.html#SHARED_CACHE"><CODE>SHARED_CACHE</CODE></A>. NO_CACHE is generally a default |
| policy. |
| <P> |
| <DD><DL> |
| </DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="getCacheKey()"><!-- --></A><H3> |
| getCacheKey</H3> |
| <PRE> |
| java.lang.String <B>getCacheKey</B>()</PRE> |
| <DL> |
| <DD>Returns a String that uniquely identifies this query for the purposes of result |
| caching. If null is returned, no caching is performed. |
| <P> |
| <DD><DL> |
| </DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="isFetchingDataRows()"><!-- --></A><H3> |
| isFetchingDataRows</H3> |
| <PRE> |
| 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> |
| </DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="isRefreshingObjects()"><!-- --></A><H3> |
| isRefreshingObjects</H3> |
| <PRE> |
| boolean <B>isRefreshingObjects</B>()</PRE> |
| <DL> |
| <DD>Returns <code>true</code> if the query results should replace any currently |
| cached values, returns <code>false</code> otherwise. If |
| <A HREF="../../../../org/apache/cayenne/query/QueryMetadata.html#isFetchingDataRows()"><CODE>isFetchingDataRows()</CODE></A>returns <code>true</code>, this setting is not |
| applicable and has no effect. |
| <P> |
| <DD><DL> |
| </DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="isResolvingInherited()"><!-- --></A><H3> |
| isResolvingInherited</H3> |
| <PRE> |
| 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> |
| </DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="getPageSize()"><!-- --></A><H3> |
| getPageSize</H3> |
| <PRE> |
| int <B>getPageSize</B>()</PRE> |
| <DL> |
| <DD>Returns query page size. Page size is a hint to Cayenne that query should be |
| performed page by page, instead of retrieveing all results at once. If the value |
| returned is less than or equal to zero, no paging should occur. |
| <P> |
| <DD><DL> |
| </DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="getFetchStartIndex()"><!-- --></A><H3> |
| getFetchStartIndex</H3> |
| <PRE> |
| int <B>getFetchStartIndex</B>()</PRE> |
| <DL> |
| <DD>Specifies a start of a range when fetching a subset of records. The last index is |
| determined by <A HREF="../../../../org/apache/cayenne/query/QueryMetadata.html#getFetchLimit()"><CODE>getFetchLimit()</CODE></A>. |
| <P> |
| <DD><DL> |
| </DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="getFetchLimit()"><!-- --></A><H3> |
| getFetchLimit</H3> |
| <PRE> |
| int <B>getFetchLimit</B>()</PRE> |
| <DL> |
| <DD>Returns the limit on the maximium number of records that can be returned by this |
| query. If the actual number of rows in the result exceeds the fetch limit, they |
| will be discarded. One possible use of fetch limit is using it as a safeguard |
| against large result sets that may lead to the application running out of memory, |
| etc. If a fetch limit is greater or equal to zero, all rows will be returned. |
| <P> |
| <DD><DL> |
| |
| <DT><B>Returns:</B><DD>the limit on the maximium number of records that can be returned by this |
| query</DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="getPrefetchTree()"><!-- --></A><H3> |
| getPrefetchTree</H3> |
| <PRE> |
| <A HREF="../../../../org/apache/cayenne/query/PrefetchTreeNode.html" title="class in org.apache.cayenne.query">PrefetchTreeNode</A> <B>getPrefetchTree</B>()</PRE> |
| <DL> |
| <DD>Returns a root node of prefetch tree used by this query, or null of no prefetches |
| are configured. |
| <P> |
| <DD><DL> |
| </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/QueryChain.html" title="class in org.apache.cayenne.query"><B>PREV CLASS</B></A> |
| <A HREF="../../../../org/apache/cayenne/query/QueryRouter.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/QueryMetadata.html" target="_top"><B>FRAMES</B></A> |
| <A HREF="QueryMetadata.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> | CONSTR | <A HREF="#method_summary">METHOD</A></FONT></TD> |
| <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2"> |
| DETAIL: <A HREF="#field_detail">FIELD</A> | CONSTR | <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> |
