blob: b7e69f1f2fc82762f5f45744b33514ed77a4ce67 [file] [log] [blame]
<!DOCTYPE HTML>
<html lang="en">
<head>
<!-- Generated by javadoc (21) on Thu Oct 05 19:54:57 CEST 2023 -->
<title>CharacteristicTypeBuilder (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.builder, class: CharacteristicTypeBuilder">
<meta name="generator" content="javadoc/ClassWriterImpl">
<meta name="keywords" content="org.apache.sis.feature.builder.CharacteristicTypeBuilder class">
<meta name="keywords" content="setName()">
<meta name="keywords" content="getValueClass()">
<meta name="keywords" content="setValueClass()">
<meta name="keywords" content="getDefaultValue()">
<meta name="keywords" content="setDefaultValue()">
<meta name="keywords" content="setDefinition()">
<meta name="keywords" content="setDesignation()">
<meta name="keywords" content="setDescription()">
<meta name="keywords" content="setDeprecated()">
<meta name="keywords" content="build()">
<meta name="keywords" content="remove()">
<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>Field</li>
<li>Constr</li>
<li><a href="#method-summary">Method</a></li>
</ul>
</li>
<li>
<p>Detail:</p>
<ul>
<li>Field</li>
<li>Constr</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>Field&nbsp;|&nbsp;</li>
<li>Constr&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>Constr&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.builder</a></div>
<h1 title="Class CharacteristicTypeBuilder" class="title">Class CharacteristicTypeBuilder&lt;V&gt;</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="TypeBuilder.html" title="class in org.apache.sis.feature.builder">TypeBuilder</a>
<div class="inheritance">CharacteristicTypeBuilder&lt;V&gt;</div>
</div>
</div>
<section class="class-description" id="class-description">
<dl class="notes">
<dt>Type Parameters:</dt>
<dd><code>V</code> - the class of characteristic values.</dd>
</dl>
<dl class="notes">
<dt>All Implemented Interfaces:</dt>
<dd><code><a href="../../../../../../org.apache.sis.util/org/apache/sis/util/Localized.html" title="interface in org.apache.sis.util">Localized</a></code></dd>
</dl>
<hr>
<div class="type-signature"><span class="modifiers">public final class </span><span class="element-name type-name-label">CharacteristicTypeBuilder&lt;V&gt;</span>
<span class="extends-implements">extends <a href="TypeBuilder.html" title="class in org.apache.sis.feature.builder">TypeBuilder</a></span></div>
<div class="block">Describes one characteristic of the <code>Attribute­Type</code> will will be built by a <code>Feature­Type­Builder</code>.
Characteristics can describe additional information useful for interpreting an attribute value, like
the units of measurement and uncertainties of a numerical value, or the coordinate reference system
(CRS) of a geometry.
<p>In many cases, all instances of the same <code>Attribute­Type</code> have the same characteristics.
For example, all values of the "temperature" attribute typically have the same units of measurement.
Such common value can be specified as the characteristic <a href="#setDefaultValue(V)">default value</a>.</p></div>
<dl class="notes">
<dt>Since:</dt>
<dd>0.8</dd>
<dt>See Also:</dt>
<dd>
<ul class="tag-list-long">
<li><a href="AttributeTypeBuilder.html#addCharacteristic(java.lang.Class)"><code>Attribute­Type­Builder​.add­Characteristic(Class)</code></a></li>
</ul>
</dd>
</dl>
</section>
<section class="summary">
<ul class="summary-list">
<!-- ========== METHOD SUMMARY =========== -->
<li>
<section class="method-summary" id="method-summary">
<h2>Method Summary</h2>
<div id="method-summary-table">
<div class="table-tabs" role="tablist" aria-orientation="horizontal"><button id="method-summary-table-tab0" role="tab" aria-selected="true" aria-controls="method-summary-table.tabpanel" tabindex="0" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table', 3)" class="active-table-tab">All Methods</button><button id="method-summary-table-tab2" role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table-tab2', 3)" class="table-tab">Instance Methods</button><button id="method-summary-table-tab4" role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table-tab4', 3)" class="table-tab">Concrete Methods</button></div>
<div id="method-summary-table.tabpanel" role="tabpanel">
<div class="summary-table three-column-summary" aria-labelledby="method-summary-table-tab0">
<div class="table-header col-first">Modifier and Type</div>
<div class="table-header col-second">Method</div>
<div class="table-header col-last">Description</div>
<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="../DefaultAttributeType.html" title="class in org.apache.sis.feature">Default­Attribute­Type</a><wbr>&lt;<a href="CharacteristicTypeBuilder.html" title="type parameter in CharacteristicTypeBuilder">V</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="#build()" class="member-name-link">build</a>()</code></div>
<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
<div class="block">Builds the characteristic type from the information specified to this builder.</div>
</div>
<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="CharacteristicTypeBuilder.html" title="type parameter in CharacteristicTypeBuilder">V</a></code></div>
<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getDefaultValue()" class="member-name-link">get­Default­Value</a>()</code></div>
<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
<div class="block">Returns the default value for the characteristic, or <code>null</code> if none.</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/Class.html" title="class or interface in java.lang" class="external-link">Class</a><wbr>&lt;<a href="CharacteristicTypeBuilder.html" title="type parameter in CharacteristicTypeBuilder">V</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="#getValueClass()" class="member-name-link">get­Value­Class</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 class of characteristic values.</div>
</div>
<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>void</code></div>
<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#remove()" class="member-name-link">remove</a>()</code></div>
<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
<div class="block">Removes this characteristics from the <code>Attribute­Type­Builder</code>.</div>
</div>
<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="CharacteristicTypeBuilder.html" title="class in org.apache.sis.feature.builder">Characteristic­Type­Builder</a><wbr>&lt;<a href="CharacteristicTypeBuilder.html" title="type parameter in CharacteristicTypeBuilder">V</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="#setDefaultValue(V)" class="member-name-link">set­Default­Value</a><wbr>(<a href="CharacteristicTypeBuilder.html" title="type parameter in CharacteristicTypeBuilder">V</a>&nbsp;value)</code></div>
<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
<div class="block">Sets the default value for the characteristic.</div>
</div>
<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="CharacteristicTypeBuilder.html" title="class in org.apache.sis.feature.builder">Characteristic­Type­Builder</a><wbr>&lt;<a href="CharacteristicTypeBuilder.html" title="type parameter in CharacteristicTypeBuilder">V</a>&gt;</code></div>
<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#setDefinition(java.lang.CharSequence)" class="member-name-link">set­Definition</a><wbr>(<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/CharSequence.html" title="class or interface in java.lang" class="external-link">Char­Sequence</a>&nbsp;definition)</code></div>
<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
<div class="block">Sets a concise definition of the element.</div>
</div>
<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="CharacteristicTypeBuilder.html" title="class in org.apache.sis.feature.builder">Characteristic­Type­Builder</a><wbr>&lt;<a href="CharacteristicTypeBuilder.html" title="type parameter in CharacteristicTypeBuilder">V</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="#setDeprecated(boolean)" class="member-name-link">set­Deprecated</a><wbr>(boolean&nbsp;deprecated)</code></div>
<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
<div class="block">Sets whether the type is deprecated.</div>
</div>
<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="CharacteristicTypeBuilder.html" title="class in org.apache.sis.feature.builder">Characteristic­Type­Builder</a><wbr>&lt;<a href="CharacteristicTypeBuilder.html" title="type parameter in CharacteristicTypeBuilder">V</a>&gt;</code></div>
<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#setDescription(java.lang.CharSequence)" class="member-name-link">set­Description</a><wbr>(<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/CharSequence.html" title="class or interface in java.lang" class="external-link">Char­Sequence</a>&nbsp;description)</code></div>
<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
<div class="block">Sets optional information beyond that required for concise definition of the element.</div>
</div>
<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="CharacteristicTypeBuilder.html" title="class in org.apache.sis.feature.builder">Characteristic­Type­Builder</a><wbr>&lt;<a href="CharacteristicTypeBuilder.html" title="type parameter in CharacteristicTypeBuilder">V</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="#setDesignation(java.lang.CharSequence)" class="member-name-link">set­Designation</a><wbr>(<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/CharSequence.html" title="class or interface in java.lang" class="external-link">Char­Sequence</a>&nbsp;designation)</code></div>
<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
<div class="block">Sets a natural language designator for the element.</div>
</div>
<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="CharacteristicTypeBuilder.html" title="class in org.apache.sis.feature.builder">Characteristic­Type­Builder</a><wbr>&lt;<a href="CharacteristicTypeBuilder.html" title="type parameter in CharacteristicTypeBuilder">V</a>&gt;</code></div>
<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#setName(java.lang.CharSequence)" class="member-name-link">set­Name</a><wbr>(<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/CharSequence.html" title="class or interface in java.lang" class="external-link">Char­Sequence</a>&nbsp;local­Part)</code></div>
<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
<div class="block">Sets the characteristic name as a simple string (local name).</div>
</div>
<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="CharacteristicTypeBuilder.html" title="class in org.apache.sis.feature.builder">Characteristic­Type­Builder</a><wbr>&lt;<a href="CharacteristicTypeBuilder.html" title="type parameter in CharacteristicTypeBuilder">V</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="#setName(java.lang.CharSequence...)" class="member-name-link">set­Name</a><wbr>(<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/CharSequence.html" title="class or interface in java.lang" class="external-link">Char­Sequence</a>...&nbsp;components)</code></div>
<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
<div class="block">Sets the characteristic name as a string in the given scope.</div>
</div>
<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="CharacteristicTypeBuilder.html" title="class in org.apache.sis.feature.builder">Characteristic­Type­Builder</a><wbr>&lt;<a href="CharacteristicTypeBuilder.html" title="type parameter in CharacteristicTypeBuilder">V</a>&gt;</code></div>
<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#setName(org.opengis.util.GenericName)" class="member-name-link">set­Name</a><wbr>(<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>&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">Sets the characteristic name as a generic name.</div>
</div>
<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>&lt;N&gt;&nbsp;<a href="CharacteristicTypeBuilder.html" title="class in org.apache.sis.feature.builder">Characteristic­Type­Builder</a><wbr>&lt;N&gt;</code></div>
<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#setValueClass(java.lang.Class)" class="member-name-link">set­Value­Class</a><wbr>(<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">Class</a>&lt;N&gt;&nbsp;type)</code></div>
<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
<div class="block">Sets the class of characteristic values.</div>
</div>
</div>
</div>
</div>
<div class="inherited-list">
<h3 id="methods-inherited-from-class-TypeBuilder">Methods inherited from class&nbsp;<a href="TypeBuilder.html" title="class in org.apache.sis.feature.builder">TypeBuilder</a></h3>
<code><a href="TypeBuilder.html#getDefinition()">get­Definition</a>, <a href="TypeBuilder.html#getDescription()">get­Description</a>, <a href="TypeBuilder.html#getDesignation()">get­Designation</a>, <a href="TypeBuilder.html#getLocale()">get­Locale</a>, <a href="TypeBuilder.html#getName()">get­Name</a>, <a href="TypeBuilder.html#isDeprecated()">is­Deprecated</a>, <a href="TypeBuilder.html#toString()">to­String</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#equals(java.lang.Object)" title="class or interface in java.lang" class="external-link">equals</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#hashCode()" title="class or interface in java.lang" class="external-link">hash­Code</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">
<!-- ============ METHOD DETAIL ========== -->
<li>
<section class="method-details" id="method-detail">
<h2>Method Details</h2>
<ul class="member-list">
<li>
<section class="detail" id="setName(org.opengis.util.GenericName)">
<h3>setName</h3>
<div class="member-signature"><span class="modifiers">public</span>&nbsp;<span class="return-type"><a href="CharacteristicTypeBuilder.html" title="class in org.apache.sis.feature.builder">CharacteristicTypeBuilder</a>&lt;<a href="CharacteristicTypeBuilder.html" title="type parameter in CharacteristicTypeBuilder">V</a>&gt;</span>&nbsp;<span class="element-name">setName</span><wbr><span class="parameters">(<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>&nbsp;name)</span></div>
<div class="block">Sets the characteristic name as a generic name.
If another name was defined before this method call, that previous value will be discarded.</div>
<dl class="notes">
<dt>Overrides:</dt>
<dd><code><a href="TypeBuilder.html#setName(org.opengis.util.GenericName)">set­Name</a></code>&nbsp;in class&nbsp;<code><a href="TypeBuilder.html" title="class in org.apache.sis.feature.builder">Type­Builder</a></code></dd>
<dt>Parameters:</dt>
<dd><code>name</code> - the generic name (cannot be <code>null</code>).</dd>
<dt>Returns:</dt>
<dd><code>this</code> for allowing method calls chaining.</dd>
<dt>See Also:</dt>
<dd>
<ul class="tag-list-long">
<li><a href="TypeBuilder.html#getName()"><code>Type­Builder​.get­Name()</code></a></li>
<li><a href="TypeBuilder.html#setName(java.lang.CharSequence)"><code>Type­Builder​.set­Name(Char­Sequence)</code></a></li>
<li><a href="../AbstractIdentifiedType.html#NAME_KEY"><code>Abstract­Identified­Type​.NAME_KEY</code></a></li>
</ul>
</dd>
</dl>
</section>
</li>
<li>
<section class="detail" id="setName(java.lang.CharSequence)">
<h3>setName</h3>
<div class="member-signature"><span class="modifiers">public</span>&nbsp;<span class="return-type"><a href="CharacteristicTypeBuilder.html" title="class in org.apache.sis.feature.builder">CharacteristicTypeBuilder</a>&lt;<a href="CharacteristicTypeBuilder.html" title="type parameter in CharacteristicTypeBuilder">V</a>&gt;</span>&nbsp;<span class="element-name">setName</span><wbr><span class="parameters">(<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/CharSequence.html" title="class or interface in java.lang" class="external-link">CharSequence</a>&nbsp;localPart)</span></div>
<div class="block">Sets the characteristic name as a simple string (local name).
The namespace will be the value specified by the last call to <a href="FeatureTypeBuilder.html#setNameSpace(java.lang.CharSequence)"><code>Feature­Type­Builder​.set­Name­Space(Char­Sequence)</code></a>,
but that namespace will not be visible in the <a href="../../../../../../org.apache.sis.metadata/org/apache/sis/util/iso/DefaultLocalName.html#toString()">string representation</a> unless the <a href="../../../../../../org.apache.sis.metadata/org/apache/sis/util/iso/AbstractName.html#toFullyQualifiedName()">fully qualified name</a> is requested.
<p>This convenience method creates a <a href="http://www.geoapi.org/3.0/javadoc/org.opengis.geoapi/org/opengis/util/LocalName.html" title="class or interface in org.opengis.util" class="external-link"><code>Local­Name</code></a> instance from
the given <code>Char­Sequence</code>, then delegates to <a href="#setName(org.opengis.util.GenericName)"><code>set­Name(Generic­Name)</code></a>.</p></div>
<dl class="notes">
<dt>Overrides:</dt>
<dd><code><a href="TypeBuilder.html#setName(java.lang.CharSequence)">set­Name</a></code>&nbsp;in class&nbsp;<code><a href="TypeBuilder.html" title="class in org.apache.sis.feature.builder">Type­Builder</a></code></dd>
<dt>Parameters:</dt>
<dd><code>local­Part</code> - the local part of the generic name as a <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> or <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>.</dd>
<dt>Returns:</dt>
<dd><code>this</code> for allowing method calls chaining.</dd>
<dt>See Also:</dt>
<dd>
<ul class="tag-list-long">
<li><a href="TypeBuilder.html#getName()"><code>Type­Builder​.get­Name()</code></a></li>
<li><a href="TypeBuilder.html#setName(java.lang.CharSequence...)"><code>Type­Builder​.set­Name(Char­Sequence...)</code></a></li>
<li><a href="FeatureTypeBuilder.html#getNameSpace()"><code>Feature­Type­Builder​.get­Name­Space()</code></a></li>
</ul>
</dd>
</dl>
</section>
</li>
<li>
<section class="detail" id="setName(java.lang.CharSequence...)">
<h3>setName</h3>
<div class="member-signature"><span class="modifiers">public</span>&nbsp;<span class="return-type"><a href="CharacteristicTypeBuilder.html" title="class in org.apache.sis.feature.builder">CharacteristicTypeBuilder</a>&lt;<a href="CharacteristicTypeBuilder.html" title="type parameter in CharacteristicTypeBuilder">V</a>&gt;</span>&nbsp;<span class="element-name">setName</span><wbr><span class="parameters">(<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/CharSequence.html" title="class or interface in java.lang" class="external-link">CharSequence</a>...&nbsp;components)</span></div>
<div class="block">Sets the characteristic name as a string in the given scope.
The <code>components</code> array must contain at least one element.
The last component (the <a href="../../../../../../org.apache.sis.metadata/org/apache/sis/util/iso/AbstractName.html#tip()">tip</a>) will be sufficient
in many cases for getting values from the <a href="../AbstractAttribute.html#characteristics()">characteristics</a> map. The other elements before the last one are optional and can be used for resolving ambiguity.
They will be visible as the name <a href="../../../../../../org.apache.sis.metadata/org/apache/sis/util/iso/DefaultScopedName.html#path()">path</a>.
<p>In addition to the path specified by the <code>components</code> array, the name may also contain
a namespace specified by the last call to <a href="FeatureTypeBuilder.html#setNameSpace(java.lang.CharSequence)"><code>Feature­Type­Builder​.set­Name­Space(Char­Sequence)</code></a>.
But contrarily to the specified components, the namespace will not be visible in the name
<a href="../../../../../../org.apache.sis.metadata/org/apache/sis/util/iso/AbstractName.html#toString()">string representation</a> unless the
<a href="../../../../../../org.apache.sis.metadata/org/apache/sis/util/iso/AbstractName.html#toFullyQualifiedName()">fully qualified name</a>
 is requested.</p>
<p>This convenience method creates a <a href="http://www.geoapi.org/3.0/javadoc/org.opengis.geoapi/org/opengis/util/LocalName.html" title="class or interface in org.opengis.util" class="external-link"><code>Local­Name</code></a> or <a href="http://www.geoapi.org/3.0/javadoc/org.opengis.geoapi/org/opengis/util/ScopedName.html" title="class or interface in org.opengis.util" class="external-link"><code>Scoped­Name</code></a>
instance depending on whether the <code>names</code> array contains exactly 1 element or more than 1 element, then
delegates to <a href="#setName(org.opengis.util.GenericName)"><code>set­Name(Generic­Name)</code></a>.</p></div>
<dl class="notes">
<dt>Overrides:</dt>
<dd><code><a href="TypeBuilder.html#setName(java.lang.CharSequence...)">set­Name</a></code>&nbsp;in class&nbsp;<code><a href="TypeBuilder.html" title="class in org.apache.sis.feature.builder">Type­Builder</a></code></dd>
<dt>Parameters:</dt>
<dd><code>components</code> - the name components as an array of <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> or <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.</dd>
<dt>Returns:</dt>
<dd><code>this</code> for allowing method calls chaining.</dd>
<dt>See Also:</dt>
<dd>
<ul class="tag-list-long">
<li><a href="TypeBuilder.html#getName()"><code>Type­Builder​.get­Name()</code></a></li>
<li><a href="TypeBuilder.html#setName(java.lang.CharSequence)"><code>Type­Builder​.set­Name(Char­Sequence)</code></a></li>
<li><a href="FeatureTypeBuilder.html#getNameSpace()"><code>Feature­Type­Builder​.get­Name­Space()</code></a></li>
</ul>
</dd>
</dl>
</section>
</li>
<li>
<section class="detail" id="getValueClass()">
<h3>getValueClass</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/Class.html" title="class or interface in java.lang" class="external-link">Class</a>&lt;<a href="CharacteristicTypeBuilder.html" title="type parameter in CharacteristicTypeBuilder">V</a>&gt;</span>&nbsp;<span class="element-name">getValueClass</span>()</div>
<div class="block">Returns the class of characteristic values.</div>
<dl class="notes">
<dt>Returns:</dt>
<dd>the class of characteristic values.</dd>
<dt>See Also:</dt>
<dd>
<ul class="tag-list">
<li><a href="#setValueClass(java.lang.Class)"><code>set­Value­Class(Class)</code></a></li>
</ul>
</dd>
</dl>
</section>
</li>
<li>
<section class="detail" id="setValueClass(java.lang.Class)">
<h3>setValueClass</h3>
<div class="member-signature"><span class="modifiers">public</span>&nbsp;<span class="type-parameters">&lt;N&gt;</span>&nbsp;<span class="return-type"><a href="CharacteristicTypeBuilder.html" title="class in org.apache.sis.feature.builder">CharacteristicTypeBuilder</a>&lt;N&gt;</span>&nbsp;<span class="element-name">setValueClass</span><wbr><span class="parameters">(<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">Class</a>&lt;N&gt;&nbsp;type)</span>
throws <span class="exceptions"><a href="../../../../../../org.apache.sis.util/org/apache/sis/util/UnconvertibleObjectException.html" title="class in org.apache.sis.util">UnconvertibleObjectException</a></span></div>
<div class="block">Sets the class of characteristic values. Callers <strong>must</strong> use the builder returned by this method
instead of <code>this</code> builder after this method call, since the returned builder may be a new instance.</div>
<dl class="notes">
<dt>Type Parameters:</dt>
<dd><code>N</code> - the compile-time value of the <code>type</code> argument.</dd>
<dt>Parameters:</dt>
<dd><code>type</code> - the new class of characteristic values.</dd>
<dt>Returns:</dt>
<dd>the characteristic builder — <em>not necessarily this instance.</em></dd>
<dt>Throws:</dt>
<dd><code><a href="../../../../../../org.apache.sis.util/org/apache/sis/util/UnconvertibleObjectException.html" title="class in org.apache.sis.util">Unconvertible­Object­Exception</a></code> - if the <a href="#getDefaultValue()">default value</a>
cannot be converted to the given <code>&lt;N&gt;</code> class.</dd>
<dt>See Also:</dt>
<dd>
<ul class="tag-list">
<li><a href="#getValueClass()"><code>get­Value­Class()</code></a></li>
</ul>
</dd>
</dl>
</section>
</li>
<li>
<section class="detail" id="getDefaultValue()">
<h3>getDefaultValue</h3>
<div class="member-signature"><span class="modifiers">public</span>&nbsp;<span class="return-type"><a href="CharacteristicTypeBuilder.html" title="type parameter in CharacteristicTypeBuilder">V</a></span>&nbsp;<span class="element-name">getDefaultValue</span>()</div>
<div class="block">Returns the default value for the characteristic, or <code>null</code> if none.</div>
<dl class="notes">
<dt>Returns:</dt>
<dd>the default characteristic value, or <code>null</code> if none.</dd>
<dt>See Also:</dt>
<dd>
<ul class="tag-list">
<li><a href="#setDefaultValue(V)"><code>set­Default­Value(Object)</code></a></li>
</ul>
</dd>
</dl>
</section>
</li>
<li>
<section class="detail" id="setDefaultValue(V)">
<h3 id="setDefaultValue(java.lang.Object)">setDefaultValue</h3>
<div class="member-signature"><span class="modifiers">public</span>&nbsp;<span class="return-type"><a href="CharacteristicTypeBuilder.html" title="class in org.apache.sis.feature.builder">CharacteristicTypeBuilder</a>&lt;<a href="CharacteristicTypeBuilder.html" title="type parameter in CharacteristicTypeBuilder">V</a>&gt;</span>&nbsp;<span class="element-name">setDefaultValue</span><wbr><span class="parameters">(<a href="CharacteristicTypeBuilder.html" title="type parameter in CharacteristicTypeBuilder">V</a>&nbsp;value)</span></div>
<div class="block">Sets the default value for the characteristic.</div>
<dl class="notes">
<dt>Parameters:</dt>
<dd><code>value</code> - characteristic default value, or <code>null</code> if none.</dd>
<dt>Returns:</dt>
<dd><code>this</code> for allowing method calls chaining.</dd>
<dt>See Also:</dt>
<dd>
<ul class="tag-list">
<li><a href="#getDefaultValue()"><code>get­Default­Value()</code></a></li>
</ul>
</dd>
</dl>
</section>
</li>
<li>
<section class="detail" id="setDefinition(java.lang.CharSequence)">
<h3>setDefinition</h3>
<div class="member-signature"><span class="modifiers">public</span>&nbsp;<span class="return-type"><a href="CharacteristicTypeBuilder.html" title="class in org.apache.sis.feature.builder">CharacteristicTypeBuilder</a>&lt;<a href="CharacteristicTypeBuilder.html" title="type parameter in CharacteristicTypeBuilder">V</a>&gt;</span>&nbsp;<span class="element-name">setDefinition</span><wbr><span class="parameters">(<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/CharSequence.html" title="class or interface in java.lang" class="external-link">CharSequence</a>&nbsp;definition)</span></div>
<div class="block">Sets a concise definition of the element.</div>
<dl class="notes">
<dt>Overrides:</dt>
<dd><code><a href="TypeBuilder.html#setDefinition(java.lang.CharSequence)">set­Definition</a></code>&nbsp;in class&nbsp;<code><a href="TypeBuilder.html" title="class in org.apache.sis.feature.builder">Type­Builder</a></code></dd>
<dt>Parameters:</dt>
<dd><code>definition</code> - a concise definition of the element, or <code>null</code> if none.</dd>
<dt>Returns:</dt>
<dd><code>this</code> for allowing method calls chaining.</dd>
<dt>See Also:</dt>
<dd>
<ul class="tag-list-long">
<li><a href="TypeBuilder.html#getDefinition()"><code>Type­Builder​.get­Definition()</code></a></li>
<li><a href="../AbstractIdentifiedType.html#DEFINITION_KEY"><code>Abstract­Identified­Type​.DEFINITION_KEY</code></a></li>
</ul>
</dd>
</dl>
</section>
</li>
<li>
<section class="detail" id="setDesignation(java.lang.CharSequence)">
<h3>setDesignation</h3>
<div class="member-signature"><span class="modifiers">public</span>&nbsp;<span class="return-type"><a href="CharacteristicTypeBuilder.html" title="class in org.apache.sis.feature.builder">CharacteristicTypeBuilder</a>&lt;<a href="CharacteristicTypeBuilder.html" title="type parameter in CharacteristicTypeBuilder">V</a>&gt;</span>&nbsp;<span class="element-name">setDesignation</span><wbr><span class="parameters">(<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/CharSequence.html" title="class or interface in java.lang" class="external-link">CharSequence</a>&nbsp;designation)</span></div>
<div class="block">Sets a natural language designator for the element.
This can be used as an alternative to the <a href="TypeBuilder.html#getName()">name</a> in user interfaces.</div>
<dl class="notes">
<dt>Overrides:</dt>
<dd><code><a href="TypeBuilder.html#setDesignation(java.lang.CharSequence)">set­Designation</a></code>&nbsp;in class&nbsp;<code><a href="TypeBuilder.html" title="class in org.apache.sis.feature.builder">Type­Builder</a></code></dd>
<dt>Parameters:</dt>
<dd><code>designation</code> - a natural language designator for the element, or <code>null</code> if none.</dd>
<dt>Returns:</dt>
<dd><code>this</code> for allowing method calls chaining.</dd>
<dt>See Also:</dt>
<dd>
<ul class="tag-list-long">
<li><a href="TypeBuilder.html#getDesignation()"><code>Type­Builder​.get­Designation()</code></a></li>
<li><a href="../AbstractIdentifiedType.html#DESIGNATION_KEY"><code>Abstract­Identified­Type​.DESIGNATION_KEY</code></a></li>
</ul>
</dd>
</dl>
</section>
</li>
<li>
<section class="detail" id="setDescription(java.lang.CharSequence)">
<h3>setDescription</h3>
<div class="member-signature"><span class="modifiers">public</span>&nbsp;<span class="return-type"><a href="CharacteristicTypeBuilder.html" title="class in org.apache.sis.feature.builder">CharacteristicTypeBuilder</a>&lt;<a href="CharacteristicTypeBuilder.html" title="type parameter in CharacteristicTypeBuilder">V</a>&gt;</span>&nbsp;<span class="element-name">setDescription</span><wbr><span class="parameters">(<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/CharSequence.html" title="class or interface in java.lang" class="external-link">CharSequence</a>&nbsp;description)</span></div>
<div class="block">Sets optional information beyond that required for concise definition of the element.
The description may assist in understanding the feature scope and application.
If the type <a href="TypeBuilder.html#isDeprecated()">is deprecated</a>, then the description should
give indication about the replacement (e.g. <cite>"superceded by …"</cite>).</div>
<dl class="notes">
<dt>Overrides:</dt>
<dd><code><a href="TypeBuilder.html#setDescription(java.lang.CharSequence)">set­Description</a></code>&nbsp;in class&nbsp;<code><a href="TypeBuilder.html" title="class in org.apache.sis.feature.builder">Type­Builder</a></code></dd>
<dt>Parameters:</dt>
<dd><code>description</code> - information beyond that required for concise definition of the element, or <code>null</code> if none.</dd>
<dt>Returns:</dt>
<dd><code>this</code> for allowing method calls chaining.</dd>
<dt>See Also:</dt>
<dd>
<ul class="tag-list-long">
<li><a href="TypeBuilder.html#getDescription()"><code>Type­Builder​.get­Description()</code></a></li>
<li><a href="../AbstractIdentifiedType.html#DESCRIPTION_KEY"><code>Abstract­Identified­Type​.DESCRIPTION_KEY</code></a></li>
</ul>
</dd>
</dl>
</section>
</li>
<li>
<section class="detail" id="setDeprecated(boolean)">
<h3>setDeprecated</h3>
<div class="member-signature"><span class="modifiers">public</span>&nbsp;<span class="return-type"><a href="CharacteristicTypeBuilder.html" title="class in org.apache.sis.feature.builder">CharacteristicTypeBuilder</a>&lt;<a href="CharacteristicTypeBuilder.html" title="type parameter in CharacteristicTypeBuilder">V</a>&gt;</span>&nbsp;<span class="element-name">setDeprecated</span><wbr><span class="parameters">(boolean&nbsp;deprecated)</span></div>
<div class="block">Sets whether the type is deprecated.
If the type is deprecated, then the <a href="TypeBuilder.html#setDescription(java.lang.CharSequence)">description</a>
should be set to an indication about the replacement (e.g. <cite>"superceded by …"</cite>).</div>
<dl class="notes">
<dt>Overrides:</dt>
<dd><code><a href="TypeBuilder.html#setDeprecated(boolean)">set­Deprecated</a></code>&nbsp;in class&nbsp;<code><a href="TypeBuilder.html" title="class in org.apache.sis.feature.builder">Type­Builder</a></code></dd>
<dt>Parameters:</dt>
<dd><code>deprecated</code> - whether this type is deprecated.</dd>
<dt>Returns:</dt>
<dd><code>this</code> for allowing method calls chaining.</dd>
<dt>See Also:</dt>
<dd>
<ul class="tag-list-long">
<li><a href="TypeBuilder.html#isDeprecated()"><code>Type­Builder​.is­Deprecated()</code></a></li>
<li><a href="../AbstractIdentifiedType.html#DEPRECATED_KEY"><code>Abstract­Identified­Type​.DEPRECATED_KEY</code></a></li>
</ul>
</dd>
</dl>
</section>
</li>
<li>
<section class="detail" id="build()">
<h3>build</h3>
<div class="member-signature"><span class="modifiers">public</span>&nbsp;<span class="return-type"><a href="../DefaultAttributeType.html" title="class in org.apache.sis.feature">DefaultAttributeType</a>&lt;<a href="CharacteristicTypeBuilder.html" title="type parameter in CharacteristicTypeBuilder">V</a>&gt;</span>&nbsp;<span class="element-name">build</span>()</div>
<div class="block">Builds the characteristic type from the information specified to this builder.
If a type has already been built and this builder state has not changed since the type creation,
then the previously created <code>Attribute­Type</code> instance is returned.
<div class="warning"><b>Warning:</b> In a future SIS version, the return type may be changed to the
<code>org​.opengis​.feature​.Attribute­Type</code> interface. This change is pending GeoAPI revision.</div></div>
<dl class="notes">
<dt>Specified by:</dt>
<dd><code><a href="TypeBuilder.html#build()">build</a></code>&nbsp;in class&nbsp;<code><a href="TypeBuilder.html" title="class in org.apache.sis.feature.builder">Type­Builder</a></code></dd>
<dt>Returns:</dt>
<dd>the characteristic type.</dd>
</dl>
</section>
</li>
<li>
<section class="detail" id="remove()">
<h3>remove</h3>
<div class="member-signature"><span class="modifiers">public</span>&nbsp;<span class="return-type">void</span>&nbsp;<span class="element-name">remove</span>()</div>
<div class="block">Removes this characteristics from the <code>Attribute­Type­Builder</code>.
After this method has been invoked, this <code>Characteristic­Type­Builder</code> instance
is no longer in the list returned by <a href="AttributeTypeBuilder.html#characteristics()"><code>Attribute­Type­Builder​.characteristics()</code></a>
and attempts to invoke any setter method on <code>this</code> will cause an
<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"><code>Illegal­State­Exception</code></a> to be thrown.</div>
</section>
</li>
</ul>
</section>
</li>
</ul>
</section>
<!-- ========= END OF CLASS DATA ========= -->
</main>
</div>
</div>
</body>
</html>