| <!DOCTYPE HTML> |
| <!-- NewPage --> |
| <html lang="en"> |
| <head> |
| <!-- Generated by javadoc (11.0.4) on Fri Sep 20 12:10:30 CEST 2019 --> |
| <title>DefaultFeatureType (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.DefaultFeatureType class"> |
| <meta name="keywords" content="isAbstract()"> |
| <meta name="keywords" content="isSimple()"> |
| <meta name="keywords" content="isAssignableFrom()"> |
| <meta name="keywords" content="getSuperTypes()"> |
| <meta name="keywords" content="getProperties()"> |
| <meta name="keywords" content="getProperty()"> |
| <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="DefaultFeatureType (Apache SIS 1.0 API)"; |
| } |
| } |
| catch(err) { |
| } |
| //--> |
| var data = {"i0":10,"i1":6,"i2":10,"i3":10,"i4":10,"i5":10,"i6":10,"i7":10,"i8":10,"i9":10,"i10":10}; |
| var tabs = {65535:["t0","All Methods"],2:["t2","Instance Methods"],4:["t3","Abstract 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/DefaultFeatureType.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 DefaultFeatureType" class="title">Class DefaultFeatureType</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>DefaultFeatureType</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">DefaultFeatureType</span> |
| extends <a href="AbstractIdentifiedType.html" title="class in org.apache.sis.feature">AbstractIdentifiedType</a></pre> |
| <div class="block">Abstraction of a real-world phenomena. A <code>FeatureType</code> instance describes the class of all |
| <a href="AbstractFeature.html" title="class in org.apache.sis.feature">feature</a> instances of that type. |
| |
| <div class="note"><b>Analogy:</b> |
| compared to the Java language, <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> while |
| <code>Feature</code> instances are equivalent to <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"><code>Object</code></a> instances of that class.</div> |
| |
| <div class="warning"><b>Warning:</b> |
| This class is expected to implement a GeoAPI <code>FeatureType</code> interface in a future version. |
| When such interface will be available, most references to <code>DefaultFeatureType</code> in the API |
| will be replaced by references to the <code>FeatureType</code> interface.</div> |
| |
| <div class="section">Naming</div> |
| The feature type <a href="AbstractIdentifiedType.html#getName()">name</a> is mandatory and should be unique. Those names are the main |
| criterion used for deciding if a feature type <a href="#isAssignableFrom(org.apache.sis.feature.DefaultFeatureType)">is assignable from</a> another type. |
| Names can be <a href="../util/iso/DefaultScopedName.html" title="class in org.apache.sis.util.iso">scoped</a> for avoiding name collision. |
| |
| <div class="section">Properties and inheritance</div> |
| Each feature type can provide descriptions for the following <a href="#getProperties(boolean)">properties</a>: |
| |
| <ul> |
| <li><a href="DefaultAttributeType.html" title="class in org.apache.sis.feature">Attributes</a></li> |
| <li><a href="DefaultAssociationRole.html" title="class in org.apache.sis.feature">Associations to other features</a></li> |
| <li><a href="AbstractOperation.html" title="class in org.apache.sis.feature">Operations</a></li> |
| </ul> |
| |
| In addition, a feature type can inherit the properties of one or more other feature types. |
| Properties defined in the sub-type can override properties of the same name defined in the |
| <a href="#getSuperTypes()">super-types</a>, provided that values of the sub-type property are |
| assignable to the super-type property. |
| |
| <div class="note"><b>Analogy:</b> compared to the Java language, the above rule is similar to overriding a method |
| with a more specific return type (a.k.a. <cite>covariant return type</cite>). This is also similar to Java arrays, |
| which are implicitly <cite>covariant</cite> (i.e. <code>String[]</code> can be casted to <code>CharSequence[]</code>, which |
| is safe for read operations but not for write operations — the later may throw <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/ArrayStoreException.html?is-external=true" title="class or interface in java.lang" class="externalLink"><code>ArrayStoreException</code></a>).</div> |
| |
| <div class="section">Instantiation</div> |
| <code>DefaultFeatureType</code> can be instantiated directly by a call to its <a href="#%3Cinit%3E(java.util.Map,boolean,org.apache.sis.feature.DefaultFeatureType%5B%5D,org.apache.sis.feature.AbstractIdentifiedType...)">constructor</a>. |
| But a more convenient approach may be to use the <a href="builder/FeatureTypeBuilder.html" title="class in org.apache.sis.feature.builder"><code>FeatureTypeBuilder</code></a> instead, |
| which provides shortcuts for frequently-used operations like creating various <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> |
| instances sharing the same namespace. |
| |
| <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 (<code>AttributeType</code> instances) 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="DefaultAttributeType.html" title="class in org.apache.sis.feature"><code>DefaultAttributeType</code></a>, |
| <a href="DefaultAssociationRole.html" title="class in org.apache.sis.feature"><code>DefaultAssociationRole</code></a>, |
| <a href="AbstractFeature.html" title="class in org.apache.sis.feature"><code>AbstractFeature</code></a>, |
| <a href="../metadata/iso/content/DefaultFeatureTypeInfo.html" title="class in org.apache.sis.metadata.iso.content"><code>DefaultFeatureTypeInfo</code></a>, |
| <a href="../storage/FeatureNaming.html" title="class in org.apache.sis.storage"><code>FeatureNaming</code></a>, |
| <a href="../../../../serialized-form.html#org.apache.sis.feature.DefaultFeatureType">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,boolean,org.apache.sis.feature.DefaultFeatureType%5B%5D,org.apache.sis.feature.AbstractIdentifiedType...)">DefaultFeatureType</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, |
| boolean isAbstract, |
| <a href="DefaultFeatureType.html" title="class in org.apache.sis.feature">DefaultFeatureType</a>[] superTypes, |
| <a href="AbstractIdentifiedType.html" title="class in org.apache.sis.feature">AbstractIdentifiedType</a>... properties)</code></th> |
| <td class="colLast"> |
| <div class="block">Constructs a feature 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="t3" class="tableTab"><span><a href="javascript:show(4);">Abstract 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>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 feature type with the given object for equality.</div> |
| </td> |
| </tr> |
| <tr id="i1" class="rowColor"> |
| <td class="colFirst"><code><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></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getName()">getName</a></span>()</code></th> |
| <td class="colLast"> </td> |
| </tr> |
| <tr id="i2" class="altColor"> |
| <td class="colFirst"><code><a href="https://docs.oracle.com/javase/8/docs/api/java/util/Collection.html?is-external=true" title="class or interface in java.util" class="externalLink">Collection</a><<a href="AbstractIdentifiedType.html" title="class in org.apache.sis.feature">AbstractIdentifiedType</a>></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getProperties(boolean)">getProperties</a></span>​(boolean includeSuperTypes)</code></th> |
| <td class="colLast"> |
| <div class="block">Returns any feature operation, any feature attribute type and any feature association role that |
| carries characteristics of a feature type.</div> |
| </td> |
| </tr> |
| <tr id="i3" class="rowColor"> |
| <td class="colFirst"><code><a href="AbstractIdentifiedType.html" title="class in org.apache.sis.feature">AbstractIdentifiedType</a></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getProperty(java.lang.String)">getProperty</a></span>​(<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> name)</code></th> |
| <td class="colLast"> |
| <div class="block">Returns the attribute, operation or association role for the given name.</div> |
| </td> |
| </tr> |
| <tr id="i4" class="altColor"> |
| <td class="colFirst"><code><a href="https://docs.oracle.com/javase/8/docs/api/java/util/Set.html?is-external=true" title="class or interface in java.util" class="externalLink">Set</a><<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="#getSuperTypes()">getSuperTypes</a></span>()</code></th> |
| <td class="colLast"> |
| <div class="block">Returns the direct parents of this feature type.</div> |
| </td> |
| </tr> |
| <tr id="i5" class="rowColor"> |
| <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 feature type.</div> |
| </td> |
| </tr> |
| <tr id="i6" class="altColor"> |
| <td class="colFirst"><code>boolean</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#isAbstract()">isAbstract</a></span>()</code></th> |
| <td class="colLast"> |
| <div class="block">Returns <code>true</code> if the feature type acts as an abstract super-type.</div> |
| </td> |
| </tr> |
| <tr id="i7" class="rowColor"> |
| <td class="colFirst"><code>boolean</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#isAssignableFrom(org.apache.sis.feature.DefaultFeatureType)">isAssignableFrom</a></span>​(<a href="DefaultFeatureType.html" title="class in org.apache.sis.feature">DefaultFeatureType</a> type)</code></th> |
| <td class="colLast"> |
| <div class="block">Returns <code>true</code> if this type is same or a super-type of the given type.</div> |
| </td> |
| </tr> |
| <tr id="i8" class="altColor"> |
| <td class="colFirst"><code>boolean</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#isSimple()">isSimple</a></span>()</code></th> |
| <td class="colLast"> |
| <div class="block">Returns <code>true</code> if this feature type contains only attributes with [1 … 1] multiplicity, |
| or operations (no feature association).</div> |
| </td> |
| </tr> |
| <tr id="i9" class="rowColor"> |
| <td class="colFirst"><code><a href="AbstractFeature.html" title="class in org.apache.sis.feature">AbstractFeature</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 feature instance of this type.</div> |
| </td> |
| </tr> |
| <tr id="i10" 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">Formats this feature in a tabular format.</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,boolean,org.apache.sis.feature.DefaultFeatureType[],org.apache.sis.feature.AbstractIdentifiedType...)"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>DefaultFeatureType</h4> |
| <pre>public DefaultFeatureType​(<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, |
| boolean isAbstract, |
| <a href="DefaultFeatureType.html" title="class in org.apache.sis.feature">DefaultFeatureType</a>[] superTypes, |
| <a href="AbstractIdentifiedType.html" title="class in org.apache.sis.feature">AbstractIdentifiedType</a>... properties)</pre> |
| <div class="block">Constructs a feature 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 class="warning"><b>Warning:</b> In a future SIS version, the type of array elements may be |
| changed to <code>org.opengis.feature.FeatureType</code> and <code>org.opengis.feature.PropertyType</code>. |
| This change is pending GeoAPI revision. In the meantime, make sure that the <code>properties</code> |
| array contains only attribute types, association roles or operations, <strong>not</strong> other |
| feature types since the later are not properties in the ISO sense.</div></div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>identification</code> - the name and other information to be given to this feature type.</dd> |
| <dd><code>isAbstract</code> - if <code>true</code>, the feature type acts as an abstract super-type.</dd> |
| <dd><code>superTypes</code> - the parents of this feature type, or <code>null</code> or empty if none.</dd> |
| <dd><code>properties</code> - any feature operation, any feature attribute type and any feature |
| association role that carries characteristics of a feature type.</dd> |
| <dt><span class="seeLabel">See Also:</span></dt> |
| <dd><a href="builder/FeatureTypeBuilder.html" title="class in org.apache.sis.feature.builder"><code>FeatureTypeBuilder</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="isAbstract()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>isAbstract</h4> |
| <pre class="methodSignature">public final boolean isAbstract()</pre> |
| <div class="block">Returns <code>true</code> if the feature type acts as an abstract super-type. |
| Abstract types can not be <a href="#newInstance()">instantiated</a>.</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd><code>true</code> if the feature type acts as an abstract super-type.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="isSimple()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>isSimple</h4> |
| <pre class="methodSignature">public boolean isSimple()</pre> |
| <div class="block">Returns <code>true</code> if this feature type contains only attributes with [1 … 1] multiplicity, |
| or operations (no feature association). |
| Such feature types can be handled as a <a href="../util/iso/DefaultRecord.html" title="class in org.apache.sis.util.iso">records</a>.</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd><code>true</code> if this feature type contains only simple attributes or operations.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="isAssignableFrom(org.apache.sis.feature.DefaultFeatureType)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>isAssignableFrom</h4> |
| <pre class="methodSignature">public boolean isAssignableFrom​(<a href="DefaultFeatureType.html" title="class in org.apache.sis.feature">DefaultFeatureType</a> type)</pre> |
| <div class="block">Returns <code>true</code> if this type is same or a super-type of the given type. |
| The check is based mainly on the feature type <a href="AbstractIdentifiedType.html#getName()">name</a>, which should be unique. |
| However as a safety, this method also checks that all properties in this feature type is assignable |
| from a property of the same name in the given type. |
| |
| <div class="section">Constraints:</div> |
| <ul> |
| <li>If <var>A</var> is assignable from <var>B</var> and <var>B</var> is assignable from <var>C</var>, |
| then <var>A</var> is assignable from <var>C</var>.</li> |
| </ul> |
| |
| <div class="note"><b>Analogy:</b> |
| if we compare <code>FeatureType</code> 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> in the Java language, then this method is equivalent |
| to <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Class.html?is-external=true#isAssignableFrom(java.lang.Class)" title="class or interface in java.lang" class="externalLink"><code>Class.isAssignableFrom(Class)</code></a>.</div></div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>type</code> - the type to be checked.</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd><code>true</code> if instances of the given type can be assigned to association of this type.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="getSuperTypes()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getSuperTypes</h4> |
| <pre class="methodSignature">public final <a href="https://docs.oracle.com/javase/8/docs/api/java/util/Set.html?is-external=true" title="class or interface in java.util" class="externalLink">Set</a><<a href="DefaultFeatureType.html" title="class in org.apache.sis.feature">DefaultFeatureType</a>> getSuperTypes()</pre> |
| <div class="block">Returns the direct parents of this feature type. |
| |
| <div class="note"><b>Analogy:</b> |
| if we compare <code>FeatureType</code> 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> in the Java language, then this method is equivalent |
| to <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Class.html?is-external=true#getSuperclass()" title="class or interface in java.lang" class="externalLink"><code>Class.getSuperclass()</code></a> except that feature types allow multi-inheritance.</div> |
| |
| <div class="warning"><b>Warning:</b> |
| The type of list elements will be changed to <code>FeatureType</code> if and when such interface |
| will be defined in GeoAPI.</div> |
| |
| <div class="note"><b>Note for subclasses:</b> |
| this method is final because it is invoked (indirectly) by constructors, and invoking a user-overrideable |
| method at construction time is not recommended. Furthermore, many Apache SIS methods need guarantees about |
| the stability of this collection. |
| </div></div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the parents of this feature type, or an empty set if none.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="getProperties(boolean)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getProperties</h4> |
| <pre class="methodSignature">public <a href="https://docs.oracle.com/javase/8/docs/api/java/util/Collection.html?is-external=true" title="class or interface in java.util" class="externalLink">Collection</a><<a href="AbstractIdentifiedType.html" title="class in org.apache.sis.feature">AbstractIdentifiedType</a>> getProperties​(boolean includeSuperTypes)</pre> |
| <div class="block">Returns any feature operation, any feature attribute type and any feature association role that |
| carries characteristics of a feature type. The returned collection will include the properties |
| inherited from the <a href="#getSuperTypes()">super-types</a> only if <code>includeSuperTypes</code> |
| is <code>true</code>. |
| |
| <div class="warning"><b>Warning:</b> |
| The type of list elements will be changed to <code>PropertyType</code> if and when such interface |
| will be defined in GeoAPI.</div></div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>includeSuperTypes</code> - <code>true</code> for including the properties inherited from the super-types, |
| or <code>false</code> for returning only the properties defined explicitly in this type.</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>feature operation, attribute type and association role that carries characteristics of this |
| feature type (not including parent types).</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="getProperty(java.lang.String)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getProperty</h4> |
| <pre class="methodSignature">public <a href="AbstractIdentifiedType.html" title="class in org.apache.sis.feature">AbstractIdentifiedType</a> getProperty​(<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> name) |
| throws <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/IllegalArgumentException.html?is-external=true" title="class or interface in java.lang" class="externalLink">IllegalArgumentException</a></pre> |
| <div class="block">Returns the attribute, operation or association role for the given name. |
| |
| <div class="warning"><b>Warning:</b> |
| The type of returned element will be changed to <code>PropertyType</code> if and when such interface |
| will be defined in GeoAPI.</div></div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>name</code> - the name of the property to search.</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the property for the given name, or <code>null</code> if none.</dd> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/IllegalArgumentException.html?is-external=true" title="class or interface in java.lang" class="externalLink">IllegalArgumentException</a></code> - if the given argument is not a property name of this feature.</dd> |
| <dt><span class="seeLabel">See Also:</span></dt> |
| <dd><a href="AbstractFeature.html#getProperty(java.lang.String)"><code>AbstractFeature.getProperty(String)</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="AbstractFeature.html" title="class in org.apache.sis.feature">AbstractFeature</a> newInstance() |
| throws <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">IllegalStateException</a></pre> |
| <div class="block">Creates a new feature instance of this type. |
| |
| <div class="note"><b>Analogy:</b> |
| if we compare <code>FeatureType</code> 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> and <code>Feature</code> to <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"><code>Object</code></a> in the Java language, |
| then this method is equivalent to <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Class.html?is-external=true#newInstance()" title="class or interface in java.lang" class="externalLink"><code>Class.newInstance()</code></a>.</div></div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>a new feature instance.</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">IllegalStateException</a></code> - if this feature type <a href="#isAbstract()">is abstract</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 feature type.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Overrides:</span></dt> |
| <dd><code><a href="AbstractIdentifiedType.html#hashCode()">hashCode</a></code> in class <code><a href="AbstractIdentifiedType.html" title="class in org.apache.sis.feature">AbstractIdentifiedType</a></code></dd> |
| <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 feature type with the given object for equality.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Overrides:</span></dt> |
| <dd><code><a href="AbstractIdentifiedType.html#equals(java.lang.Object)">equals</a></code> in class <code><a href="AbstractIdentifiedType.html" title="class in org.apache.sis.feature">AbstractIdentifiedType</a></code></dd> |
| <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="blockList"> |
| <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">Formats this feature in a tabular format.</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 feature in a tabular format.</dd> |
| <dt><span class="seeLabel">See Also:</span></dt> |
| <dd><a href="FeatureFormat.html" title="class in org.apache.sis.feature"><code>FeatureFormat</code></a></dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="getName()"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>getName</h4> |
| <pre class="methodSignature">public abstract <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> getName()</pre> |
| </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/DefaultFeatureType.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> |