| <!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 (version 1.7.0_07) on Wed Sep 18 17:57:26 EDT 2013 --> |
| <meta http-equiv="Content-Type" content="text/html" charset="UTF-8"> |
| <title>XPathBuilder (Apache Chemistry OpenCMIS 0.10.0 API)</title> |
| <meta name="date" content="2013-09-18"> |
| <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="XPathBuilder (Apache Chemistry OpenCMIS 0.10.0 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/XPathBuilder.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/chemistry/opencmis/jcr/query/QueryTranslator.html" title="class in org.apache.chemistry.opencmis.jcr.query"><span class="strong">Prev Class</span></a></li> |
| <li>Next Class</li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="../../../../../../index.html?org/apache/chemistry/opencmis/jcr/query/XPathBuilder.html" target="_top">Frames</a></li> |
| <li><a href="XPathBuilder.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.chemistry.opencmis.jcr.query</div> |
| <h2 title="Interface XPathBuilder" class="title">Interface XPathBuilder</h2> |
| </div> |
| <div class="contentContainer"> |
| <div class="description"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <hr> |
| <br> |
| <pre>public interface <span class="strong">XPathBuilder</span></pre> |
| <div class="block">This result type of <a href="../../../../../../org/apache/chemistry/opencmis/jcr/query/EvaluatorXPath.html" title="class in org.apache.chemistry.opencmis.jcr.query"><code>EvaluatorXPath</code></a> provides means for partially evaluating |
| the underlying query's condition. This allows to determine whether there is a semantically |
| equivalent translation from the CMIS query's where clause to an XPath condition. |
| <br/> |
| Specifically <code>EvaluatorXPath</code> only supports a single folder predicate. That |
| is the original CMIS query must not contain more than one IN_TREE or IN_FOLDER |
| predicate respectively. Furthermore that single folder predicate must be affirmative. |
| A literal <code>p</code> in a boolean expression <code>X</code> is affirmative if there |
| exists a boolean expression <code>Y</code> such that <code>p ∧ Y = X</code>. |
| <em>Note</em>: a single folder predicate is affirmative if any only if |
| <a href="../../../../../../org/apache/chemistry/opencmis/jcr/query/XPathBuilder.html#eval(java.lang.Boolean)"><code><code>eval(false)</code></code></a> return <code>false</code>. |
| <br/> |
| Only if both conditions hold will the XPath translation provided the <a href="../../../../../../org/apache/chemistry/opencmis/jcr/query/XPathBuilder.html#xPath()"><code>xPath()</code></a> |
| method be valid.</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="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://download.oracle.com/javase/1.5.0/docs/api/java/lang/Boolean.html?is-external=true" title="class or interface in java.lang">Boolean</a></code></td> |
| <td class="colLast"><code><strong><a href="../../../../../../org/apache/chemistry/opencmis/jcr/query/XPathBuilder.html#eval(java.lang.Boolean)">eval</a></strong>(<a href="http://download.oracle.com/javase/1.5.0/docs/api/java/lang/Boolean.html?is-external=true" title="class or interface in java.lang">Boolean</a> folderPredicateValuation)</code> |
| <div class="block">Evaluate the query condition for a given valuation of the folder predicate terms.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code><a href="http://download.oracle.com/javase/1.5.0/docs/api/java/lang/Iterable.html?is-external=true" title="class or interface in java.lang">Iterable</a><<a href="../../../../../../org/apache/chemistry/opencmis/jcr/query/XPathBuilder.html" title="interface in org.apache.chemistry.opencmis.jcr.query">XPathBuilder</a>></code></td> |
| <td class="colLast"><code><strong><a href="../../../../../../org/apache/chemistry/opencmis/jcr/query/XPathBuilder.html#folderPredicates()">folderPredicates</a></strong>()</code> |
| <div class="block">The folder predicates contained in this query's condition.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code><a href="http://download.oracle.com/javase/1.5.0/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/chemistry/opencmis/jcr/query/XPathBuilder.html#xPath()">xPath</a></strong>()</code> |
| <div class="block">Translation of the underlying CMIS query's where clause to a XPath 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="xPath()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>xPath</h4> |
| <pre><a href="http://download.oracle.com/javase/1.5.0/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> xPath()</pre> |
| <div class="block">Translation of the underlying CMIS query's where clause to a XPath condition. |
| The string is only valid if there is no more than one folder predicate and |
| the folder predicate is in affirmative position.</div> |
| </li> |
| </ul> |
| <a name="eval(java.lang.Boolean)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>eval</h4> |
| <pre><a href="http://download.oracle.com/javase/1.5.0/docs/api/java/lang/Boolean.html?is-external=true" title="class or interface in java.lang">Boolean</a> eval(<a href="http://download.oracle.com/javase/1.5.0/docs/api/java/lang/Boolean.html?is-external=true" title="class or interface in java.lang">Boolean</a> folderPredicateValuation)</pre> |
| <div class="block">Evaluate the query condition for a given valuation of the folder predicate terms.</div> |
| <dl><dt><span class="strong">Parameters:</span></dt><dd><code>folderPredicateValuation</code> - valuation for the folder predicate terms. Use <code>null</code> |
| for none.</dd> |
| <dt><span class="strong">Returns:</span></dt><dd>result of the partial evaluation. <code>null</code> means that the value of the |
| query condition is not determined the value passed for <code>folderPredicateValuation</code>.</dd></dl> |
| </li> |
| </ul> |
| <a name="folderPredicates()"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>folderPredicates</h4> |
| <pre><a href="http://download.oracle.com/javase/1.5.0/docs/api/java/lang/Iterable.html?is-external=true" title="class or interface in java.lang">Iterable</a><<a href="../../../../../../org/apache/chemistry/opencmis/jcr/query/XPathBuilder.html" title="interface in org.apache.chemistry.opencmis.jcr.query">XPathBuilder</a>> folderPredicates()</pre> |
| <div class="block">The folder predicates contained in this query's condition.</div> |
| </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/XPathBuilder.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/chemistry/opencmis/jcr/query/QueryTranslator.html" title="class in org.apache.chemistry.opencmis.jcr.query"><span class="strong">Prev Class</span></a></li> |
| <li>Next Class</li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="../../../../../../index.html?org/apache/chemistry/opencmis/jcr/query/XPathBuilder.html" target="_top">Frames</a></li> |
| <li><a href="XPathBuilder.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 © 2009-2013 <a href="http://www.apache.org/">The Apache Software Foundation</a>. All Rights Reserved.</small></p> |
| </body> |
| </html> |