This is an automated email from the ASF dual-hosted git repository. jsorel pushed a commit to branch geoapi-4.0 in repository https://gitbox.apache.org/repos/asf/sis.git
The following commit(s) were added to refs/heads/geoapi-4.0 by this push: new cd05f3d SQL : add javadoc author and version tag on SQL classes cd05f3d is described below commit cd05f3d6e4f9325833f701532fdf239d3b88c484 Author: jsorel <johann.so...@geomatys.com> AuthorDate: Fri Nov 22 12:38:23 2019 +0100 SQL : add javadoc author and version tag on SQL classes --- .../apache/sis/internal/sql/feature/ANSIInterpreter.java | 16 ++++++++-------- .../org/apache/sis/internal/sql/feature/ANSIMapping.java | 5 +++++ .../sis/internal/sql/feature/CRSIdentification.java | 7 +++++++ .../apache/sis/internal/sql/feature/ColumnAdapter.java | 4 ++++ .../org/apache/sis/internal/sql/feature/ColumnRef.java | 5 +++++ .../org/apache/sis/internal/sql/feature/Connector.java | 5 +++++ .../apache/sis/internal/sql/feature/DialectMapping.java | 5 +++++ .../org/apache/sis/internal/sql/feature/EWKBReader.java | 3 +++ .../apache/sis/internal/sql/feature/FeatureAdapter.java | 5 +++++ .../sis/internal/sql/feature/GeometryIdentification.java | 5 +++++ .../org/apache/sis/internal/sql/feature/OGC06104r4.java | 5 +++++ .../sis/internal/sql/feature/PostGISInterpreter.java | 7 +++++++ .../apache/sis/internal/sql/feature/PostGISMapping.java | 5 +++++ .../org/apache/sis/internal/sql/feature/PrimaryKey.java | 5 ++++- .../apache/sis/internal/sql/feature/QueryFeatureSet.java | 5 +++++ .../sis/internal/sql/feature/QuerySpliteratorsBench.java | 7 +++++++ .../apache/sis/internal/sql/feature/SQLBiFunction.java | 4 ++++ .../apache/sis/internal/sql/feature/SQLCloseable.java | 5 +++++ .../org/apache/sis/internal/sql/feature/SQLColumn.java | 5 +++++ .../apache/sis/internal/sql/feature/SQLQueryAdapter.java | 4 ++++ .../sis/internal/sql/feature/SQLTypeSpecification.java | 5 +++++ .../org/apache/sis/internal/sql/feature/StreamSQL.java | 5 +++-- .../org/apache/sis/internal/sql/feature/TableSubset.java | 5 +++++ 23 files changed, 116 insertions(+), 11 deletions(-) diff --git a/storage/sis-sqlstore/src/main/java/org/apache/sis/internal/sql/feature/ANSIInterpreter.java b/storage/sis-sqlstore/src/main/java/org/apache/sis/internal/sql/feature/ANSIInterpreter.java index 20a762f..712c4d3 100644 --- a/storage/sis-sqlstore/src/main/java/org/apache/sis/internal/sql/feature/ANSIInterpreter.java +++ b/storage/sis-sqlstore/src/main/java/org/apache/sis/internal/sql/feature/ANSIInterpreter.java @@ -23,7 +23,11 @@ import java.util.function.BooleanSupplier; import java.util.function.Supplier; import java.util.stream.Collectors; import java.util.stream.IntStream; - +import org.apache.sis.geometry.GeneralEnvelope; +import org.apache.sis.internal.feature.Geometries; +import org.apache.sis.internal.feature.WrapResolution; +import static org.apache.sis.util.ArgumentChecks.ensureNonNull; +import org.apache.sis.util.iso.Names; import org.opengis.filter.*; import org.opengis.filter.expression.Add; import org.opengis.filter.expression.BinaryExpression; @@ -55,13 +59,6 @@ import org.opengis.metadata.extent.GeographicBoundingBox; import org.opengis.util.GenericName; import org.opengis.util.LocalName; -import org.apache.sis.geometry.GeneralEnvelope; -import org.apache.sis.internal.feature.Geometries; -import org.apache.sis.internal.feature.WrapResolution; -import org.apache.sis.util.iso.Names; - -import static org.apache.sis.util.ArgumentChecks.ensureNonNull; - /** * Port of Geotk FilterToSQL for an ANSI compliant query builder. * @@ -74,6 +71,9 @@ import static org.apache.sis.util.ArgumentChecks.ensureNonNull; * filter refering to non pure SQL property (like relations) will cause a failure. * * @author Alexis Manin (Geomatys) + * @version 2.0 + * @since 2.0 + * @module */ public class ANSIInterpreter implements FilterVisitor, ExpressionVisitor { diff --git a/storage/sis-sqlstore/src/main/java/org/apache/sis/internal/sql/feature/ANSIMapping.java b/storage/sis-sqlstore/src/main/java/org/apache/sis/internal/sql/feature/ANSIMapping.java index 0c57fb1..536c5e1 100644 --- a/storage/sis-sqlstore/src/main/java/org/apache/sis/internal/sql/feature/ANSIMapping.java +++ b/storage/sis-sqlstore/src/main/java/org/apache/sis/internal/sql/feature/ANSIMapping.java @@ -32,6 +32,11 @@ import java.util.Optional; /** * Default JDBC mapping type, used as a fallback when no other database-specific mapping can handle value binding. + * + * @author Alexis Manin (Geomatys) + * @version 2.0 + * @since 2.0 + * @module */ class ANSIMapping implements DialectMapping { diff --git a/storage/sis-sqlstore/src/main/java/org/apache/sis/internal/sql/feature/CRSIdentification.java b/storage/sis-sqlstore/src/main/java/org/apache/sis/internal/sql/feature/CRSIdentification.java index 4b5db7b..49e6fda 100644 --- a/storage/sis-sqlstore/src/main/java/org/apache/sis/internal/sql/feature/CRSIdentification.java +++ b/storage/sis-sqlstore/src/main/java/org/apache/sis/internal/sql/feature/CRSIdentification.java @@ -31,6 +31,13 @@ import org.apache.sis.referencing.CRS; import org.apache.sis.util.collection.BackingStoreException; import org.apache.sis.util.collection.Cache; +/** + * + * @author Alexis Manin (Geomatys) + * @version 2.0 + * @since 2.0 + * @module + */ final class CRSIdentification implements SQLCloseable { final PreparedStatement wktFromSrid; diff --git a/storage/sis-sqlstore/src/main/java/org/apache/sis/internal/sql/feature/ColumnAdapter.java b/storage/sis-sqlstore/src/main/java/org/apache/sis/internal/sql/feature/ColumnAdapter.java index eca4fb7..8f2387d 100644 --- a/storage/sis-sqlstore/src/main/java/org/apache/sis/internal/sql/feature/ColumnAdapter.java +++ b/storage/sis-sqlstore/src/main/java/org/apache/sis/internal/sql/feature/ColumnAdapter.java @@ -29,6 +29,10 @@ import static org.apache.sis.util.ArgumentChecks.ensureNonNull; * placed on row of interest, and an index specifying which column defines the cell to read on this line. * * @param <T> Type of object decoded from cell. + * @author Alexis Manin (Geomatys) + * @version 2.0 + * @since 2.0 + * @module */ public interface ColumnAdapter<T> { diff --git a/storage/sis-sqlstore/src/main/java/org/apache/sis/internal/sql/feature/ColumnRef.java b/storage/sis-sqlstore/src/main/java/org/apache/sis/internal/sql/feature/ColumnRef.java index 2b6909d..2d444e0 100644 --- a/storage/sis-sqlstore/src/main/java/org/apache/sis/internal/sql/feature/ColumnRef.java +++ b/storage/sis-sqlstore/src/main/java/org/apache/sis/internal/sql/feature/ColumnRef.java @@ -25,6 +25,11 @@ import static org.apache.sis.util.ArgumentChecks.ensureNonNull; /** * A column reference. Specify name of the column, and optionally an alias to use for public visibility. * By default, column has no alias. To create a column with an alias, use {@code ColumnRef myCol = new ColumnRef("colName).as("myAlias");} + * + * @author Alexis Manin (Geomatys) + * @version 2.0 + * @since 2.0 + * @module */ final class ColumnRef { private final String name; diff --git a/storage/sis-sqlstore/src/main/java/org/apache/sis/internal/sql/feature/Connector.java b/storage/sis-sqlstore/src/main/java/org/apache/sis/internal/sql/feature/Connector.java index 24c5a54..af0f0be 100644 --- a/storage/sis-sqlstore/src/main/java/org/apache/sis/internal/sql/feature/Connector.java +++ b/storage/sis-sqlstore/src/main/java/org/apache/sis/internal/sql/feature/Connector.java @@ -27,6 +27,11 @@ import org.apache.sis.storage.DataStoreException; /** * Simple abstraction to describe a component capable of loading data from an SQL connection. Used for subsetting SQL * related feature sets. + * + * @author Alexis Manin (Geomatys) + * @version 2.0 + * @since 2.0 + * @module */ interface Connector { /** diff --git a/storage/sis-sqlstore/src/main/java/org/apache/sis/internal/sql/feature/DialectMapping.java b/storage/sis-sqlstore/src/main/java/org/apache/sis/internal/sql/feature/DialectMapping.java index 49d3385..04f7e26 100644 --- a/storage/sis-sqlstore/src/main/java/org/apache/sis/internal/sql/feature/DialectMapping.java +++ b/storage/sis-sqlstore/src/main/java/org/apache/sis/internal/sql/feature/DialectMapping.java @@ -33,6 +33,11 @@ import org.apache.sis.setup.GeometryLibrary; * <li>{@link PostGISMapping PostGIS (geographic) specific mapping}</li> * <li>{@link ANSIMapping Default mapping for simple types (text, numbers, temporal, etc.)}</li> * </ul> + * + * @author Alexis Manin (Geomatys) + * @version 2.0 + * @since 2.0 + * @module */ public interface DialectMapping extends SQLCloseable { diff --git a/storage/sis-sqlstore/src/main/java/org/apache/sis/internal/sql/feature/EWKBReader.java b/storage/sis-sqlstore/src/main/java/org/apache/sis/internal/sql/feature/EWKBReader.java index 9cd3e05..6b0e690 100644 --- a/storage/sis-sqlstore/src/main/java/org/apache/sis/internal/sql/feature/EWKBReader.java +++ b/storage/sis-sqlstore/src/main/java/org/apache/sis/internal/sql/feature/EWKBReader.java @@ -45,6 +45,9 @@ import static org.apache.sis.util.ArgumentChecks.ensureNonEmpty; * * @author Johann Sorel (Geomatys) * @author Alexis Manin (Geomatys) + * @version 2.0 + * @since 2.0 + * @module */ class EWKBReader { diff --git a/storage/sis-sqlstore/src/main/java/org/apache/sis/internal/sql/feature/FeatureAdapter.java b/storage/sis-sqlstore/src/main/java/org/apache/sis/internal/sql/feature/FeatureAdapter.java index f09cd33..061e9d2 100644 --- a/storage/sis-sqlstore/src/main/java/org/apache/sis/internal/sql/feature/FeatureAdapter.java +++ b/storage/sis-sqlstore/src/main/java/org/apache/sis/internal/sql/feature/FeatureAdapter.java @@ -38,6 +38,11 @@ import static org.apache.sis.util.ArgumentChecks.ensureNonNull; * * This object has an initialization phase, to prepare it for a specific ResultSet, through {@link #prepare(Connection)} * method. It allows mappers to fetch specific information from the database when needed. + * + * @author Alexis Manin (Geomatys) + * @version 2.0 + * @since 2.0 + * @module */ class FeatureAdapter { diff --git a/storage/sis-sqlstore/src/main/java/org/apache/sis/internal/sql/feature/GeometryIdentification.java b/storage/sis-sqlstore/src/main/java/org/apache/sis/internal/sql/feature/GeometryIdentification.java index e9788dc..16b4003 100644 --- a/storage/sis-sqlstore/src/main/java/org/apache/sis/internal/sql/feature/GeometryIdentification.java +++ b/storage/sis-sqlstore/src/main/java/org/apache/sis/internal/sql/feature/GeometryIdentification.java @@ -39,6 +39,11 @@ import static org.apache.sis.util.ArgumentChecks.ensureNonEmpty; * <a href="https://www.opengeospatial.org/standards/sfs">OGC 06-104r4 (Simple feature access - Part 2: SQL option)</a>). * * @implNote <a href="https://www.jooq.org/doc/3.12/manual/sql-execution/fetching/pojos/#N5EFC1">I miss JOOQ...</a> + * + * @author Alexis Manin (Geomatys) + * @version 2.0 + * @since 2.0 + * @module */ class GeometryIdentification implements SQLCloseable { diff --git a/storage/sis-sqlstore/src/main/java/org/apache/sis/internal/sql/feature/OGC06104r4.java b/storage/sis-sqlstore/src/main/java/org/apache/sis/internal/sql/feature/OGC06104r4.java index c9b1d19..64fb0e1 100644 --- a/storage/sis-sqlstore/src/main/java/org/apache/sis/internal/sql/feature/OGC06104r4.java +++ b/storage/sis-sqlstore/src/main/java/org/apache/sis/internal/sql/feature/OGC06104r4.java @@ -37,6 +37,11 @@ import org.apache.sis.util.collection.Cache; * access on any SQL simple feature compliant database, but the standard does not specify precisely what mode of * representation is the default (WKB or WKT). The aim is to base specific drivers on this class (see {@link PostGISMapping} * for an example). + * + * @author Alexis Manin (Geomatys) + * @version 2.0 + * @since 2.0 + * @module */ final class OGC06104r4 implements DialectMapping { diff --git a/storage/sis-sqlstore/src/main/java/org/apache/sis/internal/sql/feature/PostGISInterpreter.java b/storage/sis-sqlstore/src/main/java/org/apache/sis/internal/sql/feature/PostGISInterpreter.java index b7b59b4..f922a5a 100644 --- a/storage/sis-sqlstore/src/main/java/org/apache/sis/internal/sql/feature/PostGISInterpreter.java +++ b/storage/sis-sqlstore/src/main/java/org/apache/sis/internal/sql/feature/PostGISInterpreter.java @@ -18,6 +18,13 @@ package org.apache.sis.internal.sql.feature; import org.opengis.filter.spatial.BBOX; +/** + * + * @author Alexis Manin (Geomatys) + * @version 2.0 + * @since 2.0 + * @module + */ public class PostGISInterpreter extends ANSIInterpreter { /** diff --git a/storage/sis-sqlstore/src/main/java/org/apache/sis/internal/sql/feature/PostGISMapping.java b/storage/sis-sqlstore/src/main/java/org/apache/sis/internal/sql/feature/PostGISMapping.java index 6927e42..a2dffbf 100644 --- a/storage/sis-sqlstore/src/main/java/org/apache/sis/internal/sql/feature/PostGISMapping.java +++ b/storage/sis-sqlstore/src/main/java/org/apache/sis/internal/sql/feature/PostGISMapping.java @@ -44,6 +44,11 @@ import static org.apache.sis.internal.sql.feature.OGC06104r4.getGeometricClass; * <li><a href="http://postgis.refractions.net/documentation/manual-1.3/ch04.html#id2571020">PostGIS manual, section 4.1.2</a></li> * <li><a href="https://www.ibm.com/support/knowledgecenter/SSGU8G_14.1.0/com.ibm.spatial.doc/ids_spat_285.htm">IBM WKB description</a></li> * </ul> + * + * @author Alexis Manin (Geomatys) + * @version 2.0 + * @since 2.0 + * @module */ public final class PostGISMapping implements DialectMapping { diff --git a/storage/sis-sqlstore/src/main/java/org/apache/sis/internal/sql/feature/PrimaryKey.java b/storage/sis-sqlstore/src/main/java/org/apache/sis/internal/sql/feature/PrimaryKey.java index 057e544..263f540 100644 --- a/storage/sis-sqlstore/src/main/java/org/apache/sis/internal/sql/feature/PrimaryKey.java +++ b/storage/sis-sqlstore/src/main/java/org/apache/sis/internal/sql/feature/PrimaryKey.java @@ -29,7 +29,10 @@ import org.apache.sis.util.ArgumentChecks; * @implNote For now, only list of columns composing the key are returned. However, in the future it would be possible * to add other information, as a value type to describe how to expose primary key value. * - * @author "Alexis Manin (Geomatys)" + * @author Alexis Manin (Geomatys) + * @version 2.0 + * @since 2.0 + * @module */ interface PrimaryKey { diff --git a/storage/sis-sqlstore/src/main/java/org/apache/sis/internal/sql/feature/QueryFeatureSet.java b/storage/sis-sqlstore/src/main/java/org/apache/sis/internal/sql/feature/QueryFeatureSet.java index 83aa9eb..ab08467 100644 --- a/storage/sis-sqlstore/src/main/java/org/apache/sis/internal/sql/feature/QueryFeatureSet.java +++ b/storage/sis-sqlstore/src/main/java/org/apache/sis/internal/sql/feature/QueryFeatureSet.java @@ -53,6 +53,11 @@ import org.apache.sis.util.collection.BackingStoreException; * association). * * TODO: move query analysis in a dedicated class. + * + * @author Alexis Manin (Geomatys) + * @version 2.0 + * @since 2.0 + * @module */ public class QueryFeatureSet extends AbstractFeatureSet { diff --git a/storage/sis-sqlstore/src/main/java/org/apache/sis/internal/sql/feature/QuerySpliteratorsBench.java b/storage/sis-sqlstore/src/main/java/org/apache/sis/internal/sql/feature/QuerySpliteratorsBench.java index c7456ea..7c1e60b 100644 --- a/storage/sis-sqlstore/src/main/java/org/apache/sis/internal/sql/feature/QuerySpliteratorsBench.java +++ b/storage/sis-sqlstore/src/main/java/org/apache/sis/internal/sql/feature/QuerySpliteratorsBench.java @@ -40,6 +40,13 @@ import org.openjdk.jmh.annotations.Warmup; import static org.apache.sis.util.ArgumentChecks.ensureStrictlyPositive; +/** + * + * @author Alexis Manin (Geomatys) + * @version 2.0 + * @since 2.0 + * @module + */ @Fork(value = 2, jvmArgs = {"-server", "-Xmx2g"} ) @Warmup(iterations = 2, time = 4, timeUnit = TimeUnit.SECONDS) @Measurement(iterations = 2, time = 4, timeUnit = TimeUnit.SECONDS) diff --git a/storage/sis-sqlstore/src/main/java/org/apache/sis/internal/sql/feature/SQLBiFunction.java b/storage/sis-sqlstore/src/main/java/org/apache/sis/internal/sql/feature/SQLBiFunction.java index 42ff9f0..da3bdd2 100644 --- a/storage/sis-sqlstore/src/main/java/org/apache/sis/internal/sql/feature/SQLBiFunction.java +++ b/storage/sis-sqlstore/src/main/java/org/apache/sis/internal/sql/feature/SQLBiFunction.java @@ -29,6 +29,10 @@ import static org.apache.sis.util.ArgumentChecks.ensureNonNull; * @param <T> Type of the first arguement of the function. * @param <U> Type of the second argument of the function. * @param <R> Type of the function result. + * @author Alexis Manin (Geomatys) + * @version 2.0 + * @since 2.0 + * @module */ @FunctionalInterface interface SQLBiFunction<T, U, R> { diff --git a/storage/sis-sqlstore/src/main/java/org/apache/sis/internal/sql/feature/SQLCloseable.java b/storage/sis-sqlstore/src/main/java/org/apache/sis/internal/sql/feature/SQLCloseable.java index e09854d..c142d3f 100644 --- a/storage/sis-sqlstore/src/main/java/org/apache/sis/internal/sql/feature/SQLCloseable.java +++ b/storage/sis-sqlstore/src/main/java/org/apache/sis/internal/sql/feature/SQLCloseable.java @@ -20,6 +20,11 @@ import java.sql.SQLException; /** * Specialisation of {@link AutoCloseable standard closeable objects} for SQL related resources. + * + * @author Alexis Manin (Geomatys) + * @version 2.0 + * @since 2.0 + * @module */ interface SQLCloseable extends AutoCloseable { @Override diff --git a/storage/sis-sqlstore/src/main/java/org/apache/sis/internal/sql/feature/SQLColumn.java b/storage/sis-sqlstore/src/main/java/org/apache/sis/internal/sql/feature/SQLColumn.java index cb0d5a5..ca78992 100644 --- a/storage/sis-sqlstore/src/main/java/org/apache/sis/internal/sql/feature/SQLColumn.java +++ b/storage/sis-sqlstore/src/main/java/org/apache/sis/internal/sql/feature/SQLColumn.java @@ -28,6 +28,11 @@ import org.apache.sis.internal.metadata.sql.Reflection; * Note that for now, only a few selected information are represented. If needed, new fields could be added if needed. * The aim is to describe as well as possible all SQL related information about a column, to allow mapping to feature * model as accurate as possible. + * + * @author Alexis Manin (Geomatys) + * @version 2.0 + * @since 2.0 + * @module */ class SQLColumn { diff --git a/storage/sis-sqlstore/src/main/java/org/apache/sis/internal/sql/feature/SQLQueryAdapter.java b/storage/sis-sqlstore/src/main/java/org/apache/sis/internal/sql/feature/SQLQueryAdapter.java index 688a9cc..19c5339 100644 --- a/storage/sis-sqlstore/src/main/java/org/apache/sis/internal/sql/feature/SQLQueryAdapter.java +++ b/storage/sis-sqlstore/src/main/java/org/apache/sis/internal/sql/feature/SQLQueryAdapter.java @@ -31,6 +31,10 @@ import org.apache.sis.storage.FeatureSet; /** * + * @author Alexis Manin (Geomatys) + * @version 2.0 + * @since 2.0 + * @module */ abstract class SQLQueryAdapter implements SubsetAdapter.AdapterBuilder { diff --git a/storage/sis-sqlstore/src/main/java/org/apache/sis/internal/sql/feature/SQLTypeSpecification.java b/storage/sis-sqlstore/src/main/java/org/apache/sis/internal/sql/feature/SQLTypeSpecification.java index d8fc8da..a5d6b2d 100644 --- a/storage/sis-sqlstore/src/main/java/org/apache/sis/internal/sql/feature/SQLTypeSpecification.java +++ b/storage/sis-sqlstore/src/main/java/org/apache/sis/internal/sql/feature/SQLTypeSpecification.java @@ -33,6 +33,11 @@ import org.apache.sis.storage.DataStoreContentException; * {@link Analyzer} to create an {@link FeatureAdapter adaptation layer to the feature model}. Default implementations * can be retrieved for tables and queries respectively through {@link Analyzer#create(TableReference, TableReference)} * and {@link Analyzer#create(PreparedStatement, String, GenericName)} methods. + * + * @author Alexis Manin (Geomatys) + * @version 2.0 + * @since 2.0 + * @module */ interface SQLTypeSpecification { /** diff --git a/storage/sis-sqlstore/src/main/java/org/apache/sis/internal/sql/feature/StreamSQL.java b/storage/sis-sqlstore/src/main/java/org/apache/sis/internal/sql/feature/StreamSQL.java index ff72c02..ee24fa7 100644 --- a/storage/sis-sqlstore/src/main/java/org/apache/sis/internal/sql/feature/StreamSQL.java +++ b/storage/sis-sqlstore/src/main/java/org/apache/sis/internal/sql/feature/StreamSQL.java @@ -60,9 +60,10 @@ import static org.apache.sis.util.ArgumentChecks.ensurePositive; * {@link #filter(Predicate)} or {@link #flatMap(Function)} operations are called, as they modify volumetry (the count * of stream elements is not bound 1 to 1 to query result rows). * - * @since 1.0 - * * @author Alexis Manin (Geomatys) + * @version 2.0 + * @since 1.0 + * @module * */ class StreamSQL extends StreamDecoration<Feature> { diff --git a/storage/sis-sqlstore/src/main/java/org/apache/sis/internal/sql/feature/TableSubset.java b/storage/sis-sqlstore/src/main/java/org/apache/sis/internal/sql/feature/TableSubset.java index d202b21..a795761 100644 --- a/storage/sis-sqlstore/src/main/java/org/apache/sis/internal/sql/feature/TableSubset.java +++ b/storage/sis-sqlstore/src/main/java/org/apache/sis/internal/sql/feature/TableSubset.java @@ -35,6 +35,11 @@ import org.apache.sis.storage.event.StoreListener; /** * A {@link Table} feature set on which a query has been applied. * TODO: Override {@link #subset(Query)} method to allow stacking of SQL filter and sorting. + * + * @author Alexis Manin (Geomatys) + * @version 2.0 + * @since 2.0 + * @module */ public class TableSubset implements FeatureSet {