This is an automated email from the ASF dual-hosted git repository.
desruisseaux pushed a commit to branch geoapi-4.0
in repository https://gitbox.apache.org/repos/asf/sis.git
commit 65b60e8471794794e6fd86999808b4f772ac1b1f
Author: Martin Desruisseaux <martin.desruisse...@geomatys.com>
AuthorDate: Sun Oct 29 15:14:00 2023 +0100
Minor formatting: fix a few spelling errors in comments,
add comments about non-endorsed modules, adjust some white spaces.
---
.../main/org/apache/sis/coverage/Category.java | 2 +-
.../org.apache.sis.metadata/main/module-info.java | 2 +-
.../sis/storage/geotiff/writer/GeoEncoder.java | 2 +-
.../src/org.apache.sis.util/main/module-info.java | 12 +++---
.../storage/coveragejson/CoverageJsonStore.java | 9 ++---
.../sis/storage/coveragejson/CoverageResource.java | 46 +++++++++-------------
.../storage/coveragejson/binding/Parameters.java | 2 +-
.../sis/storage/coveragejson/package-info.java | 2 +-
8 files changed, 32 insertions(+), 45 deletions(-)
diff --git
a/endorsed/src/org.apache.sis.feature/main/org/apache/sis/coverage/Category.java
b/endorsed/src/org.apache.sis.feature/main/org/apache/sis/coverage/Category.java
index c305f2bdb2..6569b0c9cf 100644
---
a/endorsed/src/org.apache.sis.feature/main/org/apache/sis/coverage/Category.java
+++
b/endorsed/src/org.apache.sis.feature/main/org/apache/sis/coverage/Category.java
@@ -49,7 +49,7 @@ import static java.lang.Double.doubleToRawLongBits;
* <li><b>Example of quantitative observation:</b>
* another sample dimension may have a {@code Category} instance specifying
that sample values in the range [0…100]
* stands for elevation data. Those sample values are related to
measurements in the real world (altitudes in metres)
- * through a <cite>transfer function</cite>, foe example <var>altitude</var>
= (<var>sample value</var>)×100 - 25.</li>
+ * through a <cite>transfer function</cite>, for example <var>altitude</var>
= (<var>sample value</var>)×100 - 25.</li>
* </ul>
*
* Some image mixes both qualitative and quantitative categories. For example,
images of <cite>Sea Surface Temperature</cite>
diff --git a/endorsed/src/org.apache.sis.metadata/main/module-info.java
b/endorsed/src/org.apache.sis.metadata/main/module-info.java
index 8c23031110..76bb50ec4c 100644
--- a/endorsed/src/org.apache.sis.metadata/main/module-info.java
+++ b/endorsed/src/org.apache.sis.metadata/main/module-info.java
@@ -150,7 +150,7 @@ module org.apache.sis.metadata {
exports org.apache.sis.metadata.sql.util to
org.apache.sis.referencing,
org.apache.sis.storage.sql,
- org.apache.sis.referencing.database;
+ org.apache.sis.referencing.database; // In the "non-free"
subproject.
exports org.apache.sis.metadata.simple to
org.apache.sis.referencing,
diff --git
a/endorsed/src/org.apache.sis.storage.geotiff/main/org/apache/sis/storage/geotiff/writer/GeoEncoder.java
b/endorsed/src/org.apache.sis.storage.geotiff/main/org/apache/sis/storage/geotiff/writer/GeoEncoder.java
index 4774e5b3ea..c85ffcfa28 100644
---
a/endorsed/src/org.apache.sis.storage.geotiff/main/org/apache/sis/storage/geotiff/writer/GeoEncoder.java
+++
b/endorsed/src/org.apache.sis.storage.geotiff/main/org/apache/sis/storage/geotiff/writer/GeoEncoder.java
@@ -631,7 +631,7 @@ public final class GeoEncoder {
*
* @param value the value to cast to an unsigned short.
* @return the value as an unsigned short.
- * @throws ArithmeticException if the given value can not be stored as an
unsigned 16 bits integer.
+ * @throws ArithmeticException if the given value cannot be stored as an
unsigned 16 bits integer.
*
* @see #toShortEPSG(Integer)
*/
diff --git a/endorsed/src/org.apache.sis.util/main/module-info.java
b/endorsed/src/org.apache.sis.util/main/module-info.java
index 4f83c5a36f..dd5262f706 100644
--- a/endorsed/src/org.apache.sis.util/main/module-info.java
+++ b/endorsed/src/org.apache.sis.util/main/module-info.java
@@ -113,8 +113,8 @@ module org.apache.sis.util {
org.apache.sis.console,
org.apache.sis.openoffice,
org.apache.sis.gui, // In the "optional"
sub-project.
- org.apache.sis.referencing.epsg,
- org.apache.sis.referencing.database;
+ org.apache.sis.referencing.epsg, // In the "non-free"
sub-project.
+ org.apache.sis.referencing.database; // In the "non-free"
sub-project.
exports org.apache.sis.util.internal to
org.apache.sis.metadata,
@@ -132,8 +132,8 @@ module org.apache.sis.util {
org.apache.sis.cloud.aws,
org.apache.sis.console,
org.apache.sis.gui, // In the "optional"
sub-project.
- org.apache.sis.referencing.epsg,
- org.apache.sis.referencing.database;
+ org.apache.sis.referencing.epsg, // In the "non-free"
sub-project.
+ org.apache.sis.referencing.database; // In the "non-free"
sub-project.
exports org.apache.sis.pending.temporal to
org.apache.sis.metadata;
@@ -152,7 +152,7 @@ module org.apache.sis.util {
org.apache.sis.storage,
org.apache.sis.storage.xml,
org.apache.sis.storage.sql,
- org.apache.sis.storage.shapefile,
+ org.apache.sis.storage.shapefile, // In the "incubator"
sub-project.
org.apache.sis.storage.netcdf,
org.apache.sis.storage.geotiff,
org.apache.sis.storage.earthobservation,
@@ -160,7 +160,7 @@ module org.apache.sis.util {
org.apache.sis.console,
org.apache.sis.webapp, // In the "incubator"
sub-project.
org.apache.sis.gui, // In the "optional"
sub-project.
- org.apache.sis.referencing.database;
+ org.apache.sis.referencing.database; // In the "non-free"
sub-project.
exports org.apache.sis.pending.jdk to
org.apache.sis.feature,
diff --git
a/incubator/src/org.apache.sis.storage.coveragejson/main/org/apache/sis/storage/coveragejson/CoverageJsonStore.java
b/incubator/src/org.apache.sis.storage.coveragejson/main/org/apache/sis/storage/coveragejson/CoverageJsonStore.java
index 814c31fed1..ba72c5ce62 100644
---
a/incubator/src/org.apache.sis.storage.coveragejson/main/org/apache/sis/storage/coveragejson/CoverageJsonStore.java
+++
b/incubator/src/org.apache.sis.storage.coveragejson/main/org/apache/sis/storage/coveragejson/CoverageJsonStore.java
@@ -55,7 +55,6 @@ import org.apache.sis.io.stream.IOUtilities;
* @author Johann Sorel (Geomatys)
*/
public class CoverageJsonStore extends DataStore implements WritableAggregate {
-
/**
* The {@link CoverageJsonStoreProvider#LOCATION} parameter value, or
{@code null} if none.
* This is used for information purpose only, not for actual reading
operations.
@@ -115,13 +114,12 @@ public class CoverageJsonStore extends DataStore
implements WritableAggregate {
}
}
}
-
return Collections.unmodifiableList(components);
}
@Override
public synchronized Resource add(Resource resource) throws
DataStoreException {
- //ensure file is parsed
+ // Ensure file is parsed
components();
if (resource instanceof GridCoverageResource) {
@@ -133,13 +131,12 @@ public class CoverageJsonStore extends DataStore
implements WritableAggregate {
save();
return jcr;
}
-
throw new DataStoreException("Only GridCoverage resource are
supported");
}
@Override
public synchronized void remove(Resource resource) throws
DataStoreException {
- //ensure file is parsed
+ // Ensure file is parsed
components();
for (int i = 0, n = components.size(); i < n ;i++) {
@@ -153,7 +150,7 @@ public class CoverageJsonStore extends DataStore implements
WritableAggregate {
}
private synchronized void save() throws DataStoreException {
- //ensure file is parsed
+ // Ensure file is parsed
components();
final int size = components.size();
diff --git
a/incubator/src/org.apache.sis.storage.coveragejson/main/org/apache/sis/storage/coveragejson/CoverageResource.java
b/incubator/src/org.apache.sis.storage.coveragejson/main/org/apache/sis/storage/coveragejson/CoverageResource.java
index db4aeaf0ce..2a66bebd3c 100644
---
a/incubator/src/org.apache.sis.storage.coveragejson/main/org/apache/sis/storage/coveragejson/CoverageResource.java
+++
b/incubator/src/org.apache.sis.storage.coveragejson/main/org/apache/sis/storage/coveragejson/CoverageResource.java
@@ -125,13 +125,13 @@ final class CoverageResource extends
AbstractGridCoverageResource {
this.store = store;
this.binding = binding;
- //rebuild grid geometry
+ // Rebuild grid geometry
try {
gridGeometry = jsonToGridGeometry(binding.domain);
} catch (FactoryException ex) {
throw new DataStoreException("Failed to create GridGeometry from
JSON Domain", ex);
}
- //rebuild sample dimensions
+ // Rebuild sample dimensions
sampleDimensions = new ArrayList<>();
for (Entry<String,Parameter> entry :
binding.parameters.any.entrySet()) {
final SampleDimension sd = jsonToSampleDimension(entry.getKey(),
entry.getValue());
@@ -140,7 +140,7 @@ final class CoverageResource extends
AbstractGridCoverageResource {
if (binding.parameterGroups != null) {
throw new UnsupportedOperationException("Parameter groups not
supported yet.");
}
- //read datas
+ // Read datas
datas = new HashMap<>();
for (Entry<String,NdArray> entry : binding.ranges.any.entrySet()) {
datas.put(entry.getKey(), jsonToDataBuffer(entry.getValue()));
@@ -148,7 +148,7 @@ final class CoverageResource extends
AbstractGridCoverageResource {
}
/**
- * Return the JSON coverage binding.
+ * Returns the JSON coverage binding.
*/
Coverage getBinding() {
return binding;
@@ -166,7 +166,6 @@ final class CoverageResource extends
AbstractGridCoverageResource {
@Override
public GridCoverage read(GridGeometry domain, int... ranges) throws
DataStoreException {
-
final GridGeometry intersection;
if (domain != null) {
try {
@@ -177,7 +176,6 @@ final class CoverageResource extends
AbstractGridCoverageResource {
} else {
intersection = gridGeometry;
}
-
final double[][] rawDatas;
final List<SampleDimension> selected;
if (ranges == null || ranges.length == 0) {
@@ -186,7 +184,6 @@ final class CoverageResource extends
AbstractGridCoverageResource {
for (int i = 0; i < rawDatas.length; i++) {
rawDatas[i] =
datas.get(sampleDimensions.get(i).getName().toString());
}
-
} else {
selected = new ArrayList<>();
rawDatas = new double[ranges.length][0];
@@ -196,19 +193,17 @@ final class CoverageResource extends
AbstractGridCoverageResource {
rawDatas[i] = datas.get(sd.getName().toString());
}
}
-
final DataBuffer buffer = new DataBufferDouble(rawDatas,
rawDatas[0].length);
return new BufferedGridCoverage(intersection, selected, buffer);
}
/**
- * Transform JSON domain to GridGeometry.
+ * Transforms JSON domain to GridGeometry.
*/
private static GridGeometry jsonToGridGeometry(Domain domain) throws
DataStoreException, FactoryException {
-
if (Domain.DOMAINTYPE_GRID.equalsIgnoreCase(domain.domainType)) {
- //build coordinate system
+ // Build coordinate system
final List<ReferenceSystemConnection> referencing =
domain.referencing;
final List<String> axeNames = new ArrayList<>();
final List<CoordinateReferenceSystem> crss = new ArrayList<>();
@@ -225,12 +220,12 @@ final class CoverageResource extends
AbstractGridCoverageResource {
throw new DataStoreException("Coverage domain must be defined,
Coverage as part of CoverageCollection not supported yet.");
}
- //build extent
+ // Build extent
final int dimension = axeNames.size();
final Axes axes = domain.axes;
final GridGeometry[] axeGrids = new GridGeometry[dimension];
- //check if axes declared on crs are ordered in the same way as the
grid extent.
+ // Check if axes declared on crs are ordered in the same way as
the grid extent.
final int[] reorder = new int[dimension];
boolean inOrder = true;
@@ -286,7 +281,6 @@ final class CoverageResource extends
AbstractGridCoverageResource {
}
}
-
if (!inOrder) {
final MatrixSIS m = Matrices.createZero(dimension+1,
dimension+1);
for (int i = 0; i < dimension; i++) {
@@ -297,7 +291,6 @@ final class CoverageResource extends
AbstractGridCoverageResource {
gridToCrs = MathTransforms.concatenate(reorderTrs, gridToCrs);
}
-
final CoordinateReferenceSystem crs =
CRS.compound(crss.toArray(CoordinateReferenceSystem[]::new));
final GridExtent extent = new GridExtent(dnt, lower, upper, true);
return new GridGeometry(extent, PixelInCell.CELL_CENTER,
gridToCrs, crs);
@@ -322,7 +315,7 @@ final class CoverageResource extends
AbstractGridCoverageResource {
throw new DataStoreException("Unexpected axe data type :" +
axe.dataType);
}
- //rebuild axe transform
+ // Rebuild axe transform
final MathTransform1D axeTrs;
final int size;
if (axe.values != null) {
@@ -349,7 +342,7 @@ final class CoverageResource extends
AbstractGridCoverageResource {
}
/**
- * Transform JSON system object to CoordinateReferenceSystem.
+ * Transforms JSON system object to CoordinateReferenceSystem.
*/
private static CoordinateReferenceSystem
jsonToCoordinateReferenceSystem(CoverageJsonObject obj) throws FactoryException
{
if (obj instanceof GeographicCRS) {
@@ -435,10 +428,10 @@ final class CoverageResource extends
AbstractGridCoverageResource {
}
/**
- * Transform JSON NdArray to number array.
+ * Transforms JSON NdArray to number array.
*/
private static double[] jsonToDataBuffer(NdArray array) throws
DataStoreException {
- //TODO more work on checking axes order
+ // TODO: more work on checking axes order
double[] values = new double[array.values.size()];
for (int i = 0; i < values.length; i++) {
values[i] = asDouble(array.values.get(i));
@@ -474,13 +467,12 @@ final class CoverageResource extends
AbstractGridCoverageResource {
* in that reduced precision.
*/
private static Instant parseDataTime(String str) throws DataStoreException
{
-
for (DateTimeFormatter dtf : Arrays.asList(YEAR,YEAR_MONTH,
YEAR_MONTH_DAY, DATE_TIME)) {
try {
TemporalAccessor accesser = dtf.parse(str);
return Instant.from(accesser);
} catch (DateTimeParseException ex) {
- //do nothing
+ // Do nothing
}
}
throw new DataStoreException("Unable to parse date : " + str);
@@ -488,7 +480,6 @@ final class CoverageResource extends
AbstractGridCoverageResource {
static Coverage gridCoverageToBinding(GridCoverage coverage) throws
DataStoreException {
final Coverage binding = new Coverage();
-
try {
//build domain
binding.domain = gridGeometryToJson(coverage.getGridGeometry());
@@ -496,16 +487,16 @@ final class CoverageResource extends
AbstractGridCoverageResource {
throw new DataStoreException(ex.getMessage(), ex);
}
- //build parameters
+ // Build parameters
binding.parameters = new Parameters();
for (SampleDimension sd : coverage.getSampleDimensions()) {
final Entry<String, Parameter> entry = sampleDimensionToJson(sd);
binding.parameters.setAnyProperty(entry.getKey(),
entry.getValue());
}
- //build datas
+ // Build datas
binding.ranges = new Ranges();
- binding.ranges.any.putAll(imageToJson(coverage, new
ArrayList(binding.parameters.any.keySet())));
+ binding.ranges.any.putAll(imageToJson(coverage, new
ArrayList<>(binding.parameters.any.keySet())));
return binding;
}
@@ -543,7 +534,7 @@ final class CoverageResource extends
AbstractGridCoverageResource {
throw new DataStoreException("An axe in the Grid to CRS
transform has no scale value");
}
} else {
- //todo handle cases of compound transforms, would allow us to
handle no linear 1D axes.
+ // TODO: handle cases of compound transforms, would allow us to
handle no linear 1D axes.
throw new DataStoreException("Coveragejson only support linear
grid to CRS transform without rotation or shearing");
}
@@ -648,8 +639,7 @@ final class CoverageResource extends
AbstractGridCoverageResource {
}
}
-
- //TODO convert categories, units,... we might need a database of
observed properties
+ // TODO: convert categories, units,... we might need a database of
observed properties
return new AbstractMap.SimpleImmutableEntry<>(name, binding);
}
diff --git
a/incubator/src/org.apache.sis.storage.coveragejson/main/org/apache/sis/storage/coveragejson/binding/Parameters.java
b/incubator/src/org.apache.sis.storage.coveragejson/main/org/apache/sis/storage/coveragejson/binding/Parameters.java
index 2902592ffe..999b2791db 100644
---
a/incubator/src/org.apache.sis.storage.coveragejson/main/org/apache/sis/storage/coveragejson/binding/Parameters.java
+++
b/incubator/src/org.apache.sis.storage.coveragejson/main/org/apache/sis/storage/coveragejson/binding/Parameters.java
@@ -32,7 +32,7 @@ import
org.apache.sis.storage.coveragejson.binding.Parameters.Serializer;
/**
- * Constains a map of parameter objects.
+ * Contains a map of parameter objects.
*
* @author Johann Sorel (Geomatys)
*/
diff --git
a/incubator/src/org.apache.sis.storage.coveragejson/main/org/apache/sis/storage/coveragejson/package-info.java
b/incubator/src/org.apache.sis.storage.coveragejson/main/org/apache/sis/storage/coveragejson/package-info.java
index 0e10be8250..6447b3548d 100644
---
a/incubator/src/org.apache.sis.storage.coveragejson/main/org/apache/sis/storage/coveragejson/package-info.java
+++
b/incubator/src/org.apache.sis.storage.coveragejson/main/org/apache/sis/storage/coveragejson/package-info.java
@@ -16,7 +16,7 @@
*/
/**
- * Coverage-json store.
+ * CoverageJSON store.
*
* @author Johann Sorel (Geomatys)
*/
