This is an automated email from the ASF dual-hosted git repository.
desruisseaux pushed a commit to branch main
in repository https://gitbox.apache.org/repos/asf/sis-site.git
commit e496564493da51bb6c3acf5271b670f7ba07f137
Author: Martin Desruisseaux <martin.desruisse...@geomatys.com>
AuthorDate: Tue Nov 21 10:21:27 2023 +0100
Rename de "GeoAPI" style as "API" for convenience.
It is frequently used, and having the same length as "SIS" and "OGC" make
easier to format some HTML code as table.
---
.../annexes/geoapi/DefinitionProcess.html | 26 +++++++++++-----------
.../annexes/geoapi/ReduceDependency.html | 8 +++----
.../annexes/tests/GeoApiConformance.html | 26 +++++++++++-----------
.../developer-guide/introduction/Conventions.html | 4 ++--
.../referencing/ComponentsOfCRS.html | 8 +++----
.../utility/Internationalization.html | 2 +-
content/developer-guide/xml/ISO-19115.html | 2 +-
static/book/book.css | 2 +-
8 files changed, 39 insertions(+), 39 deletions(-)
diff --git a/content/developer-guide/annexes/geoapi/DefinitionProcess.html
b/content/developer-guide/annexes/geoapi/DefinitionProcess.html
index 1dfed58f..f2ada6c7 100644
--- a/content/developer-guide/annexes/geoapi/DefinitionProcess.html
+++ b/content/developer-guide/annexes/geoapi/DefinitionProcess.html
@@ -82,7 +82,7 @@
The <abbr>OGC</abbr> class <code>MD_Identifier</code> becomes the
<code>Identifier</code> interface in the
<code>org.opengis.metadata</code> package.
The <abbr>OGC</abbr> class <code>SC_CRS</code> becomes the
<code>CoordinateReferenceSystem</code> interface,
- and the <code class="OGC">usesDatum</code> association becomes a
<code class="GeoAPI">getDatum()</code> method,
+ and the <code class="OGC">usesDatum</code> association becomes a
<code class="API">getDatum()</code> method,
rather than the “<code>getUsesDatum()</code>” that would result
from an automatic conversion tool.
We do not allow programs to blindly apply rules that ignore the
conventions of the community whose schemas we translate.
</p></div>
@@ -156,12 +156,12 @@
the name of the element in that standard, and also its obligation.
For example, in the following code snippet, the first
<code>@UML</code> code indicates that the Java interface that follows
(<code>ProjectedCRS</code>) is defined using the
<code>SC_ProjectedCRS</code> type of <abbr>ISO</abbr> 19111 standard.
- The second <code>@UML</code> annotation, this time applied to the
<code class="GeoAPI">getCoordinateSystem()</code> method,
+ The second <code>@UML</code> annotation, this time applied to the
<code class="API">getCoordinateSystem()</code> method,
indicates that this method is defined using the <code
class="OGC">coordinateSystem</code> association of <abbr>ISO</abbr> 19111
standard,
and that this association is mandatory — meaning, in Java, that the
method is not allowed to return a <code>null</code> value.
</p>
-<pre><code>package <code class="GeoAPI">org.opengis.referencing.crs</code>;
+<pre><code>package <code class="API">org.opengis.referencing.crs</code>;
/**
* A 2D coordinate reference system used to approximate the shape of the earth
on a planar surface.
@@ -172,7 +172,7 @@ public interface ProjectedCRS extends GeneralDerivedCRS {
* Returns the coordinate system, which must be Cartesian.
*/
@UML(obligation=MANDATORY, specification=ISO_19111, identifier="<code
class="OGC">coordinateSystem</code>")
- CartesianCS <code class="GeoAPI">getCoordinateSystem()</code>;
+ CartesianCS <code class="API">getCoordinateSystem()</code>;
}</code></pre>
<p>
@@ -198,7 +198,7 @@ System.out.println("Standard name of type " +
type.getName() + " is " + Types.ge
<h4 id="MappingToJDK">Implicit mapping to standard <abbr>JDK</abbr></h4>
<p>
- Some classes and methods have neither an <code>@UML</code> annotation,
nor an entry in the <code class="GeoAPI">class-index.properties</code> file.
+ Some classes and methods have neither an <code>@UML</code> annotation,
nor an entry in the <code class="API">class-index.properties</code> file.
They are either extensions of GeoAPI, or else types defined in other
libraries, such as standard <abbr title="Java Development Kit">JDK</abbr>.
In this last case, the mapping to <abbr>ISO</abbr> standards is
implicit.
The following table describes this mapping for <abbr>ISO</abbr> 19103
types.
@@ -248,12 +248,12 @@ System.out.println("Standard name of type " +
type.getName() + " is " + Types.ge
<tr>
<td><code class="OGC">FreeText</code></td>
<td>(no equivalent)</td>
- <td class="leftBorder">See <code
class="GeoAPI">org.opengis.util.InternationalString</code> below.</td>
+ <td class="leftBorder">See <code
class="API">org.opengis.util.InternationalString</code> below.</td>
</tr>
<tr>
<td><code class="OGC">CharacterString</code></td>
<td><code>java.lang.String</code></td>
- <td class="leftBorder">Often <code
class="GeoAPI">org.opengis.util.InternationalString</code> (see below).</td>
+ <td class="leftBorder">Often <code
class="API">org.opengis.util.InternationalString</code> (see below).</td>
</tr>
<tr>
<td><code class="OGC">LocalisedCharacterString</code></td>
@@ -369,15 +369,15 @@ System.out.println("Standard name of type " +
type.getName() + " is " + Types.ge
Both define all authorized values, without allowing the user to add
any.
A <code class="OGC">CodeList</code> is similar to an enumeration,
except that users may add their own items.
Standard <abbr>JDK</abbr> does not offer this possibility.
- GeoAPI defines an abstract <code class="GeoAPI">CodeList</code> class
that reproduces some of the functionality of <code>Enum</code> while being
extensible.
- Extensions are made available by the <code
class="GeoAPI">valueOf(String)</code> static method, which, in contrast to
<code>Enum</code>,
+ GeoAPI defines an abstract <code class="API">CodeList</code> class
that reproduces some of the functionality of <code>Enum</code> while being
extensible.
+ Extensions are made available by the <code
class="API">valueOf(String)</code> static method, which, in contrast to
<code>Enum</code>,
creates new instances if the name provided does not correspond to the
name of an existing instance.
</p>
-<pre><code>MediumName cdRom = MediumName.<code class="GeoAPI">CD_ROM;</code>
-MediumName usbKey = MediumName.<code class="GeoAPI">valueOf</code>("<code
class="GeoAPI">USB_KEY</code>"); // There is no constraint on this value.
-assert MediumName.<code class="GeoAPI">valueOf</code>("<code
class="GeoAPI">CD_ROM</code>") == cdRom : "valueOf must return existing
constants.";
-assert MediumName.<code class="GeoAPI">valueOf</code>("<code
class="GeoAPI">USB_KEY</code>") == usbKey : "valueOf must cache the previously
requested values.";</code></pre>
+<pre><code>MediumName cdRom = MediumName.<code class="API">CD_ROM;</code>
+MediumName usbKey = MediumName.<code class="API">valueOf</code>("<code
class="API">USB_KEY</code>"); // There is no constraint on this value.
+assert MediumName.<code class="API">valueOf</code>("<code
class="API">CD_ROM</code>") == cdRom : "valueOf must return existing
constants.";
+assert MediumName.<code class="API">valueOf</code>("<code
class="API">USB_KEY</code>") == usbKey : "valueOf must cache the previously
requested values.";</code></pre>
</section>
</body>
</html>
diff --git a/content/developer-guide/annexes/geoapi/ReduceDependency.html
b/content/developer-guide/annexes/geoapi/ReduceDependency.html
index 8d86b75c..ed14fe8d 100644
--- a/content/developer-guide/annexes/geoapi/ReduceDependency.html
+++ b/content/developer-guide/annexes/geoapi/ReduceDependency.html
@@ -52,24 +52,24 @@
Java reflection methods allow access to this information during the
execution of an application.
Class <code>org.apache.sis.util.iso.Types</code> provides static
convenience methods like
<code class="SIS">getStandardName(Class)</code>, but one can avoid
those methods.
- The following example displays the standard name for the method <code
class="GeoAPI">getTitle()</code> from the <code>Citation</code> interface:
+ The following example displays the standard name for the method <code
class="API">getTitle()</code> from the <code>Citation</code> interface:
</p>
<pre><code>Class<?> type = Citation.class;
-Method method = type.getMethod("<code class="GeoAPI">getTitle</code>",
(Class<?>[]) null);
+Method method = type.getMethod("<code class="API">getTitle</code>",
(Class<?>[]) null);
UML annot = method.getAnnotation(UML.class);
String id = annot.identifier();
System.out.println("The standard name for the " + method.getName() + " method
is " + id);</code></pre>
<p>
The reverse operation — getting the Java class and method from a
standard name — is a bit more complicated.
- It requires reading the <code
class="GeoAPI">class-index.properties</code> file provided in the
<code>org.opengis.annotation</code> package.
+ It requires reading the <code
class="API">class-index.properties</code> file provided in the
<code>org.opengis.annotation</code> package.
The following example reads the files just before searching for the
name of the interface corresponding to <code>CI_Citation</code>.
Users are always encouraged to only read this file once and then save
its contents in their application’s cache.
</p>
<pre><code>Properties isoToGeoAPI = new Properties();
-try (InputStream in = UML.class.getResourceAsStream("<code
class="GeoAPI">class-index.properties</code>")) {
+try (InputStream in = UML.class.getResourceAsStream("<code
class="API">class-index.properties</code>")) {
isoToGeoAPI.load(in);
}
String isoName = "<code class="OGC">CI_Citation</code>";
diff --git a/content/developer-guide/annexes/tests/GeoApiConformance.html
b/content/developer-guide/annexes/tests/GeoApiConformance.html
index da4ba71b..671bf59e 100644
--- a/content/developer-guide/annexes/tests/GeoApiConformance.html
+++ b/content/developer-guide/annexes/tests/GeoApiConformance.html
@@ -65,15 +65,15 @@
</p></div>
<p>
- The easiest way to perform these verifications is to call the static
methods <code class="GeoAPI">validate(…)</code>
+ The easiest way to perform these verifications is to call the static
methods <code class="API">validate(…)</code>
of the <code>org.opengis.test.Validators</code> class.
As all of <code>Validators</code> methods bear the same name, it is
enough to write “<code>validate(<var>value</var>)</code>”
and then let the compiler choose the most appropriate method for the
type of object given in argument.
If the object type is not known at the time of compilation,
- the <code class="GeoAPI">dispatch(Object)</code> method can be invoked
for redirecting the work to the most appropriate <code
class="GeoAPI">validate(…)</code> method.
+ the <code class="API">dispatch(Object)</code> method can be invoked
for redirecting the work to the most appropriate <code
class="API">validate(…)</code> method.
</p>
<p>
- All <code class="GeoAPI">validate(…)</code> functions follow a chain
of dependencies,
+ All <code class="API">validate(…)</code> functions follow a chain of
dependencies,
meaning that they will also validate each component of the object to
be validated.
For example, the validation of a <code>GeographicCRS</code> implies
the validation of its component
<code>GeodeticDatum</code>, which itself implies the validation of its
component <code>Ellipsoid</code>, and so on.
@@ -98,14 +98,14 @@ public class MyTest {
* in a parent class to all test classes.
*/
static {
- Validators.<code
class="GeoAPI">DEFAULT.metadata.requireMandatoryAttributes</code> = false;
- Validators.<code
class="GeoAPI">DEFAULT.citation.requireMandatoryAttributes</code> = false;
+ Validators.<code
class="API">DEFAULT.metadata.requireMandatoryAttributes</code> = false;
+ Validators.<code
class="API">DEFAULT.citation.requireMandatoryAttributes</code> = false;
}
@Test
public void testMyMetadata() {
Metadata myObject = …; // Create an object here.
- Validators.<code class="GeoAPI">validate</code>(myObject);
+ Validators.<code class="API">validate</code>(myObject);
}
}</code></pre>
@@ -123,14 +123,14 @@ public class MyTest {
public MyTest() {
validators = new ValidatorContainer();
- validators.<code
class="GeoAPI">metadata.requireMandatoryAttributes</code> = false;
- validators.<code
class="GeoAPI">citation.requireMandatoryAttributes</code> = false;
+ validators.<code
class="API">metadata.requireMandatoryAttributes</code> = false;
+ validators.<code
class="API">citation.requireMandatoryAttributes</code> = false;
}
@Test
public void testMyMetadata() {
Metadata myObject = …; // Create an object here.
- validators.<code class="GeoAPI">validate</code>(myObject);
+ validators.<code class="API">validate</code>(myObject);
}
}</code></pre>
@@ -142,7 +142,7 @@ public class MyTest {
All test classes bear a name ending in "<code>Test</code>".
GeoAPI also provides an <code>org.opengis.test.TestSuite</code> class
including all test classes defined in the
<code>geoapi-conformance</code> module, but Apache <abbr>SIS</abbr>
does not use it.
- Instead, Apache <abbr>SIS</abbr> inherits GeoAPI’s <code
class="GeoAPI">*Test</code> classes on a case-by-case basis,
+ Instead, Apache <abbr>SIS</abbr> inherits GeoAPI’s <code
class="API">*Test</code> classes on a case-by-case basis,
in the appropriate modules.
The example below gives an example of a customized GeoAPI test:
The <a
href="http://www.geoapi.org/geoapi-conformance/apidocs/org/opengis/test/referencing/ParameterizedTransformTest.html";>parent
test javadoc</a>
@@ -175,8 +175,8 @@ public class MyTest extends ParameterizedTransformTest {
@Test
@Override
public void testLambertAzimuthalEqualArea() throws FactoryException,
TransformException {
- <code class="GeoAPI">tolerance</code> = 0.1; // 10
cm tolerance.
- super.<code class="GeoAPI">testLambertAzimuthalEqualArea()</code>;
+ <code class="API">tolerance</code> = 0.1; // 10 cm
tolerance.
+ super.<code class="API">testLambertAzimuthalEqualArea()</code>;
}
/**
@@ -186,7 +186,7 @@ public class MyTest extends ParameterizedTransformTest {
*/
@After
public void ensureAllTransformAreMath2D() {
- assertTrue(<code class="GeoAPI">transform</code> instanceof
MathTransform2D);
+ assertTrue(<code class="API">transform</code> instanceof
MathTransform2D);
}
}</code></pre>
</section>
diff --git a/content/developer-guide/introduction/Conventions.html
b/content/developer-guide/introduction/Conventions.html
index aa0a3716..9202e257 100644
--- a/content/developer-guide/introduction/Conventions.html
+++ b/content/developer-guide/introduction/Conventions.html
@@ -60,7 +60,7 @@
<p>
For example to represent a projected coordinate reference system
(Mercator, Lambert, <i>etc</i>),
<code class="OGC">SC_ProjectedCRS</code> is an <abbr>UML</abbr> and
<abbr>XML</abbr> element defined by the <abbr>ISO</abbr> 19111 standard.
- Then <code
class="GeoAPI">org.opengis.referencing.crs.<b>ProjectedCRS</b></code> is
the implementation-neutral GeoAPI interface derived from that standard,
+ Then <code
class="API">org.opengis.referencing.crs.<b>ProjectedCRS</b></code> is the
implementation-neutral GeoAPI interface derived from that standard,
and <code
class="SIS">org.apache.sis.referencing.crs.<b>DefaultProjectedCRS</b></code>
is the implementation class provided by Apache SIS.
</p>
</section>
@@ -73,7 +73,7 @@
but prefixed by <code>Abstract</code>, <code>Default</code> or
<code>General</code> word.
The <code>General</code> prefix is sometimes used instead of
<code>Default</code>
to indicate that alternative implementations are available for some
specific cases.
- For example the <code class="GeoAPI">Envelope</code> interface is
implemented by at least two Apache SIS classes:
+ For example the <code class="API">Envelope</code> interface is
implemented by at least two Apache SIS classes:
<code class="SIS">GeneralEnvelope</code> and <code
class="SIS">Envelope2D</code>.
The first implementation can represent envelopes with any number of
dimensions
while the second implementation is specialized for two-dimensional
envelopes.
diff --git a/content/developer-guide/referencing/ComponentsOfCRS.html
b/content/developer-guide/referencing/ComponentsOfCRS.html
index 733193ba..e9141f01 100644
--- a/content/developer-guide/referencing/ComponentsOfCRS.html
+++ b/content/developer-guide/referencing/ComponentsOfCRS.html
@@ -190,10 +190,10 @@ RangeMeaning atEnds =
secondAxis.getRangeMeaning(); // For a longitude a
but many ellipsoid definitions provide this factor instead of
semi-minor axis length.
</p>
-<pre><code>Unit<Length> units = ellipsoid.<code
class="GeoAPI">getAxisUnit()</code>;
-double semiMajor = ellipsoid.<code class="GeoAPI">getSemiMajorAxis()</code>;
// In units of measurement given above.
-double semiMinor = ellipsoid.<code class="GeoAPI">getSemiMinorAxis()</code>;
// In units of measurement given above.
-double ivf = ellipsoid.<code
class="GeoAPI">getInverseFlattening()</code>; // = semiMajor / (semiMajor
- semiMinor).
+<pre><code>Unit<Length> units = ellipsoid.<code
class="API">getAxisUnit()</code>;
+double semiMajor = ellipsoid.<code class="API">getSemiMajorAxis()</code>;
// In units of measurement given above.
+double semiMinor = ellipsoid.<code class="API">getSemiMinorAxis()</code>;
// In units of measurement given above.
+double ivf = ellipsoid.<code
class="API">getInverseFlattening()</code>; // = semiMajor / (semiMajor -
semiMinor).
</code></pre>
<p>
diff --git a/content/developer-guide/utility/Internationalization.html
b/content/developer-guide/utility/Internationalization.html
index 093f3807..d4d5bd7b 100644
--- a/content/developer-guide/utility/Internationalization.html
+++ b/content/developer-guide/utility/Internationalization.html
@@ -99,7 +99,7 @@
<div class="example"><p><b>Example:</b>
<abbr>SIS</abbr> includes only one instance of the
<code>OperationMethod</code>
type representing the Mercator projection, regardless of the client’s
language.
- But its <code class="GeoAPI">getName()</code> method (indirectly)
provides an instance of
+ But its <code class="API">getName()</code> method (indirectly)
provides an instance of
<code>InternationalString</code>, so that
<code>toString(Locale.ENGLISH)</code> returns <cite>Mercator projection</cite>
while <code>toString(Locale.FRENCH)</code> returns <cite>Projection de
Mercator</cite>.
</p></div>
diff --git a/content/developer-guide/xml/ISO-19115.html
b/content/developer-guide/xml/ISO-19115.html
index 7c194ae7..3068fd78 100644
--- a/content/developer-guide/xml/ISO-19115.html
+++ b/content/developer-guide/xml/ISO-19115.html
@@ -183,7 +183,7 @@ public class MyClass {
Although this mechanism has been defined in order to better support
the representation of <abbr>XML</abbr> attributes
of the <code>gco:ObjectIdentification</code> group,
it also conveniently allows other types of identifiers to be
manipulated.
- For example, the <code class="GeoAPI">ISBN</code> and <code
class="GeoAPI">ISSN</code> attributes of
+ For example, the <code class="API">ISBN</code> and <code
class="API">ISSN</code> attributes of
<code>Citation</code> may be manipulated in this way.
The methods of the <code class="SIS">IdentifiedObject</code> interface
therefore provides a specific location
where all types of identifiers (not only <abbr>XML</abbr>) associated
with an object may be manipulated.
diff --git a/static/book/book.css b/static/book/book.css
index effe5d85..09751e9c 100644
--- a/static/book/book.css
+++ b/static/book/book.css
@@ -300,7 +300,7 @@ code.OGC {
color: MediumBlue;
}
-code.GeoAPI {
+code.API {
color: Green;
}
