org/apache/sis/feature/DefaultAttributeType.html - sis-site - Git at Google

 <!DOCTYPE HTML>
 <html lang="en">
 <head>
 <!-- Generated by javadoc (19) -->
 <title>DefaultAttributeType (Apache SIS 1.3 API)</title>
 <meta name="viewport" content="width=device-width, initial-scale=1">
 <meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
 <meta name="description" content="declaration: package: org.apache.sis.feature, class: DefaultAttributeType">
 <meta name="generator" content="javadoc/ClassWriterImpl">
 <meta name="keywords" content="org.apache.sis.feature.DefaultAttributeType class">
 <meta name="keywords" content="getValueClass()">
 <meta name="keywords" content="getMinimumOccurs()">
 <meta name="keywords" content="getMaximumOccurs()">
 <meta name="keywords" content="getDefaultValue()">
 <meta name="keywords" content="characteristics()">
 <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="../../../../script-dir/jquery-ui.min.css" title="Style">
 <link rel="stylesheet" type="text/css" href="../../../../jquery-ui.overrides.css" title="Style">
 <script type="text/javascript" src="../../../../script.js"></script>
 <script type="text/javascript" src="../../../../script-dir/jquery-3.6.0.min.js"></script>
 <script type="text/javascript" src="../../../../script-dir/jquery-ui.min.js"></script>
 </head>
 <body class="class-declaration-page">
 <script type="text/javascript">var pathtoroot = "../../../../";
 loadScripts(document, 'script');</script>
 <noscript>
 <div>JavaScript is disabled on your browser.</div>
 </noscript>
 <div class="flex-box">
 <header role="banner" class="flex-header">
 <nav role="navigation">
 <!-- ========= START OF TOP NAVBAR ======= -->
 <div class="top-nav" id="navbar-top"><button id="navbar-toggle-button" aria-controls="navbar-top" aria-expanded="false" aria-label="Toggle navigation links"><span class="nav-bar-toggle-icon">&nbsp;</span><span class="nav-bar-toggle-icon">&nbsp;</span><span class="nav-bar-toggle-icon">&nbsp;</span></button>
 <div class="skip-nav"><a href="#skip-navbar-top" title="Skip navigation links">Skip navigation links</a></div>
 <ul id="navbar-top-firstrow" class="nav-list" title="Navigation">
 <li><a href="../../../../index.html">Overview</a></li>
 <li><a href="package-summary.html">Package</a></li>
 <li class="nav-bar-cell1-rev">Class</li>
 <li><a href="class-use/DefaultAttributeType.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#class">Help</a></li>
 </ul>
 <ul class="sub-nav-list-small">
 <li>
 <p>Summary:</p>
 <ul>
 <li>Nested</li>
 <li><a href="#field-summary">Field</a></li>
 <li><a href="#constructor-summary">Constr</a></li>
 <li><a href="#method-summary">Method</a></li>
 </ul>
 </li>
 <li>
 <p>Detail:</p>
 <ul>
 <li>Field</li>
 <li><a href="#constructor-detail">Constr</a></li>
 <li><a href="#method-detail">Method</a></li>
 </ul>
 </li>
 </ul>
 </div>
 <div class="sub-nav">
 <div id="navbar-sub-list">
 <ul class="sub-nav-list">
 <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="sub-nav-list">
 <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>
 <div class="nav-list-search"><a href="../../../../search.html">SEARCH</a>
 <input type="text" id="search-input" disabled placeholder="Search">
 <input type="reset" id="reset-button" disabled value="reset">
 </div>
 </div>
 <!-- ========= END OF TOP NAVBAR ========= -->
 <span class="skip-nav" id="skip-navbar-top"></span></nav>
 </header>
 <div class="flex-content">
 <main role="main">
 <!-- ======== START OF CLASS DATA ======== -->
 <div class="header">
 <div class="sub-title"><span class="package-label-in-type">Package</span>&nbsp;<a href="package-summary.html">org.apache.sis.feature</a></div>
 <h1 title="Class DefaultAttributeType" class="title">Class DefaultAttributeType&lt;V&gt;</h1>
 </div>
 <div class="inheritance" title="Inheritance Tree"><a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">Object</a>
 <div class="inheritance"><a href="AbstractIdentifiedType.html" title="class in org.apache.sis.feature">AbstractIdentifiedType</a>
 <div class="inheritance">DefaultAttributeType&lt;V&gt;</div>
 </div>
 </div>
 <section class="class-description" id="class-description">
 <dl class="notes">
 <dt>Type Parameters:</dt>
 <dd><code>V</code> - the type of attribute values. If the attribute supports multi-occurrences,
             then this is the type of elements (not the collection type).</dd>
 </dl>
 <dl class="notes">
 <dt>All Implemented Interfaces:</dt>
 <dd><code><a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/io/Serializable.html" title="class or interface in java.io" class="external-link">Serializable</a></code>, <code><a href="../util/Deprecable.html" title="interface in org.apache.sis.util">Deprecable</a></code></dd>
 </dl>
 <hr>
 <div class="type-signature"><span class="modifiers">public class </span><span class="element-name type-name-label">DefaultAttributeType&lt;V&gt;</span>
 <span class="extends-implements">extends <a href="AbstractIdentifiedType.html" title="class in org.apache.sis.feature">AbstractIdentifiedType</a></span></div>
 <div class="block">Definition of an attribute in a feature type.
  The name of attribute type is mandatory. The name <a href="../util/iso/AbstractName.html#scope()">scope</a>
  is typically the name of the <a href="DefaultFeatureType.html" title="class in org.apache.sis.feature">feature type</a> containing this attribute, but this is
  not mandatory. The scope could also be defined by the ontology for example.

  <div class="note"><b>Note:</b>
  Compared to the Java language, <code>AttributeType</code> is equivalent to <a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/lang/reflect/Field.html" title="class or interface in java.lang.reflect" class="external-link"><code>Field</code></a>
  while <code>FeatureType</code> is equivalent to <a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/lang/Class.html" title="class or interface in java.lang" class="external-link"><code>Class</code></a>.
  Attribute characterization (discussed below) is similar to <a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/lang/annotation/Annotation.html" title="class or interface in java.lang.annotation" class="external-link"><code>Annotation</code></a>.
  </div>

  <div class="warning"><b>Warning:</b>
  This class is expected to implement a GeoAPI <code>AttributeType</code> interface in a future version.
  When such interface will be available, most references to <code>DefaultAttributeType</code> in current
  API will be replaced by references to the <code>AttributeType</code> interface.</div>

  <h2>Value type</h2>
  Attributes can be used for both spatial and non-spatial properties.
  Some examples are:

  <table class="sis">
    <caption>Attribute value type examples</caption>
    <tr><th>Attribute name</th>      <th>Value type</th></tr>
    <tr><td>Building shape</td>      <td><a href="http://www.geoapi.org/3.0/javadoc/org.opengis.geoapi/org/opengis/geometry/Geometry.html" title="class or interface in org.opengis.geometry" class="external-link"><code>Geometry</code></a></td></tr>
    <tr><td>Building owner</td>      <td><a href="http://www.geoapi.org/3.0/javadoc/org.opengis.geoapi/org/opengis/metadata/citation/ResponsibleParty.html" title="class or interface in org.opengis.metadata.citation" class="external-link"><code>ResponsibleParty</code></a></td></tr>
    <tr><td>Horizontal accuracy</td> <td><a href="http://www.geoapi.org/3.0/javadoc/org.opengis.geoapi/org/opengis/metadata/quality/PositionalAccuracy.html" title="class or interface in org.opengis.metadata.quality" class="external-link"><code>PositionalAccuracy</code></a></td></tr>
  </table>

  <h2>Attribute characterization</h2>
  An <code>Attribute</code> can be characterized by other attributes. For example, an attribute that carries a measurement
  (e.g. air temperature) may have another attribute that holds the measurement accuracy (e.g. ±0.1°C).
  The accuracy value is often constant for all instances of that attribute
  (e.g. for all temperature measurements in the same dataset), but this is not mandatory.

  <div class="note"><b>Design note:</b>
  Such accuracy could be stored as an ordinary, independent, attribute (like another column in a table),
  but storing accuracy as a <a href="#characteristics()">characteristic</a> of the measurement attribute instead
  provides the following advantages:

  <ul>
    <li>The same characteristic name (e.g. “accuracy”) can be used for different attributes
        (e.g. “temperature”, “humidity”, <i>etc.</i>) since all characteristics are local to their attribute.</li>
    <li>A reference to an attribute gives also access to its characteristics. For example, any method expecting
        an <code>Attribute</code> argument, when given a measurement, can also get its accuracy at the same time.</li>
    <li>In the common case of a <a href="DefaultFeatureType.html#isSimple()">simple feature</a> with characteristics
        that are constants, declaring them as attribute characteristics allows to specify the constants only once.</li>
  </ul>
  </div>

  Constant values of characteristics are given by their <a href="#getDefaultValue()">default value</a>.
  It is still possible for any specific <code>Attribute</code> instance to specify their own value,
  but <a href="DefaultFeatureType.html#isSimple()">simple feature</a> usually don't do that.

  <h2>Immutability and thread safety</h2>
  Instances of this class are immutable if all properties (<a href="http://www.geoapi.org/3.0/javadoc/org.opengis.geoapi/org/opengis/util/GenericName.html" title="class or interface in org.opengis.util" class="external-link"><code>GenericName</code></a> and <a href="http://www.geoapi.org/3.0/javadoc/org.opengis.geoapi/org/opengis/util/InternationalString.html" title="class or interface in org.opengis.util" class="external-link"><code>InternationalString</code></a>
  instances) and all arguments (e.g. <code>defaultValue</code>) given to the constructor are also immutable.
  Such immutable instances can be shared by many objects and passed between threads without synchronization.

  <p>In particular, the <a href="#getDefaultValue()"><code>getDefaultValue()</code></a> method does <strong>not</strong> clone the returned value.
  This means that the same <code>defaultValue</code> instance may be shared by many <a href="AbstractAttribute.html" title="class in org.apache.sis.feature"><code>AbstractAttribute</code></a> instances.
  Consequently, the default value should be immutable for avoiding unexpected behavior.</p></div>
 <dl class="notes">
 <dt>Since:</dt>
 <dd>0.5</dd>
 <dt>See Also:</dt>
 <dd>
 <ul class="see-list">
 <li><a href="DefaultFeatureType.html" title="class in org.apache.sis.feature"><code>DefaultFeatureType</code></a></li>
 <li><a href="AbstractAttribute.html" title="class in org.apache.sis.feature"><code>AbstractAttribute</code></a></li>
 <li><a href="../../../../serialized-form.html#org.apache.sis.feature.DefaultAttributeType">Serialized Form</a></li>
 </ul>
 </dd>

 <p><font size="-1">Defined in the <code>sis-feature</code> module</font></p>
 </dl>
 </section>
 <section class="summary">
 <ul class="summary-list">
 <!-- =========== FIELD SUMMARY =========== -->
 <li>
 <section class="field-summary" id="field-summary">
 <h2>Field Summary</h2>
 <div class="inherited-list">
 <h3 id="fields-inherited-from-class-AbstractIdentifiedType">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></div>
 </section>
 </li>
 <!-- ======== CONSTRUCTOR SUMMARY ======== -->
 <li>
 <section class="constructor-summary" id="constructor-summary">
 <h2>Constructor Summary</h2>
 <div class="caption"><span>Constructors</span></div>
 <div class="summary-table two-column-summary">
 <div class="table-header col-first">Constructor</div>
 <div class="table-header col-last">Description</div>
 <div class="col-constructor-name even-row-color"><code><a href="#%3Cinit%3E(java.util.Map,java.lang.Class,int,int,V,org.apache.sis.feature.DefaultAttributeType...)" class="member-name-link">DefaultAttributeType</a><wbr>(<a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/util/Map.html" title="class or interface in java.util" class="external-link">Map</a>&lt;<a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>,<wbr>?&gt;&nbsp;identification,
  <a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/lang/Class.html" title="class or interface in java.lang" class="external-link">Class</a>&lt;<a href="DefaultAttributeType.html" title="type parameter in DefaultAttributeType">V</a>&gt;&nbsp;valueClass,
  int&nbsp;minimumOccurs,
  int&nbsp;maximumOccurs,
  <a href="DefaultAttributeType.html" title="type parameter in DefaultAttributeType">V</a>&nbsp;defaultValue,
  <a href="DefaultAttributeType.html" title="class in org.apache.sis.feature">DefaultAttributeType</a>&lt;?&gt;...&nbsp;characterizedBy)</code></div>
 <div class="col-last even-row-color">
 <div class="block">Constructs an attribute type from the given properties.</div>
 </div>
 </div>
 </section>
 </li>
 <!-- ========== METHOD SUMMARY =========== -->
 <li>
 <section class="method-summary" id="method-summary">
 <h2>Method Summary</h2>
 <div id="method-summary-table">
 <div class="table-tabs" role="tablist" aria-orientation="horizontal"><button id="method-summary-table-tab0" role="tab" aria-selected="true" aria-controls="method-summary-table.tabpanel" tabindex="0" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table', 3)" class="active-table-tab">All Methods</button><button id="method-summary-table-tab2" role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table-tab2', 3)" class="table-tab">Instance Methods</button><button id="method-summary-table-tab4" role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table-tab4', 3)" class="table-tab">Concrete Methods</button></div>
 <div id="method-summary-table.tabpanel" role="tabpanel">
 <div class="summary-table three-column-summary" aria-labelledby="method-summary-table-tab0">
 <div class="table-header col-first">Modifier and Type</div>
 <div class="table-header col-second">Method</div>
 <div class="table-header col-last">Description</div>
 <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/util/Map.html" title="class or interface in java.util" class="external-link">Map</a>&lt;<a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>,<wbr><a href="DefaultAttributeType.html" title="class in org.apache.sis.feature">DefaultAttributeType</a>&lt;?&gt;&gt;</code></div>
 <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#characteristics()" class="member-name-link">characteristics</a>()</code></div>
 <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
 <div class="block">Other attribute types that describes this attribute type.</div>
 </div>
 <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>boolean</code></div>
 <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#equals(java.lang.Object)" class="member-name-link">equals</a><wbr>(<a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">Object</a>&nbsp;obj)</code></div>
 <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
 <div class="block">Compares this attribute type with the given object for equality.</div>
 </div>
 <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="DefaultAttributeType.html" title="type parameter in DefaultAttributeType">V</a></code></div>
 <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getDefaultValue()" class="member-name-link">getDefaultValue</a>()</code></div>
 <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
 <div class="block">Returns the default value for the attribute.</div>
 </div>
 <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>final int</code></div>
 <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getMaximumOccurs()" class="member-name-link">getMaximumOccurs</a>()</code></div>
 <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
 <div class="block">Returns the maximum number of attribute values.</div>
 </div>
 <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>final int</code></div>
 <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getMinimumOccurs()" class="member-name-link">getMinimumOccurs</a>()</code></div>
 <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
 <div class="block">Returns the minimum number of attribute values.</div>
 </div>
 <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>final <a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/lang/Class.html" title="class or interface in java.lang" class="external-link">Class</a>&lt;<a href="DefaultAttributeType.html" title="type parameter in DefaultAttributeType">V</a>&gt;</code></div>
 <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getValueClass()" class="member-name-link">getValueClass</a>()</code></div>
 <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
 <div class="block">Returns the type of attribute values.</div>
 </div>
 <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>int</code></div>
 <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#hashCode()" class="member-name-link">hashCode</a>()</code></div>
 <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
 <div class="block">Returns a hash code value for this attribute type.</div>
 </div>
 <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="AbstractAttribute.html" title="class in org.apache.sis.feature">AbstractAttribute</a>&lt;<a href="DefaultAttributeType.html" title="type parameter in DefaultAttributeType">V</a>&gt;</code></div>
 <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#newInstance()" class="member-name-link">newInstance</a>()</code></div>
 <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
 <div class="block">Creates a new attribute instance of this type initialized to the <a href="#getDefaultValue()">default value</a>.</div>
 </div>
 <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a></code></div>
 <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#toString()" class="member-name-link">toString</a>()</code></div>
 <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
 <div class="block">Returns a string representation of this attribute type.</div>
 </div>
 </div>
 </div>
 </div>
 <div class="inherited-list">
 <h3 id="methods-inherited-from-class-AbstractIdentifiedType">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()">getDefinition</a>, <a href="AbstractIdentifiedType.html#getDescription()">getDescription</a>, <a href="AbstractIdentifiedType.html#getDesignation()">getDesignation</a>, <a href="AbstractIdentifiedType.html#getName()">getName</a>, <a href="AbstractIdentifiedType.html#getRemarks()">getRemarks</a>, <a href="AbstractIdentifiedType.html#isDeprecated()">isDeprecated</a></code></div>
 <div class="inherited-list">
 <h3 id="methods-inherited-from-class-Object">Methods inherited from class&nbsp;<a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">Object</a></h3>
 <code><a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/lang/Object.html#clone()" title="class or interface in java.lang" class="external-link">clone</a>, <a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/lang/Object.html#finalize()" title="class or interface in java.lang" class="external-link">finalize</a>, <a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/lang/Object.html#getClass()" title="class or interface in java.lang" class="external-link">getClass</a>, <a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/lang/Object.html#notify()" title="class or interface in java.lang" class="external-link">notify</a>, <a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/lang/Object.html#notifyAll()" title="class or interface in java.lang" class="external-link">notifyAll</a>, <a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/lang/Object.html#wait()" title="class or interface in java.lang" class="external-link">wait</a>, <a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/lang/Object.html#wait(long)" title="class or interface in java.lang" class="external-link">wait</a>, <a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/lang/Object.html#wait(long,int)" title="class or interface in java.lang" class="external-link">wait</a></code></div>
 </section>
 </li>
 </ul>
 </section>
 <section class="details">
 <ul class="details-list">
 <!-- ========= CONSTRUCTOR DETAIL ======== -->
 <li>
 <section class="constructor-details" id="constructor-detail">
 <h2>Constructor Details</h2>
 <ul class="member-list">
 <li>
 <section class="detail" id="&lt;init&gt;(java.util.Map,java.lang.Class,int,int,V,org.apache.sis.feature.DefaultAttributeType...)">
 <h3 id="&lt;init&gt;(java.util.Map,java.lang.Class,int,int,java.lang.Object,org.apache.sis.feature.DefaultAttributeType[])">DefaultAttributeType</h3>
 <div class="member-signature"><span class="modifiers">public</span>&nbsp;<span class="element-name">DefaultAttributeType</span><wbr><span class="parameters">(<a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/util/Map.html" title="class or interface in java.util" class="external-link">Map</a>&lt;<a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>,<wbr>?&gt;&nbsp;identification,
  <a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/lang/Class.html" title="class or interface in java.lang" class="external-link">Class</a>&lt;<a href="DefaultAttributeType.html" title="type parameter in DefaultAttributeType">V</a>&gt;&nbsp;valueClass,
  int&nbsp;minimumOccurs,
  int&nbsp;maximumOccurs,
  <a href="DefaultAttributeType.html" title="type parameter in DefaultAttributeType">V</a>&nbsp;defaultValue,
  <a href="DefaultAttributeType.html" title="class in org.apache.sis.feature">DefaultAttributeType</a>&lt;?&gt;...&nbsp;characterizedBy)</span></div>
 <div class="block">Constructs an attribute type from the given properties. The identification 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.geoapi/org/opengis/util/GenericName.html" title="class or interface in org.opengis.util" class="external-link"><code>GenericName</code></a> or <a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link"><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.geoapi/org/opengis/util/InternationalString.html" title="class or interface in org.opengis.util" class="external-link"><code>InternationalString</code></a> or <a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link"><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.geoapi/org/opengis/util/InternationalString.html" title="class or interface in org.opengis.util" class="external-link"><code>InternationalString</code></a> or <a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link"><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.geoapi/org/opengis/util/InternationalString.html" title="class or interface in org.opengis.util" class="external-link"><code>InternationalString</code></a> or <a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link"><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/en/java/javase/16/docs/api/java.base/java/lang/Boolean.html" title="class or interface in java.lang" class="external-link"><code>Boolean</code></a></td>
      <td><a href="AbstractIdentifiedType.html#isDeprecated()"><code>AbstractIdentifiedType.isDeprecated()</code></a></td>
    </tr>
  </table></div>
 <dl class="notes">
 <dt>Parameters:</dt>
 <dd><code>identification</code> - the name and other information to be given to this attribute type.</dd>
 <dd><code>valueClass</code> - the type of attribute values.</dd>
 <dd><code>minimumOccurs</code> - the minimum number of occurrences of the attribute within its containing entity.</dd>
 <dd><code>maximumOccurs</code> - the maximum number of occurrences of the attribute within its containing entity,
                          or <a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/lang/Integer.html#MAX_VALUE" title="class or interface in java.lang" class="external-link"><code>Integer.MAX_VALUE</code></a> if there is no restriction.</dd>
 <dd><code>defaultValue</code> - the default value for the attribute, or <code>null</code> if none.</dd>
 <dd><code>characterizedBy</code> - other attribute types that describes this attribute type (can be <code>null</code> for none).
                          For example if this new <code>DefaultAttributeType</code> describes a measurement,
                          then <code>characterizedBy</code> could holds the measurement accuracy.
                          See <cite>"Attribute characterization"</cite> in class Javadoc for more information.</dd>
 <dt>See Also:</dt>
 <dd>
 <ul class="see-list">
 <li><a href="builder/AttributeTypeBuilder.html" title="class in org.apache.sis.feature.builder"><code>AttributeTypeBuilder</code></a></li>
 </ul>
 </dd>
 </dl>
 </section>
 </li>
 </ul>
 </section>
 </li>
 <!-- ============ METHOD DETAIL ========== -->
 <li>
 <section class="method-details" id="method-detail">
 <h2>Method Details</h2>
 <ul class="member-list">
 <li>
 <section class="detail" id="getValueClass()">
 <h3>getValueClass</h3>
 <div class="member-signature"><span class="modifiers">public final</span>&nbsp;<span class="return-type"><a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/lang/Class.html" title="class or interface in java.lang" class="external-link">Class</a>&lt;<a href="DefaultAttributeType.html" title="type parameter in DefaultAttributeType">V</a>&gt;</span>&nbsp;<span class="element-name">getValueClass</span>()</div>
 <div class="block">Returns the type of attribute values.</div>
 <dl class="notes">
 <dt>Returns:</dt>
 <dd>the type of attribute values.</dd>
 </dl>
 </section>
 </li>
 <li>
 <section class="detail" id="getMinimumOccurs()">
 <h3>getMinimumOccurs</h3>
 <div class="member-signature"><span class="modifiers">public final</span>&nbsp;<span class="return-type">int</span>&nbsp;<span class="element-name">getMinimumOccurs</span>()</div>
 <div class="block">Returns the minimum number of attribute values.
  The returned value is greater than or equal to zero.

  <p>To be valid, an <code>Attribute</code> instance of this <code>AttributeType</code> shall have at least
  this minimum number of elements in its <a href="AbstractAttribute.html#getValues()"><code>collection of values</code></a>.</p></div>
 <dl class="notes">
 <dt>Returns:</dt>
 <dd>the minimum number of attribute values.</dd>
 </dl>
 </section>
 </li>
 <li>
 <section class="detail" id="getMaximumOccurs()">
 <h3>getMaximumOccurs</h3>
 <div class="member-signature"><span class="modifiers">public final</span>&nbsp;<span class="return-type">int</span>&nbsp;<span class="element-name">getMaximumOccurs</span>()</div>
 <div class="block">Returns the maximum number of attribute values.
  The returned value is greater than or equal to the <a href="#getMinimumOccurs()"><code>getMinimumOccurs()</code></a> value.
  If there is no maximum, then this method returns <a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/lang/Integer.html#MAX_VALUE" title="class or interface in java.lang" class="external-link"><code>Integer.MAX_VALUE</code></a>.

  <p>To be valid, an <code>Attribute</code> instance of this <code>AttributeType</code> shall have no more than
  this maximum number of elements in its <a href="AbstractAttribute.html#getValues()"><code>collection of values</code></a>.</p></div>
 <dl class="notes">
 <dt>Returns:</dt>
 <dd>the maximum number of attribute values, or <a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/lang/Integer.html#MAX_VALUE" title="class or interface in java.lang" class="external-link"><code>Integer.MAX_VALUE</code></a> if none.</dd>
 </dl>
 </section>
 </li>
 <li>
 <section class="detail" id="getDefaultValue()">
 <h3>getDefaultValue</h3>
 <div class="member-signature"><span class="modifiers">public</span>&nbsp;<span class="return-type"><a href="DefaultAttributeType.html" title="type parameter in DefaultAttributeType">V</a></span>&nbsp;<span class="element-name">getDefaultValue</span>()</div>
 <div class="block">Returns the default value for the attribute.
  This value is used when an attribute is created and no value for it is specified.</div>
 <dl class="notes">
 <dt>Returns:</dt>
 <dd>the default value for the attribute, or <code>null</code> if none.</dd>
 </dl>
 </section>
 </li>
 <li>
 <section class="detail" id="characteristics()">
 <h3>characteristics</h3>
 <div class="member-signature"><span class="modifiers">public</span>&nbsp;<span class="return-type"><a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/util/Map.html" title="class or interface in java.util" class="external-link">Map</a>&lt;<a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>,<wbr><a href="DefaultAttributeType.html" title="class in org.apache.sis.feature">DefaultAttributeType</a>&lt;?&gt;&gt;</span>&nbsp;<span class="element-name">characteristics</span>()</div>
 <div class="block">Other attribute types that describes this attribute type.
  See <cite>"Attribute characterization"</cite> in class Javadoc for more information.

  <div class="note"><b>Example:</b>
  An attribute that carries a measurement (e.g. air temperature) may have another attribute that holds the
  measurement accuracy. The accuracy is often constant for all measurements in a dataset, but not necessarily.
  If the accuracy is a constant, then the characteristics <a href="#getDefaultValue()">default value</a>
  shall hold that constant.
  </div>

  The characteristics are enumerated in the <a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/util/Map.html#values()" title="class or interface in java.util" class="external-link">map values</a>.
  The <a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/util/Map.html#keySet()" title="class or interface in java.util" class="external-link">map keys</a> are the <code>String</code> representations
  of characteristics <a href="AbstractIdentifiedType.html#getName()">name</a>, for more convenient lookups.</div>
 <dl class="notes">
 <dt>Returns:</dt>
 <dd>other attribute types that describes this attribute type, or an empty map if none.</dd>
 <dt>See Also:</dt>
 <dd>
 <ul class="see-list-long">
 <li><a href="AbstractAttribute.html#characteristics()"><code>AbstractAttribute.characteristics()</code></a></li>
 </ul>
 </dd>
 </dl>
 </section>
 </li>
 <li>
 <section class="detail" id="newInstance()">
 <h3>newInstance</h3>
 <div class="member-signature"><span class="modifiers">public</span>&nbsp;<span class="return-type"><a href="AbstractAttribute.html" title="class in org.apache.sis.feature">AbstractAttribute</a>&lt;<a href="DefaultAttributeType.html" title="type parameter in DefaultAttributeType">V</a>&gt;</span>&nbsp;<span class="element-name">newInstance</span>()</div>
 <div class="block">Creates a new attribute instance of this type initialized to the <a href="#getDefaultValue()">default value</a>.</div>
 <dl class="notes">
 <dt>Returns:</dt>
 <dd>a new attribute instance.</dd>
 <dt>See Also:</dt>
 <dd>
 <ul class="see-list-long">
 <li><a href="AbstractAttribute.html#create(org.apache.sis.feature.DefaultAttributeType)"><code>AbstractAttribute.create(DefaultAttributeType)</code></a></li>
 </ul>
 </dd>
 </dl>
 </section>
 </li>
 <li>
 <section class="detail" id="hashCode()">
 <h3>hashCode</h3>
 <div class="member-signature"><span class="modifiers">public</span>&nbsp;<span class="return-type">int</span>&nbsp;<span class="element-name">hashCode</span>()</div>
 <div class="block">Returns a hash code value for this attribute type.</div>
 <dl class="notes">
 <dt>Returns:</dt>
 <dd>the hash code for this type.</dd>
 </dl>
 </section>
 </li>
 <li>
 <section class="detail" id="equals(java.lang.Object)">
 <h3>equals</h3>
 <div class="member-signature"><span class="modifiers">public</span>&nbsp;<span class="return-type">boolean</span>&nbsp;<span class="element-name">equals</span><wbr><span class="parameters">(<a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">Object</a>&nbsp;obj)</span></div>
 <div class="block">Compares this attribute type with the given object for equality.</div>
 <dl class="notes">
 <dt>Parameters:</dt>
 <dd><code>obj</code> - the object to compare with this type.</dd>
 <dt>Returns:</dt>
 <dd><code>true</code> if the given object is equal to this type.</dd>
 </dl>
 </section>
 </li>
 <li>
 <section class="detail" id="toString()">
 <h3>toString</h3>
 <div class="member-signature"><span class="modifiers">public</span>&nbsp;<span class="return-type"><a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a></span>&nbsp;<span class="element-name">toString</span>()</div>
 <div class="block">Returns a string representation of this attribute type.
  The returned string is for debugging purpose and may change in any future SIS version.</div>
 <dl class="notes">
 <dt>Overrides:</dt>
 <dd><code><a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/lang/Object.html#toString()" title="class or interface in java.lang" class="external-link">toString</a></code>&nbsp;in class&nbsp;<code><a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">Object</a></code></dd>
 <dt>Returns:</dt>
 <dd>a string representation of this attribute type for debugging purpose.</dd>
 </dl>
 </section>
 </li>
 </ul>
 </section>
 </li>
 </ul>
 </section>
 <!-- ========= END OF CLASS DATA ========= -->
 </main>
 <footer role="contentinfo">
 <hr>
 <p class="legal-copy"><small>Copyright &#169; 2010&#x2013;2022 <a href="https://www.apache.org/">The Apache Software Foundation</a>. All rights reserved.</small></p>
 </footer>
 </div>
 </div>
 </body>
 </html>