org.h2gis.utilities

Class SFSUtilities

java.lang.Object

org.h2gis.utilities.SFSUtilities

public class SFSUtilities
extends Object

Generic utilities function to retrieve spatial metadata trough SFS specification. Compatible with H2 and PostGIS.

Author:

Nicolas Fortin, Sylvain PALOMINOS (UBS 2018)

Constructor Summary

Constructors

Constructor and Description
SFSUtilities()

Method Summary

Modifier and Type	Method and Description
static void	addTableSRIDConstraint(Connection connection, TableLocation tableLocation, int srid) Alter a table to add a SRID constraint.
static String[]	getAuthorityAndSRID(Connection connection, TableLocation table, String fieldName) Return an array of two string that correspond to the authority name and its SRID code.
static int	getFirstGeometryFieldIndex(ResultSet resultSet) Find the first geometry field name of a resultSet.
static String	getFirstGeometryFieldName(ResultSet resultSet) Find the first geometry field name of a resultSet.
static List<String>	getGeometryFields(Connection connection, String catalog, String schema, String table) Find geometry fields name of a table.
static List<String>	getGeometryFields(Connection connection, TableLocation location) Find geometry fields name of a table.
static List<String>	getGeometryFields(ResultSet resultSet) Find geometry fields name of a resultSet.
static int	getGeometryType(Connection connection, TableLocation location, String fieldName) Return the sfs geometry type identifier of the provided field of the provided table.
static int	getGeometryTypeFromGeometry(org.locationtech.jts.geom.Geometry geometry) Return the sfs geometry type identifier of the provided Geometry
static String	getGeometryTypeNameFromCode(int geometryTypeCode)
static Map<String,Integer>	getGeometryTypes(Connection connection, TableLocation location) Returns a map containing the field names as key and the SFS geometry type as value from the given table.
static org.locationtech.jts.geom.Envelope	getResultSetEnvelope(ResultSet resultSet) Compute the full extend of a ResultSet using the first geometry field.
static org.locationtech.jts.geom.Envelope	getResultSetEnvelope(ResultSet resultSet, String fieldName) Compute the full extend of a ResultSet using a specified geometry field.
static int	getSRID(Connection connection, TableLocation table) Return the SRID of the first geometry column of the input table
static int	getSRID(Connection connection, TableLocation table, String fieldName) Return the srid of a table for a given field name.
static org.locationtech.jts.geom.Envelope	getTableEnvelope(Connection connection, TableLocation location, String geometryField) Merge the bounding box of all geometries inside the provided table.
static boolean	hasGeometryField(ResultSet resultSet) Check if the ResultSet contains a geometry field
static PreparedStatement	prepareInformationSchemaStatement(Connection connection, String catalog, String schema, String table, String informationSchemaTable, String endQuery) For table containing catalog, schema and table name, this function create a prepared statement with a filter on this combination.
static PreparedStatement	prepareInformationSchemaStatement(Connection connection, String catalog, String schema, String table, String informationSchemaTable, String endQuery, String catalog_field, String schema_field, String table_field) For table containing catalog, schema and table name, this function create a prepared statement with a filter on this combination.
static Connection	wrapConnection(Connection connection) Use this only if DataSource is not available.
static DataSource	wrapSpatialDataSource(DataSource dataSource) In order to be able to use Wrapper.unwrap(Class) and Wrapper.unwrap(Class) to get SpatialResultSet and SpatialResultSetMetaData this method wrap the provided dataSource.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

SFSUtilities

public SFSUtilities()

Method Detail

getGeometryTypeNameFromCode

public static String getGeometryTypeNameFromCode(int geometryTypeCode)

getGeometryTypeFromGeometry

public static int getGeometryTypeFromGeometry(org.locationtech.jts.geom.Geometry geometry)

Return the sfs geometry type identifier of the provided Geometry

Parameters:

geometry - Geometry instance

Returns:

The sfs geometry type identifier

getGeometryType

public static int getGeometryType(Connection connection,
                                  TableLocation location,
                                  String fieldName)
                           throws SQLException

Return the sfs geometry type identifier of the provided field of the provided table.

Parameters:

connection - Active connection

location - Catalog, schema and table name

fieldName - Geometry field name or empty (take the first one)

Returns:

The sfs geometry type identifier

Throws:

SQLException

See Also:

GeometryTypeCodes

getGeometryTypes

public static Map<String,Integer> getGeometryTypes(Connection connection,
                                                   TableLocation location)
                                            throws SQLException

Returns a map containing the field names as key and the SFS geometry type as value from the given table.

Parameters:

connection - Active connection

location - Catalog, schema and table name

Returns:

A map containing the geometric fields names as key and the SFS geometry type as value.

Throws:

SQLException

See Also:

GeometryTypeCodes

wrapSpatialDataSource

public static DataSource wrapSpatialDataSource(DataSource dataSource)

In order to be able to use Wrapper.unwrap(Class) and Wrapper.unwrap(Class) to get SpatialResultSet and SpatialResultSetMetaData this method wrap the provided dataSource.

Parameters:

dataSource - H2 or PostGIS DataSource

Returns:

Wrapped DataSource, with spatial methods

wrapConnection

public static Connection wrapConnection(Connection connection)

Use this only if DataSource is not available. In order to be able to use Wrapper.unwrap(Class) and Wrapper.unwrap(Class) to get SpatialResultSet and SpatialResultSetMetaData this method wrap the provided connection.

Parameters:

connection - H2 or PostGIS Connection

Returns:

Wrapped DataSource, with spatial methods

getTableEnvelope

public static org.locationtech.jts.geom.Envelope getTableEnvelope(Connection connection,
                                                                  TableLocation location,
                                                                  String geometryField)
                                                           throws SQLException

Merge the bounding box of all geometries inside the provided table.

Parameters:

connection - Active connection (not closed by this function)

location - Location of the table

geometryField - Geometry field or empty string (take the first geometry field)

Returns:

Envelope of the table

Throws:

SQLException - If the table not exists, empty or does not contain a geometry field.

getGeometryFields

public static List<String> getGeometryFields(Connection connection,
                                             TableLocation location)
                                      throws SQLException

Find geometry fields name of a table.

Parameters:

connection - Active connection

location - Table location

Returns:

A list of Geometry fields name

Throws:

SQLException

prepareInformationSchemaStatement

public static PreparedStatement prepareInformationSchemaStatement(Connection connection,
                                                                  String catalog,
                                                                  String schema,
                                                                  String table,
                                                                  String informationSchemaTable,
                                                                  String endQuery,
                                                                  String catalog_field,
                                                                  String schema_field,
                                                                  String table_field)
                                                           throws SQLException

For table containing catalog, schema and table name, this function create a prepared statement with a filter on this combination.

Parameters:

connection - Active connection

catalog - Table catalog, may be empty

schema - Table schema, may be empty

table - Table name

informationSchemaTable - Information table location

endQuery - Additional where statement

catalog_field - Catalog field name

schema_field - Schema field name

table_field - Table field name

Returns:

Prepared statement

Throws:

SQLException

prepareInformationSchemaStatement

public static PreparedStatement prepareInformationSchemaStatement(Connection connection,
                                                                  String catalog,
                                                                  String schema,
                                                                  String table,
                                                                  String informationSchemaTable,
                                                                  String endQuery)
                                                           throws SQLException

For table containing catalog, schema and table name, this function create a prepared statement with a filter on this combination. Use "f_table_catalog","f_table_schema","f_table_name" as field names.

Parameters:

connection - Active connection

catalog - Table catalog, may be empty

schema - Table schema, may be empty

table - Table name

informationSchemaTable - Information table location

endQuery - Additional where statement

Returns:

Prepared statement

Throws:

SQLException

getGeometryFields

public static List<String> getGeometryFields(Connection connection,
                                             String catalog,
                                             String schema,
                                             String table)
                                      throws SQLException

Find geometry fields name of a table.

Parameters:

connection - Active connection

catalog - Catalog that contain schema (empty for default catalog)

schema - Schema that contain table (empty for default schema)

table - Table name (case insensitive)

Returns:

A list of Geometry fields name

Throws:

SQLException

getGeometryFields

public static List<String> getGeometryFields(ResultSet resultSet)
                                      throws SQLException

Find geometry fields name of a resultSet.

Parameters:

resultSet - ResultSet to analyse

Returns:

A list of Geometry fields name

Throws:

SQLException

getFirstGeometryFieldIndex

public static int getFirstGeometryFieldIndex(ResultSet resultSet)
                                      throws SQLException

Find the first geometry field name of a resultSet. Return -1 if there is no geometry column

Parameters:

resultSet - ResultSet to analyse

Returns:

The index of first Geometry field

Throws:

SQLException

getFirstGeometryFieldName

public static String getFirstGeometryFieldName(ResultSet resultSet)
                                        throws SQLException

Find the first geometry field name of a resultSet. Return -1 if there is no geometry column

Parameters:

resultSet - ResultSet to analyse

Returns:

The name of first geometry field

Throws:

SQLException

hasGeometryField

public static boolean hasGeometryField(ResultSet resultSet)
                                throws SQLException

Check if the ResultSet contains a geometry field

Parameters:

resultSet - ResultSet to analyse

Returns:

True if the ResultSet contains one geometry field

Throws:

SQLException

getResultSetEnvelope

public static org.locationtech.jts.geom.Envelope getResultSetEnvelope(ResultSet resultSet)
                                                               throws SQLException

Compute the full extend of a ResultSet using the first geometry field. If the ResultSet does not contain any geometry field throw an exception

Parameters:

resultSet - ResultSet to analyse

Returns:

The full envelope of the ResultSet

Throws:

SQLException

getResultSetEnvelope

public static org.locationtech.jts.geom.Envelope getResultSetEnvelope(ResultSet resultSet,
                                                                      String fieldName)
                                                               throws SQLException

Compute the full extend of a ResultSet using a specified geometry field. If the ResultSet does not contain this geometry field throw an exception

Parameters:

resultSet - ResultSet to analyse

fieldName - Field to analyse

Returns:

The full extend of the field in the ResultSet

Throws:

SQLException

getSRID

public static int getSRID(Connection connection,
                          TableLocation table)
                   throws SQLException

Return the SRID of the first geometry column of the input table

Parameters:

connection - Active connection

table - Table name

Returns:

The SRID of the first geometry column

Throws:

SQLException

getSRID

public static int getSRID(Connection connection,
                          TableLocation table,
                          String fieldName)
                   throws SQLException

Return the srid of a table for a given field name. If the specified field isn't geometric, return 0.

Parameters:

connection - Active connection

table - Table name

fieldName - Field to analyse

Returns:

The SRID of the field

Throws:

SQLException

getAuthorityAndSRID

public static String[] getAuthorityAndSRID(Connection connection,
                                           TableLocation table,
                                           String fieldName)
                                    throws SQLException

Return an array of two string that correspond to the authority name and its SRID code. If the SRID does not exist return the array {null, null}

Parameters:

connection - Active connection

table - Table name

fieldName - Field to analyse

Returns:

Array of two string that correspond to the authority name and its SRID code

Throws:

SQLException

addTableSRIDConstraint

public static void addTableSRIDConstraint(Connection connection,
                                          TableLocation tableLocation,
                                          int srid)
                                   throws SQLException

Alter a table to add a SRID constraint. The srid must be greater than zero.

Parameters:

connection - Active connection

tableLocation - TableLocation of the table to update

srid - SRID to set

Throws:

SQLException