Skip to content

Commit

Permalink
Fix doc
Browse files Browse the repository at this point in the history
  • Loading branch information
ebocher committed Nov 8, 2024
1 parent abe99e1 commit 0899e8b
Show file tree
Hide file tree
Showing 24 changed files with 52 additions and 59 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -73,8 +73,9 @@ public static void importTable(Connection connection, String fileName) throws IO
/**
* Read the GeoJSON file.
*
* @param connection database * @param fileName input file
* @param option
* @param connection database
* @param fileName input file
* @param option file option
*/
public static void importTable(Connection connection, String fileName, Value option) throws IOException, SQLException {
String tableReference = null;
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -231,9 +231,9 @@ private void geojsonWriter(ProgressVisitor progress, ResultSet rs, OutputStream
* Method to write a table to a geojson file
*
* @param progress Progress visitor following the execution.
* @param tableName
* @param fos
* @param encoding
* @param tableName table name
* @param fos {@link OutputStream}
* @param encoding file encoding
*/
private void geojsonWriter(ProgressVisitor progress, String tableName, OutputStream fos, String encoding) throws SQLException, IOException {
DBTypes dbTypes = DBUtils.getDBType(connection);
Expand Down Expand Up @@ -300,7 +300,7 @@ private void geojsonWriter(ProgressVisitor progress, String tableName, OutputStr
* Write the spatial table to GeoJSON format.
*
* @param progress Progress visitor following the execution.
* @param tableName
* @param tableName table name
* @param fileName input file
* @param encoding file encoding
* @param deleteFile true to delete the file if exist
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -211,7 +211,7 @@ public void endElement(String uri, String localName, String qName) throws SAXExc
/**
* Set the parent of this specific parser.
*
* @param parent
* @param parent {@link AbstractGpxParserDefault}
*/
public void setParent(AbstractGpxParserDefault parent) {
this.parent = parent;
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -112,7 +112,7 @@ public void endElement(String uri, String localName, String qName) throws SAXExc
/**
* Set the parent of this specific parser.
*
* @param parent
* @param parent {@link AbstractGpxParserDefault}
*/
public void setParent(AbstractGpxParserDefault parent) {
this.parent = parent;
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -34,7 +34,6 @@ public class GPXCoordinate {
*
* @param attributes Attributes of the point. Here it is latitude and
* longitude
* @throws NumberFormatException
* @return a coordinate
*/
public static Coordinate createCoordinate(Attributes attributes) throws NumberFormatException {
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -60,9 +60,10 @@ public class GridRowSet implements SimpleRowSource {
/**
* The grid will be computed according a table stored in the database
*
* @param connection database * @param deltaX
* @param deltaY
* @param tableName
* @param connection database
* @param deltaX x size
* @param deltaY y size
* @param tableName table name
*/
public GridRowSet(Connection connection, double deltaX, double deltaY, String tableName) {
this.connection = connection;
Expand All @@ -75,9 +76,10 @@ public GridRowSet(Connection connection, double deltaX, double deltaY, String ta
/**
* The grid will be computed according the envelope of a geometry
*
* @param connection database * @param deltaX
* @param deltaY
* @param geometry
* @param connection database
* @param deltaX x size
* @param deltaY y size
* @param geometry {@link Geometry}
*/
public GridRowSet(Connection connection, double deltaX, double deltaY, Geometry geometry) {
this.connection = connection;
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -51,7 +51,6 @@ public String getJavaStaticMethod() {
* @param column_name name of the geomtry column
* @param srid value of the new srid
* @return true if the SRID is changed
* @throws SQLException
*/
public static boolean changeSRID(Connection connection, String table_name, String column_name, int srid) throws SQLException {
return changeSRID(connection, null, null, table_name, column_name, srid);
Expand All @@ -66,7 +65,6 @@ public static boolean changeSRID(Connection connection, String table_name, Strin
* @param column_name name of the geomtry column
* @param srid value of the new srid
* @return true if the SRID is changed
* @throws SQLException
*/
public static boolean changeSRID(Connection connection, String schema_name, String table_name, String column_name, int srid) throws SQLException {
return changeSRID(connection, null, schema_name, table_name, column_name, srid);
Expand All @@ -82,7 +80,6 @@ public static boolean changeSRID(Connection connection, String schema_name, Stri
* @param column_name name of the geomtry column
* @param srid value of the new srid
* @return true if the SRID is changed
* @throws SQLException
*/
public static boolean changeSRID(Connection connection, String catalog_name, String schema_name, String table_name, String column_name, int srid) throws SQLException {
TableLocation tableLocation = new TableLocation(catalog_name, schema_name, table_name, DBTypes.H2GIS);
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -79,9 +79,9 @@ public static Geometry addPoint(Geometry geometry, Point point) throws SQLExcept
* Returns a new geometry based on an existing one, with a specific point as
* a new vertex.
*
* @param geometry
* @param point
* @param position
* @param geometry {@link Geometry}
* @param point {@link Point}
* @param position index
* @return same geometry if the vertex cannot be inserted
* @throws SQLException If the vertex can be inserted but it makes the
* geometry to be in an invalid shape
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -65,9 +65,9 @@ public static Geometry insertPoint(Geometry geometry, Point point) throws SQLExc
* Returns a new geometry based on an existing one, with a specific point as
* a new vertex.
*
* @param geometry
* @param point
* @param tolerance
* @param geometry {@link Geometry}
* @param point {@link Point}
* @param tolerance tolerance
* @return Null if the vertex cannot be inserted
* @throws SQLException If the vertex can be inserted but it makes the
* geometry to be in an invalid shape
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -50,8 +50,8 @@ public String getJavaStaticMethod() {
/**
* Replace the z with same value. NaN values are also updated.
*
* @param geometry
* @param z
* @param geometry {@link Geometry}
* @param z z value
* @return geometry
*/
public static Geometry updateZ(Geometry geometry, double z) {
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -45,7 +45,7 @@ public class FullConvexHull

/**
* Create a new convex hull construction for the input {@link Geometry}.
* @param geometry
* @param geometry {@link Geometry}
*/
public FullConvexHull(Geometry geometry)
{
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -51,7 +51,7 @@ public String getJavaStaticMethod() {
* Build a constrained delaunay triangulation based on a geometry
* (point, line, polygon)
*
* @param geometry
* @param geometry {@link Geometry}
* @return a set of polygons (triangles)
*/
public static GeometryCollection createCDT(Geometry geometry) throws SQLException {
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -62,7 +62,7 @@ public static GeometryCollection createDT(Geometry geometry) throws SQLException
/**
* Build a delaunay triangulation based on all coordinates of the geometry
*
* @param geometry
* @param geometry {@link Geometry}
* @param flag for flag=0 (default flag) or a MULTILINESTRING for flag=1
* @return a set of polygons (triangles)
*/
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -59,7 +59,8 @@ public String getJavaStaticMethod() {

/**
* Explode Geometry Collection into multiple geometries
* @param connection database * @param tableName the name of the input table or select query
* @param connection database
* @param tableName the name of the input table or select query
* @return A result set with the same content of specified table but with atomic geometries and duplicate values.
*/
public static ResultSet explode(Connection connection, String tableName) throws SQLException {
Expand Down Expand Up @@ -168,7 +169,6 @@ public void close() {

/**
* Read the geometry value and explode it.
* @throws SQLException
*/
private void parseRow() throws SQLException {
sourceRowGeometries.clear();
Expand Down Expand Up @@ -263,9 +263,8 @@ public ResultSet getResultSet() throws SQLException {

/**
* Perform a fast copy of columns using a limit clause.
* @param rs
* @param selectQuery
* @throws SQLException
* @param rs {@link SimpleResultSet}
* @param selectQuery select query
*/
private void copyfields(SimpleResultSet rs, String selectQuery) throws SQLException {
Statement st = null;
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -51,7 +51,7 @@ public String getJavaStaticMethod() {

/**
* Project a point using a given distance and azimuth
* @param geometry
* @param geometry {@link Geometry}
* @param distance is given in meters
* @param azimuth is given in radians and measured clockwise from true north.
* @return a project point
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -112,10 +112,10 @@ public static ArrayList<SegmentString> getSegments(Geometry inputLines, Geometry
}

/**
* Convert the a geometry as a list of segments and mark it with a flag
* @param geometry
* @param flag
* @param segments
* Convert a geometry as a list of segments and mark it with a flag
* @param geometry {@link Geometry}
* @param flag mark
* @param segments array to fill
*/
public static void addGeometryToSegments(Geometry geometry, int flag, ArrayList<SegmentString> segments) {
for (int i = 0; i < geometry.getNumGeometries(); i++) {
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -409,13 +409,12 @@ private static String expand(String geom, double tol) {

/**
* Return the first and last coordinates table
* @param st
* @param tableName
* @param pkCol
* @param geomCol
* @param tolerance
* @param st {@link Statement}
* @param tableName table name
* @param pkCol primary key column name
* @param geomCol geometry column name
* @param tolerance distance
* @param columns an array of columns
* @throws SQLException
*/
private static void firstFirstLastLast(Statement st,
TableLocation tableName,
Expand Down Expand Up @@ -583,10 +582,9 @@ private static void edgesTable(Statement st,

/**
* Edges direction according the slope (start and end z)
* @param st
* @param nodesName
* @param edgesName
* @throws SQLException
* @param st {@link Statement}
* @param nodesName nodes table name
* @param edgesName edges table name
*/
private static void orientBySlope(Statement st,
TableLocation nodesName,
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -167,7 +167,7 @@ public static void assertGeometryBarelyEquals(String expectedWKT, Object resultS

/**
* Print a geometry content
* @param geometry
* @param geometry {@link Geometry}
*/
public static void printGeometry(Object geometry){
System.out.println(ValueGeometry.getFromGeometry(geometry).getString());
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -235,7 +235,7 @@ public boolean hasZ() {

/**
* Set SFS type code
* @param sfs_geometryTypeCode
* @param sfs_geometryTypeCode SFS geometry type code
*/
public void setSfs_geometryTypeCode(int sfs_geometryTypeCode) {
this.sfs_geometryTypeCode = sfs_geometryTypeCode;
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -55,7 +55,7 @@ public enum TABLE_TYPE {
/**
* Build a new {@code TABLE_TYPE} from a {@code String table_type_name}.
*
* @param table_type_name
* @param table_type_name table type
* @return A {@code TABLE_TYPE} value.
*/
public static TABLE_TYPE fromString(String table_type_name) {
Expand Down Expand Up @@ -817,8 +817,6 @@ public static TABLE_TYPE getTableType(Connection connection, TableLocation locat

/**
* A simple method to generate a DDL create table command from a table name
* <p>
* <p>
* Takes into account only data types
*
* @param connection database
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -31,7 +31,7 @@
public interface SpatialResultSetMetaData extends ResultSetMetaData {

/**
* @param column
* @param column column index
*
* @return {@link GeometryTypeCodes} of the provided column.
*
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -492,7 +492,6 @@ public static boolean splitInterval(double beginIncluded, double endExcluded,
* @param triangleData Triangle Coordinates and Marker values
* @param isoLvls Iso level to extract.
* @return processedTriangles Return sub-triangle corresponding to iso levels. iso level are stored in markers (same for m0,m1,m2)
* @throws TopologyException
*/
public static Map<Short, Deque<TriMarkers>> processTriangle(TriMarkers triangleData, List<Double> isoLvls) throws TopologyException {
TriMarkers currentTriangle = triangleData;
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -183,8 +183,8 @@ public static Vector3D getNormalVector(Triangle t) throws IllegalArgumentExcepti

/**
* Get the vector with the highest down slope in the plan.
* @param normal
* @param epsilon
* @param normal {@link Vector3D}
* @param epsilon tolerance
* @return the steepest vector.
*/
public static Vector3D getSteepestVector(final Vector3D normal, final double epsilon) {
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -57,7 +57,7 @@ public Driver() {
/**
* Mangles the PostGIS URL to return the original PostGreSQL URL.
*
* @param url
* @param url jdbc url
* @return Mangled PostGIS URL
*/
public static String mangleURL(String url) throws SQLException {
Expand Down

0 comments on commit 0899e8b

Please sign in to comment.