| <!DOCTYPE HTML> |
| <!-- NewPage --> |
| <html lang="en"> |
| <head> |
| <!-- Generated by javadoc (11.0.4) on Fri Sep 20 12:10:30 CEST 2019 --> |
| <title>DefaultAttributeType (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.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="../../../../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="DefaultAttributeType (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,"i8":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/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">Help</a></li> |
| </ul> |
| </div> |
| <div class="subNav"> |
| <ul class="navList" id="allclasses_navbar_top"> |
| <li><a href="../../../../allclasses.html">All 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: </li> |
| <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> |
| <ul class="subNavList"> |
| <li>Detail: </li> |
| <li>Field | </li> |
| <li><a href="#constructor.detail">Constr</a> | </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"> </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> <a href="package-summary.html">org.apache.sis.feature</a></div> |
| <h2 title="Class DefaultAttributeType" class="title">Class DefaultAttributeType<V></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>DefaultAttributeType<V></li> |
| </ul> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| <div class="description"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <dl> |
| <dt><span class="paramLabel">Type Parameters:</span></dt> |
| <dd><code>V</code> - the type of attribute values.</dd> |
| </dl> |
| <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">DefaultAttributeType<V></span> |
| extends <a href="AbstractIdentifiedType.html" title="class in org.apache.sis.feature">AbstractIdentifiedType</a></pre> |
| <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/javase/8/docs/api/java/lang/reflect/Field.html?is-external=true" title="class or interface in java.lang.reflect" class="externalLink"><code>Field</code></a> |
| while <code>FeatureType</code> is equivalent to <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Class.html?is-external=true" title="class or interface in java.lang" class="externalLink"><code>Class</code></a>. |
| Attribute characterization (discussed below) is similar to <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/annotation/Annotation.html?is-external=true" title="class or interface in java.lang.annotation" class="externalLink"><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> |
| |
| <div class="section">Value type</div> |
| 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/geometry/Geometry.html?is-external=true" title="class or interface in org.opengis.geometry" class="externalLink"><code>Geometry</code></a></td></tr> |
| <tr><td>Building owner</td> <td><a href="http://www.geoapi.org/3.0/javadoc/org/opengis/metadata/citation/ResponsibleParty.html?is-external=true" title="class or interface in org.opengis.metadata.citation" class="externalLink"><code>ResponsibleParty</code></a></td></tr> |
| <tr><td>Horizontal accuracy</td> <td><a href="http://www.geoapi.org/3.0/javadoc/org/opengis/metadata/quality/PositionalAccuracy.html?is-external=true" title="class or interface in org.opengis.metadata.quality" class="externalLink"><code>PositionalAccuracy</code></a></td></tr> |
| </table> |
| |
| <div class="section">Attribute characterization</div> |
| 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 an other 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 in 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. |
| |
| <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>GenericName</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>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> |
| <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>DefaultFeatureType</code></a>, |
| <a href="AbstractAttribute.html" title="class in org.apache.sis.feature"><code>AbstractAttribute</code></a>, |
| <a href="../../../../serialized-form.html#org.apache.sis.feature.DefaultAttributeType">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 <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"> </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,java.lang.Class,int,int,V,org.apache.sis.feature.DefaultAttributeType...)">DefaultAttributeType</a></span>​(<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><<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>,​?> identification, |
| <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Class.html?is-external=true" title="class or interface in java.lang" class="externalLink">Class</a><<a href="DefaultAttributeType.html" title="type parameter in DefaultAttributeType">V</a>> valueClass, |
| int minimumOccurs, |
| int maximumOccurs, |
| <a href="DefaultAttributeType.html" title="type parameter in DefaultAttributeType">V</a> defaultValue, |
| <a href="DefaultAttributeType.html" title="class in org.apache.sis.feature">DefaultAttributeType</a><?>... characterizedBy)</code></th> |
| <td class="colLast"> |
| <div class="block">Constructs an attribute type from the given properties.</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"> </span></span><span id="t2" class="tableTab"><span><a href="javascript:show(2);">Instance Methods</a></span><span class="tabEnd"> </span></span><span id="t4" class="tableTab"><span><a href="javascript:show(8);">Concrete Methods</a></span><span class="tabEnd"> </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><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><<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>,​<a href="DefaultAttributeType.html" title="class in org.apache.sis.feature">DefaultAttributeType</a><?>></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#characteristics()">characteristics</a></span>()</code></th> |
| <td class="colLast"> |
| <div class="block">Other attribute types that describes this attribute type.</div> |
| </td> |
| </tr> |
| <tr id="i1" class="rowColor"> |
| <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>​(<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> obj)</code></th> |
| <td class="colLast"> |
| <div class="block">Compares this attribute type with the given object for equality.</div> |
| </td> |
| </tr> |
| <tr id="i2" class="altColor"> |
| <td class="colFirst"><code><a href="DefaultAttributeType.html" title="type parameter in DefaultAttributeType">V</a></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getDefaultValue()">getDefaultValue</a></span>()</code></th> |
| <td class="colLast"> |
| <div class="block">Returns the default value for the attribute.</div> |
| </td> |
| </tr> |
| <tr id="i3" 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 attribute 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="#getMinimumOccurs()">getMinimumOccurs</a></span>()</code></th> |
| <td class="colLast"> |
| <div class="block">Returns the minimum number of attribute values.</div> |
| </td> |
| </tr> |
| <tr id="i5" class="rowColor"> |
| <td class="colFirst"><code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Class.html?is-external=true" title="class or interface in java.lang" class="externalLink">Class</a><<a href="DefaultAttributeType.html" title="type parameter in DefaultAttributeType">V</a>></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getValueClass()">getValueClass</a></span>()</code></th> |
| <td class="colLast"> |
| <div class="block">Returns the type of attribute values.</div> |
| </td> |
| </tr> |
| <tr id="i6" 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 attribute type.</div> |
| </td> |
| </tr> |
| <tr id="i7" class="rowColor"> |
| <td class="colFirst"><code><a href="AbstractAttribute.html" title="class in org.apache.sis.feature">AbstractAttribute</a><<a href="DefaultAttributeType.html" title="type parameter in DefaultAttributeType">V</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 attribute instance of this type initialized to the <a href="#getDefaultValue()">default value</a>.</div> |
| </td> |
| </tr> |
| <tr id="i8" class="altColor"> |
| <td class="colFirst"><code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang" 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 attribute type.</div> |
| </td> |
| </tr> |
| </table> |
| <ul class="blockList"> |
| <li class="blockList"><a id="methods.inherited.from.class.AbstractIdentifiedType"> |
| <!-- --> |
| </a> |
| <h3>Methods inherited from class <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></li> |
| </ul> |
| <ul class="blockList"> |
| <li class="blockList"><a id="methods.inherited.from.class.Object"> |
| <!-- --> |
| </a> |
| <h3>Methods inherited from class <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">getClass</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#notify()" title="class or interface in java.lang" 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">notifyAll</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="<init>(java.util.Map,java.lang.Class,int,int,java.lang.Object,org.apache.sis.feature.DefaultAttributeType[])"> |
| <!-- --> |
| </a><a id="<init>(java.util.Map,java.lang.Class,int,int,V,org.apache.sis.feature.DefaultAttributeType...)"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>DefaultAttributeType</h4> |
| <pre>public DefaultAttributeType​(<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><<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>,​?> identification, |
| <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Class.html?is-external=true" title="class or interface in java.lang" class="externalLink">Class</a><<a href="DefaultAttributeType.html" title="type parameter in DefaultAttributeType">V</a>> valueClass, |
| int minimumOccurs, |
| int maximumOccurs, |
| <a href="DefaultAttributeType.html" title="type parameter in DefaultAttributeType">V</a> defaultValue, |
| <a href="DefaultAttributeType.html" title="class in org.apache.sis.feature">DefaultAttributeType</a><?>... characterizedBy)</pre> |
| <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/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 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/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> |
| <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><span class="seeLabel">See Also:</span></dt> |
| <dd><a href="builder/AttributeTypeBuilder.html" title="class in org.apache.sis.feature.builder"><code>AttributeTypeBuilder</code></a></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="getValueClass()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getValueClass</h4> |
| <pre class="methodSignature">public final <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Class.html?is-external=true" title="class or interface in java.lang" class="externalLink">Class</a><<a href="DefaultAttributeType.html" title="type parameter in DefaultAttributeType">V</a>> getValueClass()</pre> |
| <div class="block">Returns the type of attribute values.</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the type of attribute values.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="getMinimumOccurs()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getMinimumOccurs</h4> |
| <pre class="methodSignature">public final int getMinimumOccurs()</pre> |
| <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> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the minimum number of attribute values.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="getMaximumOccurs()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getMaximumOccurs</h4> |
| <pre class="methodSignature">public final int getMaximumOccurs()</pre> |
| <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/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>. |
| |
| <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> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the maximum number of attribute values, 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="getDefaultValue()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getDefaultValue</h4> |
| <pre class="methodSignature">public <a href="DefaultAttributeType.html" title="type parameter in DefaultAttributeType">V</a> getDefaultValue()</pre> |
| <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> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the default value for the attribute, or <code>null</code> if none.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="characteristics()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>characteristics</h4> |
| <pre class="methodSignature">public <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><<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>,​<a href="DefaultAttributeType.html" title="class in org.apache.sis.feature">DefaultAttributeType</a><?>> characteristics()</pre> |
| <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/javase/8/docs/api/java/util/Map.html?is-external=true#values()" title="class or interface in java.util" class="externalLink">map values</a>. |
| The <a href="https://docs.oracle.com/javase/8/docs/api/java/util/Map.html?is-external=true#keySet()" title="class or interface in java.util" class="externalLink">map keys</a> are the <code>String</code> representations |
| of characteristics <a href="AbstractIdentifiedType.html#getName()">name</a>, for more convenient lookups.</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>other attribute types that describes this attribute type, or an empty map if none.</dd> |
| <dt><span class="seeLabel">See Also:</span></dt> |
| <dd><a href="AbstractAttribute.html#characteristics()"><code>AbstractAttribute.characteristics()</code></a></dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="newInstance()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>newInstance</h4> |
| <pre class="methodSignature">public <a href="AbstractAttribute.html" title="class in org.apache.sis.feature">AbstractAttribute</a><<a href="DefaultAttributeType.html" title="type parameter in DefaultAttributeType">V</a>> newInstance()</pre> |
| <div class="block">Creates a new attribute instance of this type initialized to the <a href="#getDefaultValue()">default value</a>.</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>a new attribute instance.</dd> |
| <dt><span class="seeLabel">See Also:</span></dt> |
| <dd><a href="AbstractAttribute.html#create(org.apache.sis.feature.DefaultAttributeType)"><code>AbstractAttribute.create(DefaultAttributeType)</code></a></dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="hashCode()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>hashCode</h4> |
| <pre class="methodSignature">public int hashCode()</pre> |
| <div class="block">Returns a hash code value for this attribute type.</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 boolean equals​(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang" class="externalLink">Object</a> obj)</pre> |
| <div class="block">Compares this attribute type 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 <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> toString()</pre> |
| <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> |
| <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">toString</a></code> in class <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 attribute type 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/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">Help</a></li> |
| </ul> |
| </div> |
| <div class="subNav"> |
| <ul class="navList" id="allclasses_navbar_bottom"> |
| <li><a href="../../../../allclasses.html">All 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: </li> |
| <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> |
| <ul class="subNavList"> |
| <li>Detail: </li> |
| <li>Field | </li> |
| <li><a href="#constructor.detail">Constr</a> | </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 © 2010–2019 <a href="https://www.apache.org/">The Apache Software Foundation</a>. All rights reserved.</small></p> |
| </footer> |
| </body> |
| </html> |