blob: e8c15a79b159d9c8ae11ad541f069bb12364d187 [file] [log] [blame]
<!DOCTYPE HTML>
<html lang="en">
<head>
<!-- Generated by javadoc (21) on Thu Oct 05 19:54:57 CEST 2023 -->
<title>DefaultFeatureType (Apache SIS 1.4 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="dc.created" content="2023-10-05">
<meta name="description" content="declaration: module: org.apache.sis.feature, package: org.apache.sis.feature, class: DefaultFeatureType">
<meta name="generator" content="javadoc/ClassWriterImpl">
<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="../../../../../script-dir/jquery-ui.min.css" title="Style">
<script type="text/javascript" src="../../../../../script.js"></script>
<script type="text/javascript" src="../../../../../script-dir/jquery-3.6.1.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="../../../../module-summary.html">Module</a></li>
<li><a href="package-summary.html">Package</a></li>
<li class="nav-bar-cell1-rev">Class</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="module-label-in-type">Module</span>&nbsp;<a href="../../../../module-summary.html">org.apache.sis.feature</a></div>
<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 DefaultFeatureType" class="title">Class DefaultFeatureType</h1>
</div>
<div class="inheritance" title="Inheritance Tree"><a href="https://docs.oracle.com/en/java/javase/11/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">DefaultFeatureType</div>
</div>
</div>
<section class="class-description" id="class-description">
<dl class="notes">
<dt>All Implemented Interfaces:</dt>
<dd><code><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/io/Serializable.html" title="class or interface in java.io" class="external-link">Serializable</a></code>, <code><a href="../../../../../org.apache.sis.util/org/apache/sis/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">DefaultFeatureType</span>
<span class="extends-implements">extends <a href="AbstractIdentifiedType.html" title="class in org.apache.sis.feature">AbstractIdentifiedType</a></span></div>
<div class="block">Abstraction of a real-world phenomena. A <code>Feature­Type</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>Feature­Type</code> is equivalent to <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Class.html" title="class or interface in java.lang" class="external-link"><code>Class</code></a> while
<code>Feature</code> instances are equivalent to <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link"><code>Object</code></a> instances of that class.</div>
<div class="warning"><b>Warning:</b>
This class is expected to implement a GeoAPI <code>Feature­Type</code> interface in a future version.
When such interface will be available, most references to <code>Default­Feature­Type</code> in the API
will be replaced by references to the <code>Feature­Type</code> interface.</div>
<h2 id="naming-heading">Naming</h2>
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="../../../../../org.apache.sis.metadata/org/apache/sis/util/iso/DefaultScopedName.html" title="class in org.apache.sis.util.iso">scoped</a> for avoiding name collision.
<h2 id="properties-and-inheritance-heading">Properties and inheritance</h2>
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>Char­Sequence[]</code>, which
is safe for read operations but not for write operations — the latter may throw <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/ArrayStoreException.html" title="class or interface in java.lang" class="external-link"><code>Array­Store­Exception</code></a>).</div>
<h2 id="instantiation-heading">Instantiation</h2>
<code>Default­Feature­Type</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>Feature­Type­Builder</code></a> instead,
which provides shortcuts for frequently-used operations like creating various <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>Generic­Name</code></a>
instances sharing the same namespace.
<h2 id="immutability-and-thread-safety-heading">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>Generic­Name</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>International­String</code></a>
instances) and all arguments (<code>Attribute­Type</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 class="notes">
<dt>Since:</dt>
<dd>0.5</dd>
<dt>See Also:</dt>
<dd>
<ul class="tag-list">
<li><a href="DefaultAttributeType.html" title="class in org.apache.sis.feature"><code>Default­Attribute­Type</code></a></li>
<li><a href="DefaultAssociationRole.html" title="class in org.apache.sis.feature"><code>Default­Association­Role</code></a></li>
<li><a href="AbstractFeature.html" title="class in org.apache.sis.feature"><code>Abstract­Feature</code></a></li>
<li><a href="../../../../../org.apache.sis.metadata/org/apache/sis/metadata/iso/content/DefaultFeatureTypeInfo.html" title="class in org.apache.sis.metadata.iso.content"><code>Default­Feature­Type­Info</code></a></li>
<li><code><a href="../../../../../org.apache.sis.storage/org/apache/sis/storage/FeatureNaming.html" title="class in org.apache.sis.storage">Feature­Naming</a>&lt;<a href="../../../../../org.apache.sis.storage/org/apache/sis/storage/FeatureNaming.html" title="type parameter in FeatureNaming">E</a>&gt;</code></li>
<li><a href="../../../../../serialized-form.html#org.apache.sis.feature.DefaultFeatureType">Serialized Form</a></li>
</ul>
</dd>
</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,boolean,org.apache.sis.feature.DefaultFeatureType%5B%5D,org.apache.sis.feature.AbstractIdentifiedType...)" class="member-name-link">Default­Feature­Type</a><wbr>(<a href="https://docs.oracle.com/en/java/javase/11/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/11/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>,<wbr>?&gt;&nbsp;identification,
boolean&nbsp;is­Abstract,
<a href="DefaultFeatureType.html" title="class in org.apache.sis.feature">Default­Feature­Type</a>[]&nbsp;super­Types,
<a href="AbstractIdentifiedType.html" title="class in org.apache.sis.feature">Abstract­Identified­Type</a>...&nbsp;properties)</code></div>
<div class="col-last even-row-color">
<div class="block">Constructs a feature 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-tab3" role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table-tab3', 3)" class="table-tab">Abstract 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>boolean</code></div>
<div class="col-second even-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/11/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 even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
<div class="block">Compares this feature type with the given object for equality.</div>
</div>
<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><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">Generic­Name</a></code></div>
<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#getName()" class="member-name-link">get­Name</a>()</code></div>
<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3">&nbsp;</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/11/docs/api/java.base/java/util/Collection.html" title="class or interface in java.util" class="external-link">Collection</a><wbr>&lt;<a href="AbstractIdentifiedType.html" title="class in org.apache.sis.feature">Abstract­Identified­Type</a>&gt;</code></div>
<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getProperties(boolean)" class="member-name-link">get­Properties</a><wbr>(boolean&nbsp;include­Super­Types)</code></div>
<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
<div class="block">Returns any feature operation, any feature attribute type and any feature association role that
carries characteristics of a feature type.</div>
</div>
<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="AbstractIdentifiedType.html" title="class in org.apache.sis.feature">Abstract­Identified­Type</a></code></div>
<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getProperty(java.lang.String)" class="member-name-link">get­Property</a><wbr>(<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>&nbsp;name)</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 attribute, operation or association role for the given name.</div>
</div>
<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>final <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/util/Set.html" title="class or interface in java.util" class="external-link">Set</a><wbr>&lt;<a href="DefaultFeatureType.html" title="class in org.apache.sis.feature">Default­Feature­Type</a>&gt;</code></div>
<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getSuperTypes()" class="member-name-link">get­Super­Types</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 direct parents of this feature type.</div>
</div>
<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>int</code></div>
<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#hashCode()" class="member-name-link">hash­Code</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 a hash code value for this feature type.</div>
</div>
<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>final boolean</code></div>
<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#isAbstract()" class="member-name-link">is­Abstract</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 <code>true</code> if the feature type acts as an abstract super-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="#isAssignableFrom(org.apache.sis.feature.DefaultFeatureType)" class="member-name-link">is­Assignable­From</a><wbr>(<a href="DefaultFeatureType.html" title="class in org.apache.sis.feature">Default­Feature­Type</a>&nbsp;type)</code></div>
<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
<div class="block">Returns <code>true</code> if this type is same or a super-type of the given type.</div>
</div>
<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>boolean</code></div>
<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#isSimple()" class="member-name-link">is­Simple</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 <code>true</code> if this feature type contains only attributes with [1 … 1] multiplicity,
or operations (no feature association).</div>
</div>
<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="AbstractFeature.html" title="class in org.apache.sis.feature">Abstract­Feature</a></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">new­Instance</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 feature instance of this type.</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/11/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">to­String</a>()</code></div>
<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
<div class="block">Formats this feature in a tabular format.</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()">get­Definition</a>, <a href="AbstractIdentifiedType.html#getDescription()">get­Description</a>, <a href="AbstractIdentifiedType.html#getDesignation()">get­Designation</a>, <a href="AbstractIdentifiedType.html#getName()">get­Name</a>, <a href="AbstractIdentifiedType.html#getRemarks()">get­Remarks</a>, <a href="AbstractIdentifiedType.html#isDeprecated()">is­Deprecated</a></code></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/11/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/11/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/11/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/11/docs/api/java.base/java/lang/Object.html#getClass()" title="class or interface in java.lang" class="external-link">get­Class</a>, <a href="https://docs.oracle.com/en/java/javase/11/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/11/docs/api/java.base/java/lang/Object.html#notifyAll()" title="class or interface in java.lang" class="external-link">notify­All</a>, <a href="https://docs.oracle.com/en/java/javase/11/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/11/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/11/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,boolean,org.apache.sis.feature.DefaultFeatureType[],org.apache.sis.feature.AbstractIdentifiedType...)">
<h3>DefaultFeatureType</h3>
<div class="member-signature"><span class="modifiers">public</span>&nbsp;<span class="element-name">DefaultFeatureType</span><wbr><span class="parameters">(<a href="https://docs.oracle.com/en/java/javase/11/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/11/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>,<wbr>?&gt;&nbsp;identification,
boolean&nbsp;isAbstract,
<a href="DefaultFeatureType.html" title="class in org.apache.sis.feature">DefaultFeatureType</a>[]&nbsp;superTypes,
<a href="AbstractIdentifiedType.html" title="class in org.apache.sis.feature">AbstractIdentifiedType</a>...&nbsp;properties)</span></div>
<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.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/11/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/11/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/11/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/11/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/11/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 class="warning"><b>Warning:</b> In a future SIS version, the type of array elements may be
changed to <code>org​.opengis​.feature​.Feature­Type</code> and <code>org​.opengis​.feature​.Property­Type</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 class="notes">
<dt>Parameters:</dt>
<dd><code>identification</code> - the name and other information to be given to this feature type.</dd>
<dd><code>is­Abstract</code> - if <code>true</code>, the feature type acts as an abstract super-type.</dd>
<dd><code>super­Types</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>See Also:</dt>
<dd>
<ul class="tag-list">
<li><a href="builder/FeatureTypeBuilder.html" title="class in org.apache.sis.feature.builder"><code>Feature­Type­Builder</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="isAbstract()">
<h3>isAbstract</h3>
<div class="member-signature"><span class="modifiers">public final</span>&nbsp;<span class="return-type">boolean</span>&nbsp;<span class="element-name">isAbstract</span>()</div>
<div class="block">Returns <code>true</code> if the feature type acts as an abstract super-type.
Abstract types cannot be <a href="#newInstance()">instantiated</a>.</div>
<dl class="notes">
<dt>Returns:</dt>
<dd><code>true</code> if the feature type acts as an abstract super-type.</dd>
</dl>
</section>
</li>
<li>
<section class="detail" id="isSimple()">
<h3>isSimple</h3>
<div class="member-signature"><span class="modifiers">public</span>&nbsp;<span class="return-type">boolean</span>&nbsp;<span class="element-name">isSimple</span>()</div>
<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="../../../../../org.apache.sis.metadata/org/apache/sis/util/iso/DefaultRecord.html" title="class in org.apache.sis.util.iso">records</a>.</div>
<dl class="notes">
<dt>Returns:</dt>
<dd><code>true</code> if this feature type contains only simple attributes or operations.</dd>
</dl>
</section>
</li>
<li>
<section class="detail" id="isAssignableFrom(org.apache.sis.feature.DefaultFeatureType)">
<h3>isAssignableFrom</h3>
<div class="member-signature"><span class="modifiers">public</span>&nbsp;<span class="return-type">boolean</span>&nbsp;<span class="element-name">isAssignableFrom</span><wbr><span class="parameters">(<a href="DefaultFeatureType.html" title="class in org.apache.sis.feature">DefaultFeatureType</a>&nbsp;type)</span></div>
<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.
<h4 id="constraints-heading">Constraints</h4>
<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>Feature­Type</code> to <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Class.html" title="class or interface in java.lang" class="external-link"><code>Class</code></a> in the Java language, then this method is equivalent
to <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Class.html#isAssignableFrom(java.lang.Class)" title="class or interface in java.lang" class="external-link"><code>Class​.is­Assignable­From(Class)</code></a>.</div></div>
<dl class="notes">
<dt>Parameters:</dt>
<dd><code>type</code> - the type to be checked.</dd>
<dt>Returns:</dt>
<dd><code>true</code> if instances of the given type can be assigned to association of this type.</dd>
</dl>
</section>
</li>
<li>
<section class="detail" id="getSuperTypes()">
<h3>getSuperTypes</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/11/docs/api/java.base/java/util/Set.html" title="class or interface in java.util" class="external-link">Set</a>&lt;<a href="DefaultFeatureType.html" title="class in org.apache.sis.feature">DefaultFeatureType</a>&gt;</span>&nbsp;<span class="element-name">getSuperTypes</span>()</div>
<div class="block">Returns the direct parents of this feature type.
<div class="note"><b>Analogy:</b>
if we compare <code>Feature­Type</code> to <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Class.html" title="class or interface in java.lang" class="external-link"><code>Class</code></a> in the Java language, then this method is equivalent
to <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Class.html#getSuperclass()" title="class or interface in java.lang" class="external-link"><code>Class​.get­Superclass()</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>Feature­Type</code> if and when such interface
will be defined in GeoAPI.</div>
<h4 id="api-note-heading">API note</h4>
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>
<dl class="notes">
<dt>Returns:</dt>
<dd>the parents of this feature type, or an empty set if none.</dd>
</dl>
</section>
</li>
<li>
<section class="detail" id="getProperties(boolean)">
<h3>getProperties</h3>
<div class="member-signature"><span class="modifiers">public</span>&nbsp;<span class="return-type"><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/util/Collection.html" title="class or interface in java.util" class="external-link">Collection</a>&lt;<a href="AbstractIdentifiedType.html" title="class in org.apache.sis.feature">AbstractIdentifiedType</a>&gt;</span>&nbsp;<span class="element-name">getProperties</span><wbr><span class="parameters">(boolean&nbsp;includeSuperTypes)</span></div>
<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>include­Super­Types</code>
is <code>true</code>.
<div class="warning"><b>Warning:</b>
The type of list elements will be changed to <code>Property­Type</code> if and when such interface
will be defined in GeoAPI.</div></div>
<dl class="notes">
<dt>Parameters:</dt>
<dd><code>include­Super­Types</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>Returns:</dt>
<dd>feature operation, attribute type and association role that carries characteristics of this
feature type (not including parent types).</dd>
</dl>
</section>
</li>
<li>
<section class="detail" id="getProperty(java.lang.String)">
<h3>getProperty</h3>
<div class="member-signature"><span class="modifiers">public</span>&nbsp;<span class="return-type"><a href="AbstractIdentifiedType.html" title="class in org.apache.sis.feature">AbstractIdentifiedType</a></span>&nbsp;<span class="element-name">getProperty</span><wbr><span class="parameters">(<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>&nbsp;name)</span>
throws <span class="exceptions"><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/IllegalArgumentException.html" title="class or interface in java.lang" class="external-link">IllegalArgumentException</a></span></div>
<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>Property­Type</code> if and when such interface
will be defined in GeoAPI.</div></div>
<dl class="notes">
<dt>Parameters:</dt>
<dd><code>name</code> - the name of the property to search.</dd>
<dt>Returns:</dt>
<dd>the property for the given name, or <code>null</code> if none.</dd>
<dt>Throws:</dt>
<dd><code><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/IllegalArgumentException.html" title="class or interface in java.lang" class="external-link">Illegal­Argument­Exception</a></code> - if the given argument is not a property name of this feature.</dd>
<dt>See Also:</dt>
<dd>
<ul class="tag-list-long">
<li><a href="AbstractFeature.html#getProperty(java.lang.String)"><code>Abstract­Feature​.get­Property(String)</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="AbstractFeature.html" title="class in org.apache.sis.feature">AbstractFeature</a></span>&nbsp;<span class="element-name">newInstance</span>()
throws <span class="exceptions"><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/IllegalStateException.html" title="class or interface in java.lang" class="external-link">IllegalStateException</a></span></div>
<div class="block">Creates a new feature instance of this type.
<div class="note"><b>Analogy:</b>
if we compare <code>Feature­Type</code> to <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Class.html" title="class or interface in java.lang" class="external-link"><code>Class</code></a> and <code>Feature</code> to <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link"><code>Object</code></a> in the Java language,
then this method is equivalent to <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Class.html#newInstance()" title="class or interface in java.lang" class="external-link"><code>Class​.new­Instance()</code></a>.</div></div>
<dl class="notes">
<dt>Returns:</dt>
<dd>a new feature instance.</dd>
<dt>Throws:</dt>
<dd><code><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/IllegalStateException.html" title="class or interface in java.lang" class="external-link">Illegal­State­Exception</a></code> - if this feature type <a href="#isAbstract()">is abstract</a>.</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 feature type.</div>
<dl class="notes">
<dt>Overrides:</dt>
<dd><code><a href="AbstractIdentifiedType.html#hashCode()">hash­Code</a></code>&nbsp;in class&nbsp;<code><a href="AbstractIdentifiedType.html" title="class in org.apache.sis.feature">Abstract­Identified­Type</a></code></dd>
<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/11/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 feature type with the given object for equality.</div>
<dl class="notes">
<dt>Overrides:</dt>
<dd><code><a href="AbstractIdentifiedType.html#equals(java.lang.Object)">equals</a></code>&nbsp;in class&nbsp;<code><a href="AbstractIdentifiedType.html" title="class in org.apache.sis.feature">Abstract­Identified­Type</a></code></dd>
<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/11/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">Formats this feature in a tabular format.</div>
<dl class="notes">
<dt>Overrides:</dt>
<dd><code><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html#toString()" title="class or interface in java.lang" class="external-link">to­String</a></code>&nbsp;in class&nbsp;<code><a href="https://docs.oracle.com/en/java/javase/11/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 feature in a tabular format.</dd>
<dt>See Also:</dt>
<dd>
<ul class="tag-list">
<li><a href="FeatureFormat.html" title="class in org.apache.sis.feature"><code>Feature­Format</code></a></li>
</ul>
</dd>
</dl>
</section>
</li>
<li>
<section class="detail" id="getName()">
<h3>getName</h3>
<div class="member-signature"><span class="return-type"><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">GenericName</a></span>&nbsp;<span class="element-name">getName</span>()</div>
</section>
</li>
</ul>
</section>
</li>
</ul>
</section>
<!-- ========= END OF CLASS DATA ========= -->
</main>
</div>
</div>
</body>
</html>