blob: af03944f57406084a1d4cfeba26583e0427d9261 [file] [log] [blame]
<!DOCTYPE HTML>
<!-- NewPage -->
<html lang="en">
<head>
<!-- Generated by javadoc (11.0.4) on Fri Sep 20 12:10:30 CEST 2019 -->
<title>org.apache.sis.metadata.iso.spatial (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 package">
<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="org.apache.sis.metadata.iso.spatial (Apache SIS 1.0 API)";
}
}
catch(err) {
}
//-->
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 class="navBarCell1Rev">Package</li>
<li>Class</li>
<li><a href="package-use.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&nbsp;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>
<a id="skip.navbar.top">
<!-- -->
</a></div>
<!-- ========= END OF TOP NAVBAR ========= -->
</div>
<div class="navPadding">&nbsp;</div>
<script type="text/javascript"><!--
$('.navPadding').css('padding-top', $('.fixedNav').css("height"));
//-->
</script>
</nav>
</header>
<main role="main">
<div class="header">
<h1 title="Package" class="title">Package&nbsp;org.apache.sis.metadata.iso.spatial</h1>
</div>
<div class="contentContainer">
<section role="region"><a id="package.description">
<!-- -->
</a>
<div class="block">Information about the mechanisms (grid or vector) used to represent spatial data.
An explanation for this package is provided in the <a href="http://www.geoapi.org/3.0/javadoc/org/opengis/metadata/spatial/package-summary.html?is-external=true" class="externalLink">OpenGIS® javadoc</a>.
The remaining discussion on this page is specific to the SIS implementation.
<div class="section">Overview</div>
For a global overview of metadata in SIS, see the <a href="../../package-summary.html"><code>org​.apache​.sis​.metadata</code></a> package javadoc.
<table class="sis">
<caption>Package overview</caption>
<tr>
<th>Class hierarchy</th>
<th class="sep">Aggregation hierarchy</th>
</tr><tr><td style="width: 50%; white-space: nowrap">
<a href="../ISOMetadata.html" title="class in org.apache.sis.metadata.iso">ISO 19115 metadata</a><br>
<code> ├─</code> <a href="AbstractSpatialRepresentation.html" title="class in org.apache.sis.metadata.iso.spatial">Spatial representation</a> «abstract»<br>
<code> │   ├─</code> <a href="DefaultVectorSpatialRepresentation.html" title="class in org.apache.sis.metadata.iso.spatial">Vector spatial representation</a><br>
<code> │   └─</code> <a href="DefaultGridSpatialRepresentation.html" title="class in org.apache.sis.metadata.iso.spatial">Grid spatial representation</a><br>
<code> │       ├─</code> <a href="DefaultGeoreferenceable.html" title="class in org.apache.sis.metadata.iso.spatial">Georeferenceable</a><br>
<code> │       └─</code> <a href="DefaultGeorectified.html" title="class in org.apache.sis.metadata.iso.spatial">Georectified</a><br>
<code> ├─</code> <a href="AbstractGeolocationInformation.html" title="class in org.apache.sis.metadata.iso.spatial">Geolocation information</a> «abstract»<br>
<code> │   └─</code> <a href="DefaultGCPCollection.html" title="class in org.apache.sis.metadata.iso.spatial">GCP collection</a><br>
<code> ├─</code> <a href="DefaultGCP.html" title="class in org.apache.sis.metadata.iso.spatial">GCP</a><br>
<code> ├─</code> <a href="DefaultDimension.html" title="class in org.apache.sis.metadata.iso.spatial">Dimension</a><br>
<code> └─</code> <a href="DefaultGeometricObjects.html" title="class in org.apache.sis.metadata.iso.spatial">Geometric objects</a><br>
<a href="http://www.geoapi.org/3.0/javadoc/org/opengis/util/CodeList.html?is-external=true" title="class or interface in org.opengis.util" class="externalLink">Code list</a><br>
<code> ├─</code> <a href="http://www.geoapi.org/3.0/javadoc/org/opengis/metadata/spatial/TopologyLevel.html?is-external=true" title="class or interface in org.opengis.metadata.spatial" class="externalLink">Topology level</a><br>
<code> ├─</code> <a href="http://www.geoapi.org/3.0/javadoc/org/opengis/metadata/spatial/GeometricObjectType.html?is-external=true" title="class or interface in org.opengis.metadata.spatial" class="externalLink">Geometric object type</a><br>
<code> ├─</code> <a href="http://www.geoapi.org/3.0/javadoc/org/opengis/metadata/spatial/CellGeometry.html?is-external=true" title="class or interface in org.opengis.metadata.spatial" class="externalLink">Cell geometry</a><br>
<code> ├─</code> <a href="http://www.geoapi.org/3.0/javadoc/org/opengis/metadata/spatial/PixelOrientation.html?is-external=true" title="class or interface in org.opengis.metadata.spatial" class="externalLink">Pixel orientation</a><br>
<code> ├─</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">Dimension name type</a><br>
<code> └─</code> <a href="http://www.geoapi.org/3.0/javadoc/org/opengis/metadata/spatial/SpatialRepresentationType.html?is-external=true" title="class or interface in org.opengis.metadata.spatial" class="externalLink">Spatial representation type</a><br>
</td><td class="sep" style="width: 50%; white-space: nowrap">
<a href="AbstractSpatialRepresentation.html" title="class in org.apache.sis.metadata.iso.spatial">Spatial representation</a> «abstract»<br>
<a href="DefaultVectorSpatialRepresentation.html" title="class in org.apache.sis.metadata.iso.spatial">Vector spatial representation</a><br>
<code> ├─</code> <a href="http://www.geoapi.org/3.0/javadoc/org/opengis/metadata/spatial/TopologyLevel.html?is-external=true" title="class or interface in org.opengis.metadata.spatial" class="externalLink">Topology level</a> «code list»<br>
<code> └─</code> <a href="DefaultGeometricObjects.html" title="class in org.apache.sis.metadata.iso.spatial">Geometric objects</a><br>
<code>     └─</code> <a href="http://www.geoapi.org/3.0/javadoc/org/opengis/metadata/spatial/GeometricObjectType.html?is-external=true" title="class or interface in org.opengis.metadata.spatial" class="externalLink">Geometric object type</a> «code list»<br>
<a href="DefaultGridSpatialRepresentation.html" title="class in org.apache.sis.metadata.iso.spatial">Grid spatial representation</a><br>
<code> ├─</code> <a href="DefaultDimension.html" title="class in org.apache.sis.metadata.iso.spatial">Dimension</a><br>
<code> │   └─</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">Dimension name type</a> «code list»<br>
<code> └─</code> <a href="http://www.geoapi.org/3.0/javadoc/org/opengis/metadata/spatial/CellGeometry.html?is-external=true" title="class or interface in org.opengis.metadata.spatial" class="externalLink">Cell geometry</a> «code list»<br>
<a href="DefaultGeoreferenceable.html" title="class in org.apache.sis.metadata.iso.spatial">Georeferenceable</a><br>
<code> └─</code> <a href="AbstractGeolocationInformation.html" title="class in org.apache.sis.metadata.iso.spatial">Geolocation information</a> «abstract»<br>
<a href="DefaultGeorectified.html" title="class in org.apache.sis.metadata.iso.spatial">Georectified</a><br>
<code> ├─</code> <a href="http://www.geoapi.org/3.0/javadoc/org/opengis/metadata/spatial/PixelOrientation.html?is-external=true" title="class or interface in org.opengis.metadata.spatial" class="externalLink">Pixel orientation</a> «code list»<br>
<code> └─</code> <a href="DefaultGCP.html" title="class in org.apache.sis.metadata.iso.spatial">GCP</a><br>
<a href="DefaultGCPCollection.html" title="class in org.apache.sis.metadata.iso.spatial">GCP collection</a><br>
<a href="http://www.geoapi.org/3.0/javadoc/org/opengis/metadata/spatial/SpatialRepresentationType.html?is-external=true" title="class or interface in org.opengis.metadata.spatial" class="externalLink">Spatial representation type</a> «code list»<br>
</td></tr></table>
<div class="section">Null values, nil objects and collections</div>
All constructors and setter methods accept <code>null</code> arguments.
A null argument value means that the metadata element can not be provided, and the reason for that is unspecified.
Alternatively, users can specify why a metadata element is missing by providing a value created by
<a href="../../../xml/NilReason.html#createNilObject(java.lang.Class)"><code>Nil­Reason​.create­Nil­Object(Class)</code></a>.
<p>Unless otherwise noted in the Javadoc, all getter methods may return an empty collection,
an empty array or <code>null</code> if the type is neither a collection or an array.
Note that non-null values may be <a href="../../../xml/NilObject.html" title="interface in org.apache.sis.xml"><code>Nil­Object</code></a>s.</p>
<p>Unless the metadata object has been marked as unmodifiable and unless otherwise noted in the Javadoc,
all collections returned by getter methods are <cite>live</cite>: adding new elements in the collection
modify directly the underlying metadata object.</p></div>
<dl>
<dt><span class="simpleTagLabel">Since:</span></dt>
<dd>0.3</dd>
<p><font size="-1">Defined in the <code>sis-metadata</code> module</font></p>
</dl>
</section>
<ul class="blockList">
<li class="blockList">
<table class="typeSummary">
<caption><span>Class Summary</span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colFirst" scope="col">Class</th>
<th class="colLast" scope="col">Description</th>
</tr>
<tbody>
<tr class="altColor">
<th class="colFirst" scope="row"><a href="AbstractGeolocationInformation.html" title="class in org.apache.sis.metadata.iso.spatial">AbstractGeolocationInformation</a></th>
<td class="colLast">
<div class="block">Information used to determine geographic location corresponding to image location.</div>
</td>
</tr>
<tr class="rowColor">
<th class="colFirst" scope="row"><a href="AbstractSpatialRepresentation.html" title="class in org.apache.sis.metadata.iso.spatial">AbstractSpatialRepresentation</a></th>
<td class="colLast">
<div class="block">Method used to represent geographic information in the dataset.</div>
</td>
</tr>
<tr class="altColor">
<th class="colFirst" scope="row"><a href="DefaultDimension.html" title="class in org.apache.sis.metadata.iso.spatial">DefaultDimension</a></th>
<td class="colLast">
<div class="block">Axis properties.</div>
</td>
</tr>
<tr class="rowColor">
<th class="colFirst" scope="row"><a href="DefaultGCP.html" title="class in org.apache.sis.metadata.iso.spatial">DefaultGCP</a></th>
<td class="colLast">
<div class="block">Information on ground control point.</div>
</td>
</tr>
<tr class="altColor">
<th class="colFirst" scope="row"><a href="DefaultGCPCollection.html" title="class in org.apache.sis.metadata.iso.spatial">DefaultGCPCollection</a></th>
<td class="colLast">
<div class="block">Information about a control point collection.</div>
</td>
</tr>
<tr class="rowColor">
<th class="colFirst" scope="row"><a href="DefaultGeometricObjects.html" title="class in org.apache.sis.metadata.iso.spatial">DefaultGeometricObjects</a></th>
<td class="colLast">
<div class="block">Number of objects, listed by geometric object type, used in the dataset.</div>
</td>
</tr>
<tr class="altColor">
<th class="colFirst" scope="row"><a href="DefaultGeorectified.html" title="class in org.apache.sis.metadata.iso.spatial">DefaultGeorectified</a></th>
<td class="colLast">
<div class="block">Grid whose cells are regularly spaced in a geographic or projected coordinate reference system.</div>
</td>
</tr>
<tr class="rowColor">
<th class="colFirst" scope="row"><a href="DefaultGeoreferenceable.html" title="class in org.apache.sis.metadata.iso.spatial">DefaultGeoreferenceable</a></th>
<td class="colLast">
<div class="block">Grid with cells irregularly spaced in any given geographic/map projection coordinate reference system.</div>
</td>
</tr>
<tr class="altColor">
<th class="colFirst" scope="row"><a href="DefaultGridSpatialRepresentation.html" title="class in org.apache.sis.metadata.iso.spatial">DefaultGridSpatialRepresentation</a></th>
<td class="colLast">
<div class="block">Method used to represent geographic information in the dataset.</div>
</td>
</tr>
<tr class="rowColor">
<th class="colFirst" scope="row"><a href="DefaultVectorSpatialRepresentation.html" title="class in org.apache.sis.metadata.iso.spatial">DefaultVectorSpatialRepresentation</a></th>
<td class="colLast">
<div class="block">Information about the vector spatial objects in the dataset.</div>
</td>
</tr>
</tbody>
</table>
</li>
</ul>
</div>
</main>
<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 class="navBarCell1Rev">Package</li>
<li>Class</li>
<li><a href="package-use.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&nbsp;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>
<a id="skip.navbar.bottom">
<!-- -->
</a></div>
<!-- ======== END OF BOTTOM NAVBAR ======= -->
</nav>
<p class="legalCopy"><small>Copyright &#169; 2010&#x2013;2019 <a href="https://www.apache.org/">The Apache Software Foundation</a>. All rights reserved.</small></p>
</footer>
</body>
</html>