blob: fc7585d811c2b717ceb8415c96b33689570e286c [file] [log] [blame]
<!DOCTYPE HTML>
<!-- NewPage -->
<html lang="en">
<head>
<!-- Generated by javadoc (11.0.4) on Fri Sep 20 12:10:30 CEST 2019 -->
<title>DefaultAssociationRole (Apache SIS 1.0 API)</title>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<meta name="dc.created" content="2019-09-20">
<meta name="keywords" content="org.apache.sis.feature.DefaultAssociationRole class">
<meta name="keywords" content="isResolved()">
<meta name="keywords" content="getValueType()">
<meta name="keywords" content="getMinimumOccurs()">
<meta name="keywords" content="getMaximumOccurs()">
<meta name="keywords" content="newInstance()">
<meta name="keywords" content="hashCode()">
<meta name="keywords" content="equals()">
<meta name="keywords" content="toString()">
<link rel="stylesheet" type="text/css" href="../../../../stylesheet.css" title="Style">
<link rel="stylesheet" type="text/css" href="../../../../sis.css" title="Style">
<link rel="stylesheet" type="text/css" href="../../../../jquery/jquery-ui.css" title="Style">
<script type="text/javascript" src="../../../../script.js"></script>
<script type="text/javascript" src="../../../../jquery/jszip/dist/jszip.min.js"></script>
<script type="text/javascript" src="../../../../jquery/jszip-utils/dist/jszip-utils.min.js"></script>
<!--[if IE]>
<script type="text/javascript" src="../../../../jquery/jszip-utils/dist/jszip-utils-ie.min.js"></script>
<![endif]-->
<script type="text/javascript" src="../../../../jquery/jquery-3.3.1.js"></script>
<script type="text/javascript" src="../../../../jquery/jquery-migrate-3.0.1.js"></script>
<script type="text/javascript" src="../../../../jquery/jquery-ui.js"></script>
</head>
<body>
<script type="text/javascript"><!--
try {
if (location.href.indexOf('is-external=true') == -1) {
parent.document.title="DefaultAssociationRole (Apache SIS 1.0 API)";
}
}
catch(err) {
}
//-->
var data = {"i0":10,"i1":10,"i2":10,"i3":10,"i4":10,"i5":10,"i6":10,"i7":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";
var pathtoroot = "../../../../";
var useModuleDirectories = false;
loadScripts(document, 'script');</script>
<noscript>
<div>JavaScript is disabled on your browser.</div>
</noscript>
<header role="banner">
<nav role="navigation">
<div class="fixedNav">
<!-- ========= START OF TOP NAVBAR ======= -->
<div class="topNav"><a id="navbar.top">
<!-- -->
</a>
<div class="skipNav"><a href="#skip.navbar.top" title="Skip navigation links">Skip navigation links</a></div>
<a id="navbar.top.firstrow">
<!-- -->
</a>
<ul class="navList" title="Navigation">
<li><a href="../../../../index.html">Overview</a></li>
<li><a href="package-summary.html">Package</a></li>
<li class="navBarCell1Rev">Class</li>
<li><a href="class-use/DefaultAssociationRole.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" id="allclasses_navbar_top">
<li><a href="../../../../allclasses.html">All&nbsp;Classes</a></li>
</ul>
<ul class="navListSearch">
<li><label for="search">SEARCH:</label>
<input type="text" id="search" value="search" disabled="disabled">
<input type="reset" id="reset" value="reset" disabled="disabled">
</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>
<noscript>
<div>JavaScript is disabled on your browser.</div>
</noscript>
</div>
<div>
<ul class="subNavList">
<li>Summary:&nbsp;</li>
<li>Nested&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>Field&nbsp;|&nbsp;</li>
<li><a href="#constructor.detail">Constr</a>&nbsp;|&nbsp;</li>
<li><a href="#method.detail">Method</a></li>
</ul>
</div>
<a id="skip.navbar.top">
<!-- -->
</a></div>
<!-- ========= END OF TOP NAVBAR ========= -->
</div>
<div class="navPadding">&nbsp;</div>
<script type="text/javascript"><!--
$('.navPadding').css('padding-top', $('.fixedNav').css("height"));
//-->
</script>
</nav>
</header>
<!-- ======== START OF CLASS DATA ======== -->
<main role="main">
<div class="header">
<div class="subTitle"><span class="packageLabelInType">Package</span>&nbsp;<a href="package-summary.html">org.apache.sis.feature</a></div>
<h2 title="Class DefaultAssociationRole" class="title">Class DefaultAssociationRole</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" class="externalLink">Object</a></li>
<li>
<ul class="inheritance">
<li><a href="AbstractIdentifiedType.html" title="class in org.apache.sis.feature">AbstractIdentifiedType</a></li>
<li>
<ul class="inheritance">
<li>DefaultAssociationRole</li>
</ul>
</li>
</ul>
</li>
</ul>
<div class="description">
<ul class="blockList">
<li class="blockList">
<dl>
<dt>All Implemented Interfaces:</dt>
<dd><code><a href="https://docs.oracle.com/javase/8/docs/api/java/io/Serializable.html?is-external=true" title="class or interface in java.io" class="externalLink">Serializable</a></code>, <code><a href="../util/Deprecable.html" title="interface in org.apache.sis.util">Deprecable</a></code></dd>
</dl>
<hr>
<pre>public class <span class="typeNameLabel">DefaultAssociationRole</span>
extends <a href="AbstractIdentifiedType.html" title="class in org.apache.sis.feature">AbstractIdentifiedType</a></pre>
<div class="block">Indicates the role played by the association between two features.
In the area of geographic information, there exist multiple kinds of associations:
<ul>
<li><b>Aggregation</b> represents associations between features which can exist even if the aggregate is destroyed.</li>
<li><b>Composition</b> represents relationships where the owned features are destroyed together with the composite.</li>
<li><b>Spatial</b> association represents spatial or topological relationships that may exist between features (e.g. “<cite>east of</cite>”).</li>
<li><b>Temporal</b> association may represent for example a sequence of changes over time involving the replacement of some
feature instances by other feature instances.</li>
</ul>
<div class="section">Immutability and thread safety</div>
Instances of this class are immutable if all properties (<a href="http://www.geoapi.org/3.0/javadoc/org/opengis/util/GenericName.html?is-external=true" title="class or interface in org.opengis.util" class="externalLink"><code>Generic­Name</code></a> and <a href="http://www.geoapi.org/3.0/javadoc/org/opengis/util/InternationalString.html?is-external=true" title="class or interface in org.opengis.util" class="externalLink"><code>International­String</code></a>
instances) and all arguments (e.g. <code>value­Type</code>) given to the constructor are also immutable.
Such immutable instances can be shared by many objects and passed between threads without synchronization.</div>
<dl>
<dt><span class="simpleTagLabel">Since:</span></dt>
<dd>0.5</dd>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="DefaultFeatureType.html" title="class in org.apache.sis.feature"><code>Default­Feature­Type</code></a>,
<a href="AbstractAssociation.html" title="class in org.apache.sis.feature"><code>Abstract­Association</code></a>,
<a href="../../../../serialized-form.html#org.apache.sis.feature.DefaultAssociationRole">Serialized Form</a></dd>
<p><font size="-1">Defined in the <code>sis-feature</code> module</font></p>
</dl>
</li>
</ul>
</div>
<div class="summary">
<ul class="blockList">
<li class="blockList">
<!-- =========== FIELD SUMMARY =========== -->
<section role="region">
<ul class="blockList">
<li class="blockList"><a id="field.summary">
<!-- -->
</a>
<h3>Field Summary</h3>
<ul class="blockList">
<li class="blockList"><a id="fields.inherited.from.class.AbstractIdentifiedType">
<!-- -->
</a>
<h3>Fields inherited from class&nbsp;<a href="AbstractIdentifiedType.html" title="class in org.apache.sis.feature">AbstractIdentifiedType</a></h3>
<code><a href="AbstractIdentifiedType.html#DEFINITION_KEY">DEFINITION_KEY</a>, <a href="AbstractIdentifiedType.html#DEPRECATED_KEY">DEPRECATED_KEY</a>, <a href="AbstractIdentifiedType.html#DESCRIPTION_KEY">DESCRIPTION_KEY</a>, <a href="AbstractIdentifiedType.html#DESIGNATION_KEY">DESIGNATION_KEY</a>, <a href="AbstractIdentifiedType.html#NAME_KEY">NAME_KEY</a></code></li>
</ul>
</li>
</ul>
</section>
<!-- ======== CONSTRUCTOR SUMMARY ======== -->
<section role="region">
<ul class="blockList">
<li class="blockList"><a id="constructor.summary">
<!-- -->
</a>
<h3>Constructor Summary</h3>
<table class="memberSummary">
<caption><span>Constructors</span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colFirst" scope="col">Constructor</th>
<th class="colLast" scope="col">Description</th>
</tr>
<tr class="altColor">
<th class="colConstructorName" scope="row"><code><span class="memberNameLink"><a href="#%3Cinit%3E(java.util.Map,org.apache.sis.feature.DefaultFeatureType,int,int)">DefaultAssociationRole</a></span>&#8203;(<a href="https://docs.oracle.com/javase/8/docs/api/java/util/Map.html?is-external=true" title="class or interface in java.util" class="externalLink">Map</a>&lt;<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a>,&#8203;?&gt;&nbsp;identification,
<a href="DefaultFeatureType.html" title="class in org.apache.sis.feature">DefaultFeatureType</a>&nbsp;valueType,
int&nbsp;minimumOccurs,
int&nbsp;maximumOccurs)</code></th>
<td class="colLast">
<div class="block">Constructs an association to the given feature type.</div>
</td>
</tr>
<tr class="rowColor">
<th class="colConstructorName" scope="row"><code><span class="memberNameLink"><a href="#%3Cinit%3E(java.util.Map,org.opengis.util.GenericName,int,int)">DefaultAssociationRole</a></span>&#8203;(<a href="https://docs.oracle.com/javase/8/docs/api/java/util/Map.html?is-external=true" title="class or interface in java.util" class="externalLink">Map</a>&lt;<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a>,&#8203;?&gt;&nbsp;identification,
<a href="http://www.geoapi.org/3.0/javadoc/org/opengis/util/GenericName.html?is-external=true" title="class or interface in org.opengis.util" class="externalLink">GenericName</a>&nbsp;valueType,
int&nbsp;minimumOccurs,
int&nbsp;maximumOccurs)</code></th>
<td class="colLast">
<div class="block">Constructs an association to a feature type of the given name.</div>
</td>
</tr>
</table>
</li>
</ul>
</section>
<!-- ========== METHOD SUMMARY =========== -->
<section role="region">
<ul class="blockList">
<li class="blockList"><a id="method.summary">
<!-- -->
</a>
<h3>Method Summary</h3>
<table class="memberSummary">
<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="colSecond" scope="col">Method</th>
<th class="colLast" scope="col">Description</th>
</tr>
<tr id="i0" class="altColor">
<td class="colFirst"><code>boolean</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#equals(java.lang.Object)">equals</a></span>&#8203;(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang" class="externalLink">Object</a>&nbsp;obj)</code></th>
<td class="colLast">
<div class="block">Compares this association role with the given object for equality.</div>
</td>
</tr>
<tr id="i1" class="rowColor">
<td class="colFirst"><code>int</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getMaximumOccurs()">getMaximumOccurs</a></span>()</code></th>
<td class="colLast">
<div class="block">Returns the maximum number of occurrences of the association within its containing entity.</div>
</td>
</tr>
<tr id="i2" class="altColor">
<td class="colFirst"><code>int</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getMinimumOccurs()">getMinimumOccurs</a></span>()</code></th>
<td class="colLast">
<div class="block">Returns the minimum number of occurrences of the association within its containing entity.</div>
</td>
</tr>
<tr id="i3" class="rowColor">
<td class="colFirst"><code><a href="DefaultFeatureType.html" title="class in org.apache.sis.feature">DefaultFeatureType</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getValueType()">getValueType</a></span>()</code></th>
<td class="colLast">
<div class="block">Returns the type of feature values.</div>
</td>
</tr>
<tr id="i4" class="altColor">
<td class="colFirst"><code>int</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#hashCode()">hashCode</a></span>()</code></th>
<td class="colLast">
<div class="block">Returns a hash code value for this association role.</div>
</td>
</tr>
<tr id="i5" class="rowColor">
<td class="colFirst"><code>boolean</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#isResolved()">isResolved</a></span>()</code></th>
<td class="colLast">
<div class="block">Returns <code>true</code> if the associated <code>Feature­Type</code> is complete (not just a name).</div>
</td>
</tr>
<tr id="i6" class="altColor">
<td class="colFirst"><code><a href="AbstractAssociation.html" title="class in org.apache.sis.feature">AbstractAssociation</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#newInstance()">newInstance</a></span>()</code></th>
<td class="colLast">
<div class="block">Creates a new association instance of this role.</div>
</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" class="externalLink">String</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#toString()">toString</a></span>()</code></th>
<td class="colLast">
<div class="block">Returns a string representation of this association role.</div>
</td>
</tr>
</table>
<ul class="blockList">
<li class="blockList"><a id="methods.inherited.from.class.AbstractIdentifiedType">
<!-- -->
</a>
<h3>Methods inherited from class&nbsp;<a href="AbstractIdentifiedType.html" title="class in org.apache.sis.feature">AbstractIdentifiedType</a></h3>
<code><a href="AbstractIdentifiedType.html#getDefinition()">get­Definition</a>, <a href="AbstractIdentifiedType.html#getDescription()">get­Description</a>, <a href="AbstractIdentifiedType.html#getDesignation()">get­Designation</a>, <a href="AbstractIdentifiedType.html#getName()">get­Name</a>, <a href="AbstractIdentifiedType.html#getRemarks()">get­Remarks</a>, <a href="AbstractIdentifiedType.html#isDeprecated()">is­Deprecated</a></code></li>
</ul>
<ul class="blockList">
<li class="blockList"><a id="methods.inherited.from.class.Object">
<!-- -->
</a>
<h3>Methods inherited from class&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" class="externalLink">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" class="externalLink">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" class="externalLink">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" class="externalLink">get­Class</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" class="externalLink">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" class="externalLink">notify­All</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" class="externalLink">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" class="externalLink">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" class="externalLink">wait</a></code></li>
</ul>
</li>
</ul>
</section>
</li>
</ul>
</div>
<div class="details">
<ul class="blockList">
<li class="blockList">
<!-- ========= CONSTRUCTOR DETAIL ======== -->
<section role="region">
<ul class="blockList">
<li class="blockList"><a id="constructor.detail">
<!-- -->
</a>
<h3>Constructor Detail</h3>
<a id="&lt;init&gt;(java.util.Map,org.apache.sis.feature.DefaultFeatureType,int,int)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>DefaultAssociationRole</h4>
<pre>public&nbsp;DefaultAssociationRole&#8203;(<a href="https://docs.oracle.com/javase/8/docs/api/java/util/Map.html?is-external=true" title="class or interface in java.util" class="externalLink">Map</a>&lt;<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a>,&#8203;?&gt;&nbsp;identification,
<a href="DefaultFeatureType.html" title="class in org.apache.sis.feature">DefaultFeatureType</a>&nbsp;valueType,
int&nbsp;minimumOccurs,
int&nbsp;maximumOccurs)</pre>
<div class="block">Constructs an association to the given feature type. The properties map is given unchanged to
the <a href="AbstractIdentifiedType.html#%3Cinit%3E(java.util.Map)">super-class constructor</a>.
The following table is a reminder of main (not all) recognized map entries:
<table class="sis">
<caption>Recognized map entries (non exhaustive list)</caption>
<tr>
<th>Map key</th>
<th>Value type</th>
<th>Returned by</th>
</tr>
<tr>
<td><a href="AbstractIdentifiedType.html#NAME_KEY">"name"</a></td>
<td><a href="http://www.geoapi.org/3.0/javadoc/org/opengis/util/GenericName.html?is-external=true" title="class or interface in org.opengis.util" class="externalLink"><code>GenericName</code></a> or <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink"><code>String</code></a></td>
<td><a href="AbstractIdentifiedType.html#getName()"><code>AbstractIdentifiedType.getName()</code></a></td>
</tr>
<tr>
<td><a href="AbstractIdentifiedType.html#DEFINITION_KEY">"definition"</a></td>
<td><a href="http://www.geoapi.org/3.0/javadoc/org/opengis/util/InternationalString.html?is-external=true" title="class or interface in org.opengis.util" class="externalLink"><code>InternationalString</code></a> or <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink"><code>String</code></a></td>
<td><a href="AbstractIdentifiedType.html#getDefinition()"><code>AbstractIdentifiedType.getDefinition()</code></a></td>
</tr>
<tr>
<td><a href="AbstractIdentifiedType.html#DESIGNATION_KEY">"designation"</a></td>
<td><a href="http://www.geoapi.org/3.0/javadoc/org/opengis/util/InternationalString.html?is-external=true" title="class or interface in org.opengis.util" class="externalLink"><code>InternationalString</code></a> or <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink"><code>String</code></a></td>
<td><a href="AbstractIdentifiedType.html#getDesignation()"><code>AbstractIdentifiedType.getDesignation()</code></a></td>
</tr>
<tr>
<td><a href="AbstractIdentifiedType.html#DESCRIPTION_KEY">"description"</a></td>
<td><a href="http://www.geoapi.org/3.0/javadoc/org/opengis/util/InternationalString.html?is-external=true" title="class or interface in org.opengis.util" class="externalLink"><code>InternationalString</code></a> or <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink"><code>String</code></a></td>
<td><a href="AbstractIdentifiedType.html#getDescription()"><code>AbstractIdentifiedType.getDescription()</code></a></td>
</tr>
<tr>
<td><a href="AbstractIdentifiedType.html#DEPRECATED_KEY">"deprecated"</a></td>
<td><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Boolean.html?is-external=true" title="class or interface in java.lang" class="externalLink"><code>Boolean</code></a></td>
<td><a href="AbstractIdentifiedType.html#isDeprecated()"><code>AbstractIdentifiedType.isDeprecated()</code></a></td>
</tr>
</table></div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>identification</code> - the name and other information to be given to this association role.</dd>
<dd><code>value­Type</code> - the type of feature values.</dd>
<dd><code>minimum­Occurs</code> - the minimum number of occurrences of the association within its containing entity.</dd>
<dd><code>maximum­Occurs</code> - the maximum number of occurrences of the association within its containing entity,
or <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Integer.html?is-external=true#MAX_VALUE" title="class or interface in java.lang" class="externalLink"><code>Integer​.MAX_VALUE</code></a> if there is no restriction.</dd>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="builder/AssociationRoleBuilder.html" title="class in org.apache.sis.feature.builder"><code>Association­Role­Builder</code></a></dd>
</dl>
</li>
</ul>
<a id="&lt;init&gt;(java.util.Map,org.opengis.util.GenericName,int,int)">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>DefaultAssociationRole</h4>
<pre>public&nbsp;DefaultAssociationRole&#8203;(<a href="https://docs.oracle.com/javase/8/docs/api/java/util/Map.html?is-external=true" title="class or interface in java.util" class="externalLink">Map</a>&lt;<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a>,&#8203;?&gt;&nbsp;identification,
<a href="http://www.geoapi.org/3.0/javadoc/org/opengis/util/GenericName.html?is-external=true" title="class or interface in org.opengis.util" class="externalLink">GenericName</a>&nbsp;valueType,
int&nbsp;minimumOccurs,
int&nbsp;maximumOccurs)</pre>
<div class="block">Constructs an association to a feature type of the given name.
This constructor can be used when creating a cyclic graph of <a href="DefaultFeatureType.html" title="class in org.apache.sis.feature"><code>Default­Feature­Type</code></a> instances.
In such cases, at least one association needs to be created while its <code>Feature­Type</code> is not yet available.
<div class="note"><b>Example:</b>
The following establishes a bidirectional association between feature types <var>A</var> and <var>B</var>:
<blockquote><pre>String namespace = <font color="orangered">"My model"</font>;
GenericName nameOfA = Names.<b>createTypeName</b>(namespace, <font color="orangered">":"</font>, <font color="orangered">"Feature type A"</font>);
GenericName nameOfB = Names.<b>createTypeName</b>(namespace, <font color="orangered">":"</font>, <font color="orangered">"Feature type B"</font>);
FeatureType typeA = <font color="green">new</font> <b>DefaultFeatureType</b>(nameOfA, <font color="green">false</font>, <font color="green">null</font>,
<font color="green">new</font> <b>DefaultAssociationRole</b>(Names.<b>createLocalName</b>(<font color="orangered">"Association to B"</font>), nameOfB),
<i><font color="gray">// More properties if desired.</font></i>
);
FeatureType typeB = <font color="green">new</font> <b>DefaultFeatureType</b>(nameOfB, <font color="green">false</font>, <font color="green">null</font>,
<font color="green">new</font> <b>DefaultAssociationRole</b>(Names.<b>createLocalName</b>(<font color="orangered">"Association to A"</font>), featureA),
<i><font color="gray">// More properties if desired.</font></i>
);</pre></blockquote>
After the above code completed, the <a href="#getValueType()">value type</a> of <cite>"association to B"</cite>
has been automatically set to the <code>type­B</code> instance.
</div>
Callers shall make sure that the feature types graph will not contain more than one feature of the given name.
If more than one <code>Feature­Type</code> instance of the given name is found at resolution time, the selected one
is undetermined.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>identification</code> - the name and other information to be given to this association role.</dd>
<dd><code>value­Type</code> - the name of the type of feature values.</dd>
<dd><code>minimum­Occurs</code> - the minimum number of occurrences of the association within its containing entity.</dd>
<dd><code>maximum­Occurs</code> - the maximum number of occurrences of the association within its containing entity,
or <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Integer.html?is-external=true#MAX_VALUE" title="class or interface in java.lang" class="externalLink"><code>Integer​.MAX_VALUE</code></a> if there is no restriction.</dd>
</dl>
</li>
</ul>
</li>
</ul>
</section>
<!-- ============ METHOD DETAIL ========== -->
<section role="region">
<ul class="blockList">
<li class="blockList"><a id="method.detail">
<!-- -->
</a>
<h3>Method Detail</h3>
<a id="isResolved()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>isResolved</h4>
<pre class="methodSignature">public final&nbsp;boolean&nbsp;isResolved()</pre>
<div class="block">Returns <code>true</code> if the associated <code>Feature­Type</code> is complete (not just a name).
This method returns <code>false</code> if this <code>Feature­Association­Role</code> has been
<a href="#%3Cinit%3E(java.util.Map,org.opengis.util.GenericName,int,int)">constructed with only a feature name</a>
and that named feature has not yet been resolved.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd><code>true</code> if the associated feature is complete, or <code>false</code> if only its name is known.</dd>
<dt><span class="simpleTagLabel">Since:</span></dt>
<dd>0.8</dd>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="#getValueType()"><code>get­Value­Type()</code></a></dd>
</dl>
</li>
</ul>
<a id="getValueType()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getValueType</h4>
<pre class="methodSignature">public final&nbsp;<a href="DefaultFeatureType.html" title="class in org.apache.sis.feature">DefaultFeatureType</a>&nbsp;getValueType()</pre>
<div class="block">Returns the type of feature values.
<p>This method can not be invoked if <a href="#isResolved()"><code>is­Resolved()</code></a> returns <code>false</code>.
However it is still possible to <a href="Features.html#getValueTypeName(org.apache.sis.feature.AbstractIdentifiedType)">get the associated feature type name</a>.</p>
<div class="warning"><b>Warning:</b> In a future SIS version, the return type may be changed
to <code>org​.opengis​.feature​.Feature­Type</code>. This change is pending GeoAPI revision.</div></div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the type of feature values.</dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/IllegalStateException.html?is-external=true" title="class or interface in java.lang" class="externalLink">Illegal­State­Exception</a></code> - if the feature type has been specified
<a href="#%3Cinit%3E(java.util.Map,org.opengis.util.GenericName,int,int)">only by its name</a>
and not yet resolved.</dd>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="#isResolved()"><code>is­Resolved()</code></a></dd>
</dl>
</li>
</ul>
<a id="getMinimumOccurs()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getMinimumOccurs</h4>
<pre class="methodSignature">public final&nbsp;int&nbsp;getMinimumOccurs()</pre>
<div class="block">Returns the minimum number of occurrences of the association within its containing entity.
The returned value is greater than or equal to zero.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the minimum number of occurrences of the association within its containing entity.</dd>
</dl>
</li>
</ul>
<a id="getMaximumOccurs()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getMaximumOccurs</h4>
<pre class="methodSignature">public final&nbsp;int&nbsp;getMaximumOccurs()</pre>
<div class="block">Returns the maximum number of occurrences of the association within its containing entity.
The returned value is greater than or equal to the <a href="#getMinimumOccurs()"><code>get­Minimum­Occurs()</code></a> value.
If there is no maximum, then this method returns <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Integer.html?is-external=true#MAX_VALUE" title="class or interface in java.lang" class="externalLink"><code>Integer​.MAX_VALUE</code></a>.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the maximum number of occurrences of the association within its containing entity,
or <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Integer.html?is-external=true#MAX_VALUE" title="class or interface in java.lang" class="externalLink"><code>Integer​.MAX_VALUE</code></a> if none.</dd>
</dl>
</li>
</ul>
<a id="newInstance()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>newInstance</h4>
<pre class="methodSignature">public&nbsp;<a href="AbstractAssociation.html" title="class in org.apache.sis.feature">AbstractAssociation</a>&nbsp;newInstance()</pre>
<div class="block">Creates a new association instance of this role.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>a new association instance.</dd>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="AbstractAssociation.html#create(org.apache.sis.feature.DefaultAssociationRole)"><code>Abstract­Association​.create(Default­Association­Role)</code></a></dd>
</dl>
</li>
</ul>
<a id="hashCode()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>hashCode</h4>
<pre class="methodSignature">public&nbsp;int&nbsp;hashCode()</pre>
<div class="block">Returns a hash code value for this association role.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the hash code for this type.</dd>
</dl>
</li>
</ul>
<a id="equals(java.lang.Object)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>equals</h4>
<pre class="methodSignature">public&nbsp;boolean&nbsp;equals&#8203;(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang" class="externalLink">Object</a>&nbsp;obj)</pre>
<div class="block">Compares this association role with the given object for equality.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>obj</code> - the object to compare with this type.</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd><code>true</code> if the given object is equals to this type.</dd>
</dl>
</li>
</ul>
<a id="toString()">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>toString</h4>
<pre class="methodSignature">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" class="externalLink">String</a>&nbsp;toString()</pre>
<div class="block">Returns a string representation of this association role.
The returned string is for debugging purpose and may change in any future SIS version.</div>
<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#toString()" title="class or interface in java.lang" class="externalLink">to­String</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" class="externalLink">Object</a></code></dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>a string representation of this association role for debugging purpose.</dd>
</dl>
</li>
</ul>
</li>
</ul>
</section>
</li>
</ul>
</div>
</div>
</main>
<!-- ========= END OF CLASS DATA ========= -->
<footer role="contentinfo">
<nav role="navigation">
<!-- ======= START OF BOTTOM NAVBAR ====== -->
<div class="bottomNav"><a id="navbar.bottom">
<!-- -->
</a>
<div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div>
<a id="navbar.bottom.firstrow">
<!-- -->
</a>
<ul class="navList" title="Navigation">
<li><a href="../../../../index.html">Overview</a></li>
<li><a href="package-summary.html">Package</a></li>
<li class="navBarCell1Rev">Class</li>
<li><a href="class-use/DefaultAssociationRole.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" id="allclasses_navbar_bottom">
<li><a href="../../../../allclasses.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>
<noscript>
<div>JavaScript is disabled on your browser.</div>
</noscript>
</div>
<div>
<ul class="subNavList">
<li>Summary:&nbsp;</li>
<li>Nested&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>Field&nbsp;|&nbsp;</li>
<li><a href="#constructor.detail">Constr</a>&nbsp;|&nbsp;</li>
<li><a href="#method.detail">Method</a></li>
</ul>
</div>
<a id="skip.navbar.bottom">
<!-- -->
</a></div>
<!-- ======== END OF BOTTOM NAVBAR ======= -->
</nav>
<p class="legalCopy"><small>Copyright &#169; 2010&#x2013;2019 <a href="https://www.apache.org/">The Apache Software Foundation</a>. All rights reserved.</small></p>
</footer>
</body>
</html>