| <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd"> |
| <!-- NewPage --> |
| <html lang="en"> |
| <head> |
| <!-- Generated by javadoc --> |
| <meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> |
| <title>SearchCondition (Apache CXF JavaDoc 3.4.5 API)</title> |
| <link rel="stylesheet" type="text/css" href="../../../../../../stylesheet.css" title="Style"> |
| <script type="text/javascript" src="../../../../../../script.js"></script> |
| </head> |
| <body> |
| <script type="text/javascript"><!-- |
| try { |
| if (location.href.indexOf('is-external=true') == -1) { |
| parent.document.title="SearchCondition (Apache CXF JavaDoc 3.4.5 API)"; |
| } |
| } |
| catch(err) { |
| } |
| //--> |
| var methods = {"i0":6,"i1":6,"i2":6,"i3":6,"i4":6,"i5":6,"i6":6}; |
| var tabs = {65535:["t0","All Methods"],2:["t2","Instance Methods"],4:["t3","Abstract Methods"]}; |
| var altColor = "altColor"; |
| var rowColor = "rowColor"; |
| var tableTab = "tableTab"; |
| var activeTableTab = "activeTableTab"; |
| </script> |
| <noscript> |
| <div>JavaScript is disabled on your browser.</div> |
| </noscript> |
| <!-- ========= START OF TOP NAVBAR ======= --> |
| <div class="topNav"><a name="navbar.top"> |
| <!-- --> |
| </a> |
| <div class="skipNav"><a href="#skip.navbar.top" title="Skip navigation links">Skip navigation links</a></div> |
| <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/SearchCondition.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 class="aboutLanguage">Apache CXF API</div> |
| </div> |
| <div class="subNav"> |
| <ul class="navList"> |
| <li><a href="../../../../../../org/apache/cxf/jaxrs/ext/search/SearchBean.html" title="class in org.apache.cxf.jaxrs.ext.search"><span class="typeNameLink">Prev Class</span></a></li> |
| <li><a href="../../../../../../org/apache/cxf/jaxrs/ext/search/SearchConditionParser.html" title="interface in org.apache.cxf.jaxrs.ext.search"><span class="typeNameLink">Next Class</span></a></li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="../../../../../../index.html?org/apache/cxf/jaxrs/ext/search/SearchCondition.html" target="_top">Frames</a></li> |
| <li><a href="SearchCondition.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.cxf.jaxrs.ext.search</div> |
| <h2 title="Interface SearchCondition" class="title">Interface SearchCondition<T></h2> |
| </div> |
| <div class="contentContainer"> |
| <div class="description"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <dl> |
| <dt><span class="paramLabel">Type Parameters:</span></dt> |
| <dd><code>T</code> - Type of the object which will be checked by SearchCondition instance</dd> |
| </dl> |
| <dl> |
| <dt>All Known Implementing Classes:</dt> |
| <dd><a href="../../../../../../org/apache/cxf/jaxrs/ext/search/AbstractComplexCondition.html" title="class in org.apache.cxf.jaxrs.ext.search">AbstractComplexCondition</a>, <a href="../../../../../../org/apache/cxf/jaxrs/ext/search/AndSearchCondition.html" title="class in org.apache.cxf.jaxrs.ext.search">AndSearchCondition</a>, <a href="../../../../../../org/apache/cxf/jaxrs/ext/search/collections/CollectionCheckCondition.html" title="class in org.apache.cxf.jaxrs.ext.search.collections">CollectionCheckCondition</a>, <a href="../../../../../../org/apache/cxf/jaxrs/ext/search/OrSearchCondition.html" title="class in org.apache.cxf.jaxrs.ext.search">OrSearchCondition</a>, <a href="../../../../../../org/apache/cxf/jaxrs/ext/search/PrimitiveSearchCondition.html" title="class in org.apache.cxf.jaxrs.ext.search">PrimitiveSearchCondition</a>, <a href="../../../../../../org/apache/cxf/jaxrs/ext/search/SimpleSearchCondition.html" title="class in org.apache.cxf.jaxrs.ext.search">SimpleSearchCondition</a></dd> |
| </dl> |
| <hr> |
| <br> |
| <pre>public interface <span class="typeNameLabel">SearchCondition<T></span></pre> |
| <div class="block">Can be used to build plain or complex/composite search conditions. |
| <p> |
| Google Collections Predicate might've been used instead, but it is too |
| generic and its apply method is not quite needed here |
| </p></div> |
| </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="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation"> |
| <caption><span id="t0" class="activeTableTab"><span>All Methods</span><span class="tabEnd"> </span></span><span id="t2" class="tableTab"><span><a href="javascript:show(2);">Instance Methods</a></span><span class="tabEnd"> </span></span><span id="t3" class="tableTab"><span><a href="javascript:show(4);">Abstract Methods</a></span><span class="tabEnd"> </span></span></caption> |
| <tr> |
| <th class="colFirst" scope="col">Modifier and Type</th> |
| <th class="colLast" scope="col">Method and Description</th> |
| </tr> |
| <tr id="i0" class="altColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/cxf/jaxrs/ext/search/SearchCondition.html#accept-org.apache.cxf.jaxrs.ext.search.SearchConditionVisitor-">accept</a></span>(<a href="../../../../../../org/apache/cxf/jaxrs/ext/search/SearchConditionVisitor.html" title="interface in org.apache.cxf.jaxrs.ext.search">SearchConditionVisitor</a><<a href="../../../../../../org/apache/cxf/jaxrs/ext/search/SearchCondition.html" title="type parameter in SearchCondition">T</a>,?> visitor)</code> |
| <div class="block">Provides a visitor which will convert this SearchCondition into |
| a custom expression, for example, into the SQL statement, etc</div> |
| </td> |
| </tr> |
| <tr id="i1" class="rowColor"> |
| <td class="colFirst"><code><a href="https://docs.oracle.com/javase/8/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util">List</a><<a href="../../../../../../org/apache/cxf/jaxrs/ext/search/SearchCondition.html" title="type parameter in SearchCondition">T</a>></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/cxf/jaxrs/ext/search/SearchCondition.html#findAll-java.util.Collection-">findAll</a></span>(<a href="https://docs.oracle.com/javase/8/docs/api/java/util/Collection.html?is-external=true" title="class or interface in java.util">Collection</a><<a href="../../../../../../org/apache/cxf/jaxrs/ext/search/SearchCondition.html" title="type parameter in SearchCondition">T</a>> pojos)</code> |
| <div class="block">Returns a list of pojos matching the condition</div> |
| </td> |
| </tr> |
| <tr id="i2" class="altColor"> |
| <td class="colFirst"><code><a href="../../../../../../org/apache/cxf/jaxrs/ext/search/SearchCondition.html" title="type parameter in SearchCondition">T</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/cxf/jaxrs/ext/search/SearchCondition.html#getCondition--">getCondition</a></span>()</code> |
| <div class="block">Some SearchConditions may use instance of T to capture the actual search criteria |
| thus making it simpler to implement isMet(T).</div> |
| </td> |
| </tr> |
| <tr id="i3" class="rowColor"> |
| <td class="colFirst"><code><a href="../../../../../../org/apache/cxf/jaxrs/ext/search/ConditionType.html" title="enum in org.apache.cxf.jaxrs.ext.search">ConditionType</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/cxf/jaxrs/ext/search/SearchCondition.html#getConditionType--">getConditionType</a></span>()</code> |
| <div class="block">Returns the type of the condition this SearchCondition represents</div> |
| </td> |
| </tr> |
| <tr id="i4" class="altColor"> |
| <td class="colFirst"><code><a href="https://docs.oracle.com/javase/8/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util">List</a><<a href="../../../../../../org/apache/cxf/jaxrs/ext/search/SearchCondition.html" title="interface in org.apache.cxf.jaxrs.ext.search">SearchCondition</a><<a href="../../../../../../org/apache/cxf/jaxrs/ext/search/SearchCondition.html" title="type parameter in SearchCondition">T</a>>></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/cxf/jaxrs/ext/search/SearchCondition.html#getSearchConditions--">getSearchConditions</a></span>()</code> |
| <div class="block">List of conditions this SearchCondition may represent.</div> |
| </td> |
| </tr> |
| <tr id="i5" class="rowColor"> |
| <td class="colFirst"><code><a href="../../../../../../org/apache/cxf/jaxrs/ext/search/PrimitiveStatement.html" title="class in org.apache.cxf.jaxrs.ext.search">PrimitiveStatement</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/cxf/jaxrs/ext/search/SearchCondition.html#getStatement--">getStatement</a></span>()</code> |
| <div class="block">Primitive statement such a > b, i < 5, etc |
| this condition may represent.</div> |
| </td> |
| </tr> |
| <tr id="i6" class="altColor"> |
| <td class="colFirst"><code>boolean</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/cxf/jaxrs/ext/search/SearchCondition.html#isMet-T-">isMet</a></span>(<a href="../../../../../../org/apache/cxf/jaxrs/ext/search/SearchCondition.html" title="type parameter in SearchCondition">T</a> pojo)</code> |
| <div class="block">Checks if the given pojo instance meets this search condition</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="isMet-java.lang.Object-"> |
| <!-- --> |
| </a><a name="isMet-T-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>isMet</h4> |
| <pre>boolean isMet(<a href="../../../../../../org/apache/cxf/jaxrs/ext/search/SearchCondition.html" title="type parameter in SearchCondition">T</a> pojo)</pre> |
| <div class="block">Checks if the given pojo instance meets this search condition</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>pojo</code> - the object which will be checked</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>true if the pojo meets this search condition, false - otherwise</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="findAll-java.util.Collection-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>findAll</h4> |
| <pre><a href="https://docs.oracle.com/javase/8/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util">List</a><<a href="../../../../../../org/apache/cxf/jaxrs/ext/search/SearchCondition.html" title="type parameter in SearchCondition">T</a>> findAll(<a href="https://docs.oracle.com/javase/8/docs/api/java/util/Collection.html?is-external=true" title="class or interface in java.util">Collection</a><<a href="../../../../../../org/apache/cxf/jaxrs/ext/search/SearchCondition.html" title="type parameter in SearchCondition">T</a>> pojos)</pre> |
| <div class="block">Returns a list of pojos matching the condition</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>pojos</code> - list of pojos</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>list of the matching pojos or null if none have been found</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getCondition--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getCondition</h4> |
| <pre><a href="../../../../../../org/apache/cxf/jaxrs/ext/search/SearchCondition.html" title="type parameter in SearchCondition">T</a> getCondition()</pre> |
| <div class="block">Some SearchConditions may use instance of T to capture the actual search criteria |
| thus making it simpler to implement isMet(T). In some cases, the code which is given |
| SearchCondition may find it more efficient to directly deal with the captured state |
| for a more efficient lookup of matching data/records as opposed to calling |
| SearchCondition.isMet for every instance of T it knows about.</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>T the captured search criteria, can be null</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getStatement--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getStatement</h4> |
| <pre><a href="../../../../../../org/apache/cxf/jaxrs/ext/search/PrimitiveStatement.html" title="class in org.apache.cxf.jaxrs.ext.search">PrimitiveStatement</a> getStatement()</pre> |
| <div class="block">Primitive statement such a > b, i < 5, etc |
| this condition may represent. Complex conditions will return null.</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>primitive search statement, can be null</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getSearchConditions--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getSearchConditions</h4> |
| <pre><a href="https://docs.oracle.com/javase/8/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util">List</a><<a href="../../../../../../org/apache/cxf/jaxrs/ext/search/SearchCondition.html" title="interface in org.apache.cxf.jaxrs.ext.search">SearchCondition</a><<a href="../../../../../../org/apache/cxf/jaxrs/ext/search/SearchCondition.html" title="type parameter in SearchCondition">T</a>>> getSearchConditions()</pre> |
| <div class="block">List of conditions this SearchCondition may represent. |
| Composite SearchConditions will return a list of conditions they are |
| composed from, primitive ones will return null</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>list of conditions, can be null</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getConditionType--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getConditionType</h4> |
| <pre><a href="../../../../../../org/apache/cxf/jaxrs/ext/search/ConditionType.html" title="enum in org.apache.cxf.jaxrs.ext.search">ConditionType</a> getConditionType()</pre> |
| <div class="block">Returns the type of the condition this SearchCondition represents</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>condition type</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="accept-org.apache.cxf.jaxrs.ext.search.SearchConditionVisitor-"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>accept</h4> |
| <pre>void accept(<a href="../../../../../../org/apache/cxf/jaxrs/ext/search/SearchConditionVisitor.html" title="interface in org.apache.cxf.jaxrs.ext.search">SearchConditionVisitor</a><<a href="../../../../../../org/apache/cxf/jaxrs/ext/search/SearchCondition.html" title="type parameter in SearchCondition">T</a>,?> visitor)</pre> |
| <div class="block">Provides a visitor which will convert this SearchCondition into |
| a custom expression, for example, into the SQL statement, etc</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>visitor</code> - </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> |
| <div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div> |
| <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/SearchCondition.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 class="aboutLanguage">Apache CXF API</div> |
| </div> |
| <div class="subNav"> |
| <ul class="navList"> |
| <li><a href="../../../../../../org/apache/cxf/jaxrs/ext/search/SearchBean.html" title="class in org.apache.cxf.jaxrs.ext.search"><span class="typeNameLink">Prev Class</span></a></li> |
| <li><a href="../../../../../../org/apache/cxf/jaxrs/ext/search/SearchConditionParser.html" title="interface in org.apache.cxf.jaxrs.ext.search"><span class="typeNameLink">Next Class</span></a></li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="../../../../../../index.html?org/apache/cxf/jaxrs/ext/search/SearchCondition.html" target="_top">Frames</a></li> |
| <li><a href="SearchCondition.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>Apache CXF</small></p> |
| </body> |
| </html> |
