Google Git
Sign in
apache / olingo-site / refs/heads/preview/4.9.0-release-staging / . / output / javadoc / odata4 / org / apache / olingo / commons / api / edm / annotation / EdmPath.html
blob: 81bd373180a5967525d8b50c10c417aa933570d3 [file] [log] [blame]
<!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 (1.8.0_92) on Mon Aug 13 15:36:31 CEST 2018 -->
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>EdmPath (Olingo-OData 4.5.0 API)</title>
<meta name="date" content="2018-08-13">
<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="EdmPath (Olingo-OData 4.5.0 API)";
}
}
catch(err) {
}
//-->
var methods = {"i0":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/EdmPath.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/olingo/commons/api/edm/annotation/EdmOr.html" title="interface in org.apache.olingo.commons.api.edm.annotation"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
<li><a href="../../../../../../../org/apache/olingo/commons/api/edm/annotation/EdmPropertyPath.html" title="interface in org.apache.olingo.commons.api.edm.annotation"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../../../../index.html?org/apache/olingo/commons/api/edm/annotation/EdmPath.html" target="_top">Frames</a></li>
<li><a href="EdmPath.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>Nested&nbsp;|&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li>Constr&nbsp;|&nbsp;</li>
<li><a href="#method.summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail:&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li>Constr&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.olingo.commons.api.edm.annotation</div>
<h2 title="Interface EdmPath" class="title">Interface EdmPath</h2>
</div>
<div class="contentContainer">
<div class="description">
<ul class="blockList">
<li class="blockList">
<dl>
<dt>All Superinterfaces:</dt>
<dd><a href="../../../../../../../org/apache/olingo/commons/api/edm/annotation/EdmDynamicExpression.html" title="interface in org.apache.olingo.commons.api.edm.annotation">EdmDynamicExpression</a>, <a href="../../../../../../../org/apache/olingo/commons/api/edm/annotation/EdmExpression.html" title="interface in org.apache.olingo.commons.api.edm.annotation">EdmExpression</a></dd>
</dl>
<hr>
<br>
<pre>public interface <span class="typeNameLabel">EdmPath</span>
extends <a href="../../../../../../../org/apache/olingo/commons/api/edm/annotation/EdmDynamicExpression.html" title="interface in org.apache.olingo.commons.api.edm.annotation">EdmDynamicExpression</a></pre>
<div class="block">The edm:Path expression enables a value to be obtained by traversing an object graph.
It can be used in annotations that target entity containers, entity sets, entity types, complex types,
navigation properties of structured types, and properties of structured types.</div>
</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>
<ul class="blockList">
<li class="blockList"><a name="nested.classes.inherited.from.class.org.apache.olingo.commons.api.edm.annotation.EdmExpression">
<!-- -->
</a>
<h3>Nested classes/interfaces inherited from interface&nbsp;org.apache.olingo.commons.api.edm.annotation.<a href="../../../../../../../org/apache/olingo/commons/api/edm/annotation/EdmExpression.html" title="interface in org.apache.olingo.commons.api.edm.annotation">EdmExpression</a></h3>
<code><a href="../../../../../../../org/apache/olingo/commons/api/edm/annotation/EdmExpression.EdmExpressionType.html" title="enum in org.apache.olingo.commons.api.edm.annotation">EdmExpression.EdmExpressionType</a></code></li>
</ul>
</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="t3" class="tableTab"><span><a href="javascript:show(4);">Abstract 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><a href="http://docs.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../../org/apache/olingo/commons/api/edm/annotation/EdmPath.html#getValue--">getValue</a></span>()</code>
<div class="block">Returns the target value of the expression</div>
</td>
</tr>
</table>
<ul class="blockList">
<li class="blockList"><a name="methods.inherited.from.class.org.apache.olingo.commons.api.edm.annotation.EdmDynamicExpression">
<!-- -->
</a>
<h3>Methods inherited from interface&nbsp;org.apache.olingo.commons.api.edm.annotation.<a href="../../../../../../../org/apache/olingo/commons/api/edm/annotation/EdmDynamicExpression.html" title="interface in org.apache.olingo.commons.api.edm.annotation">EdmDynamicExpression</a></h3>
<code><a href="../../../../../../../org/apache/olingo/commons/api/edm/annotation/EdmDynamicExpression.html#asAnd--">asAnd</a>, <a href="../../../../../../../org/apache/olingo/commons/api/edm/annotation/EdmDynamicExpression.html#asAnnotationPath--">asAnnotationPath</a>, <a href="../../../../../../../org/apache/olingo/commons/api/edm/annotation/EdmDynamicExpression.html#asApply--">asApply</a>, <a href="../../../../../../../org/apache/olingo/commons/api/edm/annotation/EdmDynamicExpression.html#asCast--">asCast</a>, <a href="../../../../../../../org/apache/olingo/commons/api/edm/annotation/EdmDynamicExpression.html#asCollection--">asCollection</a>, <a href="../../../../../../../org/apache/olingo/commons/api/edm/annotation/EdmDynamicExpression.html#asEq--">asEq</a>, <a href="../../../../../../../org/apache/olingo/commons/api/edm/annotation/EdmDynamicExpression.html#asGe--">asGe</a>, <a href="../../../../../../../org/apache/olingo/commons/api/edm/annotation/EdmDynamicExpression.html#asGt--">asGt</a>, <a href="../../../../../../../org/apache/olingo/commons/api/edm/annotation/EdmDynamicExpression.html#asIf--">asIf</a>, <a href="../../../../../../../org/apache/olingo/commons/api/edm/annotation/EdmDynamicExpression.html#asIsOf--">asIsOf</a>, <a href="../../../../../../../org/apache/olingo/commons/api/edm/annotation/EdmDynamicExpression.html#asLabeledElement--">asLabeledElement</a>, <a href="../../../../../../../org/apache/olingo/commons/api/edm/annotation/EdmDynamicExpression.html#asLabeledElementReference--">asLabeledElementReference</a>, <a href="../../../../../../../org/apache/olingo/commons/api/edm/annotation/EdmDynamicExpression.html#asLe--">asLe</a>, <a href="../../../../../../../org/apache/olingo/commons/api/edm/annotation/EdmDynamicExpression.html#asLt--">asLt</a>, <a href="../../../../../../../org/apache/olingo/commons/api/edm/annotation/EdmDynamicExpression.html#asNavigationPropertyPath--">asNavigationPropertyPath</a>, <a href="../../../../../../../org/apache/olingo/commons/api/edm/annotation/EdmDynamicExpression.html#asNe--">asNe</a>, <a href="../../../../../../../org/apache/olingo/commons/api/edm/annotation/EdmDynamicExpression.html#asNot--">asNot</a>, <a href="../../../../../../../org/apache/olingo/commons/api/edm/annotation/EdmDynamicExpression.html#asNull--">asNull</a>, <a href="../../../../../../../org/apache/olingo/commons/api/edm/annotation/EdmDynamicExpression.html#asOr--">asOr</a>, <a href="../../../../../../../org/apache/olingo/commons/api/edm/annotation/EdmDynamicExpression.html#asPath--">asPath</a>, <a href="../../../../../../../org/apache/olingo/commons/api/edm/annotation/EdmDynamicExpression.html#asPropertyPath--">asPropertyPath</a>, <a href="../../../../../../../org/apache/olingo/commons/api/edm/annotation/EdmDynamicExpression.html#asPropertyValue--">asPropertyValue</a>, <a href="../../../../../../../org/apache/olingo/commons/api/edm/annotation/EdmDynamicExpression.html#asRecord--">asRecord</a>, <a href="../../../../../../../org/apache/olingo/commons/api/edm/annotation/EdmDynamicExpression.html#asUrlRef--">asUrlRef</a>, <a href="../../../../../../../org/apache/olingo/commons/api/edm/annotation/EdmDynamicExpression.html#isAnd--">isAnd</a>, <a href="../../../../../../../org/apache/olingo/commons/api/edm/annotation/EdmDynamicExpression.html#isAnnotationPath--">isAnnotationPath</a>, <a href="../../../../../../../org/apache/olingo/commons/api/edm/annotation/EdmDynamicExpression.html#isApply--">isApply</a>, <a href="../../../../../../../org/apache/olingo/commons/api/edm/annotation/EdmDynamicExpression.html#isCast--">isCast</a>, <a href="../../../../../../../org/apache/olingo/commons/api/edm/annotation/EdmDynamicExpression.html#isCollection--">isCollection</a>, <a href="../../../../../../../org/apache/olingo/commons/api/edm/annotation/EdmDynamicExpression.html#isEq--">isEq</a>, <a href="../../../../../../../org/apache/olingo/commons/api/edm/annotation/EdmDynamicExpression.html#isGe--">isGe</a>, <a href="../../../../../../../org/apache/olingo/commons/api/edm/annotation/EdmDynamicExpression.html#isGt--">isGt</a>, <a href="../../../../../../../org/apache/olingo/commons/api/edm/annotation/EdmDynamicExpression.html#isIf--">isIf</a>, <a href="../../../../../../../org/apache/olingo/commons/api/edm/annotation/EdmDynamicExpression.html#isIsOf--">isIsOf</a>, <a href="../../../../../../../org/apache/olingo/commons/api/edm/annotation/EdmDynamicExpression.html#isLabeledElement--">isLabeledElement</a>, <a href="../../../../../../../org/apache/olingo/commons/api/edm/annotation/EdmDynamicExpression.html#isLabeledElementReference--">isLabeledElementReference</a>, <a href="../../../../../../../org/apache/olingo/commons/api/edm/annotation/EdmDynamicExpression.html#isLe--">isLe</a>, <a href="../../../../../../../org/apache/olingo/commons/api/edm/annotation/EdmDynamicExpression.html#isLt--">isLt</a>, <a href="../../../../../../../org/apache/olingo/commons/api/edm/annotation/EdmDynamicExpression.html#isNavigationPropertyPath--">isNavigationPropertyPath</a>, <a href="../../../../../../../org/apache/olingo/commons/api/edm/annotation/EdmDynamicExpression.html#isNe--">isNe</a>, <a href="../../../../../../../org/apache/olingo/commons/api/edm/annotation/EdmDynamicExpression.html#isNot--">isNot</a>, <a href="../../../../../../../org/apache/olingo/commons/api/edm/annotation/EdmDynamicExpression.html#isNull--">isNull</a>, <a href="../../../../../../../org/apache/olingo/commons/api/edm/annotation/EdmDynamicExpression.html#isOr--">isOr</a>, <a href="../../../../../../../org/apache/olingo/commons/api/edm/annotation/EdmDynamicExpression.html#isPath--">isPath</a>, <a href="../../../../../../../org/apache/olingo/commons/api/edm/annotation/EdmDynamicExpression.html#isPropertyPath--">isPropertyPath</a>, <a href="../../../../../../../org/apache/olingo/commons/api/edm/annotation/EdmDynamicExpression.html#isPropertyValue--">isPropertyValue</a>, <a href="../../../../../../../org/apache/olingo/commons/api/edm/annotation/EdmDynamicExpression.html#isRecord--">isRecord</a>, <a href="../../../../../../../org/apache/olingo/commons/api/edm/annotation/EdmDynamicExpression.html#isUrlRef--">isUrlRef</a></code></li>
</ul>
<ul class="blockList">
<li class="blockList"><a name="methods.inherited.from.class.org.apache.olingo.commons.api.edm.annotation.EdmExpression">
<!-- -->
</a>
<h3>Methods inherited from interface&nbsp;org.apache.olingo.commons.api.edm.annotation.<a href="../../../../../../../org/apache/olingo/commons/api/edm/annotation/EdmExpression.html" title="interface in org.apache.olingo.commons.api.edm.annotation">EdmExpression</a></h3>
<code><a href="../../../../../../../org/apache/olingo/commons/api/edm/annotation/EdmExpression.html#asConstant--">asConstant</a>, <a href="../../../../../../../org/apache/olingo/commons/api/edm/annotation/EdmExpression.html#asDynamic--">asDynamic</a>, <a href="../../../../../../../org/apache/olingo/commons/api/edm/annotation/EdmExpression.html#getExpressionName--">getExpressionName</a>, <a href="../../../../../../../org/apache/olingo/commons/api/edm/annotation/EdmExpression.html#getExpressionType--">getExpressionType</a>, <a href="../../../../../../../org/apache/olingo/commons/api/edm/annotation/EdmExpression.html#isConstant--">isConstant</a>, <a href="../../../../../../../org/apache/olingo/commons/api/edm/annotation/EdmExpression.html#isDynamic--">isDynamic</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="getValue--">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>getValue</h4>
<pre><a href="http://docs.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;getValue()</pre>
<div class="block">Returns the target value of the expression</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>target value of the expression</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/EdmPath.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/olingo/commons/api/edm/annotation/EdmOr.html" title="interface in org.apache.olingo.commons.api.edm.annotation"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
<li><a href="../../../../../../../org/apache/olingo/commons/api/edm/annotation/EdmPropertyPath.html" title="interface in org.apache.olingo.commons.api.edm.annotation"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../../../../index.html?org/apache/olingo/commons/api/edm/annotation/EdmPath.html" target="_top">Frames</a></li>
<li><a href="EdmPath.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>Nested&nbsp;|&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li>Constr&nbsp;|&nbsp;</li>
<li><a href="#method.summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail:&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li>Constr&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; 2013&#x2013;2018 <a href="http://www.apache.org/">The Apache Software Foundation</a>. All rights reserved.</small></p>
</body>
</html>