Google Git
Sign in
apache / openjpa-site / f4f8b894b02554a0a851bbf380ef41d45c445062 / . / content / builds / 3.1.0 / apidocs / org / apache / openjpa / kernel / exps / CandidatePath.html
blob: 28bf483d127b200d450a85f2ae67ea27b10c9ef5 [file] [log] [blame]
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<!-- NewPage -->
<html lang="de">
<head>
<!-- Generated by javadoc (1.8.0_201) on Wed Apr 24 20:07:03 CEST 2019 -->
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>CandidatePath (OpenJPA Parent POM 3.1.0 API)</title>
<meta name="date" content="2019-04-24">
<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="CandidatePath (OpenJPA Parent POM 3.1.0 API)";
}
}
catch(err) {
}
//-->
var methods = {"i0":10,"i1":10,"i2":10,"i3":10,"i4":10,"i5":10,"i6":10,"i7":10,"i8":10,"i9":10,"i10":10,"i11":10,"i12":10,"i13":10,"i14":10,"i15":10};
var tabs = {65535:["t0","All Methods"],2:["t2","Instance Methods"],8:["t4","Concrete 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/CandidatePath.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/Arguments.html" title="interface in org.apache.openjpa.kernel.exps"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
<li><a href="../../../../../org/apache/openjpa/kernel/exps/CandidatePath.Traversal.html" title="class in org.apache.openjpa.kernel.exps"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../../index.html?org/apache/openjpa/kernel/exps/CandidatePath.html" target="_top">Frames</a></li>
<li><a href="CandidatePath.html" target="_top">No&nbsp;Frames</a></li>
</ul>
<ul class="navList" id="allclasses_navbar_top">
<li><a href="../../../../../allclasses-noframe.html">All&nbsp;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:&nbsp;</li>
<li><a href="#nested.class.summary">Nested</a>&nbsp;|&nbsp;</li>
<li><a href="#field.summary">Field</a>&nbsp;|&nbsp;</li>
<li><a href="#constructor.summary">Constr</a>&nbsp;|&nbsp;</li>
<li><a href="#method.summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail:&nbsp;</li>
<li><a href="#field.detail">Field</a>&nbsp;|&nbsp;</li>
<li><a href="#constructor.detail">Constr</a>&nbsp;|&nbsp;</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="Class CandidatePath" class="title">Class CandidatePath</h2>
</div>
<div class="contentContainer">
<ul class="inheritance">
<li><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">java.lang.Object</a></li>
<li>
<ul class="inheritance">
<li><a href="../../../../../org/apache/openjpa/kernel/exps/Val.html" title="class in org.apache.openjpa.kernel.exps">org.apache.openjpa.kernel.exps.Val</a></li>
<li>
<ul class="inheritance">
<li>org.apache.openjpa.kernel.exps.CandidatePath</li>
</ul>
</li>
</ul>
</li>
</ul>
<div class="description">
<ul class="blockList">
<li class="blockList">
<dl>
<dt>All Implemented Interfaces:</dt>
<dd><a href="https://docs.oracle.com/javase/8/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/Path.html" title="interface in org.apache.openjpa.kernel.exps">Path</a>, <a href="../../../../../org/apache/openjpa/kernel/exps/Value.html" title="interface in org.apache.openjpa.kernel.exps">Value</a></dd>
</dl>
<dl>
<dt>Direct Known Subclasses:</dt>
<dd><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 class <span class="typeNameLabel">CandidatePath</span>
extends <a href="../../../../../org/apache/openjpa/kernel/exps/Val.html" title="class in org.apache.openjpa.kernel.exps">Val</a>
implements <a href="../../../../../org/apache/openjpa/kernel/exps/Path.html" title="interface in org.apache.openjpa.kernel.exps">Path</a></pre>
<div class="block">A path represents a traversal into fields of a candidate object.</div>
<dl>
<dt><span class="simpleTagLabel">Author:</span></dt>
<dd>Abe White</dd>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="../../../../../serialized-form.html#org.apache.openjpa.kernel.exps.CandidatePath">Serialized Form</a></dd>
</dl>
</li>
</ul>
</div>
<div class="summary">
<ul class="blockList">
<li class="blockList">
<!-- ======== NESTED CLASS SUMMARY ======== -->
<ul class="blockList">
<li class="blockList"><a name="nested.class.summary">
<!-- -->
</a>
<h3>Nested Class Summary</h3>
<table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Nested Class Summary table, listing nested classes, and an explanation">
<caption><span>Nested Classes</span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colFirst" scope="col">Modifier and Type</th>
<th class="colLast" scope="col">Class and Description</th>
</tr>
<tr class="altColor">
<td class="colFirst"><code>static class&nbsp;</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/openjpa/kernel/exps/CandidatePath.Traversal.html" title="class in org.apache.openjpa.kernel.exps">CandidatePath.Traversal</a></span></code>
<div class="block">Represents a traversal through a field.</div>
</td>
</tr>
</table>
</li>
</ul>
<!-- =========== FIELD SUMMARY =========== -->
<ul class="blockList">
<li class="blockList"><a name="field.summary">
<!-- -->
</a>
<h3>Field Summary</h3>
<table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Field Summary table, listing fields, and an explanation">
<caption><span>Fields</span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colFirst" scope="col">Modifier and Type</th>
<th class="colLast" scope="col">Field and Description</th>
</tr>
<tr class="altColor">
<td class="colFirst"><code>protected <a href="https://docs.oracle.com/javase/8/docs/api/java/util/LinkedList.html?is-external=true" title="class or interface in java.util">LinkedList</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/openjpa/kernel/exps/CandidatePath.html#Z:Z_actions">_actions</a></span></code>&nbsp;</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>protected <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/openjpa/kernel/exps/CandidatePath.html#Z:Z_correlationVar">_correlationVar</a></span></code>&nbsp;</td>
</tr>
</table>
</li>
</ul>
<!-- ======== CONSTRUCTOR SUMMARY ======== -->
<ul class="blockList">
<li class="blockList"><a name="constructor.summary">
<!-- -->
</a>
<h3>Constructor Summary</h3>
<table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Constructor Summary table, listing constructors, and an explanation">
<caption><span>Constructors</span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colOne" scope="col">Constructor and Description</th>
</tr>
<tr class="altColor">
<td class="colOne"><code><span class="memberNameLink"><a href="../../../../../org/apache/openjpa/kernel/exps/CandidatePath.html#CandidatePath--">CandidatePath</a></span>()</code>&nbsp;</td>
</tr>
</table>
</li>
</ul>
<!-- ========== 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">&nbsp;</span></span><span id="t2" class="tableTab"><span><a href="javascript:show(2);">Instance Methods</a></span><span class="tabEnd">&nbsp;</span></span><span id="t4" class="tableTab"><span><a href="javascript:show(8);">Concrete Methods</a></span><span class="tabEnd">&nbsp;</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/openjpa/kernel/exps/CandidatePath.html#castTo-java.lang.Class-">castTo</a></span>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Class.html?is-external=true" title="class or interface in java.lang">Class</a>&nbsp;type)</code>
<div class="block">Cast this path to the given type.</div>
</td>
</tr>
<tr id="i1" class="rowColor">
<td class="colFirst"><code>boolean</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/openjpa/kernel/exps/CandidatePath.html#equals-java.lang.Object-">equals</a></span>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a>&nbsp;other)</code>&nbsp;</td>
</tr>
<tr id="i2" class="altColor">
<td class="colFirst"><code>protected <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/openjpa/kernel/exps/CandidatePath.html#eval-java.lang.Object-java.lang.Object-org.apache.openjpa.kernel.StoreContext-java.lang.Object:A-">eval</a></span>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a>&nbsp;candidate,
<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a>&nbsp;orig,
<a href="../../../../../org/apache/openjpa/kernel/StoreContext.html" title="interface in org.apache.openjpa.kernel">StoreContext</a>&nbsp;ctx,
<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a>[]&nbsp;params)</code>
<div class="block">Return this value for the given candidate.</div>
</td>
</tr>
<tr id="i3" class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/openjpa/kernel/exps/CandidatePath.html#get-org.apache.openjpa.meta.FieldMetaData-boolean-">get</a></span>(<a href="../../../../../org/apache/openjpa/meta/FieldMetaData.html" title="class in org.apache.openjpa.meta">FieldMetaData</a>&nbsp;field,
boolean&nbsp;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 id="i4" class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/openjpa/kernel/exps/CandidatePath.html#get-org.apache.openjpa.meta.FieldMetaData-org.apache.openjpa.meta.XMLMetaData-">get</a></span>(<a href="../../../../../org/apache/openjpa/meta/FieldMetaData.html" title="class in org.apache.openjpa.meta">FieldMetaData</a>&nbsp;fmd,
<a href="../../../../../org/apache/openjpa/meta/XMLMetaData.html" title="interface in org.apache.openjpa.meta">XMLMetaData</a>&nbsp;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 id="i5" class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/openjpa/kernel/exps/CandidatePath.html#get-org.apache.openjpa.meta.XMLMetaData-java.lang.String-">get</a></span>(<a href="../../../../../org/apache/openjpa/meta/XMLMetaData.html" title="interface in org.apache.openjpa.meta">XMLMetaData</a>&nbsp;meta,
<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;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 id="i6" class="altColor">
<td class="colFirst"><code>protected <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Class.html?is-external=true" title="class or interface in java.lang">Class</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/openjpa/kernel/exps/CandidatePath.html#getCandidateType--">getCandidateType</a></span>()</code>&nbsp;</td>
</tr>
<tr id="i7" class="rowColor">
<td class="colFirst"><code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/openjpa/kernel/exps/CandidatePath.html#getCorrelationVar--">getCorrelationVar</a></span>()</code>&nbsp;</td>
</tr>
<tr id="i8" class="altColor">
<td class="colFirst"><code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/openjpa/kernel/exps/CandidatePath.html#getSchemaAlias--">getSchemaAlias</a></span>()</code>&nbsp;</td>
</tr>
<tr id="i9" class="rowColor">
<td class="colFirst"><code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Class.html?is-external=true" title="class or interface in java.lang">Class</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/openjpa/kernel/exps/CandidatePath.html#getType--">getType</a></span>()</code>
<div class="block">Return the expected type for this value, or <code>Object</code> if
the type is unknown.</div>
</td>
</tr>
<tr id="i10" class="altColor">
<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><span class="memberNameLink"><a href="../../../../../org/apache/openjpa/kernel/exps/CandidatePath.html#getXmlMapping--">getXmlMapping</a></span>()</code>
<div class="block">Return the current XPath's xmlmapping metadata.</div>
</td>
</tr>
<tr id="i11" class="rowColor">
<td class="colFirst"><code>int</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/openjpa/kernel/exps/CandidatePath.html#hashCode--">hashCode</a></span>()</code>&nbsp;</td>
</tr>
<tr id="i12" 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><span class="memberNameLink"><a href="../../../../../org/apache/openjpa/kernel/exps/CandidatePath.html#last--">last</a></span>()</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 id="i13" class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/openjpa/kernel/exps/CandidatePath.html#setImplicitType-java.lang.Class-">setImplicitType</a></span>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Class.html?is-external=true" title="class or interface in java.lang">Class</a>&nbsp;type)</code>
<div class="block">Set the implicit type of the value, based on how it is used in the
filter.</div>
</td>
</tr>
<tr id="i14" class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/openjpa/kernel/exps/CandidatePath.html#setSchemaAlias-java.lang.String-">setSchemaAlias</a></span>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;schemaAlias)</code>
<div class="block">Set the schema alias (the identification variable)
this path is begin with.</div>
</td>
</tr>
<tr id="i15" class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/openjpa/kernel/exps/CandidatePath.html#setSubqueryContext-org.apache.openjpa.kernel.exps.Context-java.lang.String-">setSubqueryContext</a></span>(<a href="../../../../../org/apache/openjpa/kernel/exps/Context.html" title="class in org.apache.openjpa.kernel.exps">Context</a>&nbsp;conext,
<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;correlationVar)</code>&nbsp;</td>
</tr>
</table>
<ul class="blockList">
<li class="blockList"><a name="methods.inherited.from.class.org.apache.openjpa.kernel.exps.Val">
<!-- -->
</a>
<h3>Methods inherited from class&nbsp;org.apache.openjpa.kernel.exps.<a href="../../../../../org/apache/openjpa/kernel/exps/Val.html" title="class in org.apache.openjpa.kernel.exps">Val</a></h3>
<code><a href="../../../../../org/apache/openjpa/kernel/exps/Val.html#acceptVisit-org.apache.openjpa.kernel.exps.ExpressionVisitor-">acceptVisit</a>, <a href="../../../../../org/apache/openjpa/kernel/exps/Val.html#eval-java.util.Collection-java.lang.Object-org.apache.openjpa.kernel.StoreContext-java.lang.Object:A-">eval</a>, <a href="../../../../../org/apache/openjpa/kernel/exps/Val.html#evaluate-java.util.Collection-java.lang.Object-org.apache.openjpa.kernel.StoreContext-java.lang.Object:A-">evaluate</a>, <a href="../../../../../org/apache/openjpa/kernel/exps/Val.html#evaluate-java.lang.Object-java.lang.Object-org.apache.openjpa.kernel.StoreContext-java.lang.Object:A-">evaluate</a>, <a href="../../../../../org/apache/openjpa/kernel/exps/Val.html#getAlias--">getAlias</a>, <a href="../../../../../org/apache/openjpa/kernel/exps/Val.html#getMetaData--">getMetaData</a>, <a href="../../../../../org/apache/openjpa/kernel/exps/Val.html#getName--">getName</a>, <a href="../../../../../org/apache/openjpa/kernel/exps/Val.html#getPath--">getPath</a>, <a href="../../../../../org/apache/openjpa/kernel/exps/Val.html#getSelectAs--">getSelectAs</a>, <a href="../../../../../org/apache/openjpa/kernel/exps/Val.html#isAggregate--">isAggregate</a>, <a href="../../../../../org/apache/openjpa/kernel/exps/Val.html#isVariable--">isVariable</a>, <a href="../../../../../org/apache/openjpa/kernel/exps/Val.html#isXPath--">isXPath</a>, <a href="../../../../../org/apache/openjpa/kernel/exps/Val.html#setAlias-java.lang.String-">setAlias</a>, <a href="../../../../../org/apache/openjpa/kernel/exps/Val.html#setMetaData-org.apache.openjpa.meta.ClassMetaData-">setMetaData</a></code></li>
</ul>
<ul class="blockList">
<li class="blockList"><a name="methods.inherited.from.class.java.lang.Object">
<!-- -->
</a>
<h3>Methods inherited from class&nbsp;java.lang.<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a></h3>
<code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#clone--" title="class or interface in java.lang">clone</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#finalize--" title="class or interface in java.lang">finalize</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#getClass--" title="class or interface in java.lang">getClass</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#notify--" title="class or interface in java.lang">notify</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#notifyAll--" title="class or interface in java.lang">notifyAll</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#toString--" title="class or interface in java.lang">toString</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#wait--" title="class or interface in java.lang">wait</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#wait-long-" title="class or interface in java.lang">wait</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#wait-long-int-" title="class or interface in java.lang">wait</a></code></li>
</ul>
<ul class="blockList">
<li class="blockList"><a name="methods.inherited.from.class.org.apache.openjpa.kernel.exps.Value">
<!-- -->
</a>
<h3>Methods inherited from interface&nbsp;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#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#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">
<!-- ============ FIELD DETAIL =========== -->
<ul class="blockList">
<li class="blockList"><a name="field.detail">
<!-- -->
</a>
<h3>Field Detail</h3>
<a name="Z:Z_actions">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>_actions</h4>
<pre>protected&nbsp;<a href="https://docs.oracle.com/javase/8/docs/api/java/util/LinkedList.html?is-external=true" title="class or interface in java.util">LinkedList</a> _actions</pre>
</li>
</ul>
<a name="Z:Z_correlationVar">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>_correlationVar</h4>
<pre>protected&nbsp;<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> _correlationVar</pre>
</li>
</ul>
</li>
</ul>
<!-- ========= CONSTRUCTOR DETAIL ======== -->
<ul class="blockList">
<li class="blockList"><a name="constructor.detail">
<!-- -->
</a>
<h3>Constructor Detail</h3>
<a name="CandidatePath--">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>CandidatePath</h4>
<pre>public&nbsp;CandidatePath()</pre>
</li>
</ul>
</li>
</ul>
<!-- ============ 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>public&nbsp;void&nbsp;get(<a href="../../../../../org/apache/openjpa/meta/FieldMetaData.html" title="class in org.apache.openjpa.meta">FieldMetaData</a>&nbsp;field,
boolean&nbsp;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="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="../../../../../org/apache/openjpa/kernel/exps/Path.html#get-org.apache.openjpa.meta.FieldMetaData-boolean-">get</a></code>&nbsp;in interface&nbsp;<code><a href="../../../../../org/apache/openjpa/kernel/exps/Path.html" title="interface in org.apache.openjpa.kernel.exps">Path</a></code></dd>
<dd><code>nullTraversal</code> - if true, allow traversal through a null field</dd>
</dl>
</li>
</ul>
<a name="getType--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getType</h4>
<pre>public&nbsp;<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Class.html?is-external=true" title="class or interface in java.lang">Class</a>&nbsp;getType()</pre>
<div class="block"><span class="descfrmTypeLabel">Description copied from interface:&nbsp;<code><a href="../../../../../org/apache/openjpa/kernel/exps/Value.html#getType--">Value</a></code></span></div>
<div class="block">Return the expected type for this value, or <code>Object</code> if
the type is unknown.</div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="../../../../../org/apache/openjpa/kernel/exps/Value.html#getType--">getType</a></code>&nbsp;in interface&nbsp;<code><a href="../../../../../org/apache/openjpa/kernel/exps/Value.html" title="interface in org.apache.openjpa.kernel.exps">Value</a></code></dd>
</dl>
</li>
</ul>
<a name="getCandidateType--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getCandidateType</h4>
<pre>protected&nbsp;<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Class.html?is-external=true" title="class or interface in java.lang">Class</a>&nbsp;getCandidateType()</pre>
</li>
</ul>
<a name="setImplicitType-java.lang.Class-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setImplicitType</h4>
<pre>public&nbsp;void&nbsp;setImplicitType(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Class.html?is-external=true" title="class or interface in java.lang">Class</a>&nbsp;type)</pre>
<div class="block"><span class="descfrmTypeLabel">Description copied from interface:&nbsp;<code><a href="../../../../../org/apache/openjpa/kernel/exps/Value.html#setImplicitType-java.lang.Class-">Value</a></code></span></div>
<div class="block">Set the implicit type of the value, based on how it is used in the
filter. This method is only called on values who return
<code>Object</code> from <a href="../../../../../org/apache/openjpa/kernel/exps/Value.html#getType--"><code>Value.getType()</code></a>.</div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="../../../../../org/apache/openjpa/kernel/exps/Value.html#setImplicitType-java.lang.Class-">setImplicitType</a></code>&nbsp;in interface&nbsp;<code><a href="../../../../../org/apache/openjpa/kernel/exps/Value.html" title="interface in org.apache.openjpa.kernel.exps">Value</a></code></dd>
</dl>
</li>
</ul>
<a name="last--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>last</h4>
<pre>public&nbsp;<a href="../../../../../org/apache/openjpa/meta/FieldMetaData.html" title="class in org.apache.openjpa.meta">FieldMetaData</a>&nbsp;last()</pre>
<div class="block"><span class="descfrmTypeLabel">Description copied from interface:&nbsp;<code><a href="../../../../../org/apache/openjpa/kernel/exps/Path.html#last--">Path</a></code></span></div>
<div class="block">Return the last field in the path, or null if the path does not
not contain a final field.</div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="../../../../../org/apache/openjpa/kernel/exps/Path.html#last--">last</a></code>&nbsp;in interface&nbsp;<code><a href="../../../../../org/apache/openjpa/kernel/exps/Path.html" title="interface in org.apache.openjpa.kernel.exps">Path</a></code></dd>
</dl>
</li>
</ul>
<a name="castTo-java.lang.Class-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>castTo</h4>
<pre>public&nbsp;void&nbsp;castTo(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Class.html?is-external=true" title="class or interface in java.lang">Class</a>&nbsp;type)</pre>
<div class="block">Cast this path to the given type.</div>
</li>
</ul>
<a name="eval-java.lang.Object-java.lang.Object-org.apache.openjpa.kernel.StoreContext-java.lang.Object:A-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>eval</h4>
<pre>protected&nbsp;<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a>&nbsp;eval(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a>&nbsp;candidate,
<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a>&nbsp;orig,
<a href="../../../../../org/apache/openjpa/kernel/StoreContext.html" title="interface in org.apache.openjpa.kernel">StoreContext</a>&nbsp;ctx,
<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a>[]&nbsp;params)</pre>
<div class="block"><span class="descfrmTypeLabel">Description copied from class:&nbsp;<code><a href="../../../../../org/apache/openjpa/kernel/exps/Val.html#eval-java.lang.Object-java.lang.Object-org.apache.openjpa.kernel.StoreContext-java.lang.Object:A-">Val</a></code></span></div>
<div class="block">Return this value for the given candidate.</div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="../../../../../org/apache/openjpa/kernel/exps/Val.html#eval-java.lang.Object-java.lang.Object-org.apache.openjpa.kernel.StoreContext-java.lang.Object:A-">eval</a></code>&nbsp;in class&nbsp;<code><a href="../../../../../org/apache/openjpa/kernel/exps/Val.html" title="class in org.apache.openjpa.kernel.exps">Val</a></code></dd>
</dl>
</li>
</ul>
<a name="hashCode--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>hashCode</h4>
<pre>public&nbsp;int&nbsp;hashCode()</pre>
<dl>
<dt><span class="overrideSpecifyLabel">Overrides:</span></dt>
<dd><code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#hashCode--" title="class or interface in java.lang">hashCode</a></code>&nbsp;in class&nbsp;<code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a></code></dd>
</dl>
</li>
</ul>
<a name="equals-java.lang.Object-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>equals</h4>
<pre>public&nbsp;boolean&nbsp;equals(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a>&nbsp;other)</pre>
<dl>
<dt><span class="overrideSpecifyLabel">Overrides:</span></dt>
<dd><code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#equals-java.lang.Object-" title="class or interface in java.lang">equals</a></code>&nbsp;in class&nbsp;<code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a></code></dd>
</dl>
</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>public&nbsp;void&nbsp;get(<a href="../../../../../org/apache/openjpa/meta/FieldMetaData.html" title="class in org.apache.openjpa.meta">FieldMetaData</a>&nbsp;fmd,
<a href="../../../../../org/apache/openjpa/meta/XMLMetaData.html" title="interface in org.apache.openjpa.meta">XMLMetaData</a>&nbsp;meta)</pre>
<div class="block"><span class="descfrmTypeLabel">Description copied from interface:&nbsp;<code><a href="../../../../../org/apache/openjpa/kernel/exps/Path.html#get-org.apache.openjpa.meta.FieldMetaData-org.apache.openjpa.meta.XMLMetaData-">Path</a></code></span></div>
<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="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="../../../../../org/apache/openjpa/kernel/exps/Path.html#get-org.apache.openjpa.meta.FieldMetaData-org.apache.openjpa.meta.XMLMetaData-">get</a></code>&nbsp;in interface&nbsp;<code><a href="../../../../../org/apache/openjpa/kernel/exps/Path.html" title="interface in org.apache.openjpa.kernel.exps">Path</a></code></dd>
<dt><span class="paramLabel">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>public&nbsp;void&nbsp;get(<a href="../../../../../org/apache/openjpa/meta/XMLMetaData.html" title="interface in org.apache.openjpa.meta">XMLMetaData</a>&nbsp;meta,
<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;name)</pre>
<div class="block"><span class="descfrmTypeLabel">Description copied from interface:&nbsp;<code><a href="../../../../../org/apache/openjpa/kernel/exps/Path.html#get-org.apache.openjpa.meta.XMLMetaData-java.lang.String-">Path</a></code></span></div>
<div class="block">Traverse into the gevin xpath name of the current object, and update
the current object to that xpath field.</div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="../../../../../org/apache/openjpa/kernel/exps/Path.html#get-org.apache.openjpa.meta.XMLMetaData-java.lang.String-">get</a></code>&nbsp;in interface&nbsp;<code><a href="../../../../../org/apache/openjpa/kernel/exps/Path.html" title="interface in org.apache.openjpa.kernel.exps">Path</a></code></dd>
</dl>
</li>
</ul>
<a name="getXmlMapping--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getXmlMapping</h4>
<pre>public&nbsp;<a href="../../../../../org/apache/openjpa/meta/XMLMetaData.html" title="interface in org.apache.openjpa.meta">XMLMetaData</a>&nbsp;getXmlMapping()</pre>
<div class="block"><span class="descfrmTypeLabel">Description copied from interface:&nbsp;<code><a href="../../../../../org/apache/openjpa/kernel/exps/Path.html#getXmlMapping--">Path</a></code></span></div>
<div class="block">Return the current XPath's xmlmapping metadata.</div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="../../../../../org/apache/openjpa/kernel/exps/Path.html#getXmlMapping--">getXmlMapping</a></code>&nbsp;in interface&nbsp;<code><a href="../../../../../org/apache/openjpa/kernel/exps/Path.html" title="interface in org.apache.openjpa.kernel.exps">Path</a></code></dd>
<dt><span class="returnLabel">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>public&nbsp;void&nbsp;setSchemaAlias(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;schemaAlias)</pre>
<div class="block"><span class="descfrmTypeLabel">Description copied from interface:&nbsp;<code><a href="../../../../../org/apache/openjpa/kernel/exps/Path.html#setSchemaAlias-java.lang.String-">Path</a></code></span></div>
<div class="block">Set the schema alias (the identification variable)
this path is begin with.</div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="../../../../../org/apache/openjpa/kernel/exps/Path.html#setSchemaAlias-java.lang.String-">setSchemaAlias</a></code>&nbsp;in interface&nbsp;<code><a href="../../../../../org/apache/openjpa/kernel/exps/Path.html" title="interface in org.apache.openjpa.kernel.exps">Path</a></code></dd>
</dl>
</li>
</ul>
<a name="getSchemaAlias--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getSchemaAlias</h4>
<pre>public&nbsp;<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;getSchemaAlias()</pre>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="../../../../../org/apache/openjpa/kernel/exps/Path.html#getSchemaAlias--">getSchemaAlias</a></code>&nbsp;in interface&nbsp;<code><a href="../../../../../org/apache/openjpa/kernel/exps/Path.html" title="interface in org.apache.openjpa.kernel.exps">Path</a></code></dd>
</dl>
</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>public&nbsp;void&nbsp;setSubqueryContext(<a href="../../../../../org/apache/openjpa/kernel/exps/Context.html" title="class in org.apache.openjpa.kernel.exps">Context</a>&nbsp;conext,
<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;correlationVar)</pre>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="../../../../../org/apache/openjpa/kernel/exps/Path.html#setSubqueryContext-org.apache.openjpa.kernel.exps.Context-java.lang.String-">setSubqueryContext</a></code>&nbsp;in interface&nbsp;<code><a href="../../../../../org/apache/openjpa/kernel/exps/Path.html" title="interface in org.apache.openjpa.kernel.exps">Path</a></code></dd>
</dl>
</li>
</ul>
<a name="getCorrelationVar--">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>getCorrelationVar</h4>
<pre>public&nbsp;<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;getCorrelationVar()</pre>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="../../../../../org/apache/openjpa/kernel/exps/Path.html#getCorrelationVar--">getCorrelationVar</a></code>&nbsp;in interface&nbsp;<code><a href="../../../../../org/apache/openjpa/kernel/exps/Path.html" title="interface in org.apache.openjpa.kernel.exps">Path</a></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/CandidatePath.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/Arguments.html" title="interface in org.apache.openjpa.kernel.exps"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
<li><a href="../../../../../org/apache/openjpa/kernel/exps/CandidatePath.Traversal.html" title="class in org.apache.openjpa.kernel.exps"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../../index.html?org/apache/openjpa/kernel/exps/CandidatePath.html" target="_top">Frames</a></li>
<li><a href="CandidatePath.html" target="_top">No&nbsp;Frames</a></li>
</ul>
<ul class="navList" id="allclasses_navbar_bottom">
<li><a href="../../../../../allclasses-noframe.html">All&nbsp;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:&nbsp;</li>
<li><a href="#nested.class.summary">Nested</a>&nbsp;|&nbsp;</li>
<li><a href="#field.summary">Field</a>&nbsp;|&nbsp;</li>
<li><a href="#constructor.summary">Constr</a>&nbsp;|&nbsp;</li>
<li><a href="#method.summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail:&nbsp;</li>
<li><a href="#field.detail">Field</a>&nbsp;|&nbsp;</li>
<li><a href="#constructor.detail">Constr</a>&nbsp;|&nbsp;</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 &#169; 2006&#x2013;2019 <a href="http://www.apache.org">Apache Software Foundation</a>. All rights reserved.</small></p>
</body>
</html>