| <!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_121) on Fri Jan 06 19:36:28 UTC 2017 --> |
| <meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> |
| <title>Path (OpenJPA Parent POM 2.4.2 API)</title> |
| <meta name="date" content="2017-01-06"> |
| <link rel="stylesheet" type="text/css" href="../../../../../stylesheet.css" title="Style"> |
| </head> |
| <body> |
| <script type="text/javascript"><!-- |
| try { |
| if (location.href.indexOf('is-external=true') == -1) { |
| parent.document.title="Path (OpenJPA Parent POM 2.4.2 API)"; |
| } |
| } |
| catch(err) { |
| } |
| //--> |
| </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/Path.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/Parameter.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/QueryExpressions.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/Path.html" target="_top">Frames</a></li> |
| <li><a href="Path.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 Path" class="title">Interface Path</h2> |
| </div> |
| <div class="contentContainer"> |
| <div class="description"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <dl> |
| <dt>All Superinterfaces:</dt> |
| <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/kernel/exps/Value.html" title="interface in org.apache.openjpa.kernel.exps">Value</a></dd> |
| </dl> |
| <dl> |
| <dt>All Known Implementing Classes:</dt> |
| <dd><a href="../../../../../org/apache/openjpa/kernel/exps/CandidatePath.html" title="class in org.apache.openjpa.kernel.exps">CandidatePath</a>, <a href="../../../../../org/apache/openjpa/jdbc/kernel/exps/PCPath.html" title="class in org.apache.openjpa.jdbc.kernel.exps">PCPath</a></dd> |
| </dl> |
| <hr> |
| <br> |
| <pre>public interface <span class="strong">Path</span> |
| extends <a href="../../../../../org/apache/openjpa/kernel/exps/Value.html" title="interface in org.apache.openjpa.kernel.exps">Value</a></pre> |
| <div class="block">A path represents a traversal into fields of a candidate object. |
| Equivalent paths should compare equal.</div> |
| <dl><dt><span class="strong">Author:</span></dt> |
| <dd>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>void</code></td> |
| <td class="colLast"><code><strong><a href="../../../../../org/apache/openjpa/kernel/exps/Path.html#get(org.apache.openjpa.meta.FieldMetaData,%20boolean)">get</a></strong>(<a href="../../../../../org/apache/openjpa/meta/FieldMetaData.html" title="class in org.apache.openjpa.meta">FieldMetaData</a> field, |
| boolean nullTraversal)</code> |
| <div class="block">Traverse into the given field of the current object, and update |
| the current object to that field value.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><strong><a href="../../../../../org/apache/openjpa/kernel/exps/Path.html#get(org.apache.openjpa.meta.FieldMetaData,%20org.apache.openjpa.meta.XMLMetaData)">get</a></strong>(<a href="../../../../../org/apache/openjpa/meta/FieldMetaData.html" title="class in org.apache.openjpa.meta">FieldMetaData</a> fmd, |
| <a href="../../../../../org/apache/openjpa/meta/XMLMetaData.html" title="interface in org.apache.openjpa.meta">XMLMetaData</a> meta)</code> |
| <div class="block">Traverse into the given field that maps to xml column, and update |
| the current object to that field value.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><strong><a href="../../../../../org/apache/openjpa/kernel/exps/Path.html#get(org.apache.openjpa.meta.XMLMetaData,%20java.lang.String)">get</a></strong>(<a href="../../../../../org/apache/openjpa/meta/XMLMetaData.html" title="interface in org.apache.openjpa.meta">XMLMetaData</a> meta, |
| <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> name)</code> |
| <div class="block">Traverse into the gevin xpath name of the current object, and update |
| the current object to that xpath field.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><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></td> |
| <td class="colLast"><code><strong><a href="../../../../../org/apache/openjpa/kernel/exps/Path.html#getCorrelationVar()">getCorrelationVar</a></strong>()</code> </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><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></td> |
| <td class="colLast"><code><strong><a href="../../../../../org/apache/openjpa/kernel/exps/Path.html#getSchemaAlias()">getSchemaAlias</a></strong>()</code> </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code><a href="../../../../../org/apache/openjpa/meta/XMLMetaData.html" title="interface in org.apache.openjpa.meta">XMLMetaData</a></code></td> |
| <td class="colLast"><code><strong><a href="../../../../../org/apache/openjpa/kernel/exps/Path.html#getXmlMapping()">getXmlMapping</a></strong>()</code> |
| <div class="block">Return the current XPath's xmlmapping metadata.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code><a href="../../../../../org/apache/openjpa/meta/FieldMetaData.html" title="class in org.apache.openjpa.meta">FieldMetaData</a></code></td> |
| <td class="colLast"><code><strong><a href="../../../../../org/apache/openjpa/kernel/exps/Path.html#last()">last</a></strong>()</code> |
| <div class="block">Return the last field in the path, or null if the path does not |
| not contain a final field.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><strong><a href="../../../../../org/apache/openjpa/kernel/exps/Path.html#setSchemaAlias(java.lang.String)">setSchemaAlias</a></strong>(<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> schemaAlias)</code> |
| <div class="block">Set the schema alias (the identification variable) |
| this path is begin with.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><strong><a href="../../../../../org/apache/openjpa/kernel/exps/Path.html#setSubqueryContext(org.apache.openjpa.kernel.exps.Context,%20java.lang.String)">setSubqueryContext</a></strong>(<a href="../../../../../org/apache/openjpa/kernel/exps/Context.html" title="class in org.apache.openjpa.kernel.exps">Context</a> context, |
| <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> correlationVar)</code> </td> |
| </tr> |
| </table> |
| <ul class="blockList"> |
| <li class="blockList"><a name="methods_inherited_from_class_org.apache.openjpa.kernel.exps.Value"> |
| <!-- --> |
| </a> |
| <h3>Methods inherited from interface org.apache.openjpa.kernel.exps.<a href="../../../../../org/apache/openjpa/kernel/exps/Value.html" title="interface in org.apache.openjpa.kernel.exps">Value</a></h3> |
| <code><a href="../../../../../org/apache/openjpa/kernel/exps/Value.html#acceptVisit(org.apache.openjpa.kernel.exps.ExpressionVisitor)">acceptVisit</a>, <a href="../../../../../org/apache/openjpa/kernel/exps/Value.html#getAlias()">getAlias</a>, <a href="../../../../../org/apache/openjpa/kernel/exps/Value.html#getMetaData()">getMetaData</a>, <a href="../../../../../org/apache/openjpa/kernel/exps/Value.html#getName()">getName</a>, <a href="../../../../../org/apache/openjpa/kernel/exps/Value.html#getPath()">getPath</a>, <a href="../../../../../org/apache/openjpa/kernel/exps/Value.html#getSelectAs()">getSelectAs</a>, <a href="../../../../../org/apache/openjpa/kernel/exps/Value.html#getType()">getType</a>, <a href="../../../../../org/apache/openjpa/kernel/exps/Value.html#isAggregate()">isAggregate</a>, <a href="../../../../../org/apache/openjpa/kernel/exps/Value.html#isVariable()">isVariable</a>, <a href="../../../../../org/apache/openjpa/kernel/exps/Value.html#isXPath()">isXPath</a>, <a href="../../../../../org/apache/openjpa/kernel/exps/Value.html#setAlias(java.lang.String)">setAlias</a>, <a href="../../../../../org/apache/openjpa/kernel/exps/Value.html#setImplicitType(java.lang.Class)">setImplicitType</a>, <a href="../../../../../org/apache/openjpa/kernel/exps/Value.html#setMetaData(org.apache.openjpa.meta.ClassMetaData)">setMetaData</a></code></li> |
| </ul> |
| </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="get(org.apache.openjpa.meta.FieldMetaData, boolean)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>get</h4> |
| <pre>void get(<a href="../../../../../org/apache/openjpa/meta/FieldMetaData.html" title="class in org.apache.openjpa.meta">FieldMetaData</a> field, |
| boolean nullTraversal)</pre> |
| <div class="block">Traverse into the given field of the current object, and update |
| the current object to that field value.</div> |
| <dl><dt><span class="strong">Parameters:</span></dt><dd><code>nullTraversal</code> - if true, allow traversal through a null field</dd></dl> |
| </li> |
| </ul> |
| <a name="last()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>last</h4> |
| <pre><a href="../../../../../org/apache/openjpa/meta/FieldMetaData.html" title="class in org.apache.openjpa.meta">FieldMetaData</a> last()</pre> |
| <div class="block">Return the last field in the path, or null if the path does not |
| not contain a final field.</div> |
| </li> |
| </ul> |
| <a name="get(org.apache.openjpa.meta.FieldMetaData, org.apache.openjpa.meta.XMLMetaData)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>get</h4> |
| <pre>void get(<a href="../../../../../org/apache/openjpa/meta/FieldMetaData.html" title="class in org.apache.openjpa.meta">FieldMetaData</a> fmd, |
| <a href="../../../../../org/apache/openjpa/meta/XMLMetaData.html" title="interface in org.apache.openjpa.meta">XMLMetaData</a> meta)</pre> |
| <div class="block">Traverse into the given field that maps to xml column, and update |
| the current object to that field value.</div> |
| <dl><dt><span class="strong">Parameters:</span></dt><dd><code>fmd</code> - field maps to xml column</dd><dd><code>meta</code> - associated xml mapping</dd></dl> |
| </li> |
| </ul> |
| <a name="get(org.apache.openjpa.meta.XMLMetaData, java.lang.String)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>get</h4> |
| <pre>void get(<a href="../../../../../org/apache/openjpa/meta/XMLMetaData.html" title="interface in org.apache.openjpa.meta">XMLMetaData</a> meta, |
| <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> name)</pre> |
| <div class="block">Traverse into the gevin xpath name of the current object, and update |
| the current object to that xpath field.</div> |
| </li> |
| </ul> |
| <a name="getXmlMapping()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getXmlMapping</h4> |
| <pre><a href="../../../../../org/apache/openjpa/meta/XMLMetaData.html" title="interface in org.apache.openjpa.meta">XMLMetaData</a> getXmlMapping()</pre> |
| <div class="block">Return the current XPath's xmlmapping metadata.</div> |
| <dl><dt><span class="strong">Returns:</span></dt><dd>Return xmlmapping</dd></dl> |
| </li> |
| </ul> |
| <a name="setSchemaAlias(java.lang.String)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setSchemaAlias</h4> |
| <pre>void setSchemaAlias(<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> schemaAlias)</pre> |
| <div class="block">Set the schema alias (the identification variable) |
| this path is begin with.</div> |
| </li> |
| </ul> |
| <a name="getSchemaAlias()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getSchemaAlias</h4> |
| <pre><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> getSchemaAlias()</pre> |
| </li> |
| </ul> |
| <a name="setSubqueryContext(org.apache.openjpa.kernel.exps.Context, java.lang.String)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setSubqueryContext</h4> |
| <pre>void setSubqueryContext(<a href="../../../../../org/apache/openjpa/kernel/exps/Context.html" title="class in org.apache.openjpa.kernel.exps">Context</a> context, |
| <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> correlationVar)</pre> |
| </li> |
| </ul> |
| <a name="getCorrelationVar()"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>getCorrelationVar</h4> |
| <pre><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> getCorrelationVar()</pre> |
| </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/Path.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/Parameter.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/QueryExpressions.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/Path.html" target="_top">Frames</a></li> |
| <li><a href="Path.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–2017 <a href="http://www.apache.org">Apache Software Foundation</a>. All rights reserved.</small></p> |
| </body> |
| </html> |