<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd"> | |
<!--NewPage--> | |
<HTML> | |
<HEAD> | |
<!-- Generated by javadoc (build 1.6.0_29) on Thu Nov 21 14:32:40 CET 2013 --> | |
<META http-equiv="Content-Type" content="text/html; charset=UTF-8"> | |
<TITLE> | |
SQLEmbed (OpenJPA Parent POM 2.3.0 API) | |
</TITLE> | |
<META NAME="date" CONTENT="2013-11-21"> | |
<LINK REL ="stylesheet" TYPE="text/css" HREF="../../../../../../stylesheet.css" TITLE="Style"> | |
<SCRIPT type="text/javascript"> | |
function windowTitle() | |
{ | |
if (location.href.indexOf('is-external=true') == -1) { | |
parent.document.title="SQLEmbed (OpenJPA Parent POM 2.3.0 API)"; | |
} | |
} | |
</SCRIPT> | |
<NOSCRIPT> | |
</NOSCRIPT> | |
</HEAD> | |
<BODY BGCOLOR="white" onload="windowTitle();"> | |
<HR> | |
<!-- ========= START OF TOP NAVBAR ======= --> | |
<A NAME="navbar_top"><!-- --></A> | |
<A HREF="#skip-navbar_top" title="Skip navigation links"></A> | |
<TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY=""> | |
<TR> | |
<TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> | |
<A NAME="navbar_top_firstrow"><!-- --></A> | |
<TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY=""> | |
<TR ALIGN="center" VALIGN="top"> | |
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A> </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/SQLEmbed.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/jdbc/kernel/exps/SimpleCaseExpression.html" title="class in org.apache.openjpa.jdbc.kernel.exps"><B>PREV CLASS</B></A> | |
<A HREF="../../../../../../org/apache/openjpa/jdbc/kernel/exps/SQLExpression.html" title="class in org.apache.openjpa.jdbc.kernel.exps"><B>NEXT CLASS</B></A></FONT></TD> | |
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2"> | |
<A HREF="../../../../../../index.html?org/apache/openjpa/jdbc/kernel/exps/SQLEmbed.html" target="_top"><B>FRAMES</B></A> | |
<A HREF="SQLEmbed.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.openjpa.jdbc.kernel.exps</FONT> | |
<BR> | |
Class SQLEmbed</H2> | |
<PRE> | |
<A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">java.lang.Object</A> | |
<IMG SRC="../../../../../../resources/inherit.gif" ALT="extended by "><B>org.apache.openjpa.jdbc.kernel.exps.SQLEmbed</B> | |
</PRE> | |
<DL> | |
<DT><B>All Implemented Interfaces:</B> <DD><A HREF="http://download.oracle.com/javase/6/docs/api/java/io/Serializable.html?is-external=true" title="class or interface in java.io">Serializable</A>, <A HREF="../../../../../../org/apache/openjpa/jdbc/kernel/exps/JDBCFilterListener.html" title="interface in org.apache.openjpa.jdbc.kernel.exps">JDBCFilterListener</A>, <A HREF="../../../../../../org/apache/openjpa/kernel/exps/FilterListener.html" title="interface in org.apache.openjpa.kernel.exps">FilterListener</A></DD> | |
</DL> | |
<DL> | |
<DT><B>Direct Known Subclasses:</B> <DD><A HREF="../../../../../../org/apache/openjpa/jdbc/kernel/exps/SQLExpression.html" title="class in org.apache.openjpa.jdbc.kernel.exps">SQLExpression</A>, <A HREF="../../../../../../org/apache/openjpa/jdbc/kernel/exps/SQLValue.html" title="class in org.apache.openjpa.jdbc.kernel.exps">SQLValue</A></DD> | |
</DL> | |
<HR> | |
<DL> | |
<DT><PRE>public class <B>SQLEmbed</B><DT>extends <A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</A><DT>implements <A HREF="../../../../../../org/apache/openjpa/jdbc/kernel/exps/JDBCFilterListener.html" title="interface in org.apache.openjpa.jdbc.kernel.exps">JDBCFilterListener</A></DL> | |
</PRE> | |
<P> | |
Simple listener which embeds its SQL argument into the query. Listens | |
on <code>sql</code>. | |
Example:<br /> | |
<code>"price < sql(\"(SELECT AVG (PRICE) FROM PRODUCT_TABLE)\")"</code> | |
<P> | |
<P> | |
<DL> | |
<DT><B>See Also:</B><DD><A HREF="../../../../../../serialized-form.html#org.apache.openjpa.jdbc.kernel.exps.SQLEmbed">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>static <A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A></CODE></FONT></TD> | |
<TD><CODE><B><A HREF="../../../../../../org/apache/openjpa/jdbc/kernel/exps/SQLEmbed.html#TAG">TAG</A></B></CODE> | |
<BR> | |
</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/openjpa/jdbc/kernel/exps/SQLEmbed.html#SQLEmbed()">SQLEmbed</A></B>()</CODE> | |
<BR> | |
</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/openjpa/jdbc/kernel/exps/SQLEmbed.html#appendTo(org.apache.openjpa.jdbc.sql.SQLBuffer, org.apache.openjpa.jdbc.kernel.exps.FilterValue, org.apache.openjpa.jdbc.kernel.exps.FilterValue[], org.apache.openjpa.jdbc.meta.ClassMapping, org.apache.openjpa.jdbc.kernel.JDBCStore)">appendTo</A></B>(<A HREF="../../../../../../org/apache/openjpa/jdbc/sql/SQLBuffer.html" title="class in org.apache.openjpa.jdbc.sql">SQLBuffer</A> buf, | |
<A HREF="../../../../../../org/apache/openjpa/jdbc/kernel/exps/FilterValue.html" title="interface in org.apache.openjpa.jdbc.kernel.exps">FilterValue</A> target, | |
<A HREF="../../../../../../org/apache/openjpa/jdbc/kernel/exps/FilterValue.html" title="interface in org.apache.openjpa.jdbc.kernel.exps">FilterValue</A>[] args, | |
<A HREF="../../../../../../org/apache/openjpa/jdbc/meta/ClassMapping.html" title="class in org.apache.openjpa.jdbc.meta">ClassMapping</A> type, | |
<A HREF="../../../../../../org/apache/openjpa/jdbc/kernel/JDBCStore.html" title="interface in org.apache.openjpa.jdbc.kernel">JDBCStore</A> store)</CODE> | |
<BR> | |
Append the SQL for this expression or value.</TD> | |
</TR> | |
<TR BGCOLOR="white" CLASS="TableRowColor"> | |
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> | |
<CODE> <A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</A></CODE></FONT></TD> | |
<TD><CODE><B><A HREF="../../../../../../org/apache/openjpa/jdbc/kernel/exps/SQLEmbed.html#evaluate(java.lang.Object, java.lang.Class, java.lang.Object[], java.lang.Class[], java.lang.Object, org.apache.openjpa.kernel.StoreContext)">evaluate</A></B>(<A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</A> target, | |
<A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/Class.html?is-external=true" title="class or interface in java.lang">Class</A> targetClass, | |
<A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</A>[] args, | |
<A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/Class.html?is-external=true" title="class or interface in java.lang">Class</A>[] argClasses, | |
<A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</A> candidate, | |
<A HREF="../../../../../../org/apache/openjpa/kernel/StoreContext.html" title="interface in org.apache.openjpa.kernel">StoreContext</A> ctx)</CODE> | |
<BR> | |
Evaluate the given expression.</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/jdbc/kernel/exps/SQLEmbed.html#expectsArguments()">expectsArguments</A></B>()</CODE> | |
<BR> | |
Return true if this extension expects arguments to act on.</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/jdbc/kernel/exps/SQLEmbed.html#expectsTarget()">expectsTarget</A></B>()</CODE> | |
<BR> | |
Return true if this extension expects a target to act on.</TD> | |
</TR> | |
<TR BGCOLOR="white" CLASS="TableRowColor"> | |
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> | |
<CODE> <A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A></CODE></FONT></TD> | |
<TD><CODE><B><A HREF="../../../../../../org/apache/openjpa/jdbc/kernel/exps/SQLEmbed.html#getTag()">getTag</A></B>()</CODE> | |
<BR> | |
Return the tag that this extension listens for.</TD> | |
</TR> | |
<TR BGCOLOR="white" CLASS="TableRowColor"> | |
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> | |
<CODE> <A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/Class.html?is-external=true" title="class or interface in java.lang">Class</A></CODE></FONT></TD> | |
<TD><CODE><B><A HREF="../../../../../../org/apache/openjpa/jdbc/kernel/exps/SQLEmbed.html#getType(java.lang.Class, java.lang.Class[])">getType</A></B>(<A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/Class.html?is-external=true" title="class or interface in java.lang">Class</A> targetClass, | |
<A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/Class.html?is-external=true" title="class or interface in java.lang">Class</A>[] argClasses)</CODE> | |
<BR> | |
Return the expected type of the result of this listener.</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.<A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</A></B></TH> | |
</TR> | |
<TR BGCOLOR="white" CLASS="TableRowColor"> | |
<TD><CODE><A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true#clone()" title="class or interface in java.lang">clone</A>, <A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true#equals(java.lang.Object)" title="class or interface in java.lang">equals</A>, <A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true#finalize()" title="class or interface in java.lang">finalize</A>, <A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true#getClass()" title="class or interface in java.lang">getClass</A>, <A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true#hashCode()" title="class or interface in java.lang">hashCode</A>, <A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true#notify()" title="class or interface in java.lang">notify</A>, <A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true#notifyAll()" title="class or interface in java.lang">notifyAll</A>, <A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true#toString()" title="class or interface in java.lang">toString</A>, <A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true#wait()" title="class or interface in java.lang">wait</A>, <A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true#wait(long)" title="class or interface in java.lang">wait</A>, <A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true#wait(long, int)" title="class or interface in java.lang">wait</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="TAG"><!-- --></A><H3> | |
TAG</H3> | |
<PRE> | |
public static <A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A> <B>TAG</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="SQLEmbed()"><!-- --></A><H3> | |
SQLEmbed</H3> | |
<PRE> | |
public <B>SQLEmbed</B>()</PRE> | |
<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="getTag()"><!-- --></A><H3> | |
getTag</H3> | |
<PRE> | |
public <A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A> <B>getTag</B>()</PRE> | |
<DL> | |
<DD><B>Description copied from interface: <CODE><A HREF="../../../../../../org/apache/openjpa/kernel/exps/FilterListener.html#getTag()">FilterListener</A></CODE></B></DD> | |
<DD>Return the tag that this extension listens for. | |
<P> | |
<DD><DL> | |
<DT><B>Specified by:</B><DD><CODE><A HREF="../../../../../../org/apache/openjpa/kernel/exps/FilterListener.html#getTag()">getTag</A></CODE> in interface <CODE><A HREF="../../../../../../org/apache/openjpa/kernel/exps/FilterListener.html" title="interface in org.apache.openjpa.kernel.exps">FilterListener</A></CODE></DL> | |
</DD> | |
<DD><DL> | |
</DL> | |
</DD> | |
</DL> | |
<HR> | |
<A NAME="expectsArguments()"><!-- --></A><H3> | |
expectsArguments</H3> | |
<PRE> | |
public boolean <B>expectsArguments</B>()</PRE> | |
<DL> | |
<DD><B>Description copied from interface: <CODE><A HREF="../../../../../../org/apache/openjpa/kernel/exps/FilterListener.html#expectsArguments()">FilterListener</A></CODE></B></DD> | |
<DD>Return true if this extension expects arguments to act on. Some | |
extensions may not need arguments; for example, an extension to | |
switch a string to upper case might be of the form: | |
<code>field.ext:toUpperCase ()</code>. | |
<P> | |
<DD><DL> | |
<DT><B>Specified by:</B><DD><CODE><A HREF="../../../../../../org/apache/openjpa/kernel/exps/FilterListener.html#expectsArguments()">expectsArguments</A></CODE> in interface <CODE><A HREF="../../../../../../org/apache/openjpa/kernel/exps/FilterListener.html" title="interface in org.apache.openjpa.kernel.exps">FilterListener</A></CODE></DL> | |
</DD> | |
<DD><DL> | |
</DL> | |
</DD> | |
</DL> | |
<HR> | |
<A NAME="expectsTarget()"><!-- --></A><H3> | |
expectsTarget</H3> | |
<PRE> | |
public boolean <B>expectsTarget</B>()</PRE> | |
<DL> | |
<DD><B>Description copied from interface: <CODE><A HREF="../../../../../../org/apache/openjpa/kernel/exps/FilterListener.html#expectsTarget()">FilterListener</A></CODE></B></DD> | |
<DD>Return true if this extension expects a target to act on. Some | |
extensions act on a field or object value; others stand alone. | |
<code>field.ext:toUpperCase ()</code> acts on the target | |
<code>field</code> but has no arguments, while another possible form, | |
<code>ext:toUpperCase (field)</code> has no target but does have an | |
argument. | |
<P> | |
<DD><DL> | |
<DT><B>Specified by:</B><DD><CODE><A HREF="../../../../../../org/apache/openjpa/kernel/exps/FilterListener.html#expectsTarget()">expectsTarget</A></CODE> in interface <CODE><A HREF="../../../../../../org/apache/openjpa/kernel/exps/FilterListener.html" title="interface in org.apache.openjpa.kernel.exps">FilterListener</A></CODE></DL> | |
</DD> | |
<DD><DL> | |
</DL> | |
</DD> | |
</DL> | |
<HR> | |
<A NAME="evaluate(java.lang.Object, java.lang.Class, java.lang.Object[], java.lang.Class[], java.lang.Object, org.apache.openjpa.kernel.StoreContext)"><!-- --></A><H3> | |
evaluate</H3> | |
<PRE> | |
public <A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</A> <B>evaluate</B>(<A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</A> target, | |
<A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/Class.html?is-external=true" title="class or interface in java.lang">Class</A> targetClass, | |
<A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</A>[] args, | |
<A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/Class.html?is-external=true" title="class or interface in java.lang">Class</A>[] argClasses, | |
<A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</A> candidate, | |
<A HREF="../../../../../../org/apache/openjpa/kernel/StoreContext.html" title="interface in org.apache.openjpa.kernel">StoreContext</A> ctx)</PRE> | |
<DL> | |
<DD><B>Description copied from interface: <CODE><A HREF="../../../../../../org/apache/openjpa/kernel/exps/FilterListener.html#evaluate(java.lang.Object, java.lang.Class, java.lang.Object[], java.lang.Class[], java.lang.Object, org.apache.openjpa.kernel.StoreContext)">FilterListener</A></CODE></B></DD> | |
<DD>Evaluate the given expression. This method is used when | |
evaluating in-memory expressions. The method used when evaluating | |
data store expressions will change depending on the data store in use. | |
<P> | |
<DD><DL> | |
<DT><B>Specified by:</B><DD><CODE><A HREF="../../../../../../org/apache/openjpa/kernel/exps/FilterListener.html#evaluate(java.lang.Object, java.lang.Class, java.lang.Object[], java.lang.Class[], java.lang.Object, org.apache.openjpa.kernel.StoreContext)">evaluate</A></CODE> in interface <CODE><A HREF="../../../../../../org/apache/openjpa/kernel/exps/FilterListener.html" title="interface in org.apache.openjpa.kernel.exps">FilterListener</A></CODE></DL> | |
</DD> | |
<DD><DL> | |
<DT><B>Parameters:</B><DD><CODE>target</CODE> - the target object / field value to act on; will be | |
null if this extension does not expect a target<DD><CODE>targetClass</CODE> - the expected class of the target; given in case | |
the target evaluates to null and typing is needed<DD><CODE>args</CODE> - the values of the arguments given in the filter; | |
will be null if this extension does not expect an argument<DD><CODE>argClasses</CODE> - the expected classes of the arguments; given in case | |
an argument evaluates to null and typing is needed<DD><CODE>candidate</CODE> - the candidate object being evaluated<DD><CODE>ctx</CODE> - the persistence context | |
<DT><B>Returns:</B><DD>the value of the extension for this candidate; if | |
this extension is an expression, this method should | |
return <A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/Boolean.html?is-external=true#TRUE" title="class or interface in java.lang"><CODE>Boolean.TRUE</CODE></A> or <A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/Boolean.html?is-external=true#FALSE" title="class or interface in java.lang"><CODE>Boolean.FALSE</CODE></A></DL> | |
</DD> | |
</DL> | |
<HR> | |
<A NAME="appendTo(org.apache.openjpa.jdbc.sql.SQLBuffer, org.apache.openjpa.jdbc.kernel.exps.FilterValue, org.apache.openjpa.jdbc.kernel.exps.FilterValue[], org.apache.openjpa.jdbc.meta.ClassMapping, org.apache.openjpa.jdbc.kernel.JDBCStore)"><!-- --></A><H3> | |
appendTo</H3> | |
<PRE> | |
public void <B>appendTo</B>(<A HREF="../../../../../../org/apache/openjpa/jdbc/sql/SQLBuffer.html" title="class in org.apache.openjpa.jdbc.sql">SQLBuffer</A> buf, | |
<A HREF="../../../../../../org/apache/openjpa/jdbc/kernel/exps/FilterValue.html" title="interface in org.apache.openjpa.jdbc.kernel.exps">FilterValue</A> target, | |
<A HREF="../../../../../../org/apache/openjpa/jdbc/kernel/exps/FilterValue.html" title="interface in org.apache.openjpa.jdbc.kernel.exps">FilterValue</A>[] args, | |
<A HREF="../../../../../../org/apache/openjpa/jdbc/meta/ClassMapping.html" title="class in org.apache.openjpa.jdbc.meta">ClassMapping</A> type, | |
<A HREF="../../../../../../org/apache/openjpa/jdbc/kernel/JDBCStore.html" title="interface in org.apache.openjpa.jdbc.kernel">JDBCStore</A> store)</PRE> | |
<DL> | |
<DD><B>Description copied from interface: <CODE><A HREF="../../../../../../org/apache/openjpa/jdbc/kernel/exps/JDBCFilterListener.html#appendTo(org.apache.openjpa.jdbc.sql.SQLBuffer, org.apache.openjpa.jdbc.kernel.exps.FilterValue, org.apache.openjpa.jdbc.kernel.exps.FilterValue[], org.apache.openjpa.jdbc.meta.ClassMapping, org.apache.openjpa.jdbc.kernel.JDBCStore)">JDBCFilterListener</A></CODE></B></DD> | |
<DD>Append the SQL for this expression or value. | |
<P> | |
<DD><DL> | |
<DT><B>Specified by:</B><DD><CODE><A HREF="../../../../../../org/apache/openjpa/jdbc/kernel/exps/JDBCFilterListener.html#appendTo(org.apache.openjpa.jdbc.sql.SQLBuffer, org.apache.openjpa.jdbc.kernel.exps.FilterValue, org.apache.openjpa.jdbc.kernel.exps.FilterValue[], org.apache.openjpa.jdbc.meta.ClassMapping, org.apache.openjpa.jdbc.kernel.JDBCStore)">appendTo</A></CODE> in interface <CODE><A HREF="../../../../../../org/apache/openjpa/jdbc/kernel/exps/JDBCFilterListener.html" title="interface in org.apache.openjpa.jdbc.kernel.exps">JDBCFilterListener</A></CODE></DL> | |
</DD> | |
<DD><DL> | |
<DT><B>Parameters:</B><DD><CODE>buf</CODE> - the SQL buffer to append to<DD><CODE>target</CODE> - the target to act on, or null if the listener | |
doesn't expect a target<DD><CODE>args</CODE> - the values of the arguments given in the filter, or | |
null if this listener doesn't expect arguments<DD><CODE>type</CODE> - the class mapping for the query's candidate class<DD><CODE>store</CODE> - the store that owns the query</DL> | |
</DD> | |
</DL> | |
<HR> | |
<A NAME="getType(java.lang.Class, java.lang.Class[])"><!-- --></A><H3> | |
getType</H3> | |
<PRE> | |
public <A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/Class.html?is-external=true" title="class or interface in java.lang">Class</A> <B>getType</B>(<A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/Class.html?is-external=true" title="class or interface in java.lang">Class</A> targetClass, | |
<A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/Class.html?is-external=true" title="class or interface in java.lang">Class</A>[] argClasses)</PRE> | |
<DL> | |
<DD><B>Description copied from interface: <CODE><A HREF="../../../../../../org/apache/openjpa/kernel/exps/FilterListener.html#getType(java.lang.Class, java.lang.Class[])">FilterListener</A></CODE></B></DD> | |
<DD>Return the expected type of the result of this listener. | |
<P> | |
<DD><DL> | |
<DT><B>Specified by:</B><DD><CODE><A HREF="../../../../../../org/apache/openjpa/kernel/exps/FilterListener.html#getType(java.lang.Class, java.lang.Class[])">getType</A></CODE> in interface <CODE><A HREF="../../../../../../org/apache/openjpa/kernel/exps/FilterListener.html" title="interface in org.apache.openjpa.kernel.exps">FilterListener</A></CODE></DL> | |
</DD> | |
<DD><DL> | |
<DT><B>Parameters:</B><DD><CODE>targetClass</CODE> - the expected class of the target, or null if no target<DD><CODE>argClasses</CODE> - the expected classes of the arguments, or null if | |
no arguments</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/SQLEmbed.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/jdbc/kernel/exps/SimpleCaseExpression.html" title="class in org.apache.openjpa.jdbc.kernel.exps"><B>PREV CLASS</B></A> | |
<A HREF="../../../../../../org/apache/openjpa/jdbc/kernel/exps/SQLExpression.html" title="class in org.apache.openjpa.jdbc.kernel.exps"><B>NEXT CLASS</B></A></FONT></TD> | |
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2"> | |
<A HREF="../../../../../../index.html?org/apache/openjpa/jdbc/kernel/exps/SQLEmbed.html" target="_top"><B>FRAMES</B></A> | |
<A HREF="SQLEmbed.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> | |
Copyright © 2006–2013 <a href="http://www.apache.org">Apache Software Foundation</a>. All rights reserved. | |
</BODY> | |
</HTML> |