| <!DOCTYPE HTML> |
| <!-- NewPage --> |
| <html lang="en"> |
| <head> |
| <!-- Generated by javadoc (11.0.4) on Fri Sep 20 12:10:30 CEST 2019 --> |
| <title>DefaultDimension (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.metadata.iso.spatial.DefaultDimension class"> |
| <meta name="keywords" content="castOrCopy()"> |
| <meta name="keywords" content="getDimensionName()"> |
| <meta name="keywords" content="setDimensionName()"> |
| <meta name="keywords" content="getDimensionSize()"> |
| <meta name="keywords" content="setDimensionSize()"> |
| <meta name="keywords" content="getResolution()"> |
| <meta name="keywords" content="setResolution()"> |
| <meta name="keywords" content="getDimensionTitle()"> |
| <meta name="keywords" content="setDimensionTitle()"> |
| <meta name="keywords" content="getDimensionDescription()"> |
| <meta name="keywords" content="setDimensionDescription()"> |
| <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="DefaultDimension (Apache SIS 1.0 API)"; |
| } |
| } |
| catch(err) { |
| } |
| //--> |
| var data = {"i0":9,"i1":10,"i2":10,"i3":10,"i4":10,"i5":10,"i6":10,"i7":10,"i8":10,"i9":10,"i10":10}; |
| var tabs = {65535:["t0","All Methods"],1:["t1","Static Methods"],2:["t2","Instance Methods"],8:["t4","Concrete Methods"]}; |
| var altColor = "altColor"; |
| var rowColor = "rowColor"; |
| var tableTab = "tableTab"; |
| var activeTableTab = "activeTableTab"; |
| var pathtoroot = "../../../../../../"; |
| var useModuleDirectories = false; |
| loadScripts(document, 'script');</script> |
| <noscript> |
| <div>JavaScript is disabled on your browser.</div> |
| </noscript> |
| <header role="banner"> |
| <nav role="navigation"> |
| <div class="fixedNav"> |
| <!-- ========= START OF TOP NAVBAR ======= --> |
| <div class="topNav"><a id="navbar.top"> |
| <!-- --> |
| </a> |
| <div class="skipNav"><a href="#skip.navbar.top" title="Skip navigation links">Skip navigation links</a></div> |
| <a id="navbar.top.firstrow"> |
| <!-- --> |
| </a> |
| <ul class="navList" title="Navigation"> |
| <li><a href="../../../../../../index.html">Overview</a></li> |
| <li><a href="package-summary.html">Package</a></li> |
| <li class="navBarCell1Rev">Class</li> |
| <li><a href="class-use/DefaultDimension.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><a href="#nested.class.summary">Nested</a> | </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.metadata.iso.spatial</a></div> |
| <h2 title="Class DefaultDimension" class="title">Class DefaultDimension</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="../../AbstractMetadata.html" title="class in org.apache.sis.metadata">AbstractMetadata</a></li> |
| <li> |
| <ul class="inheritance"> |
| <li><a href="../../ModifiableMetadata.html" title="class in org.apache.sis.metadata">ModifiableMetadata</a></li> |
| <li> |
| <ul class="inheritance"> |
| <li><a href="../ISOMetadata.html" title="class in org.apache.sis.metadata.iso">ISOMetadata</a></li> |
| <li> |
| <ul class="inheritance"> |
| <li>DefaultDimension</li> |
| </ul> |
| </li> |
| </ul> |
| </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/Emptiable.html" title="interface in org.apache.sis.util">Emptiable</a></code>, <code><a href="../../../util/LenientComparable.html" title="interface in org.apache.sis.util">LenientComparable</a></code>, <code><a href="../../../xml/IdentifiedObject.html" title="interface in org.apache.sis.xml">IdentifiedObject</a></code>, <code><a href="http://www.geoapi.org/3.0/javadoc/org/opengis/metadata/spatial/Dimension.html?is-external=true" title="class or interface in org.opengis.metadata.spatial" class="externalLink">Dimension</a></code></dd> |
| </dl> |
| <hr> |
| <pre><a href="../../TitleProperty.html" title="annotation in org.apache.sis.metadata">@TitleProperty</a>(<a href="../../TitleProperty.html#name()">name</a>="dimensionName") |
| public class <span class="typeNameLabel">DefaultDimension</span> |
| extends <a href="../ISOMetadata.html" title="class in org.apache.sis.metadata.iso">ISOMetadata</a> |
| implements <a href="http://www.geoapi.org/3.0/javadoc/org/opengis/metadata/spatial/Dimension.html?is-external=true" title="class or interface in org.opengis.metadata.spatial" class="externalLink">Dimension</a></pre> |
| <div class="block">Axis properties. |
| The following properties are mandatory in a well-formed metadata according ISO 19115: |
| |
| <div class="preformat"><code>MD_Dimension</code> |
| <code> ├─dimensionName……</code> Name of the axis. |
| <code> └─dimensionSize……</code> Number of elements along the axis.</div> |
| |
| <p><b>Limitations:</b></p> |
| <ul> |
| <li>Instances of this class are not synchronized for multi-threading. |
| Synchronization, if needed, is caller's responsibility.</li> |
| <li>Serialized objects of this class are not guaranteed to be compatible with future Apache SIS releases. |
| Serialization support is appropriate for short term storage or RMI between applications running the |
| same version of Apache SIS. For long term storage, use <a href="../../../xml/XML.html" title="class in org.apache.sis.xml"><code>XML</code></a> instead.</li> |
| </ul></div> |
| <dl> |
| <dt><span class="simpleTagLabel">Since:</span></dt> |
| <dd>0.3</dd> |
| <dt><span class="seeLabel">See Also:</span></dt> |
| <dd><a href="../../../../../../serialized-form.html#org.apache.sis.metadata.iso.spatial.DefaultDimension">Serialized Form</a></dd> |
| |
| <p><font size="-1">Defined in the <code>sis-metadata</code> module</font></p> |
| </dl> |
| </li> |
| </ul> |
| </div> |
| <div class="summary"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <!-- ======== NESTED CLASS SUMMARY ======== --> |
| <section role="region"> |
| <ul class="blockList"> |
| <li class="blockList"><a id="nested.class.summary"> |
| <!-- --> |
| </a> |
| <h3>Nested Class Summary</h3> |
| <ul class="blockList"> |
| <li class="blockList"><a id="nested.classes.inherited.from.class.org.apache.sis.metadata.ModifiableMetadata"> |
| <!-- --> |
| </a> |
| <h3>Nested classes/interfaces inherited from class <a href="../../ModifiableMetadata.html" title="class in org.apache.sis.metadata">ModifiableMetadata</a></h3> |
| <code><a href="../../ModifiableMetadata.State.html" title="enum in org.apache.sis.metadata">ModifiableMetadata.State</a></code></li> |
| </ul> |
| </li> |
| </ul> |
| </section> |
| <!-- =========== 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.ISOMetadata"> |
| <!-- --> |
| </a> |
| <h3>Fields inherited from class <a href="../ISOMetadata.html" title="class in org.apache.sis.metadata.iso">ISOMetadata</a></h3> |
| <code><a href="../ISOMetadata.html#identifiers">identifiers</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()">DefaultDimension</a></span>()</code></th> |
| <td class="colLast"> |
| <div class="block">Constructs an initially empty dimension.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <th class="colConstructorName" scope="row"><code><span class="memberNameLink"><a href="#%3Cinit%3E(org.opengis.metadata.spatial.Dimension)">DefaultDimension</a></span>​(<a href="http://www.geoapi.org/3.0/javadoc/org/opengis/metadata/spatial/Dimension.html?is-external=true" title="class or interface in org.opengis.metadata.spatial" class="externalLink">Dimension</a> object)</code></th> |
| <td class="colLast"> |
| <div class="block">Constructs a new instance initialized with the values from the specified metadata object.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <th class="colConstructorName" scope="row"><code><span class="memberNameLink"><a href="#%3Cinit%3E(org.opengis.metadata.spatial.DimensionNameType,int)">DefaultDimension</a></span>​(<a href="http://www.geoapi.org/3.0/javadoc/org/opengis/metadata/spatial/DimensionNameType.html?is-external=true" title="class or interface in org.opengis.metadata.spatial" class="externalLink">DimensionNameType</a> dimensionName, |
| int dimensionSize)</code></th> |
| <td class="colLast"> |
| <div class="block">Creates a dimension initialized to the given type and size.</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="t1" class="tableTab"><span><a href="javascript:show(1);">Static Methods</a></span><span class="tabEnd"> </span></span><span id="t2" class="tableTab"><span><a href="javascript:show(2);">Instance Methods</a></span><span class="tabEnd"> </span></span><span id="t4" class="tableTab"><span><a href="javascript:show(8);">Concrete Methods</a></span><span class="tabEnd"> </span></span></caption> |
| <tr> |
| <th class="colFirst" scope="col">Modifier and Type</th> |
| <th class="colSecond" scope="col">Method</th> |
| <th class="colLast" scope="col">Description</th> |
| </tr> |
| <tr id="i0" class="altColor"> |
| <td class="colFirst"><code>static <a href="DefaultDimension.html" title="class in org.apache.sis.metadata.iso.spatial">DefaultDimension</a></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#castOrCopy(org.opengis.metadata.spatial.Dimension)">castOrCopy</a></span>​(<a href="http://www.geoapi.org/3.0/javadoc/org/opengis/metadata/spatial/Dimension.html?is-external=true" title="class or interface in org.opengis.metadata.spatial" class="externalLink">Dimension</a> object)</code></th> |
| <td class="colLast"> |
| <div class="block">Returns a SIS metadata implementation with the values of the given arbitrary implementation.</div> |
| </td> |
| </tr> |
| <tr id="i1" class="rowColor"> |
| <td class="colFirst"><code><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">InternationalString</a></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getDimensionDescription()">getDimensionDescription</a></span>()</code></th> |
| <td class="colLast"> |
| <div class="block">Return the axis dimension description.</div> |
| </td> |
| </tr> |
| <tr id="i2" class="altColor"> |
| <td class="colFirst"><code><a href="http://www.geoapi.org/3.0/javadoc/org/opengis/metadata/spatial/DimensionNameType.html?is-external=true" title="class or interface in org.opengis.metadata.spatial" class="externalLink">DimensionNameType</a></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getDimensionName()">getDimensionName</a></span>()</code></th> |
| <td class="colLast"> |
| <div class="block">Returns the name of the axis.</div> |
| </td> |
| </tr> |
| <tr id="i3" class="rowColor"> |
| <td class="colFirst"><code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Integer.html?is-external=true" title="class or interface in java.lang" class="externalLink">Integer</a></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getDimensionSize()">getDimensionSize</a></span>()</code></th> |
| <td class="colLast"> |
| <div class="block">Returns the number of elements along the axis.</div> |
| </td> |
| </tr> |
| <tr id="i4" class="altColor"> |
| <td class="colFirst"><code><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">InternationalString</a></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getDimensionTitle()">getDimensionTitle</a></span>()</code></th> |
| <td class="colLast"> |
| <div class="block">Returns the enhancement / modifier of the dimension name.</div> |
| </td> |
| </tr> |
| <tr id="i5" class="rowColor"> |
| <td class="colFirst"><code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Double.html?is-external=true" title="class or interface in java.lang" class="externalLink">Double</a></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getResolution()">getResolution</a></span>()</code></th> |
| <td class="colLast"> |
| <div class="block">Returns the degree of detail in the grid dataset.</div> |
| </td> |
| </tr> |
| <tr id="i6" class="altColor"> |
| <td class="colFirst"><code>void</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#setDimensionDescription(org.opengis.util.InternationalString)">setDimensionDescription</a></span>​(<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">InternationalString</a> newValue)</code></th> |
| <td class="colLast"> |
| <div class="block">Sets the axis dimension description.</div> |
| </td> |
| </tr> |
| <tr id="i7" class="rowColor"> |
| <td class="colFirst"><code>void</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#setDimensionName(org.opengis.metadata.spatial.DimensionNameType)">setDimensionName</a></span>​(<a href="http://www.geoapi.org/3.0/javadoc/org/opengis/metadata/spatial/DimensionNameType.html?is-external=true" title="class or interface in org.opengis.metadata.spatial" class="externalLink">DimensionNameType</a> newValue)</code></th> |
| <td class="colLast"> |
| <div class="block">Sets the name of the axis.</div> |
| </td> |
| </tr> |
| <tr id="i8" class="altColor"> |
| <td class="colFirst"><code>void</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#setDimensionSize(java.lang.Integer)">setDimensionSize</a></span>​(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Integer.html?is-external=true" title="class or interface in java.lang" class="externalLink">Integer</a> newValue)</code></th> |
| <td class="colLast"> |
| <div class="block">Sets the number of elements along the axis.</div> |
| </td> |
| </tr> |
| <tr id="i9" class="rowColor"> |
| <td class="colFirst"><code>void</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#setDimensionTitle(org.opengis.util.InternationalString)">setDimensionTitle</a></span>​(<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">InternationalString</a> newValue)</code></th> |
| <td class="colLast"> |
| <div class="block">Sets the enhancement / modifier of the dimension name.</div> |
| </td> |
| </tr> |
| <tr id="i10" class="altColor"> |
| <td class="colFirst"><code>void</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#setResolution(java.lang.Double)">setResolution</a></span>​(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Double.html?is-external=true" title="class or interface in java.lang" class="externalLink">Double</a> newValue)</code></th> |
| <td class="colLast"> |
| <div class="block">Sets the degree of detail in the grid dataset.</div> |
| </td> |
| </tr> |
| </table> |
| <ul class="blockList"> |
| <li class="blockList"><a id="methods.inherited.from.class.ISOMetadata"> |
| <!-- --> |
| </a> |
| <h3>Methods inherited from class <a href="../ISOMetadata.html" title="class in org.apache.sis.metadata.iso">ISOMetadata</a></h3> |
| <code><a href="../ISOMetadata.html#getIdentifier()">getIdentifier</a>, <a href="../ISOMetadata.html#getIdentifierMap()">getIdentifierMap</a>, <a href="../ISOMetadata.html#getIdentifiers()">getIdentifiers</a>, <a href="../ISOMetadata.html#getStandard()">getStandard</a>, <a href="../ISOMetadata.html#setIdentifier(org.opengis.metadata.Identifier)">setIdentifier</a>, <a href="../ISOMetadata.html#transitionTo(org.apache.sis.metadata.ModifiableMetadata.State)">transitionTo</a></code></li> |
| </ul> |
| <ul class="blockList"> |
| <li class="blockList"><a id="methods.inherited.from.class.ModifiableMetadata"> |
| <!-- --> |
| </a> |
| <h3>Methods inherited from class <a href="../../ModifiableMetadata.html" title="class in org.apache.sis.metadata">ModifiableMetadata</a></h3> |
| <code><a href="../../ModifiableMetadata.html#checkWritePermission()">checkWritePermission</a>, <a href="../../ModifiableMetadata.html#checkWritePermission(java.lang.Object)">checkWritePermission</a>, <a href="../../ModifiableMetadata.html#collectionType(java.lang.Class)">collectionType</a>, <a href="../../ModifiableMetadata.html#copyCollection(java.util.Collection,java.lang.Class)">copyCollection</a>, <a href="../../ModifiableMetadata.html#copyList(java.util.Collection,java.lang.Class)">copyList</a>, <a href="../../ModifiableMetadata.html#copyMap(java.util.Map,java.lang.Class)">copyMap</a>, <a href="../../ModifiableMetadata.html#copySet(java.util.Collection,java.lang.Class)">copySet</a>, <a href="../../ModifiableMetadata.html#freeze()">freeze</a>, <a href="../../ModifiableMetadata.html#isModifiable()">isModifiable</a>, <a href="../../ModifiableMetadata.html#nonNullCollection(java.util.Collection,java.lang.Class)">nonNullCollection</a>, <a href="../../ModifiableMetadata.html#nonNullList(java.util.List,java.lang.Class)">nonNullList</a>, <a href="../../ModifiableMetadata.html#nonNullMap(java.util.Map,java.lang.Class)">nonNullMap</a>, <a href="../../ModifiableMetadata.html#nonNullSet(java.util.Set,java.lang.Class)">nonNullSet</a>, <a href="../../ModifiableMetadata.html#singleton(E,java.lang.Class)">singleton</a>, <a href="../../ModifiableMetadata.html#state()">state</a>, <a href="../../ModifiableMetadata.html#unmodifiable()">unmodifiable</a>, <a href="../../ModifiableMetadata.html#writeCollection(java.util.Collection,java.util.Collection,java.lang.Class)">writeCollection</a>, <a href="../../ModifiableMetadata.html#writeList(java.util.Collection,java.util.List,java.lang.Class)">writeList</a>, <a href="../../ModifiableMetadata.html#writeMap(java.util.Map,java.util.Map,java.lang.Class)">writeMap</a>, <a href="../../ModifiableMetadata.html#writeSet(java.util.Collection,java.util.Set,java.lang.Class)">writeSet</a></code></li> |
| </ul> |
| <ul class="blockList"> |
| <li class="blockList"><a id="methods.inherited.from.class.AbstractMetadata"> |
| <!-- --> |
| </a> |
| <h3>Methods inherited from class <a href="../../AbstractMetadata.html" title="class in org.apache.sis.metadata">AbstractMetadata</a></h3> |
| <code><a href="../../AbstractMetadata.html#asMap()">asMap</a>, <a href="../../AbstractMetadata.html#asTreeTable()">asTreeTable</a>, <a href="../../AbstractMetadata.html#equals(java.lang.Object)">equals</a>, <a href="../../AbstractMetadata.html#equals(java.lang.Object,org.apache.sis.util.ComparisonMode)">equals</a>, <a href="../../AbstractMetadata.html#getInterface()">getInterface</a>, <a href="../../AbstractMetadata.html#hashCode()">hashCode</a>, <a href="../../AbstractMetadata.html#isEmpty()">isEmpty</a>, <a href="../../AbstractMetadata.html#prune()">prune</a>, <a href="../../AbstractMetadata.html#toString()">toString</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>()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>DefaultDimension</h4> |
| <pre>public DefaultDimension()</pre> |
| <div class="block">Constructs an initially empty dimension.</div> |
| </li> |
| </ul> |
| <a id="<init>(org.opengis.metadata.spatial.DimensionNameType,int)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>DefaultDimension</h4> |
| <pre>public DefaultDimension​(<a href="http://www.geoapi.org/3.0/javadoc/org/opengis/metadata/spatial/DimensionNameType.html?is-external=true" title="class or interface in org.opengis.metadata.spatial" class="externalLink">DimensionNameType</a> dimensionName, |
| int dimensionSize)</pre> |
| <div class="block">Creates a dimension initialized to the given type and size.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>dimensionName</code> - the name of the axis, or <code>null</code> if none, or <code>null</code> if none.</dd> |
| <dd><code>dimensionSize</code> - the number of elements along the axis, 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 <code>dimensionSize</code> is negative.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="<init>(org.opengis.metadata.spatial.Dimension)"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>DefaultDimension</h4> |
| <pre>public DefaultDimension​(<a href="http://www.geoapi.org/3.0/javadoc/org/opengis/metadata/spatial/Dimension.html?is-external=true" title="class or interface in org.opengis.metadata.spatial" class="externalLink">Dimension</a> object)</pre> |
| <div class="block">Constructs a new instance initialized with the values from the specified metadata object. |
| This is a <cite>shallow</cite> copy constructor, since the other metadata contained in the |
| given object are not recursively copied. |
| |
| <div class="note"><b>Note on properties validation:</b> |
| This constructor does not verify the property values of the given metadata (e.g. whether it contains |
| unexpected negative values). This is because invalid metadata exist in practice, and verifying their |
| validity in this copy constructor is often too late. Note that this is not the only hole, as invalid |
| metadata instances can also be obtained by unmarshalling an invalid XML document. |
| </div></div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>object</code> - the metadata to copy values from, or <code>null</code> if none.</dd> |
| <dt><span class="seeLabel">See Also:</span></dt> |
| <dd><a href="#castOrCopy(org.opengis.metadata.spatial.Dimension)"><code>castOrCopy(Dimension)</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="castOrCopy(org.opengis.metadata.spatial.Dimension)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>castOrCopy</h4> |
| <pre class="methodSignature">public static <a href="DefaultDimension.html" title="class in org.apache.sis.metadata.iso.spatial">DefaultDimension</a> castOrCopy​(<a href="http://www.geoapi.org/3.0/javadoc/org/opengis/metadata/spatial/Dimension.html?is-external=true" title="class or interface in org.opengis.metadata.spatial" class="externalLink">Dimension</a> object)</pre> |
| <div class="block">Returns a SIS metadata implementation with the values of the given arbitrary implementation. |
| This method performs the first applicable action in the following choices: |
| |
| <ul> |
| <li>If the given object is <code>null</code>, then this method returns <code>null</code>.</li> |
| <li>Otherwise if the given object is already an instance of |
| <code>DefaultDimension</code>, then it is returned unchanged.</li> |
| <li>Otherwise a new <code>DefaultDimension</code> instance is created using the |
| <a href="#%3Cinit%3E(org.opengis.metadata.spatial.Dimension)">copy constructor</a> |
| and returned. Note that this is a <cite>shallow</cite> copy operation, since the other |
| metadata contained in the given object are not recursively copied.</li> |
| </ul></div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>object</code> - the object to get as a SIS implementation, or <code>null</code> if none.</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>a SIS implementation containing the values of the given object (may be the |
| given object itself), or <code>null</code> if the argument was null.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="getDimensionName()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getDimensionName</h4> |
| <pre class="methodSignature">public <a href="http://www.geoapi.org/3.0/javadoc/org/opengis/metadata/spatial/DimensionNameType.html?is-external=true" title="class or interface in org.opengis.metadata.spatial" class="externalLink">DimensionNameType</a> getDimensionName()</pre> |
| <div class="block">Returns the name of the axis.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="http://www.geoapi.org/3.0/javadoc/org/opengis/metadata/spatial/Dimension.html?is-external=true#getDimensionName()" title="class or interface in org.opengis.metadata.spatial" class="externalLink">getDimensionName</a></code> in interface <code><a href="http://www.geoapi.org/3.0/javadoc/org/opengis/metadata/spatial/Dimension.html?is-external=true" title="class or interface in org.opengis.metadata.spatial" class="externalLink">Dimension</a></code></dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>name of the axis, or <code>null</code>.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="setDimensionName(org.opengis.metadata.spatial.DimensionNameType)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setDimensionName</h4> |
| <pre class="methodSignature">public void setDimensionName​(<a href="http://www.geoapi.org/3.0/javadoc/org/opengis/metadata/spatial/DimensionNameType.html?is-external=true" title="class or interface in org.opengis.metadata.spatial" class="externalLink">DimensionNameType</a> newValue)</pre> |
| <div class="block">Sets the name of the axis.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>newValue</code> - the new dimension name.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="getDimensionSize()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getDimensionSize</h4> |
| <pre class="methodSignature"><a href="../../../measure/ValueRange.html" title="annotation in org.apache.sis.measure">@ValueRange</a>(<a href="../../../measure/ValueRange.html#minimum()">minimum</a>=0.0) |
| public <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Integer.html?is-external=true" title="class or interface in java.lang" class="externalLink">Integer</a> getDimensionSize()</pre> |
| <div class="block">Returns the number of elements along the axis.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="http://www.geoapi.org/3.0/javadoc/org/opengis/metadata/spatial/Dimension.html?is-external=true#getDimensionSize()" title="class or interface in org.opengis.metadata.spatial" class="externalLink">getDimensionSize</a></code> in interface <code><a href="http://www.geoapi.org/3.0/javadoc/org/opengis/metadata/spatial/Dimension.html?is-external=true" title="class or interface in org.opengis.metadata.spatial" class="externalLink">Dimension</a></code></dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>number of elements along the axis, or <code>null</code>.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="setDimensionSize(java.lang.Integer)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setDimensionSize</h4> |
| <pre class="methodSignature">public void setDimensionSize​(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Integer.html?is-external=true" title="class or interface in java.lang" class="externalLink">Integer</a> newValue)</pre> |
| <div class="block">Sets the number of elements along the axis.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>newValue</code> - the new dimension size, or <code>null</code>.</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 value is negative.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="getResolution()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getResolution</h4> |
| <pre class="methodSignature"><a href="../../../measure/ValueRange.html" title="annotation in org.apache.sis.measure">@ValueRange</a>(<a href="../../../measure/ValueRange.html#minimum()">minimum</a>=0.0, |
| <a href="../../../measure/ValueRange.html#isMinIncluded()">isMinIncluded</a>=false) |
| public <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Double.html?is-external=true" title="class or interface in java.lang" class="externalLink">Double</a> getResolution()</pre> |
| <div class="block">Returns the degree of detail in the grid dataset.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="http://www.geoapi.org/3.0/javadoc/org/opengis/metadata/spatial/Dimension.html?is-external=true#getResolution()" title="class or interface in org.opengis.metadata.spatial" class="externalLink">getResolution</a></code> in interface <code><a href="http://www.geoapi.org/3.0/javadoc/org/opengis/metadata/spatial/Dimension.html?is-external=true" title="class or interface in org.opengis.metadata.spatial" class="externalLink">Dimension</a></code></dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>degree of detail in the grid dataset, or <code>null</code>.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="setResolution(java.lang.Double)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setResolution</h4> |
| <pre class="methodSignature">public void setResolution​(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Double.html?is-external=true" title="class or interface in java.lang" class="externalLink">Double</a> newValue)</pre> |
| <div class="block">Sets the degree of detail in the grid dataset.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>newValue</code> - the new resolution, or <code>null</code>.</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 value is NaN, zero or negative.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="getDimensionTitle()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getDimensionTitle</h4> |
| <pre class="methodSignature"><a href="http://www.geoapi.org/3.0/javadoc/org/opengis/annotation/UML.html?is-external=true" title="class or interface in org.opengis.annotation" class="externalLink">@UML</a>(<a href="http://www.geoapi.org/3.0/javadoc/org/opengis/annotation/UML.html?is-external=true#identifier()" title="class or interface in org.opengis.annotation" class="externalLink">identifier</a>="dimensionTitle", |
| <a href="http://www.geoapi.org/3.0/javadoc/org/opengis/annotation/UML.html?is-external=true#obligation()" title="class or interface in org.opengis.annotation" class="externalLink">obligation</a>=<a href="http://www.geoapi.org/3.0/javadoc/org/opengis/annotation/Obligation.html?is-external=true#OPTIONAL" title="class or interface in org.opengis.annotation" class="externalLink">OPTIONAL</a>, |
| <a href="http://www.geoapi.org/3.0/javadoc/org/opengis/annotation/UML.html?is-external=true#specification()" title="class or interface in org.opengis.annotation" class="externalLink">specification</a>=<a href="http://www.geoapi.org/3.0/javadoc/org/opengis/annotation/Specification.html?is-external=true#ISO_19115" title="class or interface in org.opengis.annotation" class="externalLink">ISO_19115</a>) |
| public <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">InternationalString</a> getDimensionTitle()</pre> |
| <div class="block">Returns the enhancement / modifier of the dimension name. |
| |
| <div class="note"><b>Example:</b> |
| dimensionName = "column", dimensionTitle = "longitude"</div></div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the enhancement / modifier of the dimension name.</dd> |
| <dt><span class="simpleTagLabel">Since:</span></dt> |
| <dd>0.5</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="setDimensionTitle(org.opengis.util.InternationalString)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setDimensionTitle</h4> |
| <pre class="methodSignature">public void setDimensionTitle​(<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">InternationalString</a> newValue)</pre> |
| <div class="block">Sets the enhancement / modifier of the dimension name.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>newValue</code> - the new enhancement / modifier of the dimension name.</dd> |
| <dt><span class="simpleTagLabel">Since:</span></dt> |
| <dd>0.5</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="getDimensionDescription()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getDimensionDescription</h4> |
| <pre class="methodSignature"><a href="http://www.geoapi.org/3.0/javadoc/org/opengis/annotation/UML.html?is-external=true" title="class or interface in org.opengis.annotation" class="externalLink">@UML</a>(<a href="http://www.geoapi.org/3.0/javadoc/org/opengis/annotation/UML.html?is-external=true#identifier()" title="class or interface in org.opengis.annotation" class="externalLink">identifier</a>="dimensionDescription", |
| <a href="http://www.geoapi.org/3.0/javadoc/org/opengis/annotation/UML.html?is-external=true#obligation()" title="class or interface in org.opengis.annotation" class="externalLink">obligation</a>=<a href="http://www.geoapi.org/3.0/javadoc/org/opengis/annotation/Obligation.html?is-external=true#OPTIONAL" title="class or interface in org.opengis.annotation" class="externalLink">OPTIONAL</a>, |
| <a href="http://www.geoapi.org/3.0/javadoc/org/opengis/annotation/UML.html?is-external=true#specification()" title="class or interface in org.opengis.annotation" class="externalLink">specification</a>=<a href="http://www.geoapi.org/3.0/javadoc/org/opengis/annotation/Specification.html?is-external=true#ISO_19115" title="class or interface in org.opengis.annotation" class="externalLink">ISO_19115</a>) |
| public <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">InternationalString</a> getDimensionDescription()</pre> |
| <div class="block">Return the axis dimension description.</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the axis dimension description.</dd> |
| <dt><span class="simpleTagLabel">Since:</span></dt> |
| <dd>0.5</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="setDimensionDescription(org.opengis.util.InternationalString)"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>setDimensionDescription</h4> |
| <pre class="methodSignature">public void setDimensionDescription​(<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">InternationalString</a> newValue)</pre> |
| <div class="block">Sets the axis dimension description.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>newValue</code> - the new axis dimension description.</dd> |
| <dt><span class="simpleTagLabel">Since:</span></dt> |
| <dd>0.5</dd> |
| </dl> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| </section> |
| </li> |
| </ul> |
| </div> |
| </div> |
| </main> |
| <!-- ========= END OF CLASS DATA ========= --> |
| <footer role="contentinfo"> |
| <nav role="navigation"> |
| <!-- ======= START OF BOTTOM NAVBAR ====== --> |
| <div class="bottomNav"><a id="navbar.bottom"> |
| <!-- --> |
| </a> |
| <div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div> |
| <a id="navbar.bottom.firstrow"> |
| <!-- --> |
| </a> |
| <ul class="navList" title="Navigation"> |
| <li><a href="../../../../../../index.html">Overview</a></li> |
| <li><a href="package-summary.html">Package</a></li> |
| <li class="navBarCell1Rev">Class</li> |
| <li><a href="class-use/DefaultDimension.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><a href="#nested.class.summary">Nested</a> | </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> |
