| <!DOCTYPE HTML> |
| <html lang="en"> |
| <head> |
| <!-- Generated by javadoc (21) on Thu Oct 05 19:54:57 CEST 2023 --> |
| <title>org.apache.sis.referencing.factory (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.referencing, package: org.apache.sis.referencing.factory"> |
| <meta name="generator" content="javadoc/PackageWriterImpl"> |
| <meta name="keywords" content="org.apache.sis.referencing.factory 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="../../../../../../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="package-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"> </span><span class="nav-bar-toggle-icon"> </span><span class="nav-bar-toggle-icon"> </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 class="nav-bar-cell1-rev">Package</li> |
| <li>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#package">Help</a></li> |
| </ul> |
| <ul class="sub-nav-list-small"> |
| <li> |
| <p>Package:</p> |
| <ul> |
| <li><a href="#package-description">Description</a></li> |
| <li><a href="#related-package-summary">Related Packages</a></li> |
| <li><a href="#class-summary">Classes and Interfaces</a></li> |
| </ul> |
| </li> |
| </ul> |
| </div> |
| <div class="sub-nav"> |
| <div id="navbar-sub-list"> |
| <ul class="sub-nav-list"> |
| <li>Package: </li> |
| <li><a href="#package-description">Description</a> | </li> |
| <li><a href="#related-package-summary">Related Packages</a> | </li> |
| <li><a href="#class-summary">Classes and Interfaces</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"> |
| <div class="header"> |
| <div class="sub-title"><span class="module-label-in-package">Module</span> <a href="../../../../../module-summary.html">org.apache.sis.referencing</a></div> |
| <h1 title="Package org.apache.sis.referencing.factory" class="title">Package org.apache.sis.referencing.factory</h1> |
| </div> |
| <hr> |
| <div class="package-signature">package <span class="element-name">org.apache.sis.referencing.factory</span></div> |
| <section class="package-description" id="package-description"> |
| <div class="block">Creates Coordinate Reference System (CRS) objects from given properties or authority codes. |
| This package provides two kinds of factories: |
| |
| <ul class="verbose"> |
| <li><a href="GeodeticAuthorityFactory.html" title="class in org.apache.sis.referencing.factory"><code>GeodeticAuthorityFactory</code></a> |
| creates geodetic objects from codes defined by an authority. |
| An <cite>authority</cite> is an organization that maintains definitions of authority codes. |
| An <cite>authority code</cite> is a compact string defined by an authority to reference a particular spatial reference object. |
| A frequently used set of authority codes is the <a href="https://epsg.org/">EPSG geodetic dataset</a>, |
| a database of coordinate systems and other spatial referencing objects where each object has a code number ID.</li> |
| |
| <li><a href="GeodeticObjectFactory.html" title="class in org.apache.sis.referencing.factory"><code>GeodeticObjectFactory</code></a> |
| creates complex objects that cannot be created by the authority factories. |
| Allows also <cite>inversion of control</cite> when used with the |
| <a href="sql/EPSGFactory.html" title="class in org.apache.sis.referencing.factory.sql">EPSG authority factory</a> |
| or with the <a href="../../io/wkt/WKTFormat.html" title="class in org.apache.sis.io.wkt">WKT parser</a>.</li> |
| </ul> |
| |
| Authority factories available in Apache SIS are listed below. |
| Factories defined in this package do not require any configuration or external resources. |
| Factories defined in the <a href="sql/package-summary.html"><code>sql</code></a> sub-package require a connection to a database. |
| |
| <table class="sis"> |
| <caption>Authority factory implementations</caption> |
| <tr> |
| <th>Authorities</th> |
| <th>Implementation class</th> |
| <th>Conditions</th> |
| </tr><tr> |
| <td><code>CRS</code>, <code>AUTO</code> and <code>AUTO2</code></td> |
| <td><a href="CommonAuthorityFactory.html" title="class in org.apache.sis.referencing.factory"><code>CommonAuthorityFactory</code></a></td> |
| <td>None.</td> |
| </tr><tr> |
| <td><code>EPSG</code></td> |
| <td><a href="sql/EPSGFactory.html" title="class in org.apache.sis.referencing.factory.sql"><code>EPSGFactory</code></a></td> |
| <td>Requires installation of EPSG dataset.</td> |
| </tr> |
| </table></div> |
| <dl class="notes"> |
| <dt>Since:</dt> |
| <dd>0.6</dd> |
| </dl> |
| </section> |
| <section class="summary"> |
| <ul class="summary-list"> |
| <li> |
| <div id="related-package-summary"> |
| <div class="caption"><span>Related Packages</span></div> |
| <div class="summary-table three-column-summary"> |
| <div class="table-header col-first">Module</div> |
| <div class="table-header col-second">Package</div> |
| <div class="table-header col-last">Description</div> |
| <div class="col-plain even-row-color"><a href="../../../../../module-summary.html">org.apache.sis.referencing</a></div> |
| <div class="col-first even-row-color"><a href="../package-summary.html">org.apache.sis.referencing</a></div> |
| <div class="col-last even-row-color"> |
| <div class="block">Base classes for reference systems used for general positioning.</div> |
| </div> |
| <div class="col-plain odd-row-color"><a href="../../../../../module-summary.html">org.apache.sis.referencing</a></div> |
| <div class="col-first odd-row-color"><a href="sql/package-summary.html">org.apache.sis.referencing.factory.sql</a></div> |
| <div class="col-last odd-row-color"> |
| <div class="block">Factories for geodetic objects defined in a SQL database, typically the EPSG dataset.</div> |
| </div> |
| <div class="col-plain even-row-color"><a href="../../../../../module-summary.html">org.apache.sis.referencing</a></div> |
| <div class="col-first even-row-color"><a href="../crs/package-summary.html">org.apache.sis.referencing.crs</a></div> |
| <div class="col-last even-row-color"> |
| <div class="block">Coordinate Reference System (CRS) definitions as coordinate systems related to the earth through datum.</div> |
| </div> |
| <div class="col-plain odd-row-color"><a href="../../../../../module-summary.html">org.apache.sis.referencing</a></div> |
| <div class="col-first odd-row-color"><a href="../cs/package-summary.html">org.apache.sis.referencing.cs</a></div> |
| <div class="col-last odd-row-color"> |
| <div class="block">Coordinate System (CS) definitions as the set of coordinate system axes that spans the coordinate space.</div> |
| </div> |
| <div class="col-plain even-row-color"><a href="../../../../../module-summary.html">org.apache.sis.referencing</a></div> |
| <div class="col-first even-row-color"><a href="../datum/package-summary.html">org.apache.sis.referencing.datum</a></div> |
| <div class="col-last even-row-color"> |
| <div class="block">Relationship of a <code>CoordinateSystem</code> (an abstract mathematical entity) to the earth or other system.</div> |
| </div> |
| <div class="col-plain odd-row-color"><a href="../../../../../../org.apache.sis.referencing.gazetteer/module-summary.html">org.apache.sis.referencing.gazetteer</a></div> |
| <div class="col-first odd-row-color"><a href="../../../../../../org.apache.sis.referencing.gazetteer/org/apache/sis/referencing/gazetteer/package-summary.html">org.apache.sis.referencing.gazetteer</a></div> |
| <div class="col-last odd-row-color"> |
| <div class="block">Mapping between geographic identifiers (addresses, grid indexes…) and locations (descriptions, coordinates…).</div> |
| </div> |
| <div class="col-plain even-row-color"><a href="../../../../../module-summary.html">org.apache.sis.referencing</a></div> |
| <div class="col-first even-row-color"><a href="../operation/package-summary.html">org.apache.sis.referencing.operation</a></div> |
| <div class="col-last even-row-color"> |
| <div class="block">Relationship between any two <a href="../crs/AbstractCRS.html" title="class in org.apache.sis.referencing.crs">Coordinate Reference Systems</a> (CRS).</div> |
| </div> |
| </div> |
| </div> |
| </li> |
| <li> |
| <div id="class-summary"> |
| <div class="table-tabs" role="tablist" aria-orientation="horizontal"><button id="class-summary-tab0" role="tab" aria-selected="true" aria-controls="class-summary.tabpanel" tabindex="0" onkeydown="switchTab(event)" onclick="show('class-summary', 'class-summary', 2)" class="active-table-tab">All Classes and Interfaces</button><button id="class-summary-tab2" role="tab" aria-selected="false" aria-controls="class-summary.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('class-summary', 'class-summary-tab2', 2)" class="table-tab">Classes</button><button id="class-summary-tab3" role="tab" aria-selected="false" aria-controls="class-summary.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('class-summary', 'class-summary-tab3', 2)" class="table-tab">Enum Classes</button><button id="class-summary-tab5" role="tab" aria-selected="false" aria-controls="class-summary.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('class-summary', 'class-summary-tab5', 2)" class="table-tab">Exception Classes</button></div> |
| <div id="class-summary.tabpanel" role="tabpanel"> |
| <div class="summary-table two-column-summary" aria-labelledby="class-summary-tab0"> |
| <div class="table-header col-first">Class</div> |
| <div class="table-header col-last">Description</div> |
| <div class="col-first even-row-color class-summary class-summary-tab2"><a href="CommonAuthorityFactory.html" title="class in org.apache.sis.referencing.factory">CommonAuthorityFactory</a></div> |
| <div class="col-last even-row-color class-summary class-summary-tab2"> |
| <div class="block">Creates coordinate reference systems in the "<code>OGC</code>", "<code>CRS</code>" or <code>"AUTO(2)"</code> namespaces.</div> |
| </div> |
| <div class="col-first odd-row-color class-summary class-summary-tab2"><a href="ConcurrentAuthorityFactory.html" title="class in org.apache.sis.referencing.factory">ConcurrentAuthorityFactory</a><DAO extends <a href="GeodeticAuthorityFactory.html" title="class in org.apache.sis.referencing.factory">GeodeticAuthorityFactory</a>></div> |
| <div class="col-last odd-row-color class-summary class-summary-tab2"> |
| <div class="block">A concurrent authority factory that caches all objects created by another factory.</div> |
| </div> |
| <div class="col-first even-row-color class-summary class-summary-tab5"><a href="FactoryDataException.html" title="class in org.apache.sis.referencing.factory">FactoryDataException</a></div> |
| <div class="col-last even-row-color class-summary class-summary-tab5"> |
| <div class="block">Thrown when a factory contains invalid data.</div> |
| </div> |
| <div class="col-first odd-row-color class-summary class-summary-tab2"><a href="GeodeticAuthorityFactory.html" title="class in org.apache.sis.referencing.factory">GeodeticAuthorityFactory</a></div> |
| <div class="col-last odd-row-color class-summary class-summary-tab2"> |
| <div class="block">Creates geodetic objects from codes defined by an authority.</div> |
| </div> |
| <div class="col-first even-row-color class-summary class-summary-tab2"><a href="GeodeticObjectFactory.html" title="class in org.apache.sis.referencing.factory">GeodeticObjectFactory</a></div> |
| <div class="col-last even-row-color class-summary class-summary-tab2"> |
| <div class="block">Creates <a href="../crs/AbstractCRS.html" title="class in org.apache.sis.referencing.crs">Coordinate Reference System</a> (CRS) implementations, |
| with their <a href="../cs/AbstractCS.html" title="class in org.apache.sis.referencing.cs">Coordinate System</a> (CS) |
| and <a href="../datum/AbstractDatum.html" title="class in org.apache.sis.referencing.datum">Datum</a> components.</div> |
| </div> |
| <div class="col-first odd-row-color class-summary class-summary-tab2"><a href="IdentifiedObjectFinder.html" title="class in org.apache.sis.referencing.factory">IdentifiedObjectFinder</a></div> |
| <div class="col-last odd-row-color class-summary class-summary-tab2"> |
| <div class="block">Searches in an authority factory for objects approximately equal to a given object.</div> |
| </div> |
| <div class="col-first even-row-color class-summary class-summary-tab3"><a href="IdentifiedObjectFinder.Domain.html" title="enum class in org.apache.sis.referencing.factory">IdentifiedObjectFinder.Domain</a></div> |
| <div class="col-last even-row-color class-summary class-summary-tab3"> |
| <div class="block">The domain of the search (for example whether to include deprecated objects in the search).</div> |
| </div> |
| <div class="col-first odd-row-color class-summary class-summary-tab2"><a href="IdentifiedObjectSet.html" title="class in org.apache.sis.referencing.factory">IdentifiedObjectSet</a><T extends <a href="http://www.geoapi.org/3.0/javadoc/org.opengis.geoapi/org/opengis/referencing/IdentifiedObject.html" title="class or interface in org.opengis.referencing" class="external-link">IdentifiedObject</a>></div> |
| <div class="col-last odd-row-color class-summary class-summary-tab2"> |
| <div class="block">A lazy set of <code>IdentifiedObject</code> instances created from their authority codes only when first needed.</div> |
| </div> |
| <div class="col-first even-row-color class-summary class-summary-tab5"><a href="InvalidGeodeticParameterException.html" title="class in org.apache.sis.referencing.factory">InvalidGeodeticParameterException</a></div> |
| <div class="col-last even-row-color class-summary class-summary-tab5"> |
| <div class="block">Thrown when a factory <code>createFoo(…)</code> method is given invalid parameters.</div> |
| </div> |
| <div class="col-first odd-row-color class-summary class-summary-tab5"><a href="MissingFactoryResourceException.html" title="class in org.apache.sis.referencing.factory">MissingFactoryResourceException</a></div> |
| <div class="col-last odd-row-color class-summary class-summary-tab5"> |
| <div class="block">Thrown when a particular object cannot be created because a resource is missing.</div> |
| </div> |
| <div class="col-first even-row-color class-summary class-summary-tab2"><a href="MultiAuthoritiesFactory.html" title="class in org.apache.sis.referencing.factory">MultiAuthoritiesFactory</a></div> |
| <div class="col-last even-row-color class-summary class-summary-tab2"> |
| <div class="block">A factory that delegates the object creation to another factory determined from the <var>authority</var> part |
| in “<var>authority</var>:<var>code</var>” arguments.</div> |
| </div> |
| <div class="col-first odd-row-color class-summary class-summary-tab5"><a href="NoSuchAuthorityFactoryException.html" title="class in org.apache.sis.referencing.factory">NoSuchAuthorityFactoryException</a></div> |
| <div class="col-last odd-row-color class-summary class-summary-tab5"> |
| <div class="block">Thrown when no factory has been found for a given authority name.</div> |
| </div> |
| <div class="col-first even-row-color class-summary class-summary-tab5"><a href="UnavailableFactoryException.html" title="class in org.apache.sis.referencing.factory">UnavailableFactoryException</a></div> |
| <div class="col-last even-row-color class-summary class-summary-tab5"> |
| <div class="block">Thrown when a whole factory cannot be created because a resource is missing.</div> |
| </div> |
| </div> |
| </div> |
| </div> |
| </li> |
| </ul> |
| </section> |
| </main> |
| </div> |
| </div> |
| </body> |
| </html> |
