Google Git
Sign in
apache / olingo-site / refs/heads/preview/4.9.0-release-staging / . / output / javadoc / odata4 / org / apache / olingo / commons / api / edm / EdmTerm.html
blob: 4fc4fa06ffd97f93e3aac2915ab553114f9f5b6f [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>EdmTerm (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="EdmTerm (Olingo-OData 4.5.0 API)";
}
}
catch(err) {
}
//-->
var methods = {"i0":6,"i1":6,"i2":6,"i3":6,"i4":6,"i5":6,"i6":6,"i7":6,"i8":6,"i9":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/EdmTerm.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/EdmStructuredType.html" title="interface in org.apache.olingo.commons.api.edm"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
<li><a href="../../../../../../org/apache/olingo/commons/api/edm/EdmType.html" title="interface in org.apache.olingo.commons.api.edm"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../../../index.html?org/apache/olingo/commons/api/edm/EdmTerm.html" target="_top">Frames</a></li>
<li><a href="EdmTerm.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</div>
<h2 title="Interface EdmTerm" class="title">Interface EdmTerm</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/EdmAnnotatable.html" title="interface in org.apache.olingo.commons.api.edm">EdmAnnotatable</a>, <a href="../../../../../../org/apache/olingo/commons/api/edm/EdmNamed.html" title="interface in org.apache.olingo.commons.api.edm">EdmNamed</a></dd>
</dl>
<hr>
<br>
<pre>public interface <span class="typeNameLabel">EdmTerm</span>
extends <a href="../../../../../../org/apache/olingo/commons/api/edm/EdmNamed.html" title="interface in org.apache.olingo.commons.api.edm">EdmNamed</a>, <a href="../../../../../../org/apache/olingo/commons/api/edm/EdmAnnotatable.html" title="interface in org.apache.olingo.commons.api.edm">EdmAnnotatable</a></pre>
<div class="block">An <a href="../../../../../../org/apache/olingo/commons/api/edm/EdmTerm.html" title="interface in org.apache.olingo.commons.api.edm"><code>EdmTerm</code></a> defines a term in a vocabulary.</div>
</li>
</ul>
</div>
<div class="summary">
<ul class="blockList">
<li class="blockList">
<!-- ========== METHOD SUMMARY =========== -->
<ul class="blockList">
<li class="blockList"><a name="method.summary">
<!-- -->
</a>
<h3>Method Summary</h3>
<table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation">
<caption><span id="t0" class="activeTableTab"><span>All Methods</span><span class="tabEnd">&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/util/List.html?is-external=true" title="class or interface in java.util">List</a>&lt;<a href="../../../../../../org/apache/olingo/commons/api/edm/TargetType.html" title="enum in org.apache.olingo.commons.api.edm">TargetType</a>&gt;</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/olingo/commons/api/edm/EdmTerm.html#getAppliesTo--">getAppliesTo</a></span>()</code>&nbsp;</td>
</tr>
<tr id="i1" class="rowColor">
<td class="colFirst"><code><a href="../../../../../../org/apache/olingo/commons/api/edm/EdmTerm.html" title="interface in org.apache.olingo.commons.api.edm">EdmTerm</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/olingo/commons/api/edm/EdmTerm.html#getBaseTerm--">getBaseTerm</a></span>()</code>
<div class="block">When applying a term with a base term,the base term MUST also be applied with the same qualifier, and so on until a
term without a base term is reached.</div>
</td>
</tr>
<tr id="i2" 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/EdmTerm.html#getDefaultValue--">getDefaultValue</a></span>()</code>&nbsp;</td>
</tr>
<tr id="i3" class="rowColor">
<td class="colFirst"><code><a href="../../../../../../org/apache/olingo/commons/api/edm/FullQualifiedName.html" title="class in org.apache.olingo.commons.api.edm">FullQualifiedName</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/olingo/commons/api/edm/EdmTerm.html#getFullQualifiedName--">getFullQualifiedName</a></span>()</code>&nbsp;</td>
</tr>
<tr id="i4" class="altColor">
<td class="colFirst"><code><a href="http://docs.oracle.com/javase/6/docs/api/java/lang/Integer.html?is-external=true" title="class or interface in java.lang">Integer</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/olingo/commons/api/edm/EdmTerm.html#getMaxLength--">getMaxLength</a></span>()</code>&nbsp;</td>
</tr>
<tr id="i5" class="rowColor">
<td class="colFirst"><code><a href="http://docs.oracle.com/javase/6/docs/api/java/lang/Integer.html?is-external=true" title="class or interface in java.lang">Integer</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/olingo/commons/api/edm/EdmTerm.html#getPrecision--">getPrecision</a></span>()</code>&nbsp;</td>
</tr>
<tr id="i6" class="altColor">
<td class="colFirst"><code><a href="http://docs.oracle.com/javase/6/docs/api/java/lang/Integer.html?is-external=true" title="class or interface in java.lang">Integer</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/olingo/commons/api/edm/EdmTerm.html#getScale--">getScale</a></span>()</code>&nbsp;</td>
</tr>
<tr id="i7" class="rowColor">
<td class="colFirst"><code><a href="../../../../../../org/apache/olingo/commons/api/edm/geo/SRID.html" title="class in org.apache.olingo.commons.api.edm.geo">SRID</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/olingo/commons/api/edm/EdmTerm.html#getSrid--">getSrid</a></span>()</code>&nbsp;</td>
</tr>
<tr id="i8" class="altColor">
<td class="colFirst"><code><a href="../../../../../../org/apache/olingo/commons/api/edm/EdmType.html" title="interface in org.apache.olingo.commons.api.edm">EdmType</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/olingo/commons/api/edm/EdmTerm.html#getType--">getType</a></span>()</code>&nbsp;</td>
</tr>
<tr id="i9" class="rowColor">
<td class="colFirst"><code>boolean</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/olingo/commons/api/edm/EdmTerm.html#isNullable--">isNullable</a></span>()</code>&nbsp;</td>
</tr>
</table>
<ul class="blockList">
<li class="blockList"><a name="methods.inherited.from.class.org.apache.olingo.commons.api.edm.EdmNamed">
<!-- -->
</a>
<h3>Methods inherited from interface&nbsp;org.apache.olingo.commons.api.edm.<a href="../../../../../../org/apache/olingo/commons/api/edm/EdmNamed.html" title="interface in org.apache.olingo.commons.api.edm">EdmNamed</a></h3>
<code><a href="../../../../../../org/apache/olingo/commons/api/edm/EdmNamed.html#getName--">getName</a></code></li>
</ul>
<ul class="blockList">
<li class="blockList"><a name="methods.inherited.from.class.org.apache.olingo.commons.api.edm.EdmAnnotatable">
<!-- -->
</a>
<h3>Methods inherited from interface&nbsp;org.apache.olingo.commons.api.edm.<a href="../../../../../../org/apache/olingo/commons/api/edm/EdmAnnotatable.html" title="interface in org.apache.olingo.commons.api.edm">EdmAnnotatable</a></h3>
<code><a href="../../../../../../org/apache/olingo/commons/api/edm/EdmAnnotatable.html#getAnnotation-org.apache.olingo.commons.api.edm.EdmTerm-java.lang.String-">getAnnotation</a>, <a href="../../../../../../org/apache/olingo/commons/api/edm/EdmAnnotatable.html#getAnnotations--">getAnnotations</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="getType--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getType</h4>
<pre><a href="../../../../../../org/apache/olingo/commons/api/edm/EdmType.html" title="interface in org.apache.olingo.commons.api.edm">EdmType</a>&nbsp;getType()</pre>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>type of value returned by the expression contained in an annotation using this term</dd>
</dl>
</li>
</ul>
<a name="getFullQualifiedName--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getFullQualifiedName</h4>
<pre><a href="../../../../../../org/apache/olingo/commons/api/edm/FullQualifiedName.html" title="class in org.apache.olingo.commons.api.edm">FullQualifiedName</a>&nbsp;getFullQualifiedName()</pre>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the fully qualified name of this term</dd>
</dl>
</li>
</ul>
<a name="getBaseTerm--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getBaseTerm</h4>
<pre><a href="../../../../../../org/apache/olingo/commons/api/edm/EdmTerm.html" title="interface in org.apache.olingo.commons.api.edm">EdmTerm</a>&nbsp;getBaseTerm()</pre>
<div class="block">When applying a term with a base term,the base term MUST also be applied with the same qualifier, and so on until a
term without a base term is reached.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the base term if found or null otherwise</dd>
</dl>
</li>
</ul>
<a name="getAppliesTo--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getAppliesTo</h4>
<pre><a href="http://docs.oracle.com/javase/6/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util">List</a>&lt;<a href="../../../../../../org/apache/olingo/commons/api/edm/TargetType.html" title="enum in org.apache.olingo.commons.api.edm">TargetType</a>&gt;&nbsp;getAppliesTo()</pre>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>list of CSDL element that this term can be applied to; if no value is supplied, the term is not restricted
in its application.</dd>
</dl>
</li>
</ul>
<a name="isNullable--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>isNullable</h4>
<pre>boolean&nbsp;isNullable()</pre>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>true if nullable</dd>
</dl>
</li>
</ul>
<a name="getMaxLength--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getMaxLength</h4>
<pre><a href="http://docs.oracle.com/javase/6/docs/api/java/lang/Integer.html?is-external=true" title="class or interface in java.lang">Integer</a>&nbsp;getMaxLength()</pre>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the maximum length as an Integer or null if not specified</dd>
</dl>
</li>
</ul>
<a name="getPrecision--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getPrecision</h4>
<pre><a href="http://docs.oracle.com/javase/6/docs/api/java/lang/Integer.html?is-external=true" title="class or interface in java.lang">Integer</a>&nbsp;getPrecision()</pre>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the precision as an Integer or null if not specified</dd>
</dl>
</li>
</ul>
<a name="getScale--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getScale</h4>
<pre><a href="http://docs.oracle.com/javase/6/docs/api/java/lang/Integer.html?is-external=true" title="class or interface in java.lang">Integer</a>&nbsp;getScale()</pre>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the scale as an Integer or null if not specified</dd>
</dl>
</li>
</ul>
<a name="getSrid--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getSrid</h4>
<pre><a href="../../../../../../org/apache/olingo/commons/api/edm/geo/SRID.html" title="class in org.apache.olingo.commons.api.edm.geo">SRID</a>&nbsp;getSrid()</pre>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>a non-negative integer or the special value <tt>variable</tt></dd>
</dl>
</li>
</ul>
<a name="getDefaultValue--">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>getDefaultValue</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;getDefaultValue()</pre>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the default value as a String or null if not specified</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/EdmTerm.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/EdmStructuredType.html" title="interface in org.apache.olingo.commons.api.edm"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
<li><a href="../../../../../../org/apache/olingo/commons/api/edm/EdmType.html" title="interface in org.apache.olingo.commons.api.edm"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../../../index.html?org/apache/olingo/commons/api/edm/EdmTerm.html" target="_top">Frames</a></li>
<li><a href="EdmTerm.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>