Revision: 6664
http://sourceforge.net/p/jump-pilot/code/6664
Author: michaudm
Date: 2020-12-28 19:49:02 +0000 (Mon, 28 Dec 2020)
Log Message:
-----------
Fix javadoc and improve pre-java5 code
Modified Paths:
--------------
core/trunk/src/com/vividsolutions/jump/I18N.java
core/trunk/src/com/vividsolutions/jump/algorithm/Densifier.java
core/trunk/src/com/vividsolutions/jump/algorithm/LengthSubstring.java
core/trunk/src/com/vividsolutions/jump/coordsys/CoordinateSystem.java
core/trunk/src/com/vividsolutions/jump/datastore/DataStoreConnection.java
core/trunk/src/com/vividsolutions/jump/datastore/DataStoreLayer.java
core/trunk/src/com/vividsolutions/jump/datastore/DataStoreMetadata.java
core/trunk/src/com/vividsolutions/jump/datastore/SQLUtil.java
core/trunk/src/com/vividsolutions/jump/datastore/h2/H2FeatureInputStream.java
core/trunk/src/com/vividsolutions/jump/datastore/mariadb/MariadbDSConnection.java
core/trunk/src/com/vividsolutions/jump/datastore/mariadb/MariadbDataStoreDriver.java
core/trunk/src/com/vividsolutions/jump/datastore/mariadb/MariadbFeatureInputStream.java
core/trunk/src/com/vividsolutions/jump/datastore/mariadb/MariadbSQLBuilder.java
core/trunk/src/com/vividsolutions/jump/datastore/spatialdatabases/AbstractSpatialDatabasesDSDriver.java
core/trunk/src/com/vividsolutions/jump/datastore/spatialdatabases/AbstractSpatialDatabasesDSExtension.java
core/trunk/src/com/vividsolutions/jump/datastore/spatialdatabases/SpatialDatabasesDSConnection.java
core/trunk/src/com/vividsolutions/jump/datastore/spatialdatabases/SpatialDatabasesDSMetadata.java
core/trunk/src/com/vividsolutions/jump/datastore/spatialdatabases/SpatialDatabasesFeatureInputStream.java
core/trunk/src/com/vividsolutions/jump/datastore/spatialdatabases/SpatialDatabasesValueConverterFactory.java
core/trunk/src/com/vividsolutions/jump/geom/AbstractGeometryProcessor.java
core/trunk/src/com/vividsolutions/jump/geom/Angle.java
core/trunk/src/com/vividsolutions/jump/geom/CoordUtil.java
core/trunk/src/com/vividsolutions/jump/geom/MakeValidOp.java
core/trunk/src/com/vividsolutions/jump/io/FMEGMLReader.java
core/trunk/src/com/vividsolutions/jump/io/FMEGMLWriter.java
core/trunk/src/com/vividsolutions/jump/io/GMLOutputTemplate.java
core/trunk/src/com/vividsolutions/jump/io/GMLReader.java
core/trunk/src/com/vividsolutions/jump/io/GMLWriter.java
core/trunk/src/com/vividsolutions/jump/io/JMLReader.java
core/trunk/src/com/vividsolutions/jump/io/JMLWriter.java
core/trunk/src/com/vividsolutions/jump/io/ShapefileReader.java
core/trunk/src/com/vividsolutions/jump/io/ShapefileWriter.java
core/trunk/src/com/vividsolutions/jump/io/WKTReader.java
core/trunk/src/com/vividsolutions/jump/io/WKTWriter.java
core/trunk/src/com/vividsolutions/jump/io/datasource/DataSource.java
core/trunk/src/com/vividsolutions/jump/io/datasource/DataSourceQuery.java
core/trunk/src/com/vividsolutions/jump/io/datasource/DelegatingCompressedFileHandler.java
core/trunk/src/com/vividsolutions/jump/package.html
core/trunk/src/com/vividsolutions/jump/plugin/edit/Features2SegmentStringsWithData.java
core/trunk/src/com/vividsolutions/jump/plugin/edit/NoderPlugIn.java
core/trunk/src/com/vividsolutions/jump/plugin/edit/SegmentStringsWithData2Features.java
core/trunk/src/com/vividsolutions/jump/util/CollectionUtil.java
core/trunk/src/com/vividsolutions/jump/workbench/imagery/geotiff/RasterPainter.java
core/trunk/src/com/vividsolutions/jump/workbench/model/MeasureLayerFinder.java
core/trunk/src/com/vividsolutions/jump/workbench/plugin/AbstractPlugIn.java
core/trunk/src/com/vividsolutions/jump/workbench/plugin/PlugIn.java
core/trunk/src/com/vividsolutions/jump/workbench/plugin/ShortcutEnabled.java
core/trunk/src/com/vividsolutions/jump/workbench/plugin/ThreadedPlugIn.java
core/trunk/src/com/vividsolutions/jump/workbench/ui/AbstractDriverPanel.java
core/trunk/src/com/vividsolutions/jump/workbench/ui/EditTransaction.java
core/trunk/src/com/vividsolutions/jump/workbench/ui/FontChooser.java
core/trunk/src/com/vividsolutions/jump/workbench/ui/GenericNames.java
core/trunk/src/com/vividsolutions/jump/workbench/ui/LayerPrinter.java
core/trunk/src/com/vividsolutions/jump/workbench/ui/MenuNames.java
core/trunk/src/com/vividsolutions/jump/workbench/ui/OptionsPanelV2.java
core/trunk/src/com/vividsolutions/jump/workbench/ui/RecursiveListener.java
core/trunk/src/com/vividsolutions/jump/workbench/ui/TextEditor.java
core/trunk/src/com/vividsolutions/jump/workbench/ui/addremove/AddRemoveList.java
core/trunk/src/com/vividsolutions/jump/workbench/ui/cursortool/AbstractCursorTool.java
core/trunk/src/com/vividsolutions/jump/workbench/ui/cursortool/Animations.java
core/trunk/src/com/vividsolutions/jump/workbench/ui/cursortool/CoordinateListMetrics.java
core/trunk/src/com/vividsolutions/jump/workbench/ui/cursortool/CursorToolPluginWrapper.java
core/trunk/src/com/vividsolutions/jump/workbench/ui/cursortool/DragTool.java
core/trunk/src/com/vividsolutions/jump/workbench/ui/cursortool/MultiClickTool.java
core/trunk/src/com/vividsolutions/jump/workbench/ui/cursortool/PolygonTool.java
core/trunk/src/com/vividsolutions/jump/workbench/ui/cursortool/SpecifyFeaturesTool.java
core/trunk/src/com/vividsolutions/jump/workbench/ui/plugin/datastore/AddDatastoreLayerPlugIn.java
core/trunk/src/com/vividsolutions/jump/workbench/ui/plugin/imagery/ImageryUtils.java
core/trunk/src/com/vividsolutions/jump/workbench/ui/renderer/style/ChoosableStyle.java
core/trunk/src/com/vividsolutions/jump/workbench/ui/renderer/style/LineStringStyle.java
core/trunk/src/com/vividsolutions/jump/workbench/ui/renderer/style/Style.java
core/trunk/src/com/vividsolutions/jump/workbench/ui/toolbox/ToolboxPlugInV2.java
core/trunk/src/com/vividsolutions/jump/workbench/ui/warp/AffineTransformPlugIn.java
core/trunk/src/com/vividsolutions/jump/workbench/ui/warp/ProjectiveTransformPlugIn.java
core/trunk/src/com/vividsolutions/jump/workbench/ui/wizard/WizardPanel.java
core/trunk/src/com/vividsolutions/jump/workbench/ui/wizard/WizardPanelV2.java
core/trunk/src/de/fho/jump/pirol/plugins/EditAttributeByFormula/AddFormulaPartToTextArea_Action.java
core/trunk/src/de/fho/jump/pirol/plugins/EditAttributeByFormula/AddTextFieldTextToTextAreaOnClick_Action.java
core/trunk/src/de/fho/jump/pirol/plugins/EditAttributeByFormula/EditAttributeByFormulaDialog.java
core/trunk/src/de/fho/jump/pirol/utilities/FormulaParsing/FormulaParser.java
core/trunk/src/de/hawhamburg/sridsupport/SRIDStyle.java
core/trunk/src/de/latlon/deejump/wfs/data/JUMPFeatureFactory.java
core/trunk/src/de/latlon/deejump/wfs/jump/WFSLayer.java
core/trunk/src/de/soldin/jumpcore/geomconv/GCPlugin.java
core/trunk/src/net/iharder/Base64.java
core/trunk/src/org/deegree/model/spatialschema/GMLGeometryAdapter.java
core/trunk/src/org/deegree/model/spatialschema/JTSAdapter.java
core/trunk/src/org/geotiff/epsg/GeographicCS.java
core/trunk/src/org/geotiff/epsg/HorizontalCS.java
core/trunk/src/org/geotiff/epsg/ProjectedCS.java
core/trunk/src/org/openjump/core/apitools/comparisonandsorting/CoordinateComparator.java
core/trunk/src/org/openjump/core/apitools/comparisonandsorting/ObjectComparator.java
core/trunk/src/org/openjump/core/attributeoperations/Classifier1D.java
core/trunk/src/org/openjump/core/attributeoperations/JoinAttributes.java
core/trunk/src/org/openjump/core/attributeoperations/SpatialRelationOp.java
core/trunk/src/org/openjump/core/ccordsys/Unit.java
core/trunk/src/org/openjump/core/geomutils/algorithm/GeometryConverter.java
core/trunk/src/org/openjump/core/geomutils/algorithm/IntersectGeometries.java
core/trunk/src/org/openjump/core/rasterimage/sextante/ISextanteDataObject.java
core/trunk/src/org/openjump/core/rasterimage/sextante/ISextanteRasterLayer.java
core/trunk/src/org/openjump/core/rasterimage/styler/SLDHandler.java
core/trunk/src/org/openjump/core/rasterimage/styler/StylePlugger.java
core/trunk/src/org/openjump/core/rasterimage/styler/ui/ColorsTablePanel.java
core/trunk/src/org/openjump/core/ui/DatasetOptionsPanel.java
core/trunk/src/org/openjump/core/ui/SelectionStyllingOptionsPanel.java
core/trunk/src/org/openjump/core/ui/plugin/customize/CmdRunner.java
core/trunk/src/org/openjump/core/ui/plugin/datastore/EditDataStoreQueryPlugIn.java
core/trunk/src/org/openjump/core/ui/plugin/datastore/RefreshDataStoreQueryPlugIn.java
core/trunk/src/org/openjump/core/ui/plugin/datastore/SaveToDataStoreDataSourceQuery.java
core/trunk/src/org/openjump/core/ui/plugin/datastore/WritableDataStoreDataSource.java
core/trunk/src/org/openjump/core/ui/plugin/edittoolbox/cursortools/CutPolygonTool.java
core/trunk/src/org/openjump/core/ui/plugin/layer/pirolraster/ChangeRasterImagePropertiesPlugIn.java
core/trunk/src/org/openjump/core/ui/plugin/layer/pirolraster/LoadSextanteRasterImagePlugIn.java
core/trunk/src/org/openjump/core/ui/plugin/raster/RasterImageLayerProperties.java
core/trunk/src/org/openjump/core/ui/plugin/style/SaveStylePlugIn.java
core/trunk/src/org/openjump/core/ui/plugin/tools/AdvancedMeasureOptionsPanel.java
core/trunk/src/org/openjump/core/ui/plugin/tools/AdvancedMeasurePlugin.java
core/trunk/src/org/openjump/core/ui/plugin/tools/AdvancedMeasureTool.java
core/trunk/src/org/openjump/core/ui/plugin/tools/MeasurementStyle.java
core/trunk/src/org/openjump/core/ui/plugin/tools/SimplifyWithJTSAlgorithmPlugIn.java
core/trunk/src/org/openjump/core/ui/plugin/tools/SpatialJoinPlugIn.java
core/trunk/src/org/openjump/core/ui/plugin/view/InstallKeyPanPlugIn.java
core/trunk/src/org/openjump/core/ui/plugin/view/SuperZoomPanTool.java
core/trunk/src/org/openjump/core/ui/plugin/wms/WMSStylePlugIn.java
core/trunk/src/org/openjump/core/ui/style/decoration/TextBasedVertexStyle.java
core/trunk/src/org/openjump/core/ui/swing/DetachableInternalFrame.java
core/trunk/src/org/openjump/core/ui/swing/VertexStylePanel.java
core/trunk/src/org/openjump/core/ui/util/FeatureSchemaUtils.java
core/trunk/src/org/openjump/core/ui/util/GeometryUtils.java
core/trunk/src/org/openjump/core/ui/util/LayerableUtil.java
core/trunk/src/org/openjump/swing/factory/component/ComponentFactory.java
core/trunk/src/org/saig/core/crypt/BlowFishManager.java
core/trunk/src/org/saig/core/crypt/CryptManager.java
core/trunk/src/org/saig/core/crypt/CryptManagerException.java
core/trunk/src/org/saig/core/crypt/CryptManagerFactory.java
core/trunk/src/org/saig/core/util/SwingWorker.java
core/trunk/src/org/saig/jump/widgets/config/HTTPProxySettings.java
core/trunk/src/org/saig/jump/widgets/config/ProxyAuth.java
core/trunk/src/org/saig/jump/widgets/util/AbstractWaitDialog.java
Modified: core/trunk/src/com/vividsolutions/jump/I18N.java
===================================================================
--- core/trunk/src/com/vividsolutions/jump/I18N.java 2020-12-28 19:39:42 UTC
(rev 6663)
+++ core/trunk/src/com/vividsolutions/jump/I18N.java 2020-12-28 19:49:02 UTC
(rev 6664)
@@ -255,7 +255,8 @@
*
* use static I18N.getMessage() methods instead
*
- * @param categoryPrefix
+ * @param categoryPrefix the category
+ * @return I18N object for this category
*/
public static I18N getInstance(final String categoryPrefix) {
return getInstance((Object) categoryPrefix);
@@ -268,6 +269,7 @@
* use static I18N.getMessage() methods instead
*
* @param path path of the ResourceBundle
+ * @return I18N object for the ResourceBundle located at path
*/
public static I18N getInstance(final File path) {
return getInstance((Object) path);
@@ -278,6 +280,7 @@
* knows what is using this code anyway.
*
* use static I18N.getMessage() methods instead
+ * @return singleton I18N object for OpenJUMP
*/
public static I18N getInstance() {
// is initialized statically above
@@ -287,7 +290,7 @@
/**
* [ede] utility method which is used in several places
* (loadFile,getLanguage...)
- *
+ * @param localeCode a locale code String
* @return a Locale from the localeCode
*/
public static Locale fromCode(final String localeCode) {
@@ -315,7 +318,7 @@
* and country, and if only lang is specified, loads the corresponding
* resource bundle.
*
- * @param langcountry
+ * @param langcountry the code for the lang and country locale to set
*/
public static void setLocale(final String langcountry) {
Locale loc = fromCode(langcountry);
@@ -335,7 +338,7 @@
}
/**
- * Process text with the locale 'jump_<locale>.properties' file
+ * Process text with the locale 'jump_<locale>.properties' file
*
* @param label the key to look for.
* @return i18n label [Michael Michaud 2007-03-23] If no resourcebundle is
Modified: core/trunk/src/com/vividsolutions/jump/algorithm/Densifier.java
===================================================================
--- core/trunk/src/com/vividsolutions/jump/algorithm/Densifier.java
2020-12-28 19:39:42 UTC (rev 6663)
+++ core/trunk/src/com/vividsolutions/jump/algorithm/Densifier.java
2020-12-28 19:49:02 UTC (rev 6664)
@@ -74,6 +74,7 @@
*
* @param geom the geometry to densify
* @param maxLength the maximum length between two vertices
+ * @return a new, densified Geometry
*/
public static Geometry densify(Geometry geom, double maxLength) {
Densifier densifier = new Densifier(geom, maxLength);
Modified: core/trunk/src/com/vividsolutions/jump/algorithm/LengthSubstring.java
===================================================================
--- core/trunk/src/com/vividsolutions/jump/algorithm/LengthSubstring.java
2020-12-28 19:39:42 UTC (rev 6663)
+++ core/trunk/src/com/vividsolutions/jump/algorithm/LengthSubstring.java
2020-12-28 19:49:02 UTC (rev 6664)
@@ -14,7 +14,7 @@
* an inverted section of the line is returned
* </ul>
* <p>
- * FUTURE: should handle startLength > endLength, and flip the returned
+ * FUTURE: should handle startLength > endLength, and flip the returned
* linestring. Also should handle negative lengths (they are measured from end
* of line backwards).
*/
Modified: core/trunk/src/com/vividsolutions/jump/coordsys/CoordinateSystem.java
===================================================================
--- core/trunk/src/com/vividsolutions/jump/coordsys/CoordinateSystem.java
2020-12-28 19:39:42 UTC (rev 6663)
+++ core/trunk/src/com/vividsolutions/jump/coordsys/CoordinateSystem.java
2020-12-28 19:49:02 UTC (rev 6664)
@@ -79,6 +79,7 @@
/**
* @deprecated reprojection will be implemented differently at a later
point
+ * @return the Projection
*/
@Deprecated
public Projection getProjection() {
Modified:
core/trunk/src/com/vividsolutions/jump/datastore/DataStoreConnection.java
===================================================================
--- core/trunk/src/com/vividsolutions/jump/datastore/DataStoreConnection.java
2020-12-28 19:39:42 UTC (rev 6663)
+++ core/trunk/src/com/vividsolutions/jump/datastore/DataStoreConnection.java
2020-12-28 19:49:02 UTC (rev 6664)
@@ -11,16 +11,21 @@
public interface DataStoreConnection {
/**
* retrieve metadata describing the database's datasets (column names etc.)
+ * @return the DataStoreMetadata
*/
DataStoreMetadata getMetadata();
/**
* expose underlying JDBC connection
+ * @return the Connection
*/
Connection getJdbcConnection();
/**
* expose sqlbuilder
+ * @param srid the SpatialReferenceSystemID
+ * @param colNames array of columns to query
+ * @return the SpatialDatabasesSQLBuilder
*/
SpatialDatabasesSQLBuilder getSqlBuilder(SpatialReferenceSystemID srid,
String[] colNames);
@@ -27,8 +32,11 @@
/**
* run a query
- *
- * @see {@link Query}
+ *
+ * @param query the query to execute
+ * @return a FeatureInputStream
+ * @see Query
+ * @throws Exception if an Exception occurs during query execution
*/
FeatureInputStream execute(Query query) throws Exception;
Modified: core/trunk/src/com/vividsolutions/jump/datastore/DataStoreLayer.java
===================================================================
--- core/trunk/src/com/vividsolutions/jump/datastore/DataStoreLayer.java
2020-12-28 19:39:42 UTC (rev 6663)
+++ core/trunk/src/com/vividsolutions/jump/datastore/DataStoreLayer.java
2020-12-28 19:49:02 UTC (rev 6664)
@@ -65,6 +65,7 @@
/**
* Returns the where clause with WHERE keyword removed
+ * @return the where clause String without the "where" keyword
*/
public String getWhereClause() {
return where.trim().toLowerCase().startsWith("where")
Modified:
core/trunk/src/com/vividsolutions/jump/datastore/DataStoreMetadata.java
===================================================================
--- core/trunk/src/com/vividsolutions/jump/datastore/DataStoreMetadata.java
2020-12-28 19:39:42 UTC (rev 6663)
+++ core/trunk/src/com/vividsolutions/jump/datastore/DataStoreMetadata.java
2020-12-28 19:49:02 UTC (rev 6664)
@@ -12,6 +12,7 @@
/**
* list all tables
+ * @return an array of dataset names for this DataStore
*/
String[] getDatasetNames();
@@ -23,6 +24,8 @@
*
* @param datasetName
* the table name (optionally prefixed by a schema name)
+ * @return the list of columns to be used as a PrimaryKey
+ * @throws SQLException if the server throws an Exception during Primary Key
retrieval
*/
List<PrimaryKeyColumn> getPrimaryKeyColumns(String datasetName)
throws SQLException;
@@ -37,7 +40,12 @@
Envelope getExtents(String datasetName, String attributeName);
/**
- * get the SRID of a table's (geometry) column
+ * Get the SRID of a table's (geometry) column
+ *
+ * @param datasetName the dataset name
+ * @param colName the column name
+ * @return the SpatialReferenceSystemID for this column
+ * @throws SQLException if the server throws an Exception during SRID
retrieval
*/
SpatialReferenceSystemID getSRID(String datasetName, String colName)
throws SQLException;
@@ -44,11 +52,14 @@
/**
* list columns of a table
+ * @param datasetName name of the table or dataset
+ * @return the names of this dataset columns
*/
String[] getColumnNames(String datasetName);
/**
* DataSoreConnection used by these metadata
+ * @return a DataStoreConnection
*/
DataStoreConnection getDataStoreConnection();
}
\ No newline at end of file
Modified: core/trunk/src/com/vividsolutions/jump/datastore/SQLUtil.java
===================================================================
--- core/trunk/src/com/vividsolutions/jump/datastore/SQLUtil.java
2020-12-28 19:39:42 UTC (rev 6663)
+++ core/trunk/src/com/vividsolutions/jump/datastore/SQLUtil.java
2020-12-28 19:49:02 UTC (rev 6664)
@@ -23,10 +23,10 @@
* name), the returned array contains a null element at index 0<br>
* Examples :<br>
* <ul>
- * <li>myschema.mytable -> [myschema, mytable]</li>
- * <li>"MySchema"."MyTable" -> [MySchema, MyTable]</li>
- * <li>MyTable -> [null, MyTable]</li>
- * <li>2_table -> [null, 2_table]</li>
+ * <li>myschema.mytable -> [myschema, mytable]</li>
+ * <li>"MySchema"."MyTable" -> [MySchema, MyTable]</li>
+ * <li>MyTable -> [null, MyTable]</li>
+ * <li>2_table -> [null, 2_table]</li>
* </ul>
*/
public static String[] splitTableName(String fullName) {
Modified:
core/trunk/src/com/vividsolutions/jump/datastore/h2/H2FeatureInputStream.java
===================================================================
---
core/trunk/src/com/vividsolutions/jump/datastore/h2/H2FeatureInputStream.java
2020-12-28 19:39:42 UTC (rev 6663)
+++
core/trunk/src/com/vividsolutions/jump/datastore/h2/H2FeatureInputStream.java
2020-12-28 19:49:02 UTC (rev 6664)
@@ -26,8 +26,8 @@
/**
* Returns a H2ResultSetConverter
- * @param rs
- * @return
+ * @param rs a ResultSet
+ * @return the SpatialDatabasesResultSetConverter to be used
*/
@Override
protected SpatialDatabasesResultSetConverter
getResultSetConverter(ResultSet rs) {
Modified:
core/trunk/src/com/vividsolutions/jump/datastore/mariadb/MariadbDSConnection.java
===================================================================
---
core/trunk/src/com/vividsolutions/jump/datastore/mariadb/MariadbDSConnection.java
2020-12-28 19:39:42 UTC (rev 6663)
+++
core/trunk/src/com/vividsolutions/jump/datastore/mariadb/MariadbDSConnection.java
2020-12-28 19:49:02 UTC (rev 6664)
@@ -35,7 +35,7 @@
*
* @param query the query to execute
* @return the results of the query
- * @throws SQLException
+ * @throws SQLException if an Exception occurs during query execution
*/
@Override
public FeatureInputStream executeFilterQuery(FilterQuery query) throws
SQLException {
@@ -57,7 +57,7 @@
*
* @param query the query to execute
* @return the results of the query
- * @throws SQLException
+ * @throws SQLException if an Exception occurs during query execution
*/
@Override
public FeatureInputStream executeAdhocQuery(AdhocQuery query) throws
Exception {
Modified:
core/trunk/src/com/vividsolutions/jump/datastore/mariadb/MariadbDataStoreDriver.java
===================================================================
---
core/trunk/src/com/vividsolutions/jump/datastore/mariadb/MariadbDataStoreDriver.java
2020-12-28 19:39:42 UTC (rev 6663)
+++
core/trunk/src/com/vividsolutions/jump/datastore/mariadb/MariadbDataStoreDriver.java
2020-12-28 19:49:02 UTC (rev 6664)
@@ -23,9 +23,9 @@
/**
* returns the right type of DataStoreConnection
- * @param params
- * @return
- * @throws Exception
+ * @param params list of parameters to connect to a MariadbDataStore
+ * @return a Connection to a MariadbDataStore
+ * @throws Exception if an exception occurs while building the connection
*/
@Override
public DataStoreConnection createConnection(ParameterList params)
Modified:
core/trunk/src/com/vividsolutions/jump/datastore/mariadb/MariadbFeatureInputStream.java
===================================================================
---
core/trunk/src/com/vividsolutions/jump/datastore/mariadb/MariadbFeatureInputStream.java
2020-12-28 19:39:42 UTC (rev 6663)
+++
core/trunk/src/com/vividsolutions/jump/datastore/mariadb/MariadbFeatureInputStream.java
2020-12-28 19:49:02 UTC (rev 6664)
@@ -20,8 +20,8 @@
/**
* Returns a MariadbResultSetConverter
- * @param rs
- * @return
+ * @param rs a ResultSet
+ * @return the SpatialDatabasesResultSetConverter to convert the ResultSet
*/
@Override
protected SpatialDatabasesResultSetConverter
getResultSetConverter(ResultSet rs) {
Modified:
core/trunk/src/com/vividsolutions/jump/datastore/mariadb/MariadbSQLBuilder.java
===================================================================
---
core/trunk/src/com/vividsolutions/jump/datastore/mariadb/MariadbSQLBuilder.java
2020-12-28 19:39:42 UTC (rev 6663)
+++
core/trunk/src/com/vividsolutions/jump/datastore/mariadb/MariadbSQLBuilder.java
2020-12-28 19:49:02 UTC (rev 6664)
@@ -20,8 +20,8 @@
/**
* Builds a valid SQL spatial query with the given spatial filter.
- * @param query
- * @return a SQL query to get column names
+ * @param query a spatial filter
+ * @return the SQL query string for this spatial filter
*/
@Override
public String getSQL(FilterQuery query) {
@@ -48,7 +48,8 @@
/**
* Returns the query allowing to test a DataStoreLayer: builds a query with
where
* clause and limit 0 to check where clause.
- * @return
+ * @param dsLayer a DataStoreLayer
+ * @return a SQL String querying dsLayer with an optional where clause and a
limit of 0
*/
@Override
public String getCheckSQL(DataStoreLayer dsLayer) {
@@ -68,8 +69,8 @@
/**
* Returns the string representing a SQL column definition.
* Implementors should take care of column names (case, quotes)
- * @param colNames
- * @param geomColName
+ * @param colNames array of column names
+ * @param geomColName geometry column name
* @return column list
*/
@Override
Modified:
core/trunk/src/com/vividsolutions/jump/datastore/spatialdatabases/AbstractSpatialDatabasesDSDriver.java
===================================================================
---
core/trunk/src/com/vividsolutions/jump/datastore/spatialdatabases/AbstractSpatialDatabasesDSDriver.java
2020-12-28 19:39:42 UTC (rev 6663)
+++
core/trunk/src/com/vividsolutions/jump/datastore/spatialdatabases/AbstractSpatialDatabasesDSDriver.java
2020-12-28 19:49:02 UTC (rev 6664)
@@ -127,8 +127,8 @@
* overwrite this method if you have some fancy url scheme and
* createJdbcConnection() will use that instead of the default implementation
*
- * @param params
- * @return
+ * @param params list of parameters to create a JDBC URL
+ * @return an URL String from given parameters
*/
protected String createJdbcUrl(ParameterList params) {
String url;
@@ -150,9 +150,9 @@
* convenience wrapper for the
* {@link #createJdbcConnection(ParameterList, Properties)} below
*
- * @param params
- * @return
- * @throws Exception
+ * @param params list of parameters to create a Connection to a Spatial
Database
+ * @return a Connection from the given parameters
+ * @throws Exception if an exception occurs during connection creation
*/
protected Connection createJdbcConnection(ParameterList params)
throws Exception {
@@ -161,6 +161,10 @@
/**
* use this method in your implementation to create the actual JDBC
connection
+ * @param params list of parameters to create a Connection to a Spatial
Database
+ * @param connProps properties to create the connection
+ * @return a Connection from the list of parameters and the database
properties
+ * @throws Exception if an exception occurs during connection creation
*/
protected Connection createJdbcConnection(ParameterList params,
Properties connProps) throws Exception {
Modified:
core/trunk/src/com/vividsolutions/jump/datastore/spatialdatabases/AbstractSpatialDatabasesDSExtension.java
===================================================================
---
core/trunk/src/com/vividsolutions/jump/datastore/spatialdatabases/AbstractSpatialDatabasesDSExtension.java
2020-12-28 19:39:42 UTC (rev 6663)
+++
core/trunk/src/com/vividsolutions/jump/datastore/spatialdatabases/AbstractSpatialDatabasesDSExtension.java
2020-12-28 19:49:02 UTC (rev 6664)
@@ -77,9 +77,9 @@
/**
* implement to assign a readable name to the datastore driver extension
- *
- * @Override
+ * @return the name of this SpatialDatabase
*/
+ @Override
abstract public String getName();
/**
Modified:
core/trunk/src/com/vividsolutions/jump/datastore/spatialdatabases/SpatialDatabasesDSConnection.java
===================================================================
---
core/trunk/src/com/vividsolutions/jump/datastore/spatialdatabases/SpatialDatabasesDSConnection.java
2020-12-28 19:39:42 UTC (rev 6663)
+++
core/trunk/src/com/vividsolutions/jump/datastore/spatialdatabases/SpatialDatabasesDSConnection.java
2020-12-28 19:49:02 UTC (rev 6664)
@@ -67,7 +67,7 @@
*
* @param query the query to execute
* @return the results of the query
- * @throws SQLException
+ * @throws SQLException if an Exception occurs during query execution
*/
public FeatureInputStream executeFilterQuery(FilterQuery query)
throws SQLException {
Modified:
core/trunk/src/com/vividsolutions/jump/datastore/spatialdatabases/SpatialDatabasesDSMetadata.java
===================================================================
---
core/trunk/src/com/vividsolutions/jump/datastore/spatialdatabases/SpatialDatabasesDSMetadata.java
2020-12-28 19:39:42 UTC (rev 6663)
+++
core/trunk/src/com/vividsolutions/jump/datastore/spatialdatabases/SpatialDatabasesDSMetadata.java
2020-12-28 19:49:02 UTC (rev 6664)
@@ -20,12 +20,13 @@
/**
* A base class for Spatial Databases DataStore Metadata: DB accessed through
* JDBC driver, implementing if possible OGC SFSQL. Uses postgis default values
- * => already implements mechanism for postgis databases
+ * =< already implements mechanism for postgis databases
*
- * Ex: Postgis, Oracle Spatial, SpatiaLite, SQL Server.<br:>
- * For each spatial db support, a child class should be added based on this
+ * <p>Ex: Postgis, Oracle Spatial, SpatiaLite, SQL Server.</p>
+ * <p>For each spatial db support, a child class should be added based on this
* class implementing methods as needed. PostGIS was the Spatial DB used for
- * first impl. TODO: sql injection
+ * first impl.</p>
+ * TODO: sql injection
*
* @author Nicolas Ribot
*/
@@ -183,14 +184,14 @@
* Returns the schema name based on the given tableName: string before . if
* exists, else returns schemaName
*
- * @param schemaName
- * @return
+ * @param tableName the table name, eventually qualified
+ * @return the name of the schema
*/
- protected String getSchemaName(String schemaName) {
- int dotPos = schemaName.indexOf(".");
+ protected String getSchemaName(String tableName) {
+ int dotPos = tableName.indexOf(".");
String schema = this.defaultSchemaName;
if (dotPos != -1) {
- schema = schemaName.substring(0, dotPos);
+ schema = tableName.substring(0, dotPos);
}
return schema;
}
@@ -199,8 +200,8 @@
* Returns the table name based on the given tableName: string after "." if
* exists, else returns tableName
*
- * @param tableName
- * @return
+ * @param tableName the table name, eventually qualified
+ * @return the table part of the eventually qualified table name
*/
protected String getTableName(String tableName) {
int dotPos = tableName.indexOf(".");
@@ -214,8 +215,8 @@
/**
* Returns true if the given Exception concerns a missing geometric metadata
* table
- *
- * @return
+ * @param e an exception
+ * @return true if the exception is about missing geometry column
*/
protected boolean missingGeoException(Exception e) {
return (e instanceof SQLException &&
e.getMessage().contains("geometry_columns"));
@@ -256,7 +257,7 @@
/**
* Nico Ribot: 2018-08-07: new method using a query to get all information
for datasets
* in a structure, to avoid querying too much the server
- * @return
+ * @return dataset (table) names from this spatial Database
*/
public String[] getDatasetNames() {
final List datasetNames = new ArrayList();
@@ -362,8 +363,8 @@
* Retrieves list of geometric tables from a custom DB Query: Should use OGC
* metadata geoemtry_columns or equivalent mechanism according to target DB.
*
- * @param datasetName
- * @return
+ * @param datasetName name of a dataset
+ * @return list of GeometryColumn's referenced in this dataset
*/
public List<GeometryColumn> getGeometryAttributes(String datasetName) {
String sql = getGeoColumnsQuery(datasetName);
@@ -399,6 +400,8 @@
* name)
* @return the list of columns involved in the Primary Key (generally, a
* single column)
+ * @throws SQLException if the server throws an Exception while trying to get
+ * PrimaryKey columns
*/
public List<PrimaryKeyColumn> getPrimaryKeyColumns(String datasetName)
throws SQLException {
final List<PrimaryKeyColumn> identifierColumns = new
ArrayList<PrimaryKeyColumn>();
@@ -448,11 +451,11 @@
* gets the list of columns for the given dataset. TODO: factorize MD
* retrieval in an Util class ?
*
- * @param datasetName
+ * @param datasetName the dataset (table) name
* @return an array of column names
*/
public synchronized String[] getColumnNames(String datasetName) {
- final List<String> cols = new ArrayList<String>();
+ final List<String> cols = new ArrayList<>();
ResultSet rs = null;
try {
@@ -476,10 +479,10 @@
/**
* Returns whether column is used by a spatial index (Gist) or not.
- * @param dsName
- * @param column
- * @return
- * @throws java.sql.SQLException
+ * @param dsName a dataset (table) name
+ * @param column a column name
+ * @return true if the column is indexed
+ * @throws java.sql.SQLException if an exception occurs during metadata
querying
*/
public boolean isIndexed(final String dsName, final String column) throws
SQLException {
ResultSet rs = null;
@@ -579,6 +582,7 @@
* @param tableName unquoted table name
* @param normalizeColumnNames whether column names must be normalized
(lowercased
* and without special characters) or not
+ * @return the sql string to create the table
*/
public String getCreateTableStatement(FeatureSchema fSchema,
String schemaName, String tableName,
boolean normalizeColumnNames) {
@@ -597,6 +601,7 @@
* @param normalizeColumnNames whether feature attribute names must be
normalized
* (lower case without spacial characters) to
specify
* table column names.
+ * @return the sql string containing the list of columns for this schema
*/
public String createColumnList(FeatureSchema schema,
boolean includeSQLDataType,
@@ -645,6 +650,14 @@
* rather than constraints (new default behaviour in 2.x)</p>
* <p>The geometry column name must have its final form. Attribute name
normalization
* is the responsability of the calling method.</p>
+ *
+ * @param schemaName the name of the Schema
+ * @param tableName the name of the Table
+ * @param geometryColumn the name of the geometry column
+ * @param srid the SRID for the geometry column
+ * @param geometryType the (SQL) geometry type as a String
+ * @param dim the coordinate dimension (2 or 3)
+ * @return a SQL query string to add a geometry column to a table
*/
public String getAddGeometryColumnStatement(String schemaName, String
tableName,
String geometryColumn,
int srid, String geometryType, int dim) {
Modified:
core/trunk/src/com/vividsolutions/jump/datastore/spatialdatabases/SpatialDatabasesFeatureInputStream.java
===================================================================
---
core/trunk/src/com/vividsolutions/jump/datastore/spatialdatabases/SpatialDatabasesFeatureInputStream.java
2020-12-28 19:39:42 UTC (rev 6663)
+++
core/trunk/src/com/vividsolutions/jump/datastore/spatialdatabases/SpatialDatabasesFeatureInputStream.java
2020-12-28 19:49:02 UTC (rev 6664)
@@ -44,14 +44,14 @@
/**
*
- * @return
+ * @return the underlaying query String
*/
public String getQueryString(){return queryString;}
/**
* To overload
- * @param rs
- * @return
+ * @param rs a ResultSet
+ * @return the SpatialDatabasesResultSetConverter to be used
*/
protected SpatialDatabasesResultSetConverter
getResultSetConverter(ResultSet rs) {
return new SpatialDatabasesResultSetConverter(conn, rs);
Modified:
core/trunk/src/com/vividsolutions/jump/datastore/spatialdatabases/SpatialDatabasesValueConverterFactory.java
===================================================================
---
core/trunk/src/com/vividsolutions/jump/datastore/spatialdatabases/SpatialDatabasesValueConverterFactory.java
2020-12-28 19:39:42 UTC (rev 6663)
+++
core/trunk/src/com/vividsolutions/jump/datastore/spatialdatabases/SpatialDatabasesValueConverterFactory.java
2020-12-28 19:49:02 UTC (rev 6664)
@@ -38,10 +38,11 @@
/**
* Base class to get converter from factory.
* Should never be called !!
- * @param rsm
- * @param columnIndex
- * @return
- * @throws SQLException
+ * @param rsm a ResultSetMetaData
+ * @param columnIndex column index
+ * @return the value converter to use for this column
+ * @throws SQLException if the server throws an exception during
ResultSetMetaData reading
+ * @throws UnsupportedOperationException if the method is not implemented
*/
public ValueConverter getConverter(ResultSetMetaData rsm, int columnIndex)
throws SQLException {
Modified:
core/trunk/src/com/vividsolutions/jump/geom/AbstractGeometryProcessor.java
===================================================================
--- core/trunk/src/com/vividsolutions/jump/geom/AbstractGeometryProcessor.java
2020-12-28 19:39:42 UTC (rev 6663)
+++ core/trunk/src/com/vividsolutions/jump/geom/AbstractGeometryProcessor.java
2020-12-28 19:49:02 UTC (rev 6664)
@@ -23,6 +23,8 @@
/**
* Main method taking an input geometry and returning a new Geometry which
* may have different properties.
+ * @param geometry the Geometry to process
+ * @return a new Geometry
*/
public Geometry process(Geometry geometry) {
List<Geometry> list= new ArrayList<>();
@@ -46,7 +48,11 @@
}
}
- /** Method to process Points. Override this method to transform punctal
elements).*/
+ /**
+ * Method to process Points. Override this method to transform punctal
elements).
+ * @param point input Point
+ * @param list the list accumulating all processed simple component.
+ */
public void process(Point point, List<Geometry> list) {
Point clone = (Point)point.clone();
process(clone.getCoordinateSequence());
@@ -53,7 +59,11 @@
list.add(clone);
}
- /** Method to process LineStrings. Override this method to transform
linear elements).*/
+ /**
+ * Method to process LineStrings. Override this method to transform linear
elements).
+ * @param lineString input LineString
+ * @param list the list accumulating all processed simple component.
+ */
public void process(LineString lineString, List<Geometry> list) {
LineString clone = (LineString)lineString.clone();
process(clone.getCoordinateSequence());
@@ -60,7 +70,11 @@
list.add(clone);
}
- /** Method to process LinearRings.*/
+ /**
+ * Method to process LinearRings.
+ * @param linearRing input LinearRing
+ * @return a new processed LinearRing
+ */
public LinearRing process(LinearRing linearRing) {
LinearRing clone = (LinearRing)linearRing.clone();
process(clone.getCoordinateSequence());
@@ -67,7 +81,11 @@
return clone;
}
- /** Method to process Polygons. Override this method to transform areal
elements).*/
+ /**
+ * Method to process Polygons. Override this method to transform areal
elements).
+ * @param polygon input Polygon
+ * @param list the list accumulating all processed simple component.
+ */
public void process(Polygon polygon, List<Geometry> list) {
LinearRing ext = process((LinearRing)polygon.getExteriorRing());
LinearRing[] holes = new LinearRing[polygon.getNumInteriorRing()];
@@ -77,7 +95,10 @@
list.add(polygon.getFactory().createPolygon(ext, holes));
}
- /** Method to change CoordinateSequences of a geometry - ex. simplifiers.
*/
+ /**
+ * Method to change CoordinateSequences of a geometry - ex. simplifiers.
+ * @param sequence the CoordinateSequence to process
+ */
public void process(CoordinateSequence sequence) {
int d = sequence.getDimension();
for (int i = 0 ; i < sequence.size() ; i++) {
@@ -92,7 +113,9 @@
}
}
- /** Method to change each single coordinate of a Geometry - ex. coord
transformation. */
+ /**
+ * Method to change each single coordinate of a Geometry - ex. coord
transformation.
+ */
public double[] process(double[] dd) {
return dd;
}
Modified: core/trunk/src/com/vividsolutions/jump/geom/Angle.java
===================================================================
--- core/trunk/src/com/vividsolutions/jump/geom/Angle.java 2020-12-28
19:39:42 UTC (rev 6663)
+++ core/trunk/src/com/vividsolutions/jump/geom/Angle.java 2020-12-28
19:49:02 UTC (rev 6664)
@@ -66,6 +66,8 @@
/**
* Returns the angle of the vector from p0 to p1.
* The angle will be between -Pi and Pi.
+ * @param p0 first coordinate
+ * @param p1 second coordinate
* @return the angle (in radians) that p0-p1 makes with the positive x-axis.
*/
public static double angle(Coordinate p0, Coordinate p1) {
@@ -77,6 +79,7 @@
/**
* Returns the angle of the vector from (0,) to p.
* The angle will be between -Pi and Pi.
+ * @param p coordinate of a point p
* @return the angle (in radians) that p makes with the positive x-axis.
*/
public static double angle(Coordinate p) {
Modified: core/trunk/src/com/vividsolutions/jump/geom/CoordUtil.java
===================================================================
--- core/trunk/src/com/vividsolutions/jump/geom/CoordUtil.java 2020-12-28
19:39:42 UTC (rev 6663)
+++ core/trunk/src/com/vividsolutions/jump/geom/CoordUtil.java 2020-12-28
19:49:02 UTC (rev 6664)
@@ -63,6 +63,7 @@
/**
* @param coordinates not empty
+ * @return the average position of all input coordinates
*/
public static Coordinate average(Collection coordinates) {
Assert.isTrue(!coordinates.isEmpty());
Modified: core/trunk/src/com/vividsolutions/jump/geom/MakeValidOp.java
===================================================================
--- core/trunk/src/com/vividsolutions/jump/geom/MakeValidOp.java
2020-12-28 19:39:42 UTC (rev 6663)
+++ core/trunk/src/com/vividsolutions/jump/geom/MakeValidOp.java
2020-12-28 19:49:02 UTC (rev 6664)
@@ -44,10 +44,10 @@
/**
* Operator to make a geometry valid.
- * <br/>
- * Making a geometry valid will remove duplicate points although duplicate
points
- * do not make a geometry invalid.
*
+ * <p>Making a geometry valid will remove duplicate points although duplicate
points
+ * do not make a geometry invalid.</p>
+ *
* @author Micha\xEBl Michaud
*/
public class MakeValidOp {
Modified: core/trunk/src/com/vividsolutions/jump/io/FMEGMLReader.java
===================================================================
--- core/trunk/src/com/vividsolutions/jump/io/FMEGMLReader.java 2020-12-28
19:39:42 UTC (rev 6663)
+++ core/trunk/src/com/vividsolutions/jump/io/FMEGMLReader.java 2020-12-28
19:49:02 UTC (rev 6664)
@@ -45,15 +45,15 @@
/**
* A driver that reads GML files following the FME default schema.
- * <p>
+ *
* <h3>DataProperties for the driver</h3>
*
- * <table border=1 width=100%>
+ * <table border=1 style="width:100%;" summary="">
* <tr><th>Parameter</th><th>Meaning</th></tr>
* <tr><td>File <i>or</i> DefaultValue</td><td>File name for the input FME
.xml file</td></tr>
* <tr><td>CompressedFile</td><td>File name (a .zip or .gz) with a
.jml/.xml/.gml inside (specified by File)</td></tr>
* </table>
- * <p>
+ *
* This is implemented using the more general {@link GMLReader}.
* It makes a {@link GMLInputTemplate} to pass to the GMLReader by examining
* the schema specified in the input file.
Modified: core/trunk/src/com/vividsolutions/jump/io/FMEGMLWriter.java
===================================================================
--- core/trunk/src/com/vividsolutions/jump/io/FMEGMLWriter.java 2020-12-28
19:39:42 UTC (rev 6663)
+++ core/trunk/src/com/vividsolutions/jump/io/FMEGMLWriter.java 2020-12-28
19:49:02 UTC (rev 6664)
@@ -53,53 +53,52 @@
* interface:
* </p>
*
- * <table border='1' cellspacing='0' cellpadding='4'>
+ * <table style="border-collapse: collapse;" summary="">
* <tr>
- * <th>Parameter</th>
- * <th>Meaning</th>
+ * <th style="border: 1px solid #999; padding: 4px;">Parameter</th>
+ * <th style="border: 1px solid #999; padding: 4px;">Meaning</th>
* </tr>
* <tr>
- * <td>OutputFile or DefaultValue</td>
- * <td>File name for output .xml file</td>
+ * <td style="border: 1px solid #999; padding: 4px;">OutputFile or
DefaultValue</td>
+ * <td style="border: 1px solid #999; padding: 4px;">File name for
output .xml file</td>
* </tr>
* <tr>
- * <td>FMEFormatVersion</td>
- * <td>'2000' or '2001'</td>
+ * <td style="border: 1px solid #999; padding:
4px;">FMEFormatVersion</td>
+ * <td style="border: 1px solid #999; padding: 4px;">'2000' or
'2001'</td>
* </tr>
* </table>
* <br>
- * </p>
-
+ *
* <p>
* The format version specifies which version of FME GML this
* should produce.
* </p>
*
- * <table border='1' cellspacing='0' cellpadding='4'>
+ * <table style="border-collapse: collapse;" summary="">
* <tr>
- * <td> 2000 </td>
- * <td><pre>
- <dataset
- xmlns="http://www.safe.com/xml/namespaces/fmegml2";
- xmlns:fme="http://www.safe.com/xml/namespaces/fmegml2";
- xmlns:gml="http://www.opengis.net/gml";
- xmlns:xsi="http://www.w3.org/2000/10/XMLSchema-instance";
- xsi:schemaLocation="http://www.safe.com/xml/schemas/fmegml2.xsd";
>
- </pre>
- </td>
- </tr>
+ * <td style="border: 1px solid #999; padding: 4px;"> 2000 </td>
+ * <td style="border: 1px solid #999; padding: 4px;"><pre>
+ * <dataset
+ * xmlns="http://www.safe.com/xml/namespaces/fmegml2";
+ * xmlns:fme="http://www.safe.com/xml/namespaces/fmegml2";
+ * xmlns:gml="http://www.opengis.net/gml";
+ * xmlns:xsi="http://www.w3.org/2000/10/XMLSchema-instance";
+ * xsi:schemaLocation="http://www.safe.com/xml/schemas/fmegml2.xsd";
>
+ * </pre>
+ * </td>
+ * </tr>
* <tr>
- * <td> 2001 </td>
- <td><pre>
- <dataset
- xmlns="http://www.safe.com/xml/schemas/FMEFeatures";
- xmlns:fme="http://www.safe.com/xml/schemas/FMEFeatures";
- xmlns:gml="http://www.opengis.net/gml";
- xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance";
-
xsi:schemaLocation="http://www.safe.com/xml/schemas/FMEFeatures.xsd"; >
- </pre>
- </td>
- </tr>
+ * <td style="border: 1px solid #999; padding: 4px;"> 2001 </td>
+ * <td style="border: 1px solid #999; padding: 4px;"><pre>
+ * <dataset
+ * xmlns="http://www.safe.com/xml/schemas/FMEFeatures";
+ * xmlns:fme="http://www.safe.com/xml/schemas/FMEFeatures";
+ * xmlns:gml="http://www.opengis.net/gml";
+ * xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance";
+ *
xsi:schemaLocation="http://www.safe.com/xml/schemas/FMEFeatures.xsd"; >
+ * </pre>
+ * </td>
+ * </tr>
* </table>
*
*/
Modified: core/trunk/src/com/vividsolutions/jump/io/GMLOutputTemplate.java
===================================================================
--- core/trunk/src/com/vividsolutions/jump/io/GMLOutputTemplate.java
2020-12-28 19:39:42 UTC (rev 6663)
+++ core/trunk/src/com/vividsolutions/jump/io/GMLOutputTemplate.java
2020-12-28 19:49:02 UTC (rev 6664)
@@ -39,7 +39,7 @@
/**
* This class provides a parser for reading GMLOuputTemplates. This does NOT
contain an evaluator for <br>
- * taking the parsed GMLOutputTemplate and a featureCollection and producing
properly <bR>
+ * taking the parsed GMLOutputTemplate and a featureCollection and producing
properly <br>
* formatted output GML. Thats the {@link GMLWriter} class.<br>
*<br>
*<br>
@@ -49,7 +49,7 @@
*method. <br>
*The valuators (things that look like "<%") are:<br>
* <%=GEOMETRY> - replace this with a GML represention of the
geometry<br>
- * <%=COLUMN <column name>> - replace this with the corresponding JCS
column value <br>
+ * <%=COLUMN <column name>> - replace this with the corresponding
JCS column value <br>
* <%FEATURE> - this marks the start of a feature in the
OutputTemplate <Br>
* <%ENDFEATURE> - This marks the end of a feature in the
OutputTempalte <br>
*<br>
Modified: core/trunk/src/com/vividsolutions/jump/io/GMLReader.java
===================================================================
--- core/trunk/src/com/vividsolutions/jump/io/GMLReader.java 2020-12-28
19:39:42 UTC (rev 6663)
+++ core/trunk/src/com/vividsolutions/jump/io/GMLReader.java 2020-12-28
19:49:02 UTC (rev 6664)
@@ -79,41 +79,40 @@
* <p>
* DataProperties for the JCSReader load(DataProperties) interface:
* </p>
- * <p>
- * <table border='1' cellspacing='0' cellpadding='4'>
+ *
+ * <table style="border-collapse: collapse;" summary="">
* <tr>
- * <th>Parameter</th>
- * <th>Meaning</th>
+ * <th style="border: 1px solid #999; padding: 4px;">Parameter</th>
+ * <th style="border: 1px solid #999; padding: 4px;">Meaning</th>
* </tr>
* <tr>
- * <td>
+ * <td style="border: 1px solid #999; padding: 4px;">
* File or DefaultValue</td>
*
- * <td>
+ * <td style="border: 1px solid #999; padding: 4px;">
* File name for the input .xml file</td>
* </tr>
*
* <tr>
- * <td>
+ * <td style="border: 1px solid #999; padding: 4px;">
* InputTemplateFile</td>
- * <td>
+ * <td style="border: 1px solid #999; padding: 4px;">
* Filename for the GMLInputTemplate .xml file</td>
* </tr>
*
* <tr>
- * <td>CompressedFile</td>
- * <td>
+ * <td style="border: 1px solid #999; padding: 4px;">CompressedFile</td>
+ * <td style="border: 1px solid #999; padding: 4px;">
* File name (a .zip or .gz) with a .jml/.xml/.gml inside (specified by
File)</td>
* </tr>
*
* <tr>
- * <td>
+ * <td style="border: 1px solid #999; padding: 4px;">
* CompressedFileTemplate</td>
- * <td>File name (.zip or .gz) with the input template in (specified by
+ * <td style="border: 1px solid #999; padding: 4px;">File name (.zip or .gz)
with the input template in (specified by
* InputTemplateFile)</td>
* </tr>
* </table>
- * </p>
*
* <br>
* NOTE: If InputTemplateFile is unspecified, GMLReader will try to read one
off
@@ -132,7 +131,7 @@
*
* <pre>
* gmlReader.setInputTemplate( GMLInputTemplate);
- * gmlReader.load( <Reader> , <stream name> );
+ * gmlReader.load( <Reader> , <stream name> );
* </pre>
*
* <br>
@@ -156,15 +155,15 @@
* init <br>
*
* <PRE>
- * 0 -----> 1
+ * 0 -----> 1
* |
* | Collection start Tag
* |
- * -->2----------------> FINISH
+ * -->2----------------> FINISH
* \ | End Collection tag
* End Feature tag \ |
* \|
- * 4<-------->3
+ * 4<-------->3
* Geometry start/end
* </PRE>
*
@@ -172,7 +171,7 @@
* For multi-geometries <br>
* On start Multi-geometry, increment state by 1 (or jump to 1000 if at state
4) <br>
* make sure recursivegeometry[state-1000] is null <br>
- * <put any object into the recursivegeometry[state-1000] collection>
+ * <put any object into the recursivegeometry[state-1000] collection>
*
* <br>
* <br>
@@ -193,39 +192,39 @@
*
* <pre>
* example of double GCs:
- * START geometry ->move to state 4
- * START TAG: multi* -> move to state 1000, geometry = recursivegeometry[0]
- * <POINT>
+ * START geometry -> move to state 4
+ * START TAG: multi* -> move to state 1000, geometry =
recursivegeometry[0]
+ * <POINT>
*
- * -> added to geometry <POINT>
+ * -> added to geometry <POINT>
*
- * -> added to geometry START TAG: multi* -> move to state 1001, geometry =
- * recursivegeometry[1] <POINT>
+ * -> added to geometry START TAG: multi* -> move to state 1001,
geometry =
+ * recursivegeometry[1] <POINT>
*
- * -> added to geometry <POINT>
+ * -> added to geometry <POINT>
*
- * -> added to geometry END TAG: multi -> move to state 1000, build geometry
in
+ * -> added to geometry END TAG: multi -> move to state 1000, build
geometry in
* recursivegeometry[1], add to recursivegeometry[0], geometry =
- * recursivegeometry[0] <POINT>
+ * recursivegeometry[0] <POINT>
*
- * -> added to geometry END TAG: multi -> <finished> move to state 4, build
+ * -> added to geometry END TAG: multi -> <finished> move to
state 4, build
* geometry in recursivegeometry[0] (thats the result) and put it in
- * finalGeometry END geometry -> add to feature collection example of simple
- * geometry: START geometry ->move to state 4 BEGIN polygon ->clear out inner
- * ring accumulator BEGIN outerboundary BEGIN linearring END linearring -> put
- * points in linearRing END outerboundary -> put linearRing in outerBoundary
- * BEGIN innerboundary BEGIN linearring END linearring -> put points in
- * linearRing END innerboundary -> add linearRing to innerBoundary list END
- * polygon -> build polygon (put in geometry, which is recursivegeometry[0]
END
- * geometry => add to feature collection
+ * finalGeometry END geometry -> add to feature collection example of
simple
+ * geometry: START geometry -> move to state 4 BEGIN polygon -> clear
out inner
+ * ring accumulator BEGIN outerboundary BEGIN linearring END linearring ->
put
+ * points in linearRing END outerboundary -> put linearRing in
outerBoundary
+ * BEGIN innerboundary BEGIN linearring END linearring -> put points in
+ * linearRing END innerboundary -> add linearRing to innerBoundary list END
+ * polygon -> build polygon (put in geometry, which is
recursivegeometry[0] END
+ * geometry => add to feature collection
* </pre>
*
* Most of the work is done in the endTag method! <br>
* <br>
* New additions: Jan 2005 by Dave Blasby allow srid to be parsed from the GML
- * file For example: <gml:LineString srsName="EPSG:42102"> ....
- * </gml:LineString> The SRID of the created geometry will be 42102. It accepts
- * srsNames of the form "<letters>:<number>". ie. "EPSG:111" or "DAVE:222" or
+ * file For example: <gml:LineString srsName="EPSG:42102"> ....
+ * </gml:LineString> The SRID of the created geometry will be 42102. It
accepts
+ * srsNames of the form "<letters>:<number>". ie. "EPSG:111" or
"DAVE:222" or
* "BCGOV:333" etc... The Geometry's SRID will be the number. If you have a
* GEOMETRYCOLLECTION with more than one SRID specified the SRID of the result
* will be indeterminate (this isnt correct GML).
@@ -237,12 +236,12 @@
*
* New Addition: Jan, 2005by Dave Blasby Added slightly better support for
* type=OBJECT. It sticks a String in. Before it would probably throw an error.
- * Added support for multi-objects for example: <a> <b>...1...</b>
- * <b>...2...</b> <b>...3...</b> </a> Old behavior would be to for column 'b'
to
+ * Added support for multi-objects for example: <a>
<b>...1...</b>
+ * <b>...2...</b> <b>...3...</b> </a> Old
behavior would be to for column 'b' to
* have value "...3...". New behavior (only if you set b's type to 'OBJECT' and
- * set the GMLReader to processMultiItems as lists) <a><b>...1...</b></a> --> b
+ * set the GMLReader to processMultiItems as lists)
<a><b>...1...</b></a> --> b
* get the string "...1..." (as before)
- * <a><b>...1...</b><b>...2...</b><b>...3...</b></a> --> 'b' is a list of
String
+ *
<a><b>...1...</b><b>...2...</b><b>...3...</b></a>
--> 'b' is a list of String
* ['...1...','...2...','...3...']
*
*/
Modified: core/trunk/src/com/vividsolutions/jump/io/GMLWriter.java
===================================================================
--- core/trunk/src/com/vividsolutions/jump/io/GMLWriter.java 2020-12-28
19:39:42 UTC (rev 6663)
+++ core/trunk/src/com/vividsolutions/jump/io/GMLWriter.java 2020-12-28
19:49:02 UTC (rev 6664)
@@ -69,21 +69,22 @@
* <p>
* DataProperties for the JCSWriter write(featureSchema,DataProperties)
interface:<br>
* </p>
- * <p>
- * <table border='1' cellspacing='0' cellpadding='4'>
+ *
+ * <table style="border-collapse: collapse;" summary="">
* <tr>
- * <th>Parameter</th><th>Meaning</th>
+ * <th style="border: 1px solid #999; padding: 4px;">Parameter</th>
+ * <th style="border: 1px solid #999; padding: 4px;">Meaning</th>
* </tr>
* <tr>
- * <td>OutputFile or DefaultValue</td>
- * <td>File name for output .xml file</td>
+ * <td style="border: 1px solid #999; padding: 4px;">OutputFile or
DefaultValue</td>
+ * <td style="border: 1px solid #999; padding: 4px;">File name for output
.xml file</td>
* </tr>
* <tr>
- * <td>OutputTemplateFile</td>
- * <td>File name for GMLOutputTemplate file</td>
+ * <td style="border: 1px solid #999; padding: 4px;">OutputTemplateFile</td>
+ * <td style="border: 1px solid #999; padding: 4px;">File name for
GMLOutputTemplate file</td>
* </tr>
* </table><br>
- * </p>
+ *
* NOTE: If OutputTemplateFile is unspecified, one will be auto-created (the
JCS format).
* <br>
* <br>
@@ -97,7 +98,7 @@
* or:
* <pre>
* gmlWriter.setOutputTemplate( GMLOutputTemplate);
- * gmlWriter.write( <writer>, <stream name>);
+ * gmlWriter.write( <writer>, <stream name>);
* </pre>
* <br>
@@ -106,7 +107,7 @@
* <br>
* <br>
*
- * Output will be formed from the OutputTeplate like:<Br>
+ * Output will be formed from the OutputTeplate like:<br>
* <br>
* <pre>
* headerText
@@ -432,7 +433,7 @@
/**
* Given a FeatureSchema, make an output template
* in the JCS format
- * @param fcmd input featureSchema
+ * @param fc input FeatureCollection
*/
private static GMLOutputTemplate makeOutputTemplate(FeatureCollection fc) {
GMLOutputTemplate result;
@@ -485,7 +486,7 @@
* GMLInputTemplate for the JCS format. Used by makeOutputTemplate since
the
* output template includes an inputtemplate.
*
- * @param fcmd the featureSchema to describe
+ * @param fc the FeatureCollection to describe
*/
private static String makeInputTemplate(FeatureCollection fc) {
String result = "";
Modified: core/trunk/src/com/vividsolutions/jump/io/JMLReader.java
===================================================================
--- core/trunk/src/com/vividsolutions/jump/io/JMLReader.java 2020-12-28
19:39:42 UTC (rev 6663)
+++ core/trunk/src/com/vividsolutions/jump/io/JMLReader.java 2020-12-28
19:49:02 UTC (rev 6664)
@@ -55,25 +55,25 @@
* DataProperties for the JMLReader load(DataProperties) interface:<br><br>
* </p>
*
- * <table border='1' cellspacing='0' cellpadding='4'>
+ * <table style="border-collapse: collapse;" summary="">
* <tr>
- * <th>Parameter</th>
- * <th>Meaning</th>
+ * <th style="border: 1px solid #999; padding: 4px;">Parameter</th>
+ * <th style="border: 1px solid #999; padding: 4px;">Meaning</th>
* </tr>
* <tr>
- * <td>File or DefaultValue</td>
- * <td>File name for the input JML file</td>
+ * <td style="border: 1px solid #999; padding: 4px;">File or
DefaultValue</td>
+ * <td style="border: 1px solid #999; padding: 4px;">File name for the
input JML file</td>
* </tr>
* <tr>
- * <td>CompressedFile</td>
- * <td>
+ * <td style="border: 1px solid #999; padding: 4px;">CompressedFile</td>
+ * <td style="border: 1px solid #999; padding: 4px;">
* File name (a .zip or .gz) with a .jml/.xml/.gml inside (specified by
* File)
* </td>
* </tr>
* <tr>
- * <td>CompressedFileTemplate</td>
- * <td>
+ * <td style="border: 1px solid #999; padding:
4px;">CompressedFileTemplate</td>
+ * <td style="border: 1px solid #999; padding: 4px;">
* File name (.zip or .gz) with the input template in (specified by
* InputTemplateFile)
* </td>
@@ -80,7 +80,6 @@
* </tr>
* </table>
* <br>
- * <br>
*/
public class JMLReader extends GMLReader {
Modified: core/trunk/src/com/vividsolutions/jump/io/JMLWriter.java
===================================================================
--- core/trunk/src/com/vividsolutions/jump/io/JMLWriter.java 2020-12-28
19:39:42 UTC (rev 6663)
+++ core/trunk/src/com/vividsolutions/jump/io/JMLWriter.java 2020-12-28
19:49:02 UTC (rev 6664)
@@ -54,18 +54,16 @@
* DataProperties for the JMLWriter write(DataProperties) interface:<br><br>
* </p>
*
- * <p>
- * <table border='1' cellspacing='0' cellpadding='4'>
+ * <table style="border-collapse: collapse;" summary="">
* <tr>
- * <th>Parameter</th>
- * <th>Meaning</th>
+ * <th style="border: 1px solid #999; padding: 4px;">Parameter</th>
+ * <th style="border: 1px solid #999; padding: 4px;">Meaning</th>
* </tr>
* <tr>
- * <td>OutputFile or DefaultValue</td>
- * <td>File name for the output JML file</td>
+ * <td style="border: 1px solid #999; padding: 4px;">OutputFile or
DefaultValue</td>
+ * <td style="border: 1px solid #999; padding: 4px;">File name for the
output JML file</td>
* </tr>
* </table><br>
- * </p>
*/
public class JMLWriter extends GMLWriter /*implements JUMPWriter */ {
Modified: core/trunk/src/com/vividsolutions/jump/io/ShapefileReader.java
===================================================================
--- core/trunk/src/com/vividsolutions/jump/io/ShapefileReader.java
2020-12-28 19:39:42 UTC (rev 6663)
+++ core/trunk/src/com/vividsolutions/jump/io/ShapefileReader.java
2020-12-28 19:49:02 UTC (rev 6664)
@@ -67,17 +67,17 @@
* DataProperties for the JUMPReader load(DataProperties) interface:<br><br>
* </p>
*
- * <p>
- * <table border='1' cellspacing='0' cellpadding='4'>
+ * <table style="border-collapse: collapse;" summary="">
* <tr>
- * <th>Parameter</th><th>Meaning</th>
+ * <th style="border: 1px solid #999; padding: 4px;">Parameter</th>
+ * <th style="border: 1px solid #999; padding: 4px;">Meaning</th>
* </tr>
* <tr>
- * <td>InputFile or DefaultValue</td>
- * <td>File name for the input .shp file</td>
+ * <td style="border: 1px solid #999; padding: 4px;">InputFile or
DefaultValue</td>
+ * <td style="border: 1px solid #999; padding: 4px;">File name for the
input .shp file</td>
* </tr>
* <tr>
- * <td colspan='2'>
+ * <td colspan='2' style="border: 1px solid #999; padding: 4px;">
* NOTE: The input .dbf is assumed to be 'beside' (in the same
* directory) as the .shp file.
* </td>
@@ -84,12 +84,12 @@
* </tr>
* <tr>
- * <td>CompressedFile</td>
- * <td>File name (.zip or .tgz NOT a .gz) with .shp and .dbf file
inside</td>
+ * <td style="border: 1px solid #999; padding: 4px;">CompressedFile</td>
+ * <td style="border: 1px solid #999; padding: 4px;">File name (.zip or
.tgz NOT a .gz) with .shp and .dbf file inside</td>
* </tr>
*
* <tr>
- * <td colspan='2'>
+ * <td colspan='2' style="border: 1px solid #999; padding: 4px;">
* Uses a modified version of geotools to do the .dbf and .shp
* file reading. If you are reading from a .zip file, the dbf
* file will be copied to your temp directory and deleted
@@ -97,7 +97,6 @@
* </td>
* </tr>
* </table>
-
*/
public class ShapefileReader extends AbstractJUMPReader {
Modified: core/trunk/src/com/vividsolutions/jump/io/ShapefileWriter.java
===================================================================
--- core/trunk/src/com/vividsolutions/jump/io/ShapefileWriter.java
2020-12-28 19:39:42 UTC (rev 6663)
+++ core/trunk/src/com/vividsolutions/jump/io/ShapefileWriter.java
2020-12-28 19:49:02 UTC (rev 6664)
@@ -60,24 +60,24 @@
* DataProperties for the ShapefileWriter write(DataProperties)
interface:<br><br>
* </p>
*
- * <p>
- * <table border='1' cellspacing='0' cellpadding='4'>
+ * <table style="border-collapse: collapse;" summary="">
* <tr>
- * <th>Parameter</th>
- * <th>Meaning</th>
+ * <th style="border: 1px solid #999; padding: 4px;">Parameter</th>
+ * <th style="border: 1px solid #999; padding: 4px;">Meaning</th>
* </tr>
* <tr>
- * <td>OutputFile or DefaultValue</td>
- * <td>File name for the output .shp file</td>
+ * <td style="border: 1px solid #999; padding: 4px;">OutputFile or
DefaultValue</td>
+ * <td style="border: 1px solid #999; padding: 4px;">File name for the
output .shp file</td>
* </tr>
* <tr>
- * <td>ShapeType</td>
- * <td>
+ * <td style="border: 1px solid #999; padding: 4px;">ShapeType</td>
+ * <td style="border: 1px solid #999; padding: 4px;">
* Dimensionality of the Shapefile - 'xy', 'xym' or 'xyz'. 'xymz' and
* 'xyzm' are the same as 'xyz'
* </td>
* </tr>
- * </table><br>
+ * </table>
+ * <br>
*
* <p>
* NOTE: The input .dbf and .shx is assumed to be 'beside' (in the
@@ -91,22 +91,22 @@
* JUMP columns are converted to DBF columns by:
* </p>
*
- * <table border='1' cellspacing='0' cellpadding='4'>
+ * <table style="border-collapse: collapse;" summary="">
* <tr>
- * <th>JUMP Column</th>
- * <th>DBF column</th>
+ * <th style="border: 1px solid #999; padding: 4px;">JUMP Column</th>
+ * <th style="border: 1px solid #999; padding: 4px;">DBF column</th>
* </tr>
* <tr>
- * <td>STRING</td>
- * <td>Type 'C' length is size of longest string in the FeatureCollection
</td>
+ * <td style="border: 1px solid #999; padding: 4px;">STRING</td>
+ * <td style="border: 1px solid #999; padding: 4px;">Type 'C' length is
size of longest string in the FeatureCollection </td>
* </tr>
* <tr>
- * <td>DOUBLE</td>
- * <td>Type 'N' length is 33, with 16 digits right of the decimal</td>
+ * <td style="border: 1px solid #999; padding: 4px;">DOUBLE</td>
+ * <td style="border: 1px solid #999; padding: 4px;">Type 'N' length is
33, with 16 digits right of the decimal</td>
* </tr>
* <tr>
- * <td>INTEGER</td>
- * <td>Type 'N' length is 16, with 0 digits right of the decimal</td>
+ * <td style="border: 1px solid #999; padding: 4px;">INTEGER</td>
+ * <td style="border: 1px solid #999; padding: 4px;">Type 'N' length is
16, with 0 digits right of the decimal</td>
* </tr>
* </table>
*
@@ -125,58 +125,58 @@
* FeatureCollection must be first be normalized to one type:
* </p>
*
- * <table border='1' cellspacing='0' cellpadding='4'>
+ * <table style="border-collapse: collapse;" summary="">
* <tr>
- * <th>First non-NULL non-Point geometry in FeatureCollection</th>
- * <th>Coordinate Dimensionality</th>
- * <th>Shape Type</th>
+ * <th style="border: 1px solid #999; padding: 4px;">First non-NULL
non-Point geometry in FeatureCollection</th>
+ * <th style="border: 1px solid #999; padding: 4px;">Coordinate
Dimensionality</th>
+ * <th style="border: 1px solid #999; padding: 4px;">Shape Type</th>
* </tr>
* <tr>
- * <td>
+ * <td style="border: 1px solid #999; padding: 4px;">
* MULTIPOINT
* </td>
- * <td>
+ * <td style="border: 1px solid #999; padding: 4px;">
* xy xym xyzm
* </td>
- * <td>
+ * <td style="border: 1px solid #999; padding: 4px;">
* MULTIPOINT MULTIPOINTM MULTIPOINTZ
* </td>
* </tr>
* <tr>
- * <td>
+ * <td style="border: 1px solid #999; padding: 4px;">
* LINESTRING/MULTILINESTRING
* </td>
- * <td>
+ * <td style="border: 1px solid #999; padding: 4px;">
* xy xym xyzm
* </td>
- * <td>
+ * <td style="border: 1px solid #999; padding: 4px;">
* POLYLINE POLYLINEM POLYLINEZ
* </td>
* </tr>
* <tr>
- * <td>
+ * <td style="border: 1px solid #999; padding: 4px;">
* POLYGON/MULTIPOLYGON
* </td>
- * <td>
+ * <td style="border: 1px solid #999; padding: 4px;">
* xy xym xyzm
* </td>
- * <td>
+ * <td style="border: 1px solid #999; padding: 4px;">
* POLYGON POLYGONM POLYGONZ
* </td>
* </tr>
* <tr>
- * <th>All geometries in FeatureCollection are</th>
- * <th>Coordinate Dimensionality</th>
- * <th>Shape Type</th>
+ * <th style="border: 1px solid #999; padding: 4px;">All geometries in
FeatureCollection are</th>
+ * <th style="border: 1px solid #999; padding: 4px;">Coordinate
Dimensionality</th>
+ * <th style="border: 1px solid #999; padding: 4px;">Shape Type</th>
* </tr>
* <tr>
- * <td>
+ * <td style="border: 1px solid #999; padding: 4px;">
* POINT
* </td>
- * <td>
+ * <td style="border: 1px solid #999; padding: 4px;">
* xy xym xyzm
* </td>
- * <td>
+ * <td style="border: 1px solid #999; padding: 4px;">
* POINT POINTM POINTZ
* </td>
* </tr>
Modified: core/trunk/src/com/vividsolutions/jump/io/WKTReader.java
===================================================================
--- core/trunk/src/com/vividsolutions/jump/io/WKTReader.java 2020-12-28
19:39:42 UTC (rev 6663)
+++ core/trunk/src/com/vividsolutions/jump/io/WKTReader.java 2020-12-28
19:49:02 UTC (rev 6664)
@@ -48,24 +48,22 @@
* DataProperties for the JUMPReader load(DataProperties)
* interface:<br>
* </p>
- *
- * <p>
- * <table border='1' cellspacing='0' cellpadding='4'>
+ *
+ * <table style="border-collapse: collapse;" summary="">
* <tr>
- * <th>Parameter</th>
- * <th>Meaning</th>
+ * <th style="border: 1px solid #999; padding: 4px;">Parameter</th>
+ * <th style="border: 1px solid #999; padding: 4px;">Meaning</th>
* </tr>
* <tr>
- * <td>File or DefaultValue</td>
- * <td>File name for the input WKT file</td>
+ * <td style="border: 1px solid #999; padding: 4px;">File or
DefaultValue</td>
+ * <td style="border: 1px solid #999; padding: 4px;">File name for the
input WKT file</td>
* </tr>
* <tr>
- * <td>CompressedFile</td>
- * <td>File name (a .zip or .gz) with a .jml/.xml/.gml inside
+ * <td style="border: 1px solid #999; padding: 4px;">CompressedFile</td>
+ * <td style="border: 1px solid #999; padding: 4px;">File name (a .zip or
.gz) with a .jml/.xml/.gml inside
* (specified by File)</td>
* </tr>
* </table> <br>
- * </p>
*
*/
public class WKTReader extends AbstractJUMPReader {
Modified: core/trunk/src/com/vividsolutions/jump/io/WKTWriter.java
===================================================================
--- core/trunk/src/com/vividsolutions/jump/io/WKTWriter.java 2020-12-28
19:39:42 UTC (rev 6663)
+++ core/trunk/src/com/vividsolutions/jump/io/WKTWriter.java 2020-12-28
19:49:02 UTC (rev 6664)
@@ -49,19 +49,17 @@
* write(featureSchema,DataProperties) interface:<br>
* </p>
*
- * <p>
- * <table border='1' cellspacing='0' cellpadding='4'>
+ * <table style="border-collapse: collapse;" summary="">
* <tr>
- * <th>Parameter</th>
- * <th>Meaning</th>
+ * <th style="border: 1px solid #999; padding: 4px;">Parameter</th>
+ * <th style="border: 1px solid #999; padding: 4px;">Meaning</th>
* </tr>
* <tr>
- * <td>OutputFile or DefaultValue</td>
- * <td>File name for output .wkt file</td>
+ * <td style="border: 1px solid #999; padding: 4px;">OutputFile or
DefaultValue</td>
+ * <td style="border: 1px solid #999; padding: 4px;">File name for output
.wkt file</td>
* </tr>
* </table>
* <br>
- * </p>
*/
public class WKTWriter implements JUMPWriter {
Modified: core/trunk/src/com/vividsolutions/jump/io/datasource/DataSource.java
===================================================================
--- core/trunk/src/com/vividsolutions/jump/io/datasource/DataSource.java
2020-12-28 19:39:42 UTC (rev 6663)
+++ core/trunk/src/com/vividsolutions/jump/io/datasource/DataSource.java
2020-12-28 19:49:02 UTC (rev 6664)
@@ -52,6 +52,7 @@
/**
* Sets properties required to open a DataSource, such as username, password,
* filename, coordinate system, etc. Called by DataSourceQueryChoosers.
+ * @param properties the map containing properties for this DataSource
*/
public void setProperties(Map<String,Object> properties) {
this.properties = new HashMap<>(properties);
@@ -69,6 +70,7 @@
/**
* Creates a new Connection to this DataSource.
+ * @return a Connection to connect to this DataSource
*/
public abstract Connection getConnection();
Modified:
core/trunk/src/com/vividsolutions/jump/io/datasource/DataSourceQuery.java
===================================================================
--- core/trunk/src/com/vividsolutions/jump/io/datasource/DataSourceQuery.java
2020-12-28 19:39:42 UTC (rev 6663)
+++ core/trunk/src/com/vividsolutions/jump/io/datasource/DataSourceQuery.java
2020-12-28 19:49:02 UTC (rev 6664)
@@ -67,6 +67,7 @@
/**
* Returns the DataSource against which to apply the
* (implementation-dependent) query string.
+ * @return the DataSource of this DataSourceQuery
*/
public DataSource getDataSource() {
return dataSource;
@@ -75,6 +76,7 @@
/**
* Returns the implementation-dependent query string wrapped by this
* DataSourceQuery
+ * @return the Query String of this DataSourceQuery
*/
public String getQuery() {
return query;
@@ -89,6 +91,7 @@
/**
* Called by Java2XML
+ * @param dataSource the DataSource to use for this DataSourceQuery
*/
public void setDataSource(DataSource dataSource) {
this.dataSource = dataSource;
@@ -96,6 +99,7 @@
/**
* Called by Java2XML
+ * @param query the query String to use for this DataSourceQuery
*/
public void setQuery(String query) {
this.query = query;
Modified:
core/trunk/src/com/vividsolutions/jump/io/datasource/DelegatingCompressedFileHandler.java
===================================================================
---
core/trunk/src/com/vividsolutions/jump/io/datasource/DelegatingCompressedFileHandler.java
2020-12-28 19:39:42 UTC (rev 6663)
+++
core/trunk/src/com/vividsolutions/jump/io/datasource/DelegatingCompressedFileHandler.java
2020-12-28 19:49:02 UTC (rev 6664)
@@ -48,7 +48,7 @@
* data before handing it to the JUMPReader. Anyway, developers should now be
* writing DataSources instead of JUMPReaders.
*
- * @Deprecated use CompressedFile instead [07.2016]
+ * @deprecated use CompressedFile instead [07.2016]
*/
@Deprecated
public class DelegatingCompressedFileHandler extends AbstractJUMPReader {
Modified: core/trunk/src/com/vividsolutions/jump/package.html
===================================================================
--- core/trunk/src/com/vividsolutions/jump/package.html 2020-12-28 19:39:42 UTC
(rev 6663)
+++ core/trunk/src/com/vividsolutions/jump/package.html 2020-12-28 19:49:02 UTC
(rev 6664)
@@ -44,19 +44,19 @@
<ul>
<li><a
href =
- "http://www.jump-project.org/jump/doc/JUMP User Guide.pdf">JUMP
+ "http://www.jump-project.org/jump/doc/JUMP%20User%20Guide.pdf";>JUMP
Workbench User's Guide</a></li>
<li><a
href =
- "http://www.jump-project.org/jump/doc/JUMP Developer Guide.pdf">JUMP
+ "http://www.jump-project.org/jump/doc/JUMP%20Developer%20Guide.pdf";>JUMP
Developer's Guide</a></li>
<li><a
href =
- "http://www.jump-project.org/jump/doc/JUMP Technical Report.pdf">JUMP
+ "http://www.jump-project.org/jump/doc/JUMP%20Technical%20Report.pdf";>JUMP
Technical Report</a></li>
<li><a
href =
- "http://www.jump-project.org/jump/doc/JUMP Data Sheet.pdf">JUMP
+ "http://www.jump-project.org/jump/doc/JUMP%20Data%20Sheet.pdf";>JUMP
Data Sheet</a></li>
</ul>
Modified:
core/trunk/src/com/vividsolutions/jump/plugin/edit/Features2SegmentStringsWithData.java
===================================================================
---
core/trunk/src/com/vividsolutions/jump/plugin/edit/Features2SegmentStringsWithData.java
2020-12-28 19:39:42 UTC (rev 6663)
+++
core/trunk/src/com/vividsolutions/jump/plugin/edit/Features2SegmentStringsWithData.java
2020-12-28 19:49:02 UTC (rev 6664)
@@ -42,7 +42,7 @@
* Utility class to transform a collection of Features into a List of
* SegmentStrings, and to store genealogy data into their data field.
*
- * @author Michaël Michaud
+ * @author Michaël Michaud
*/
public class Features2SegmentStringsWithData {
Modified: core/trunk/src/com/vividsolutions/jump/plugin/edit/NoderPlugIn.java
===================================================================
--- core/trunk/src/com/vividsolutions/jump/plugin/edit/NoderPlugIn.java
2020-12-28 19:39:42 UTC (rev 6663)
+++ core/trunk/src/com/vividsolutions/jump/plugin/edit/NoderPlugIn.java
2020-12-28 19:49:02 UTC (rev 6664)
@@ -65,8 +65,8 @@
/**
* Noder PlugIn computes intersection nodes in a collection of linear or areal
- * features.</p>
- * Main options are :
+ * features.
+ * <p>Main options are :</p>
* <ul>
* <li>Input features : selected features or selected layer</li>
* <li>Output : new layer or layer update</li>
Modified:
core/trunk/src/com/vividsolutions/jump/plugin/edit/SegmentStringsWithData2Features.java
===================================================================
---
core/trunk/src/com/vividsolutions/jump/plugin/edit/SegmentStringsWithData2Features.java
2020-12-28 19:39:42 UTC (rev 6663)
+++
core/trunk/src/com/vividsolutions/jump/plugin/edit/SegmentStringsWithData2Features.java
2020-12-28 19:49:02 UTC (rev 6664)
@@ -53,7 +53,7 @@
* corresponding SegmentString's Map</li>
* </ul>
*
- * @author Michaël Michaud
+ * @author Michaël Michaud
*/
public class SegmentStringsWithData2Features {
Modified: core/trunk/src/com/vividsolutions/jump/util/CollectionUtil.java
===================================================================
--- core/trunk/src/com/vividsolutions/jump/util/CollectionUtil.java
2020-12-28 19:39:42 UTC (rev 6663)
+++ core/trunk/src/com/vividsolutions/jump/util/CollectionUtil.java
2020-12-28 19:49:02 UTC (rev 6664)
@@ -142,7 +142,7 @@
return new List[] { keys, values };
}
- public static <T> Collection<T> concatenate(Collection<Collection<T>>
collections) {
+ public static <T> Collection<T> concatenate(Collection<? extends
Collection<T>> collections) {
List<T> concatenation = new ArrayList<>();
for (Collection<T> collection : collections) {
concatenation.addAll(collection);
Modified:
core/trunk/src/com/vividsolutions/jump/workbench/imagery/geotiff/RasterPainter.java
===================================================================
---
core/trunk/src/com/vividsolutions/jump/workbench/imagery/geotiff/RasterPainter.java
2020-12-28 19:39:42 UTC (rev 6663)
+++
core/trunk/src/com/vividsolutions/jump/workbench/imagery/geotiff/RasterPainter.java
2020-12-28 19:49:02 UTC (rev 6664)
@@ -13,7 +13,7 @@
/**
* @deprecated replaced by geoimg code, more efficient
- * @TODO to be removed in version 2
+ * TODO to be removed in version 2
*/
@Deprecated
public class RasterPainter
Modified:
core/trunk/src/com/vividsolutions/jump/workbench/model/MeasureLayerFinder.java
===================================================================
---
core/trunk/src/com/vividsolutions/jump/workbench/model/MeasureLayerFinder.java
2020-12-28 19:39:42 UTC (rev 6663)
+++
core/trunk/src/com/vividsolutions/jump/workbench/model/MeasureLayerFinder.java
2020-12-28 19:49:02 UTC (rev 6664)
@@ -20,7 +20,7 @@
/**
* A special LayerFinder for the AdvancedMeasureTool.
*
- * @author Matthias Scholz <[email protected]>
+ * @author Matthias Scholz <[email protected]>
*/
public class MeasureLayerFinder extends SystemLayerFinder {
Modified:
core/trunk/src/com/vividsolutions/jump/workbench/plugin/AbstractPlugIn.java
===================================================================
--- core/trunk/src/com/vividsolutions/jump/workbench/plugin/AbstractPlugIn.java
2020-12-28 19:39:42 UTC (rev 6663)
+++ core/trunk/src/com/vividsolutions/jump/workbench/plugin/AbstractPlugIn.java
2020-12-28 19:49:02 UTC (rev 6664)
@@ -141,6 +141,7 @@
* system yet or (2) does not modify the system. In either case, the undo
* history will be preserved. If this method is not called, then this plug-in
* will be assumed to be non-undoable, and the undo history will be
truncated.
+ * @param context plugin context
*/
protected void reportNothingToUndoYet(PlugInContext context) {
// The LayerManager can be null if for example there are no TaskFrames
@@ -311,9 +312,12 @@
}
/**
+ * @param plugIn the plugin
+ * @param workbenchContext context of the application
* @param taskMonitorManager
* can be null if you do not wish to use the Task Monitor
* progress-reporting framework
+ * @return an ActionListener for this PlugIn
*/
public static ActionListener toActionListener(final PlugIn plugIn,
@@ -416,7 +420,7 @@
/**
* Utility method to fetch enable checks from enablechecked plugins.
*
- * @param plugin
+ * @param plugin a PlugIn
* @return enable check
*/
public static EnableCheck getEnableCheck(PlugIn plugin) {
@@ -429,11 +433,11 @@
* enabled plugin. Used to register multiple shortcut enabled plugins in one
* go.
*
- * @param plugin
+ * @param plugin a PlugIn
* @return plugins array
*/
public static PlugIn[] fetchShortcutEnabledPlugins(PlugIn plugin) {
- Vector plugins = new Vector();
+ Vector<PlugIn> plugins = new Vector();
// add plugin
if (plugin instanceof ShortcutEnabled
&& ((ShortcutEnabled) plugin).isShortcutEnabled())
@@ -453,8 +457,8 @@
* Utility method to register global shortcuts. Should be preferred to the
* more direct approach using WorkbenchFrame.addKeyboardShortcut() .
*
- * @param plugin
- * @return done
+ * @param plugin a PlugIn
+ * @return true if shortcuts have been added for the PlugIn
*/
public static boolean registerShortcuts(PlugIn plugin) {
PlugIn[] shortys = fetchShortcutEnabledPlugins(plugin);
Modified: core/trunk/src/com/vividsolutions/jump/workbench/plugin/PlugIn.java
===================================================================
--- core/trunk/src/com/vividsolutions/jump/workbench/plugin/PlugIn.java
2020-12-28 19:39:42 UTC (rev 6663)
+++ core/trunk/src/com/vividsolutions/jump/workbench/plugin/PlugIn.java
2020-12-28 19:49:02 UTC (rev 6664)
@@ -56,10 +56,14 @@
* @see PlugInManager
*/
public interface PlugIn {
+
/**
* Called when Workbench starts up to allow plugins to initialize
themselves.
+ *
+ * @param context context of the PlugIn
+ * @throws Exception if an exception occur during initialization
*/
- public void initialize(PlugInContext context) throws Exception;
+ void initialize(PlugInContext context) throws Exception;
/**
* Performs the action for this plugin.
@@ -68,6 +72,7 @@
* should return <code>false</code> to prevent the run method
* from being called.
*
+ * @param context context of this PlugIn
* @return true if the action completed, false if it was aborted.
* Used by ThreadedPlugIns to indicate that their #run method needn't be
* called next.
@@ -74,11 +79,11 @@
* @throws Exception if a problem occurs during plug-in execution
* @see ThreadedPlugIn
*/
- public boolean execute(PlugInContext context) throws Exception;
+ boolean execute(PlugInContext context) throws Exception;
/**
* Returns a very brief description of this PlugIn e.g. for display as a
menu item
* @return the name of this PlugIn
*/
- public String getName();
+ String getName();
}
Modified:
core/trunk/src/com/vividsolutions/jump/workbench/plugin/ShortcutEnabled.java
===================================================================
---
core/trunk/src/com/vividsolutions/jump/workbench/plugin/ShortcutEnabled.java
2020-12-28 19:39:42 UTC (rev 6663)
+++
core/trunk/src/com/vividsolutions/jump/workbench/plugin/ShortcutEnabled.java
2020-12-28 19:49:02 UTC (rev 6664)
@@ -10,18 +10,20 @@
*
*/
public interface ShortcutEnabled {
- public boolean isShortcutEnabled();
+
+ boolean isShortcutEnabled();
/**
* Convenience Method for getShortcutKeys() and getShortcutModifiers()
+ * @return the KeyStroke associated to the shortcut
*/
- public KeyStroke getShortcutKeyStroke();
+ KeyStroke getShortcutKeyStroke();
- public int getShortcutModifiers();
+ int getShortcutModifiers();
- public void setShortcutModifiers(int shortcutModifiers);
+ void setShortcutModifiers(int shortcutModifiers);
- public int getShortcutKeys();
+ int getShortcutKeys();
- public void setShortcutKeys(int shortcutKeys);
+ void setShortcutKeys(int shortcutKeys);
}
Modified:
core/trunk/src/com/vividsolutions/jump/workbench/plugin/ThreadedPlugIn.java
===================================================================
--- core/trunk/src/com/vividsolutions/jump/workbench/plugin/ThreadedPlugIn.java
2020-12-28 19:39:42 UTC (rev 6663)
+++ core/trunk/src/com/vividsolutions/jump/workbench/plugin/ThreadedPlugIn.java
2020-12-28 19:49:02 UTC (rev 6664)
@@ -65,7 +65,9 @@
* executed on the GUI thread.
* @param monitor context to which this task can report its progress and
* check whether a party has requested its cancellation
+ * @param context context of this PlugIn
+ * @throws Exception if an Exception occurs during the run
*/
- public void run(TaskMonitor monitor, PlugInContext context)
+ void run(TaskMonitor monitor, PlugInContext context)
throws Exception;
}
Modified:
core/trunk/src/com/vividsolutions/jump/workbench/ui/AbstractDriverPanel.java
===================================================================
---
core/trunk/src/com/vividsolutions/jump/workbench/ui/AbstractDriverPanel.java
2020-12-28 19:39:42 UTC (rev 6663)
+++
core/trunk/src/com/vividsolutions/jump/workbench/ui/AbstractDriverPanel.java
2020-12-28 19:49:02 UTC (rev 6664)
@@ -66,6 +66,7 @@
/**
* Adds an ActionListener that should be notified when the user presses
* this panel's OK or Cancel button.
+ * @param l an ActionListener
*/
public abstract void addActionListener(ActionListener l);
@@ -91,6 +92,7 @@
* Returns the current panel values. Subclasses overriding this method
should
* call the superclass method first. DriverDialog takes care of merging
* the returned cache with the original cache.
+ * @return the DriverPanelCache
*/
public DriverPanelCache getCache() {
return new DriverPanelCache();
Modified:
core/trunk/src/com/vividsolutions/jump/workbench/ui/EditTransaction.java
===================================================================
--- core/trunk/src/com/vividsolutions/jump/workbench/ui/EditTransaction.java
2020-12-28 19:39:42 UTC (rev 6663)
+++ core/trunk/src/com/vividsolutions/jump/workbench/ui/EditTransaction.java
2020-12-28 19:49:02 UTC (rev 6664)
@@ -45,7 +45,7 @@
/**
* Takes care of "rollback" (if any geometries are invalid) and undo,
* for PlugIns and CursorTools that modify geometries.
- * <p> Also:
+ * <p> Also:</p>
* <UL>
* <LI>warns the user if invalid geometries are found</LI>
* <LI>invalidates the layer envelope cache</LI>
@@ -52,7 +52,7 @@
* <LI>invalidates the geometry envelope caches</LI>
* <LI>(undoably) removes features from the layer when their geometries
are made empty</LI>
* <LI>(undoably) adds features to the layer when they start with empty
geometries </LI>
- * </UL></p>
+ * </UL>
*/
public class EditTransaction {
Modified: core/trunk/src/com/vividsolutions/jump/workbench/ui/FontChooser.java
===================================================================
--- core/trunk/src/com/vividsolutions/jump/workbench/ui/FontChooser.java
2020-12-28 19:39:42 UTC (rev 6663)
+++ core/trunk/src/com/vividsolutions/jump/workbench/ui/FontChooser.java
2020-12-28 19:49:02 UTC (rev 6664)
@@ -53,7 +53,7 @@
* Based on FontChooser by Janos Szatmary. Posted on the Sun Java forums.
*
* Szatmary, Janos. "A FontChooser Class (source included)." April 2001.
- * Available from http://forum.java.sun.com/thread.jsp?forum=57&thread=124810.
+ * Available from <a
href="http://forum.java.sun.com/thread.jsp?forum=57&thread=124810";>java
forum</a>
* Internet; accessed 6 November 2002.
*
*/
Modified: core/trunk/src/com/vividsolutions/jump/workbench/ui/GenericNames.java
===================================================================
--- core/trunk/src/com/vividsolutions/jump/workbench/ui/GenericNames.java
2020-12-28 19:39:42 UTC (rev 6663)
+++ core/trunk/src/com/vividsolutions/jump/workbench/ui/GenericNames.java
2020-12-28 19:49:02 UTC (rev 6664)
@@ -36,7 +36,7 @@
/**
* Use these for generic names as layer, layer A, function...
*
- * @author Basile Chandesris - <[email protected]>
+ * @author Basile Chandesris - <[email protected]>
*/
public interface GenericNames {
String LAYER = I18N.get("ui.GenericNames.LAYER");
Modified: core/trunk/src/com/vividsolutions/jump/workbench/ui/LayerPrinter.java
===================================================================
--- core/trunk/src/com/vividsolutions/jump/workbench/ui/LayerPrinter.java
2020-12-28 19:39:42 UTC (rev 6663)
+++ core/trunk/src/com/vividsolutions/jump/workbench/ui/LayerPrinter.java
2020-12-28 19:49:02 UTC (rev 6664)
@@ -17,7 +17,7 @@
/**
* Renders layers as an Image, which can then be saved to a file or printed.
- * @See LayerPrinter2 (created in 2007)
+ * @see org.openjump.core.ui.plugin.file.LayerPrinter2 (created in 2007)
*/
@Deprecated
public class LayerPrinter {
Modified: core/trunk/src/com/vividsolutions/jump/workbench/ui/MenuNames.java
===================================================================
--- core/trunk/src/com/vividsolutions/jump/workbench/ui/MenuNames.java
2020-12-28 19:39:42 UTC (rev 6663)
+++ core/trunk/src/com/vividsolutions/jump/workbench/ui/MenuNames.java
2020-12-28 19:49:02 UTC (rev 6664)
@@ -35,7 +35,7 @@
/**
* First level menus names of JUMP
- * @author Basile Chandesris - <[email protected]>
+ * @author Basile Chandesris - <[email protected]>
*/
public class MenuNames {
public static final String FILE = I18N.get("ui.MenuNames.FILE");
Modified:
core/trunk/src/com/vividsolutions/jump/workbench/ui/OptionsPanelV2.java
===================================================================
--- core/trunk/src/com/vividsolutions/jump/workbench/ui/OptionsPanelV2.java
2020-12-28 19:39:42 UTC (rev 6663)
+++ core/trunk/src/com/vividsolutions/jump/workbench/ui/OptionsPanelV2.java
2020-12-28 19:49:02 UTC (rev 6664)
@@ -37,11 +37,7 @@
/**
* TODO Purpose of
- * <p>
- * </p>
- *
- * @author
- * @since 1.0
+ *
*/
public abstract class OptionsPanelV2 extends JPanel implements OptionsPanel {
Modified:
core/trunk/src/com/vividsolutions/jump/workbench/ui/RecursiveListener.java
===================================================================
--- core/trunk/src/com/vividsolutions/jump/workbench/ui/RecursiveListener.java
2020-12-28 19:39:42 UTC (rev 6663)
+++ core/trunk/src/com/vividsolutions/jump/workbench/ui/RecursiveListener.java
2020-12-28 19:49:02 UTC (rev 6664)
@@ -51,6 +51,7 @@
*
* <p>
* Uses:
+ * </p>
* <ul>
* <li> add a KeyListener to all components in an application to
* watch for global function keys </li>
@@ -57,7 +58,6 @@
* <li> add a FocusListener to all components in a scrollable panel
* to allow auto scrolling on tab </li>
* </ul>
- * </p>
*
* <p>
* Subclass and implement addListenerTo() and removeListenerFrom().
Modified: core/trunk/src/com/vividsolutions/jump/workbench/ui/TextEditor.java
===================================================================
--- core/trunk/src/com/vividsolutions/jump/workbench/ui/TextEditor.java
2020-12-28 19:39:42 UTC (rev 6663)
+++ core/trunk/src/com/vividsolutions/jump/workbench/ui/TextEditor.java
2020-12-28 19:49:02 UTC (rev 6664)
@@ -46,9 +46,9 @@
/**
*
*
- * /** Modified from
+ * Modified from
* http://jfontchooser.osdn.jp/site/jfontchooser/project-summary.html MIT/X
- * common Licence, Copyright (c) <2004> <Masahiko SAWAI>
+ * common Licence, Copyright (c) 2004 Masahiko SAWAI
*
* - The panel gets Font and Text preview from a selected Text component -
* Preview panel works as text editor. Preview is saved as text -
@@ -59,7 +59,7 @@
* TextEditor editor = new JFontChooser();
* editor.showDialog(Component.getParent(), "Title of this font/editor
panel");
*
- * // <Optional, set font, font size, font style and preview text in the
TextEditor from a JTextComponent>
+ * // Optional, set font, font size, font style and preview text in the
TextEditor from a JTextComponent
* //
* // editor.setSelectedFont(JTextComponent.getFont());
* // editor.setSelectedFontSize(JTextComponent.getFont().getSize());
@@ -71,7 +71,7 @@
* Font font = editor.getSelectedFont();
* System.out.println("Selected Font : " + font);
*
- * // <Optional, get modified text String from preview panel>
+ * // Optional, get modified text String from preview panel
* //
* // String string = editor.getSampleTextField().getText()
* // System.out.println("Selected modified text: "string);
@@ -80,7 +80,7 @@
* reportNothingToUndoYet(null);
* }
*
- * <pre>
+ * </pre>
*
*
* @author Giuseppe Aruta
@@ -345,7 +345,7 @@
* @param name
* the family name of the selected font.
*
- * @see getSelectedFontFamily
+ * @see #getSelectedFontFamily
**/
public void setSelectedFontFamily(String name) {
final String[] names = getFontFamilies();
Modified:
core/trunk/src/com/vividsolutions/jump/workbench/ui/addremove/AddRemoveList.java
===================================================================
---
core/trunk/src/com/vividsolutions/jump/workbench/ui/addremove/AddRemoveList.java
2020-12-28 19:39:42 UTC (rev 6663)
+++
core/trunk/src/com/vividsolutions/jump/workbench/ui/addremove/AddRemoveList.java
2020-12-28 19:49:02 UTC (rev 6664)
@@ -40,16 +40,19 @@
public interface AddRemoveList {
- public AddRemoveListModel getModel();
- public void add(InputChangedListener listener);
- public void add(MouseListener listener);
+ AddRemoveListModel getModel();
- public List getSelectedItems();
+ void add(InputChangedListener listener);
+ void add(MouseListener listener);
+
+ List getSelectedItems();
+
/**
* Will only be called if the AddRemovePanel's Move Up and Move Down
* buttons are visible.
+ * @param items to be selected
*/
- public void setSelectedItems(Collection items);
+ void setSelectedItems(Collection items);
}
Modified:
core/trunk/src/com/vividsolutions/jump/workbench/ui/cursortool/AbstractCursorTool.java
===================================================================
---
core/trunk/src/com/vividsolutions/jump/workbench/ui/cursortool/AbstractCursorTool.java
2020-12-28 19:39:42 UTC (rev 6663)
+++
core/trunk/src/com/vividsolutions/jump/workbench/ui/cursortool/AbstractCursorTool.java
2020-12-28 19:49:02 UTC (rev 6664)
@@ -204,6 +204,8 @@
/**
* The cursor will look best if the image is a 32 x 32 transparent GIF.
+ * @param image the cursor image
+ * @return a Cursor
*/
public static Cursor createCursor(Image image) {
// <<TODO>> Compute image center rather than hardcoding 16, 16. [Jon
@@ -245,6 +247,7 @@
/**
* Important for XOR drawing. Even if #getShape returns null, this method
will
* return true between calls of #redrawShape and #clearShape.
+ * @return true if the cursor shape is on screen (even if not visible)
*/
public boolean isShapeOnScreen() {
return shapeOnScreen;
@@ -337,6 +340,7 @@
/**
* @deprecated Use #setStroke instead.
+ * @param strokeWidth stroke width of this cursor tool
*/
protected void setStrokeWidth(int strokeWidth) {
setStroke(new BasicStroke(strokeWidth));
@@ -356,6 +360,7 @@
/**
* @return null if nothing should be drawn
+ * @throws Exception if an Exception occurs during Shape construction
*/
protected abstract Shape getShape() throws Exception;
@@ -438,8 +443,8 @@
* Draw the image in XOR mode at the specified position on screen. The
* position and the image is remembered for a later clear.
*
- * @param g
- * @throws Exception
+ * @param g the graphics context
+ * @throws Exception if an Exception occurs during drawing
*/
protected void drawImageXOR(Graphics2D g) throws Exception {
Image newImage = getImage();
@@ -502,7 +507,7 @@
/**
* Redraws the image on screen.
*
- * @throws Exception
+ * @throws Exception if an Exception occurs during drawing
*/
protected void redrawImage() throws Exception {
redrawImage(getGraphics2D());
@@ -628,6 +633,7 @@
/**
* Optional means of execution, with undoability.
+ * @param command undoable command to execute
*/
protected void execute(UndoableCommand command) {
AbstractPlugIn.execute(command, getPanel());
Modified:
core/trunk/src/com/vividsolutions/jump/workbench/ui/cursortool/Animations.java
===================================================================
---
core/trunk/src/com/vividsolutions/jump/workbench/ui/cursortool/Animations.java
2020-12-28 19:39:42 UTC (rev 6663)
+++
core/trunk/src/com/vividsolutions/jump/workbench/ui/cursortool/Animations.java
2020-12-28 19:49:02 UTC (rev 6664)
@@ -59,7 +59,10 @@
}
/**
+ * @param center center of the Animation in view coordinates
* @param expanding true to expand; false to contract
+ * @param color color of the animation
+ * @param panel LayerViewPanel to draw animation to
* @param dash null for no dashes
*/
public static void drawExpandingRing(Point2D center, boolean expanding,
Modified:
core/trunk/src/com/vividsolutions/jump/workbench/ui/cursortool/CoordinateListMetrics.java
===================================================================
---
core/trunk/src/com/vividsolutions/jump/workbench/ui/cursortool/CoordinateListMetrics.java
2020-12-28 19:39:42 UTC (rev 6663)
+++
core/trunk/src/com/vividsolutions/jump/workbench/ui/cursortool/CoordinateListMetrics.java
2020-12-28 19:49:02 UTC (rev 6664)
@@ -64,12 +64,12 @@
* Display the coordinates metrics with the option to compute the distance
for
* a closed geometry.
*
- * @param coordinates
- * @param panel
- * @param closedDistance
+ * @param coordinates list of coordinates
+ * @param panel the LayerViewPanel
+ * @param closedDistance true if coordinates represent a closed line (ring)
*/
public void displayMetrics(List coordinates, LayerViewPanel panel, boolean
closedDistance) {
- panel.getContext().setStatusMessage(getMetricsString(coordinates,
panel, closedDistance));
+ panel.getContext().setStatusMessage(getMetricsString(coordinates,
panel, closedDistance));
}
public String getMetricsString(List coordinates, LayerViewPanel panel)
@@ -83,9 +83,9 @@
* 14-3-2014 (Giuseppe Aruta) Added compute of last distance (between last
point
* and the cursor and the compute of azimuth
*
- * @param coordinates
- * @param panel
- * @param closedDistance
+ * @param coordinates list of coordinates
+ * @param panel the LayerViewPanel
+ * @param closedDistance true if coordinates represent a closed line (ring)
* @return the String representing the geometry metrics
*/
public String getMetricsString(List coordinates, LayerViewPanel panel,
boolean closedDistance)
@@ -117,8 +117,8 @@
* Computes the distance with the option to compute the distance for
* a closed geometry.
*
- * @param coordinates
- * @param closedDistance
+ * @param coordinates list of coordinates
+ * @param closedDistance true if coordinates represent a closed line (ring)
* @return the sum of the distance between coordinates
*/
public static double distance(List coordinates, boolean closedDistance)
@@ -138,7 +138,7 @@
/**
* Computes the angle between the last 2 segments in the coordinates list
*
- * @param coordinates
+ * @param coordinates list of coordinates
* @return the angle in degrees
*/
public static double angle(List coordinates)
@@ -160,8 +160,10 @@
/**
* Computes the area for the coordinates list.
- * The area is forcd to be positive.
+ * The area is forced to be positive.
* The coordinate list can be open, and the closing coordinate is supplied
+ * @param coordinates list of coordinates
+ * @return the area as a double
*/
private static double area(List coordinates)
{
@@ -185,7 +187,8 @@
* Giuseppe Aruta (Peppe - ma15569) 03-14-2014
* Computes the angle facing North (upper side of the view)
*
- * @param coordinates
+ * @param coordinates list of coordinates
+ * @param closedDistance true if coordinates represent a closed line (ring)
* @return the angle in degrees
*/
public static double azimuth(List coordinates, boolean closedDistance)
@@ -217,9 +220,9 @@
* Computes the angle between the last drawn segment
* and the position of the cursor
*
- * @param coordinates
- * @param closedDistance
- * @return the the distance between coordinates of last point and
coordinates of cursor
+ * @param coordinates list of coordinates
+ * @param closedDistance true if coordinates represent a closed line (ring)
+ * @return the distance between coordinates of last point and coordinates
of cursor
*/
public static double distancelast(List coordinates, boolean closedDistance)
{
@@ -241,8 +244,11 @@
}
/**
- * Giuseppe Aruta 2015_01_10 code from ConstrainedMamager.class return
+ * Giuseppe Aruta 2015_01_10 code from ConstrainedManager.class return
* Bearing in degrees (between EW axes, -180 to +180) from 2 coordinates
+ * @param coordinates list of coordinates
+ * @param closedDistance true if coordinates represent a closed line (ring)
+ * @return bearing in degrees
*/
public static double bearing(List coordinates, boolean closedDistance) {
Modified:
core/trunk/src/com/vividsolutions/jump/workbench/ui/cursortool/CursorToolPluginWrapper.java
===================================================================
---
core/trunk/src/com/vividsolutions/jump/workbench/ui/cursortool/CursorToolPluginWrapper.java
2020-12-28 19:39:42 UTC (rev 6663)
+++
core/trunk/src/com/vividsolutions/jump/workbench/ui/cursortool/CursorToolPluginWrapper.java
2020-12-28 19:49:02 UTC (rev 6664)
@@ -20,7 +20,7 @@
* make sure the cursor tool respects shortcuts by wrapping it into
* {@link com.vividsolutions.jump.workbench.ui.cursortool.QuasimodeTool}
*
- * @param cursorTool
+ * @param cursorTool the cursor tool
*/
public CursorToolPluginWrapper(CursorTool cursorTool) {
super();
Modified:
core/trunk/src/com/vividsolutions/jump/workbench/ui/cursortool/DragTool.java
===================================================================
---
core/trunk/src/com/vividsolutions/jump/workbench/ui/cursortool/DragTool.java
2020-12-28 19:39:42 UTC (rev 6663)
+++
core/trunk/src/com/vividsolutions/jump/workbench/ui/cursortool/DragTool.java
2020-12-28 19:49:02 UTC (rev 6664)
@@ -81,6 +81,7 @@
/**
* A click is converted into a box by being expanded by this amount in the
* four directions.
+ * @param clickBuffer buffer size in view coordinates
*/
protected void setViewClickBuffer(int clickBuffer) {
this.viewClickBuffer = clickBuffer;
@@ -184,7 +185,11 @@
}
/**
- *@return null if nothing should be drawn
+ * @param source initial position
+ * @param destination final position
+ * @return a Rectangle defined by the initial and final position or
+ * null if nothing should be drawn
+ * @throws Exception if an Exception occurs during the Rectangle
construction
*/
protected Shape getShape(Point2D source, Point2D destination)
throws Exception {
Modified:
core/trunk/src/com/vividsolutions/jump/workbench/ui/cursortool/MultiClickTool.java
===================================================================
---
core/trunk/src/com/vividsolutions/jump/workbench/ui/cursortool/MultiClickTool.java
2020-12-28 19:39:42 UTC (rev 6663)
+++
core/trunk/src/com/vividsolutions/jump/workbench/ui/cursortool/MultiClickTool.java
2020-12-28 19:49:02 UTC (rev 6664)
@@ -80,8 +80,10 @@
/**
* Will return an empty List once the shape is cleared.
+ *
+ * @return a list of clicked coordinates
*
- * @see MultiClickTool#clearShape
+ * @see MultiClickTool#clearShape()
*/
public List getCoordinates() {
return Collections.unmodifiableList(coordinates);
Modified:
core/trunk/src/com/vividsolutions/jump/workbench/ui/cursortool/PolygonTool.java
===================================================================
---
core/trunk/src/com/vividsolutions/jump/workbench/ui/cursortool/PolygonTool.java
2020-12-28 19:39:42 UTC (rev 6663)
+++
core/trunk/src/com/vividsolutions/jump/workbench/ui/cursortool/PolygonTool.java
2020-12-28 19:49:02 UTC (rev 6664)
@@ -52,6 +52,8 @@
/**
* Callers should check whether the polygon returned is valid.
+ * @return a Polygon
+ * @throws NoninvertibleTransformException if an exception occurs during
coordinate transformation
*/
protected Polygon getPolygon() throws NoninvertibleTransformException {
ArrayList closedPoints = new ArrayList(getCoordinates());
Modified:
core/trunk/src/com/vividsolutions/jump/workbench/ui/cursortool/SpecifyFeaturesTool.java
===================================================================
---
core/trunk/src/com/vividsolutions/jump/workbench/ui/cursortool/SpecifyFeaturesTool.java
2020-12-28 19:39:42 UTC (rev 6663)
+++
core/trunk/src/com/vividsolutions/jump/workbench/ui/cursortool/SpecifyFeaturesTool.java
2020-12-28 19:49:02 UTC (rev 6664)
@@ -46,27 +46,26 @@
* around them. Works with invalid features (using EnvelopeIntersector).
*/
public abstract class SpecifyFeaturesTool extends DragTool {
+
public SpecifyFeaturesTool() {
}
- protected Iterator candidateLayersIterator() {
+ protected Iterator<Layer> candidateLayersIterator() {
return getPanel().getLayerManager().iterator();
}
/**
+ * @param layer a Layer
* @param envelope
* the envelope, which may have zero area
* @return those features of the layer that intersect the given
envelope; an
* empty FeatureCollection if no features intersect it
*/
- private static Set intersectingFeatures(Layer layer, Envelope envelope)
{
- HashSet intersectingFeatures = new HashSet();
- List candidateFeatures =
layer.getFeatureCollectionWrapper().query(
+ private static Set<Feature> intersectingFeatures(Layer layer, Envelope
envelope) {
+ HashSet<Feature> intersectingFeatures = new HashSet<>();
+ List<Feature> candidateFeatures =
layer.getFeatureCollectionWrapper().query(
envelope);
- //String a = "" +
layer.getFeatureCollectionWrapper().getUltimateWrappee();
- //String b = "" +
layer.getFeatureCollectionWrapper().getUltimateWrappee().size();
- for (Iterator i = candidateFeatures.iterator(); i.hasNext();) {
- Feature feature = (Feature) i.next();
+ for (Feature feature : candidateFeatures) {
// optimization - if the feature envelope is completely
inside the
// query envelope it must be selected
@@ -91,12 +90,10 @@
}
}
- protected Set specifiedFeatures() throws
NoninvertibleTransformException {
- HashSet allFeatures = new LinkedHashSet();
+ protected Set<Feature> specifiedFeatures() throws
NoninvertibleTransformException {
+ HashSet<Feature> allFeatures = new LinkedHashSet<>();
- for (Iterator i =
layerToSpecifiedFeaturesMap().values().iterator(); i
- .hasNext();) {
- Set features = (Set) i.next();
+ for (Set<Feature> features :
layerToSpecifiedFeaturesMap().values()) {
allFeatures.addAll(features);
}
@@ -106,26 +103,28 @@
/**
* Returns the layers containing the specified features, and the
specified
* features themselves.
+ * @return a Map mapping layers to features of this layer and
intersecting the box
+ * @throws NoninvertibleTransformException if a problem occurs during
intersection operation
*/
- protected Map layerToSpecifiedFeaturesMap()
+ protected Map<Layer,Set<Feature>> layerToSpecifiedFeaturesMap()
throws NoninvertibleTransformException {
return layerToSpecifiedFeaturesMap(candidateLayersIterator(),
getBoxInModelCoordinates());
}
- public static Map layerToSpecifiedFeaturesMap(Iterator layerIterator,
+ public static Map<Layer,Set<Feature>>
layerToSpecifiedFeaturesMap(Iterator<Layer> layerIterator,
Envelope boxInModelCoordinates)
throws NoninvertibleTransformException {
- HashMap layerToFeaturesMap = new HashMap();
+ HashMap<Layer,Set<Feature>> layerToFeaturesMap = new
HashMap<>();
- for (Iterator i = layerIterator; i.hasNext();) {
- Layer layer = (Layer) i.next();
+ while (layerIterator.hasNext()) {
+ Layer layer = layerIterator.next();
if (!layer.isVisible()) {
continue;
}
- Set intersectingFeatures = intersectingFeatures(layer,
+ Set<Feature> intersectingFeatures =
intersectingFeatures(layer,
boxInModelCoordinates);
if (intersectingFeatures.isEmpty()) {
@@ -139,24 +138,22 @@
}
/**
- * @param layers
- * Layers to filter in
+ * @param layers Layers to filter in
+ * @return a collection of features belonging to layers and
intersecting the box
+ * @throws NoninvertibleTransformException if a problem occurs during
intersection operation
*/
- protected Collection specifiedFeatures(Collection layers)
+ protected Collection<Feature> specifiedFeatures(Collection<Layer>
layers)
throws NoninvertibleTransformException {
- ArrayList specifiedFeatures = new ArrayList();
- Map layerToSpecifiedFeaturesMap = layerToSpecifiedFeaturesMap();
+ ArrayList<Feature> specifiedFeatures = new ArrayList<>();
+ Map<Layer,Set<Feature>> layerToSpecifiedFeaturesMap =
layerToSpecifiedFeaturesMap();
- for (Iterator i =
layerToSpecifiedFeaturesMap.keySet().iterator(); i
- .hasNext();) {
- Layer layer = (Layer) i.next();
+ for (Layer layer : layerToSpecifiedFeaturesMap.keySet()) {
if (!layers.contains(layer)) {
continue;
}
- specifiedFeatures.addAll((Collection)
layerToSpecifiedFeaturesMap
- .get(layer));
+
specifiedFeatures.addAll(layerToSpecifiedFeaturesMap.get(layer));
}
return specifiedFeatures;
Modified:
core/trunk/src/com/vividsolutions/jump/workbench/ui/plugin/datastore/AddDatastoreLayerPlugIn.java
===================================================================
---
core/trunk/src/com/vividsolutions/jump/workbench/ui/plugin/datastore/AddDatastoreLayerPlugIn.java
2020-12-28 19:39:42 UTC (rev 6663)
+++
core/trunk/src/com/vividsolutions/jump/workbench/ui/plugin/datastore/AddDatastoreLayerPlugIn.java
2020-12-28 19:49:02 UTC (rev 6664)
@@ -17,7 +17,7 @@
import javax.swing.ImageIcon;
/**
- * @see {@link org.openjump.core.ui.plugin.datastore.AddDataStoreLayerWizard}
+ * @see org.openjump.core.ui.plugin.datastore.AddDataStoreLayerWizard
*/
@Deprecated
public class AddDatastoreLayerPlugIn extends AbstractAddDatastoreLayerPlugIn {
Modified:
core/trunk/src/com/vividsolutions/jump/workbench/ui/plugin/imagery/ImageryUtils.java
===================================================================
---
core/trunk/src/com/vividsolutions/jump/workbench/ui/plugin/imagery/ImageryUtils.java
2020-12-28 19:39:42 UTC (rev 6663)
+++
core/trunk/src/com/vividsolutions/jump/workbench/ui/plugin/imagery/ImageryUtils.java
2020-12-28 19:49:02 UTC (rev 6664)
@@ -65,7 +65,7 @@
* : ex. C:/Folder/file.tif
* @param bufferedImage
* : BufferedImage from a layer
- * @return
+ * @return true if the image has been saved
*/
@Deprecated
public static boolean saveToTiff(File tiffFile, BufferedImage
bufferedImage) {
@@ -104,11 +104,10 @@
*
* @param pngFile
* : ex. C:/Folder/file.png
- * @param bufferedImage
+ * @param image
* : BufferedImage from a layer
- * @return
+ * @return true if the image has been saved
*/
-
public static boolean saveToPng(File pngFile, BufferedImage image) {
try {
ImageIO.write(image, "png", pngFile);
@@ -124,9 +123,9 @@
/**
@@ Diff output truncated at 100000 characters. @@
_______________________________________________
Jump-pilot-devel mailing list
[email protected]
https://lists.sourceforge.net/lists/listinfo/jump-pilot-devel
