| <!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_11) on Tue Feb 12 17:38:28 PST 2008 --> |
| <META http-equiv="Content-Type" content="text/html; charset=ISO-8859-1"> |
| <TITLE> |
| StoreQuery (OpenJPA 1.0.2 API) |
| </TITLE> |
| |
| <META NAME="keywords" CONTENT="org.apache.openjpa.kernel.StoreQuery interface"> |
| |
| <LINK REL ="stylesheet" TYPE="text/css" HREF="../../../../stylesheet.css" TITLE="Style"> |
| |
| <SCRIPT type="text/javascript"> |
| function windowTitle() |
| { |
| parent.document.title="StoreQuery (OpenJPA 1.0.2 API)"; |
| } |
| </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="class-use/StoreQuery.html"><FONT CLASS="NavBarFont1"><B>Use</B></FONT></A> </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-all.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/openjpa/kernel/StoreManager.html" title="interface in org.apache.openjpa.kernel"><B>PREV CLASS</B></A> |
| <A HREF="../../../../org/apache/openjpa/kernel/StoreQuery.Executor.html" title="interface in org.apache.openjpa.kernel"><B>NEXT CLASS</B></A></FONT></TD> |
| <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2"> |
| <A HREF="../../../../index.html?org/apache/openjpa/kernel/StoreQuery.html" target="_top"><B>FRAMES</B></A> |
| <A HREF="StoreQuery.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: <A HREF="#nested_class_summary">NESTED</A> | <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.openjpa.kernel</FONT> |
| <BR> |
| Interface StoreQuery</H2> |
| <DL> |
| <DT><B>All Superinterfaces:</B> <DD><A HREF="../../../../org/apache/openjpa/kernel/QueryOperations.html" title="interface in org.apache.openjpa.kernel">QueryOperations</A>, <A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/io/Serializable.html" title="class or interface in java.io">Serializable</A></DD> |
| </DL> |
| <DL> |
| <DT><B>All Known Implementing Classes:</B> <DD><A HREF="../../../../org/apache/openjpa/kernel/AbstractStoreQuery.html" title="class in org.apache.openjpa.kernel">AbstractStoreQuery</A>, <A HREF="../../../../org/apache/openjpa/kernel/ExpressionStoreQuery.html" title="class in org.apache.openjpa.kernel">ExpressionStoreQuery</A>, <A HREF="../../../../org/apache/openjpa/jdbc/kernel/JDBCStoreQuery.html" title="class in org.apache.openjpa.jdbc.kernel">JDBCStoreQuery</A>, <A HREF="../../../../org/apache/openjpa/kernel/MethodStoreQuery.html" title="class in org.apache.openjpa.kernel">MethodStoreQuery</A>, <A HREF="../../../../org/apache/openjpa/datacache/QueryCacheStoreQuery.html" title="class in org.apache.openjpa.datacache">QueryCacheStoreQuery</A>, <A HREF="../../../../org/apache/openjpa/jdbc/kernel/SQLStoreQuery.html" title="class in org.apache.openjpa.jdbc.kernel">SQLStoreQuery</A></DD> |
| </DL> |
| <HR> |
| <DL> |
| <DT><PRE>public interface <B>StoreQuery</B><DT>extends <A HREF="../../../../org/apache/openjpa/kernel/QueryOperations.html" title="interface in org.apache.openjpa.kernel">QueryOperations</A>, <A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/io/Serializable.html" title="class or interface in java.io">Serializable</A></DL> |
| </PRE> |
| |
| <P> |
| Component that executes queries against the datastore. For |
| expression-based queries, consider subclassing |
| <CODE>ExpressionStoreManagerQuery</CODE>. |
| <P> |
| |
| <P> |
| <DL> |
| <DT><B>Since:</B></DT> |
| <DD>0.4.0</DD> |
| <DT><B>Author:</B></DT> |
| <DD>Abe White</DD> |
| </DL> |
| <HR> |
| |
| <P> |
| <!-- ======== NESTED CLASS SUMMARY ======== --> |
| |
| <A NAME="nested_class_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>Nested Class Summary</B></FONT></TH> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE>static interface</CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../org/apache/openjpa/kernel/StoreQuery.Executor.html" title="interface in org.apache.openjpa.kernel">StoreQuery.Executor</A></B></CODE> |
| |
| <BR> |
| An executor provides a uniform interface to the mechanism for executing |
| either an in-memory or datastore query.</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE>static class</CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../org/apache/openjpa/kernel/StoreQuery.Range.html" title="class in org.apache.openjpa.kernel">StoreQuery.Range</A></B></CODE> |
| |
| <BR> |
| A query result range.</TD> |
| </TR> |
| </TABLE> |
| <!-- =========== 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 boolean[]</CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../org/apache/openjpa/kernel/StoreQuery.html#EMPTY_BOOLEANS">EMPTY_BOOLEANS</A></B></CODE> |
| |
| <BR> |
| </TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE>static <A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/Class.html" title="class or interface in java.lang">Class</A>[]</CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../org/apache/openjpa/kernel/StoreQuery.html#EMPTY_CLASSES">EMPTY_CLASSES</A></B></CODE> |
| |
| <BR> |
| </TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE>static <A HREF="../../../../org/apache/openjpa/meta/ClassMetaData.html" title="class in org.apache.openjpa.meta">ClassMetaData</A>[]</CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../org/apache/openjpa/kernel/StoreQuery.html#EMPTY_METAS">EMPTY_METAS</A></B></CODE> |
| |
| <BR> |
| </TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE>static <A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/Object.html" title="class or interface in java.lang">Object</A>[]</CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../org/apache/openjpa/kernel/StoreQuery.html#EMPTY_OBJECTS">EMPTY_OBJECTS</A></B></CODE> |
| |
| <BR> |
| </TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE>static <A HREF="http://jakarta.apache.org/commons/collections/api-release/org/apache/commons/collections/map/LinkedMap.html" title="class or interface in org.apache.commons.collections.map">LinkedMap</A></CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../org/apache/openjpa/kernel/StoreQuery.html#EMPTY_PARAMS">EMPTY_PARAMS</A></B></CODE> |
| |
| <BR> |
| </TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE>static <A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A>[]</CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../org/apache/openjpa/kernel/StoreQuery.html#EMPTY_STRINGS">EMPTY_STRINGS</A></B></CODE> |
| |
| <BR> |
| </TD> |
| </TR> |
| </TABLE> |
| <A NAME="fields_inherited_from_class_org.apache.openjpa.kernel.QueryOperations"><!-- --></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.openjpa.kernel.<A HREF="../../../../org/apache/openjpa/kernel/QueryOperations.html" title="interface in org.apache.openjpa.kernel">QueryOperations</A></B></TH> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD><CODE><A HREF="../../../../org/apache/openjpa/kernel/QueryOperations.html#OP_DELETE">OP_DELETE</A>, <A HREF="../../../../org/apache/openjpa/kernel/QueryOperations.html#OP_SELECT">OP_SELECT</A>, <A HREF="../../../../org/apache/openjpa/kernel/QueryOperations.html#OP_UPDATE">OP_UPDATE</A></CODE></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> <A HREF="../../../../org/apache/openjpa/kernel/exps/AggregateListener.html" title="interface in org.apache.openjpa.kernel.exps">AggregateListener</A></CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../org/apache/openjpa/kernel/StoreQuery.html#getAggregateListener(java.lang.String)">getAggregateListener</A></B>(<A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A> tag)</CODE> |
| |
| <BR> |
| Return the standard filter listener for the given tag, or null.</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE> <A HREF="../../../../org/apache/openjpa/kernel/QueryContext.html" title="interface in org.apache.openjpa.kernel">QueryContext</A></CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../org/apache/openjpa/kernel/StoreQuery.html#getContext()">getContext</A></B>()</CODE> |
| |
| <BR> |
| Return the query context that has been set.</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE> <A HREF="../../../../org/apache/openjpa/kernel/exps/FilterListener.html" title="interface in org.apache.openjpa.kernel.exps">FilterListener</A></CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../org/apache/openjpa/kernel/StoreQuery.html#getFilterListener(java.lang.String)">getFilterListener</A></B>(<A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A> tag)</CODE> |
| |
| <BR> |
| Return the standard filter listener for the given tag, or null.</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/openjpa/kernel/StoreQuery.html#invalidateCompilation()">invalidateCompilation</A></B>()</CODE> |
| |
| <BR> |
| Invalidate any internal compilation state.</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE> <A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/Object.html" title="class or interface in java.lang">Object</A></CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../org/apache/openjpa/kernel/StoreQuery.html#newCompilation()">newCompilation</A></B>()</CODE> |
| |
| <BR> |
| Create a new compilation for this query.</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE> <A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/Object.html" title="class or interface in java.lang">Object</A></CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../org/apache/openjpa/kernel/StoreQuery.html#newCompilationKey()">newCompilationKey</A></B>()</CODE> |
| |
| <BR> |
| Create a new key for caching compiled query information.</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE> <A HREF="../../../../org/apache/openjpa/kernel/StoreQuery.Executor.html" title="interface in org.apache.openjpa.kernel">StoreQuery.Executor</A></CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../org/apache/openjpa/kernel/StoreQuery.html#newDataStoreExecutor(org.apache.openjpa.meta.ClassMetaData, boolean)">newDataStoreExecutor</A></B>(<A HREF="../../../../org/apache/openjpa/meta/ClassMetaData.html" title="class in org.apache.openjpa.meta">ClassMetaData</A> meta, |
| boolean subs)</CODE> |
| |
| <BR> |
| Return an executor for datastore execution of this query.</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE> <A HREF="../../../../org/apache/openjpa/kernel/StoreQuery.Executor.html" title="interface in org.apache.openjpa.kernel">StoreQuery.Executor</A></CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../org/apache/openjpa/kernel/StoreQuery.html#newInMemoryExecutor(org.apache.openjpa.meta.ClassMetaData, boolean)">newInMemoryExecutor</A></B>(<A HREF="../../../../org/apache/openjpa/meta/ClassMetaData.html" title="class in org.apache.openjpa.meta">ClassMetaData</A> meta, |
| boolean subs)</CODE> |
| |
| <BR> |
| Return an executor for in-memory execution 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/openjpa/kernel/StoreQuery.html#populateFromCompilation(java.lang.Object)">populateFromCompilation</A></B>(<A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/Object.html" title="class or interface in java.lang">Object</A> comp)</CODE> |
| |
| <BR> |
| Populate internal data from compilation.</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/openjpa/kernel/StoreQuery.html#requiresCandidateType()">requiresCandidateType</A></B>()</CODE> |
| |
| <BR> |
| Whether this query requires a candidate class.</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/openjpa/kernel/StoreQuery.html#requiresParameterDeclarations()">requiresParameterDeclarations</A></B>()</CODE> |
| |
| <BR> |
| Whether this query requires parameters to be declared.</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/openjpa/kernel/StoreQuery.html#setContext(org.apache.openjpa.kernel.QueryContext)">setContext</A></B>(<A HREF="../../../../org/apache/openjpa/kernel/QueryContext.html" title="interface in org.apache.openjpa.kernel">QueryContext</A> ctx)</CODE> |
| |
| <BR> |
| Set the current query context.</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/openjpa/kernel/StoreQuery.html#setQuery(java.lang.Object)">setQuery</A></B>(<A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/Object.html" title="class or interface in java.lang">Object</A> query)</CODE> |
| |
| <BR> |
| This is invoked when the user or a facade creates a new query with |
| an object that the system does not recognize.</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/openjpa/kernel/StoreQuery.html#supportsAbstractExecutors()">supportsAbstractExecutors</A></B>()</CODE> |
| |
| <BR> |
| Return true if this query supports execution against abstract or |
| interface types.</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/openjpa/kernel/StoreQuery.html#supportsDataStoreExecution()">supportsDataStoreExecution</A></B>()</CODE> |
| |
| <BR> |
| True if this query supports datastore execution, false if it |
| can only run in memory.</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/openjpa/kernel/StoreQuery.html#supportsInMemoryExecution()">supportsInMemoryExecution</A></B>()</CODE> |
| |
| <BR> |
| True if this query supports in-memory execution, false if it |
| can only run against the datastore.</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/openjpa/kernel/StoreQuery.html#supportsParameterDeclarations()">supportsParameterDeclarations</A></B>()</CODE> |
| |
| <BR> |
| Whether this query supports declared parameters.</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="EMPTY_PARAMS"><!-- --></A><H3> |
| EMPTY_PARAMS</H3> |
| <PRE> |
| static final <A HREF="http://jakarta.apache.org/commons/collections/api-release/org/apache/commons/collections/map/LinkedMap.html" title="class or interface in org.apache.commons.collections.map">LinkedMap</A> <B>EMPTY_PARAMS</B></PRE> |
| <DL> |
| <DL> |
| </DL> |
| </DL> |
| <HR> |
| |
| <A NAME="EMPTY_METAS"><!-- --></A><H3> |
| EMPTY_METAS</H3> |
| <PRE> |
| static final <A HREF="../../../../org/apache/openjpa/meta/ClassMetaData.html" title="class in org.apache.openjpa.meta">ClassMetaData</A>[] <B>EMPTY_METAS</B></PRE> |
| <DL> |
| <DL> |
| </DL> |
| </DL> |
| <HR> |
| |
| <A NAME="EMPTY_STRINGS"><!-- --></A><H3> |
| EMPTY_STRINGS</H3> |
| <PRE> |
| static final <A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A>[] <B>EMPTY_STRINGS</B></PRE> |
| <DL> |
| <DL> |
| </DL> |
| </DL> |
| <HR> |
| |
| <A NAME="EMPTY_OBJECTS"><!-- --></A><H3> |
| EMPTY_OBJECTS</H3> |
| <PRE> |
| static final <A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/Object.html" title="class or interface in java.lang">Object</A>[] <B>EMPTY_OBJECTS</B></PRE> |
| <DL> |
| <DL> |
| </DL> |
| </DL> |
| <HR> |
| |
| <A NAME="EMPTY_CLASSES"><!-- --></A><H3> |
| EMPTY_CLASSES</H3> |
| <PRE> |
| static final <A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/Class.html" title="class or interface in java.lang">Class</A>[] <B>EMPTY_CLASSES</B></PRE> |
| <DL> |
| <DL> |
| </DL> |
| </DL> |
| <HR> |
| |
| <A NAME="EMPTY_BOOLEANS"><!-- --></A><H3> |
| EMPTY_BOOLEANS</H3> |
| <PRE> |
| static final boolean[] <B>EMPTY_BOOLEANS</B></PRE> |
| <DL> |
| <DL> |
| </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="getContext()"><!-- --></A><H3> |
| getContext</H3> |
| <PRE> |
| <A HREF="../../../../org/apache/openjpa/kernel/QueryContext.html" title="interface in org.apache.openjpa.kernel">QueryContext</A> <B>getContext</B>()</PRE> |
| <DL> |
| <DD>Return the query context that has been set. |
| <P> |
| <DD><DL> |
| </DL> |
| </DD> |
| <DD><DL> |
| </DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="setContext(org.apache.openjpa.kernel.QueryContext)"><!-- --></A><H3> |
| setContext</H3> |
| <PRE> |
| void <B>setContext</B>(<A HREF="../../../../org/apache/openjpa/kernel/QueryContext.html" title="interface in org.apache.openjpa.kernel">QueryContext</A> ctx)</PRE> |
| <DL> |
| <DD>Set the current query context. This will be called before use. |
| <P> |
| <DD><DL> |
| </DL> |
| </DD> |
| <DD><DL> |
| </DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="setQuery(java.lang.Object)"><!-- --></A><H3> |
| setQuery</H3> |
| <PRE> |
| boolean <B>setQuery</B>(<A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/Object.html" title="class or interface in java.lang">Object</A> query)</PRE> |
| <DL> |
| <DD>This is invoked when the user or a facade creates a new query with |
| an object that the system does not recognize. Return true if |
| the object is recognized by the store, false otherwise. |
| <P> |
| <DD><DL> |
| </DL> |
| </DD> |
| <DD><DL> |
| </DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="getFilterListener(java.lang.String)"><!-- --></A><H3> |
| getFilterListener</H3> |
| <PRE> |
| <A HREF="../../../../org/apache/openjpa/kernel/exps/FilterListener.html" title="interface in org.apache.openjpa.kernel.exps">FilterListener</A> <B>getFilterListener</B>(<A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A> tag)</PRE> |
| <DL> |
| <DD>Return the standard filter listener for the given tag, or null. |
| <P> |
| <DD><DL> |
| </DL> |
| </DD> |
| <DD><DL> |
| </DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="getAggregateListener(java.lang.String)"><!-- --></A><H3> |
| getAggregateListener</H3> |
| <PRE> |
| <A HREF="../../../../org/apache/openjpa/kernel/exps/AggregateListener.html" title="interface in org.apache.openjpa.kernel.exps">AggregateListener</A> <B>getAggregateListener</B>(<A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A> tag)</PRE> |
| <DL> |
| <DD>Return the standard filter listener for the given tag, or null. |
| <P> |
| <DD><DL> |
| </DL> |
| </DD> |
| <DD><DL> |
| </DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="newCompilationKey()"><!-- --></A><H3> |
| newCompilationKey</H3> |
| <PRE> |
| <A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/Object.html" title="class or interface in java.lang">Object</A> <B>newCompilationKey</B>()</PRE> |
| <DL> |
| <DD>Create a new key for caching compiled query information. May be null. |
| <P> |
| <DD><DL> |
| </DL> |
| </DD> |
| <DD><DL> |
| </DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="newCompilation()"><!-- --></A><H3> |
| newCompilation</H3> |
| <PRE> |
| <A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/Object.html" title="class or interface in java.lang">Object</A> <B>newCompilation</B>()</PRE> |
| <DL> |
| <DD>Create a new compilation for this query. May be null. |
| <P> |
| <DD><DL> |
| </DL> |
| </DD> |
| <DD><DL> |
| </DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="populateFromCompilation(java.lang.Object)"><!-- --></A><H3> |
| populateFromCompilation</H3> |
| <PRE> |
| void <B>populateFromCompilation</B>(<A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/Object.html" title="class or interface in java.lang">Object</A> comp)</PRE> |
| <DL> |
| <DD>Populate internal data from compilation. |
| <P> |
| <DD><DL> |
| </DL> |
| </DD> |
| <DD><DL> |
| </DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="invalidateCompilation()"><!-- --></A><H3> |
| invalidateCompilation</H3> |
| <PRE> |
| void <B>invalidateCompilation</B>()</PRE> |
| <DL> |
| <DD>Invalidate any internal compilation state. |
| <P> |
| <DD><DL> |
| </DL> |
| </DD> |
| <DD><DL> |
| </DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="supportsDataStoreExecution()"><!-- --></A><H3> |
| supportsDataStoreExecution</H3> |
| <PRE> |
| boolean <B>supportsDataStoreExecution</B>()</PRE> |
| <DL> |
| <DD>True if this query supports datastore execution, false if it |
| can only run in memory. |
| <P> |
| <DD><DL> |
| </DL> |
| </DD> |
| <DD><DL> |
| </DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="supportsInMemoryExecution()"><!-- --></A><H3> |
| supportsInMemoryExecution</H3> |
| <PRE> |
| boolean <B>supportsInMemoryExecution</B>()</PRE> |
| <DL> |
| <DD>True if this query supports in-memory execution, false if it |
| can only run against the datastore. |
| <P> |
| <DD><DL> |
| </DL> |
| </DD> |
| <DD><DL> |
| </DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="newInMemoryExecutor(org.apache.openjpa.meta.ClassMetaData, boolean)"><!-- --></A><H3> |
| newInMemoryExecutor</H3> |
| <PRE> |
| <A HREF="../../../../org/apache/openjpa/kernel/StoreQuery.Executor.html" title="interface in org.apache.openjpa.kernel">StoreQuery.Executor</A> <B>newInMemoryExecutor</B>(<A HREF="../../../../org/apache/openjpa/meta/ClassMetaData.html" title="class in org.apache.openjpa.meta">ClassMetaData</A> meta, |
| boolean subs)</PRE> |
| <DL> |
| <DD>Return an executor for in-memory execution of this query. |
| Executors must be cachable and thread safe. If this class returns |
| true from <A HREF="../../../../org/apache/openjpa/kernel/StoreQuery.html#supportsAbstractExecutors()"><CODE>supportsAbstractExecutors()</CODE></A>, the given metadata |
| will always be for the candidate class of this query, or possibly |
| null if the candidate class is not itself persistence capable (like |
| an interface or abstract base class). Otherwise, the given type will |
| be a mapped class. |
| <P> |
| <DD><DL> |
| </DL> |
| </DD> |
| <DD><DL> |
| <DT><B>Parameters:</B><DD><CODE>subs</CODE> - whether to include dependent mapped subclasses in the |
| results; independent subclasses should never be included</DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="newDataStoreExecutor(org.apache.openjpa.meta.ClassMetaData, boolean)"><!-- --></A><H3> |
| newDataStoreExecutor</H3> |
| <PRE> |
| <A HREF="../../../../org/apache/openjpa/kernel/StoreQuery.Executor.html" title="interface in org.apache.openjpa.kernel">StoreQuery.Executor</A> <B>newDataStoreExecutor</B>(<A HREF="../../../../org/apache/openjpa/meta/ClassMetaData.html" title="class in org.apache.openjpa.meta">ClassMetaData</A> meta, |
| boolean subs)</PRE> |
| <DL> |
| <DD>Return an executor for datastore execution of this query. |
| Executors must be cachable and thread safe. If this class returns |
| true from <A HREF="../../../../org/apache/openjpa/kernel/StoreQuery.html#supportsAbstractExecutors()"><CODE>supportsAbstractExecutors()</CODE></A>, the given metadata |
| will always be for the candidate class of this query, or possibly |
| null if the candidate class is not itself persistence capable (like |
| an interface or abstract base class). Otherwise, the given type will |
| be a mapped class. |
| <P> |
| <DD><DL> |
| </DL> |
| </DD> |
| <DD><DL> |
| <DT><B>Parameters:</B><DD><CODE>subs</CODE> - whether to include dependent mapped subclasses in the |
| results; independent subclasses should never be included</DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="supportsAbstractExecutors()"><!-- --></A><H3> |
| supportsAbstractExecutors</H3> |
| <PRE> |
| boolean <B>supportsAbstractExecutors</B>()</PRE> |
| <DL> |
| <DD>Return true if this query supports execution against abstract or |
| interface types. Returns false by default, meaning we will only |
| request executors for persistent classes. In this case, we will |
| automatically combine the results of the executors for all |
| implementing classes if we execute a query for an interface for |
| abstract type. |
| <P> |
| <DD><DL> |
| </DL> |
| </DD> |
| <DD><DL> |
| </DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="requiresCandidateType()"><!-- --></A><H3> |
| requiresCandidateType</H3> |
| <PRE> |
| boolean <B>requiresCandidateType</B>()</PRE> |
| <DL> |
| <DD>Whether this query requires a candidate class. |
| <P> |
| <DD><DL> |
| </DL> |
| </DD> |
| <DD><DL> |
| </DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="requiresParameterDeclarations()"><!-- --></A><H3> |
| requiresParameterDeclarations</H3> |
| <PRE> |
| boolean <B>requiresParameterDeclarations</B>()</PRE> |
| <DL> |
| <DD>Whether this query requires parameters to be declared. |
| <P> |
| <DD><DL> |
| </DL> |
| </DD> |
| <DD><DL> |
| </DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="supportsParameterDeclarations()"><!-- --></A><H3> |
| supportsParameterDeclarations</H3> |
| <PRE> |
| boolean <B>supportsParameterDeclarations</B>()</PRE> |
| <DL> |
| <DD>Whether this query supports declared parameters. |
| <P> |
| <DD><DL> |
| </DL> |
| </DD> |
| <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="class-use/StoreQuery.html"><FONT CLASS="NavBarFont1"><B>Use</B></FONT></A> </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-all.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/openjpa/kernel/StoreManager.html" title="interface in org.apache.openjpa.kernel"><B>PREV CLASS</B></A> |
| <A HREF="../../../../org/apache/openjpa/kernel/StoreQuery.Executor.html" title="interface in org.apache.openjpa.kernel"><B>NEXT CLASS</B></A></FONT></TD> |
| <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2"> |
| <A HREF="../../../../index.html?org/apache/openjpa/kernel/StoreQuery.html" target="_top"><B>FRAMES</B></A> |
| <A HREF="StoreQuery.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: <A HREF="#nested_class_summary">NESTED</A> | <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> |
| Copyright © 2006-2008 <a href="http://www.apache.org">Apache Software Foundation</a>. All Rights Reserved. |
| </BODY> |
| </HTML> |
