Fix doc

orbisgis · Oct 30, 2024 · d9a5a65 · d9a5a65
1 parent 390cfaa
commit d9a5a65
Show file tree

Hide file tree

Showing 4 changed files with 54 additions and 68 deletions.
diff --git a/h2gis-functions/src/main/java/org/h2gis/functions/io/kml/KMLWriterDriver.java b/h2gis-functions/src/main/java/org/h2gis/functions/io/kml/KMLWriterDriver.java
@@ -177,8 +177,7 @@ private void writeKML(ProgressVisitor progress,File fileName,ResultSet rs,String
      * Write the spatial table to a KMZ format
      *
      * @param progress Progress visitor following the execution.
-     * @param fileNameWithExtension
-     * @throws SQLException
+     * @param fileNameWithExtension file name
      */
     private void writeKMZ(ProgressVisitor progress,File fileName, String fileNameWithExtension, ResultSet rs,String geomField,  String encoding) throws SQLException {
         ZipOutputStream zos = null;
@@ -216,8 +215,7 @@ private void writeKMZ(ProgressVisitor progress,File fileName, String fileNameWit
      * column in the placeMark element. The other geomtry columns are ignored.
      *
      * @param progress Progress visitor following the execution.
-     * @param outputStream
-     * @throws SQLException
+     * @param outputStream {@link FileOutputStream}
      */
     private void writeKMLDocument(ProgressVisitor progress, OutputStream outputStream, ResultSet rs, String geomField,  String encoding) throws SQLException {
         try {
@@ -278,8 +276,8 @@ private void writeKMLDocument(ProgressVisitor progress, OutputStream outputStrea
      * </SimpleField>
      * </Schema>
      *
-     * @param xmlOut
-     * @param metaData
+     * @param xmlOut {@link XMLStreamWriter}
+     * @param metaData {@link ResultSetMetaData}
      */
     private void writeSchema(XMLStreamWriter xmlOut, ResultSetMetaData metaData) throws XMLStreamException, SQLException {
         columnCount = metaData.getColumnCount();
@@ -313,10 +311,9 @@ private void writeSchema(XMLStreamWriter xmlOut, ResultSetMetaData metaData) thr
      *
      * <SimpleField type="string" name="string">
      *
-     * @param xmlOut
-     * @param columnName
-     * @param columnType
-     * @throws XMLStreamException
+     * @param xmlOut {@link XMLStreamWriter}
+     * @param columnName column name
+     * @param columnType column type
      */
     private void writeSimpleField(XMLStreamWriter xmlOut, String columnName, String columnType) throws XMLStreamException {
         xmlOut.writeStartElement("SimpleField");
@@ -352,9 +349,9 @@ private void writeSimpleField(XMLStreamWriter xmlOut, String columnName, String
      * </Placemark>
      * }
      *
-     * @param xmlOut
-     * @param rs
-     * @param geomField
+     * @param xmlOut {@link XMLStreamWriter}
+     * @param rs {@link ResultSet}
+     * @param geomField geometry column
      */
     public void writePlacemark(XMLStreamWriter xmlOut, ResultSet rs, String geomField) throws XMLStreamException, SQLException {
         xmlOut.writeStartElement("Placemark");
@@ -403,7 +400,7 @@ public void writePlacemark(XMLStreamWriter xmlOut, ResultSet rs, String geomFiel
      * </ExtendedData>
      * }
      *
-     * @param xmlOut
+     * @param xmlOut {@link XMLStreamWriter}
      */
     public void writeExtendedData(XMLStreamWriter xmlOut, ResultSet rs) throws XMLStreamException, SQLException {
         xmlOut.writeStartElement("ExtendedData");
@@ -421,7 +418,7 @@ public void writeExtendedData(XMLStreamWriter xmlOut, ResultSet rs) throws XMLSt
 
     /**
      *
-     * @param xmlOut
+     * @param xmlOut {@link XMLStreamWriter}
      */
     public void writeSimpleData(XMLStreamWriter xmlOut, String columnName, String value) throws XMLStreamException {
         xmlOut.writeStartElement("SimpleData");
@@ -433,10 +430,9 @@ public void writeSimpleData(XMLStreamWriter xmlOut, String columnName, String va
     /**
      * Return the kml type representation from SQL data type
      *
-     * @param sqlTypeId
-     * @param sqlTypeName
-     * @return
-     * @throws SQLException
+     * @param sqlTypeId sql type code
+     * @param sqlTypeName sql type name
+     * @return kml type
      */
     private static String getKMLType(int sqlTypeId, String sqlTypeName) throws SQLException {
         switch (sqlTypeId) {

diff --git a/h2gis-functions/src/main/java/org/h2gis/functions/io/osm/OSMElement.java b/h2gis-functions/src/main/java/org/h2gis/functions/io/osm/OSMElement.java
@@ -51,7 +51,7 @@ public OSMElement() {
     /**
      * The id of the element
      *
-     * @return
+     * @return id value
      */
     public long getID() {
         return id;
@@ -60,7 +60,7 @@ public long getID() {
     /**
      * Set an id to the element
      *
-     * @param id
+     * @param id set id value
      */
     public void setId(String id) {
         this.id = Long.valueOf(id);
@@ -69,7 +69,7 @@ public void setId(String id) {
     /**
      * The user
      *
-     * @return
+     * @return user value
      */
     public String getUser() {
         return user;
@@ -105,7 +105,7 @@ public void setName(String name) {
 
     /**
      *
-     * @return
+     * @return true if visible
      */
     public boolean getVisible() {
         return visible;
@@ -119,7 +119,7 @@ public void setVisible(String visible) {
 
     /**
      *
-     * @return
+     * @return GPX version
      */
     public int getVersion() {
         return version;
@@ -131,7 +131,7 @@ public void setVersion(String version) {
 
     /**
      *
-     * @return
+     * @return change set value
      */
     public int getChangeSet() {
         return changeset;
@@ -145,7 +145,7 @@ public void setChangeset(String changeset) {
 
     /**
      *
-     * @return
+     * @return time stamp
      */
     public Timestamp getTimeStamp() {
         return timestamp;
@@ -167,8 +167,8 @@ public void setTimestamp(String OSMtime) throws SAXException {
 
     /**
      *
-     * @param key
-     * @param value
+     * @param key key value
+     * @param value value
      * @return True if the tag should be inserted in the tag table.
      */
     public boolean addTag(String key, String value) {

diff --git a/h2gis-functions/src/main/java/org/h2gis/functions/io/osm/OSMTablesFactory.java b/h2gis-functions/src/main/java/org/h2gis/functions/io/osm/OSMTablesFactory.java
@@ -105,10 +105,9 @@ public static PreparedStatement createNodeTable(Connection connection, String no
     /**
      * Create a table to store the node tags.
      *
-     * @param connection
-     * @param nodeTagTableName
-     * @return
-     * @throws SQLException
+     * @param connection database
+     * @param nodeTagTableName table name
+     * @return PreparedStatement
      */
     public static PreparedStatement createNodeTagTable(Connection connection, String nodeTagTableName) throws SQLException {
         try (Statement stmt = connection.createStatement()) {
@@ -128,10 +127,9 @@ public static PreparedStatement createNodeTagTable(Connection connection, String
      * changeset="4142606" timestamp="2010-03-16T11:47:08Z">
      * }
      *
-     * @param connection
-     * @param wayTableName
-     * @return
-     * @throws SQLException
+     * @param connection database
+     * @param wayTableName table name
+     * @return PreparedStatement
      */
     public static PreparedStatement createWayTable(Connection connection, String wayTableName) throws SQLException {
         try (Statement stmt = connection.createStatement()) {
@@ -146,10 +144,9 @@ public static PreparedStatement createWayTable(Connection connection, String way
     /**
      * Create a table to store the way tags.
      *
-     * @param connection
-     * @param wayTagTableName
-     * @return
-     * @throws SQLException
+     * @param connection database
+     * @param wayTagTableName table name
+     * @return PreparedStatement
      */
     public static PreparedStatement createWayTagTable(Connection connection, String wayTagTableName) throws SQLException {
         try (Statement stmt = connection.createStatement()) {
@@ -164,10 +161,9 @@ public static PreparedStatement createWayTagTable(Connection connection, String
     /**
      * Create a table to store the list of nodes for each way.
      *
-     * @param connection
-     * @param wayNodeTableName
-     * @return
-     * @throws SQLException
+     * @param connection database
+     * @param wayNodeTableName table name
+     * @return PreparedStatement
      */
     public static PreparedStatement createWayNodeTable(Connection connection, String wayNodeTableName) throws SQLException{
         try (Statement stmt = connection.createStatement()) {
@@ -182,10 +178,9 @@ public static PreparedStatement createWayNodeTable(Connection connection, String
     /**
      * Create the relation table.
      *
-     * @param connection
-     * @param relationTable
-     * @return
-     * @throws SQLException
+     * @param connection database
+     * @param relationTable table name
+     * @return PreparedStatement
      */
     public static PreparedStatement createRelationTable(Connection connection, String relationTable) throws SQLException {
         try (Statement stmt = connection.createStatement()) {
@@ -206,10 +201,9 @@ public static PreparedStatement createRelationTable(Connection connection, Strin
     /**
      * Create the relation tags table
      *
-     * @param connection
-     * @param relationTagTable
-     * @return
-     * @throws SQLException
+     * @param connection database
+     * @param relationTagTable table name
+     * @return PreparedStatement
      */
     public static PreparedStatement createRelationTagTable(Connection connection, String relationTagTable) throws SQLException {
         try (Statement stmt = connection.createStatement()) {
@@ -224,10 +218,9 @@ public static PreparedStatement createRelationTagTable(Connection connection, St
     /**
      * Create the node members table
      *
-     * @param connection
-     * @param nodeMemberTable
-     * @return
-     * @throws SQLException
+     * @param connection database
+     * @param nodeMemberTable table name
+     * @return PreparedStatement
      */
     public static PreparedStatement createNodeMemberTable(Connection connection, String nodeMemberTable) throws SQLException {
         try (Statement stmt = connection.createStatement()) {
@@ -242,10 +235,9 @@ public static PreparedStatement createNodeMemberTable(Connection connection, Str
     /**
      * Create a table to store all way members.
      *
-     * @param connection
-     * @param wayMemberTable
-     * @return
-     * @throws SQLException
+     * @param connection database
+     * @param wayMemberTable table name
+     * @return PreparedStatement
      */
     public static PreparedStatement createWayMemberTable(Connection connection, String wayMemberTable) throws SQLException {
         try (Statement stmt = connection.createStatement()) {
@@ -260,10 +252,9 @@ public static PreparedStatement createWayMemberTable(Connection connection, Stri
     /**
      * Store all relation members
      *
-     * @param connection
-     * @param relationMemberTable
-     * @return
-     * @throws SQLException
+     * @param connection database
+     * @param relationMemberTable table name
+     * @return PreparedStatement
      */
     public static PreparedStatement createRelationMemberTable(Connection connection, String relationMemberTable) throws SQLException {
         try (Statement stmt = connection.createStatement()) {
@@ -279,9 +270,8 @@ public static PreparedStatement createRelationMemberTable(Connection connection,
     /**
      * Drop the existing OSM tables used to store the imported OSM data 
      *
-     * @param connection
-     * @param tablePrefix
-     * @throws SQLException
+     * @param connection database
+     * @param tablePrefix table prefix
      */
     public static void dropOSMTables(Connection connection, String tablePrefix) throws SQLException {
         final DBTypes dbType = DBUtils.getDBType(connection);

diff --git a/h2gis-functions/src/main/java/org/h2gis/functions/io/overpass/ST_AsOverpassBbox.java b/h2gis-functions/src/main/java/org/h2gis/functions/io/overpass/ST_AsOverpassBbox.java
@@ -44,7 +44,7 @@ public String getJavaStaticMethod() {
     /**
      * Return a string representation of the Geometry envelope conform
      * to be overpass format :
-     * south, west, north, east -> minY,minX, maxY, maxX
+     * south, west, north, east :  minY,minX, maxY, maxX
      *
      *
      * @param geom input geometry