| <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd"> |
| <!-- NewPage --> |
| <html lang="it"> |
| <head> |
| <!-- Generated by javadoc (version 1.7.0_80) on Thu Jun 14 10:04:00 CEST 2018 --> |
| <meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> |
| <title>FilterListener (OpenJPA Parent POM 2.4.3 API)</title> |
| <meta name="date" content="2018-06-14"> |
| <link rel="stylesheet" type="text/css" href="../../../../../stylesheet.css" title="Style"> |
| </head> |
| <body> |
| <script type="text/javascript"><!-- |
| if (location.href.indexOf('is-external=true') == -1) { |
| parent.document.title="FilterListener (OpenJPA Parent POM 2.4.3 API)"; |
| } |
| //--> |
| </script> |
| <noscript> |
| <div>JavaScript is disabled on your browser.</div> |
| </noscript> |
| <!-- ========= START OF TOP NAVBAR ======= --> |
| <div class="topNav"><a name="navbar_top"> |
| <!-- --> |
| </a><a href="#skip-navbar_top" title="Skip navigation links"></a><a name="navbar_top_firstrow"> |
| <!-- --> |
| </a> |
| <ul class="navList" title="Navigation"> |
| <li><a href="../../../../../overview-summary.html">Overview</a></li> |
| <li><a href="package-summary.html">Package</a></li> |
| <li class="navBarCell1Rev">Class</li> |
| <li><a href="class-use/FilterListener.html">Use</a></li> |
| <li><a href="package-tree.html">Tree</a></li> |
| <li><a href="../../../../../deprecated-list.html">Deprecated</a></li> |
| <li><a href="../../../../../index-all.html">Index</a></li> |
| <li><a href="../../../../../help-doc.html">Help</a></li> |
| </ul> |
| </div> |
| <div class="subNav"> |
| <ul class="navList"> |
| <li><a href="../../../../../org/apache/openjpa/kernel/exps/ExpressionVisitor.html" title="interface in org.apache.openjpa.kernel.exps"><span class="strong">Prev Class</span></a></li> |
| <li><a href="../../../../../org/apache/openjpa/kernel/exps/InMemoryExpressionFactory.html" title="class in org.apache.openjpa.kernel.exps"><span class="strong">Next Class</span></a></li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="../../../../../index.html?org/apache/openjpa/kernel/exps/FilterListener.html" target="_top">Frames</a></li> |
| <li><a href="FilterListener.html" target="_top">No Frames</a></li> |
| </ul> |
| <ul class="navList" id="allclasses_navbar_top"> |
| <li><a href="../../../../../allclasses-noframe.html">All Classes</a></li> |
| </ul> |
| <div> |
| <script type="text/javascript"><!-- |
| allClassesLink = document.getElementById("allclasses_navbar_top"); |
| if(window==top) { |
| allClassesLink.style.display = "block"; |
| } |
| else { |
| allClassesLink.style.display = "none"; |
| } |
| //--> |
| </script> |
| </div> |
| <div> |
| <ul class="subNavList"> |
| <li>Summary: </li> |
| <li>Nested | </li> |
| <li>Field | </li> |
| <li>Constr | </li> |
| <li><a href="#method_summary">Method</a></li> |
| </ul> |
| <ul class="subNavList"> |
| <li>Detail: </li> |
| <li>Field | </li> |
| <li>Constr | </li> |
| <li><a href="#method_detail">Method</a></li> |
| </ul> |
| </div> |
| <a name="skip-navbar_top"> |
| <!-- --> |
| </a></div> |
| <!-- ========= END OF TOP NAVBAR ========= --> |
| <!-- ======== START OF CLASS DATA ======== --> |
| <div class="header"> |
| <div class="subTitle">org.apache.openjpa.kernel.exps</div> |
| <h2 title="Interface FilterListener" class="title">Interface FilterListener</h2> |
| </div> |
| <div class="contentContainer"> |
| <div class="description"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <dl> |
| <dt>All Superinterfaces:</dt> |
| <dd><a href="http://docs.oracle.com/javase/6/docs/api/java/io/Serializable.html?is-external=true" title="class or interface in java.io">Serializable</a></dd> |
| </dl> |
| <dl> |
| <dt>All Known Subinterfaces:</dt> |
| <dd><a href="../../../../../org/apache/openjpa/jdbc/kernel/exps/JDBCFilterListener.html" title="interface in org.apache.openjpa.jdbc.kernel.exps">JDBCFilterListener</a></dd> |
| </dl> |
| <dl> |
| <dt>All Known Implementing Classes:</dt> |
| <dd><a href="../../../../../org/apache/openjpa/jdbc/kernel/exps/GetColumn.html" title="class in org.apache.openjpa.jdbc.kernel.exps">GetColumn</a>, <a href="../../../../../org/apache/openjpa/jdbc/kernel/exps/JDBCStringContains.html" title="class in org.apache.openjpa.jdbc.kernel.exps">JDBCStringContains</a>, <a href="../../../../../org/apache/openjpa/jdbc/kernel/exps/JDBCWildcardMatch.html" title="class in org.apache.openjpa.jdbc.kernel.exps">JDBCWildcardMatch</a>, <a href="../../../../../org/apache/openjpa/jdbc/kernel/exps/SQLEmbed.html" title="class in org.apache.openjpa.jdbc.kernel.exps">SQLEmbed</a>, <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>, <a href="../../../../../org/apache/openjpa/kernel/exps/StringContains.html" title="class in org.apache.openjpa.kernel.exps">StringContains</a>, <a href="../../../../../org/apache/openjpa/kernel/exps/WildcardMatch.html" title="class in org.apache.openjpa.kernel.exps">WildcardMatch</a></dd> |
| </dl> |
| <hr> |
| <br> |
| <pre>public interface <span class="strong">FilterListener</span> |
| extends <a href="http://docs.oracle.com/javase/6/docs/api/java/io/Serializable.html?is-external=true" title="class or interface in java.io">Serializable</a></pre> |
| <div class="block">A filter listener extends expression filters with custom functionality.</div> |
| <dl><dt><span class="strong">Author:</span></dt> |
| <dd>Steve Kim, Abe White</dd></dl> |
| </li> |
| </ul> |
| </div> |
| <div class="summary"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <!-- ========== METHOD SUMMARY =========== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="method_summary"> |
| <!-- --> |
| </a> |
| <h3>Method Summary</h3> |
| <table class="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation"> |
| <caption><span>Methods</span><span class="tabEnd"> </span></caption> |
| <tr> |
| <th class="colFirst" scope="col">Modifier and Type</th> |
| <th class="colLast" scope="col">Method and Description</th> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code><a href="http://docs.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a></code></td> |
| <td class="colLast"><code><strong><a href="../../../../../org/apache/openjpa/kernel/exps/FilterListener.html#evaluate(java.lang.Object,%20java.lang.Class,%20java.lang.Object[],%20java.lang.Class[],%20java.lang.Object,%20org.apache.openjpa.kernel.StoreContext)">evaluate</a></strong>(<a href="http://docs.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://docs.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://docs.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://docs.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://docs.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> |
| <div class="block">Evaluate the given expression.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code>boolean</code></td> |
| <td class="colLast"><code><strong><a href="../../../../../org/apache/openjpa/kernel/exps/FilterListener.html#expectsArguments()">expectsArguments</a></strong>()</code> |
| <div class="block">Return true if this extension expects arguments to act on.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>boolean</code></td> |
| <td class="colLast"><code><strong><a href="../../../../../org/apache/openjpa/kernel/exps/FilterListener.html#expectsTarget()">expectsTarget</a></strong>()</code> |
| <div class="block">Return true if this extension expects a target to act on.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code><a href="http://docs.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a></code></td> |
| <td class="colLast"><code><strong><a href="../../../../../org/apache/openjpa/kernel/exps/FilterListener.html#getTag()">getTag</a></strong>()</code> |
| <div class="block">Return the tag that this extension listens for.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code><a href="http://docs.oracle.com/javase/6/docs/api/java/lang/Class.html?is-external=true" title="class or interface in java.lang">Class</a></code></td> |
| <td class="colLast"><code><strong><a href="../../../../../org/apache/openjpa/kernel/exps/FilterListener.html#getType(java.lang.Class,%20java.lang.Class[])">getType</a></strong>(<a href="http://docs.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://docs.oracle.com/javase/6/docs/api/java/lang/Class.html?is-external=true" title="class or interface in java.lang">Class</a>[] argClasses)</code> |
| <div class="block">Return the expected type of the result of this listener.</div> |
| </td> |
| </tr> |
| </table> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| </div> |
| <div class="details"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <!-- ============ METHOD DETAIL ========== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="method_detail"> |
| <!-- --> |
| </a> |
| <h3>Method Detail</h3> |
| <a name="getTag()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getTag</h4> |
| <pre><a href="http://docs.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> getTag()</pre> |
| <div class="block">Return the tag that this extension listens for.</div> |
| </li> |
| </ul> |
| <a name="expectsArguments()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>expectsArguments</h4> |
| <pre>boolean expectsArguments()</pre> |
| <div class="block">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>.</div> |
| </li> |
| </ul> |
| <a name="expectsTarget()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>expectsTarget</h4> |
| <pre>boolean expectsTarget()</pre> |
| <div class="block">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.</div> |
| </li> |
| </ul> |
| <a name="evaluate(java.lang.Object, java.lang.Class, java.lang.Object[], java.lang.Class[], java.lang.Object, org.apache.openjpa.kernel.StoreContext)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>evaluate</h4> |
| <pre><a href="http://docs.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a> evaluate(<a href="http://docs.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://docs.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://docs.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://docs.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://docs.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> |
| <div class="block">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.</div> |
| <dl><dt><span class="strong">Parameters:</span></dt><dd><code>target</code> - the target object / field value to act on; will be |
| null if this extension does not expect a target</dd><dd><code>targetClass</code> - the expected class of the target; given in case |
| the target evaluates to null and typing is needed</dd><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><dd><code>argClasses</code> - the expected classes of the arguments; given in case |
| an argument evaluates to null and typing is needed</dd><dd><code>candidate</code> - the candidate object being evaluated</dd><dd><code>ctx</code> - the persistence context</dd> |
| <dt><span class="strong">Returns:</span></dt><dd>the value of the extension for this candidate; if |
| this extension is an expression, this method should |
| return <a href="http://docs.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://docs.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></dd> |
| <dt><span class="strong">Throws:</span></dt> |
| <dd><code><a href="../../../../../org/apache/openjpa/util/UserException.html" title="class in org.apache.openjpa.util">UserException</a></code> - if this extension does not |
| support in-memory operation</dd></dl> |
| </li> |
| </ul> |
| <a name="getType(java.lang.Class, java.lang.Class[])"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>getType</h4> |
| <pre><a href="http://docs.oracle.com/javase/6/docs/api/java/lang/Class.html?is-external=true" title="class or interface in java.lang">Class</a> getType(<a href="http://docs.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://docs.oracle.com/javase/6/docs/api/java/lang/Class.html?is-external=true" title="class or interface in java.lang">Class</a>[] argClasses)</pre> |
| <div class="block">Return the expected type of the result of this listener.</div> |
| <dl><dt><span class="strong">Parameters:</span></dt><dd><code>targetClass</code> - the expected class of the target, or null if no target</dd><dd><code>argClasses</code> - the expected classes of the arguments, or null if |
| no arguments</dd></dl> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| </div> |
| </div> |
| <!-- ========= END OF CLASS DATA ========= --> |
| <!-- ======= START OF BOTTOM NAVBAR ====== --> |
| <div class="bottomNav"><a name="navbar_bottom"> |
| <!-- --> |
| </a><a href="#skip-navbar_bottom" title="Skip navigation links"></a><a name="navbar_bottom_firstrow"> |
| <!-- --> |
| </a> |
| <ul class="navList" title="Navigation"> |
| <li><a href="../../../../../overview-summary.html">Overview</a></li> |
| <li><a href="package-summary.html">Package</a></li> |
| <li class="navBarCell1Rev">Class</li> |
| <li><a href="class-use/FilterListener.html">Use</a></li> |
| <li><a href="package-tree.html">Tree</a></li> |
| <li><a href="../../../../../deprecated-list.html">Deprecated</a></li> |
| <li><a href="../../../../../index-all.html">Index</a></li> |
| <li><a href="../../../../../help-doc.html">Help</a></li> |
| </ul> |
| </div> |
| <div class="subNav"> |
| <ul class="navList"> |
| <li><a href="../../../../../org/apache/openjpa/kernel/exps/ExpressionVisitor.html" title="interface in org.apache.openjpa.kernel.exps"><span class="strong">Prev Class</span></a></li> |
| <li><a href="../../../../../org/apache/openjpa/kernel/exps/InMemoryExpressionFactory.html" title="class in org.apache.openjpa.kernel.exps"><span class="strong">Next Class</span></a></li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="../../../../../index.html?org/apache/openjpa/kernel/exps/FilterListener.html" target="_top">Frames</a></li> |
| <li><a href="FilterListener.html" target="_top">No Frames</a></li> |
| </ul> |
| <ul class="navList" id="allclasses_navbar_bottom"> |
| <li><a href="../../../../../allclasses-noframe.html">All Classes</a></li> |
| </ul> |
| <div> |
| <script type="text/javascript"><!-- |
| allClassesLink = document.getElementById("allclasses_navbar_bottom"); |
| if(window==top) { |
| allClassesLink.style.display = "block"; |
| } |
| else { |
| allClassesLink.style.display = "none"; |
| } |
| //--> |
| </script> |
| </div> |
| <div> |
| <ul class="subNavList"> |
| <li>Summary: </li> |
| <li>Nested | </li> |
| <li>Field | </li> |
| <li>Constr | </li> |
| <li><a href="#method_summary">Method</a></li> |
| </ul> |
| <ul class="subNavList"> |
| <li>Detail: </li> |
| <li>Field | </li> |
| <li>Constr | </li> |
| <li><a href="#method_detail">Method</a></li> |
| </ul> |
| </div> |
| <a name="skip-navbar_bottom"> |
| <!-- --> |
| </a></div> |
| <!-- ======== END OF BOTTOM NAVBAR ======= --> |
| <p class="legalCopy"><small>Copyright © 2006–2018 <a href="http://www.apache.org">Apache Software Foundation</a>. All rights reserved.</small></p> |
| </body> |
| </html> |