# All Classes and Interfaces

Class
Description
AbstractGpxParser
Abstract class of all Gpx-Parsers.
AbstractGpxParserDefault
Main class to parse the GPX file
AbstractGpxParserRte
Abstract class of the parsers dedicated to routes.
AbstractGpxParserTrk
Abstract class of the parsers dedicated to tracks.
AbstractGpxParserWpt
Abstract class of the parsers dedicated to waypoints.
AltitudeMode
Specifies how altitude components in the coordinates element are interpreted.
AscDriverFunction
Asc driver to import ESRI ASCII Raster file as polygons
AscRead
SQL function to import ESRI ASCII Raster file as points or polygons table.
AscReaderDriver
Driver to import ESRI ASCII Raster file as polygons This class is written to directly access the ESRI ascii grid format.
CoordinatesUtils
This utility class provides some useful methods related to JTS `Coordinate` objects.
CSVDriverFunction
Basic CSV importer and exporter
DbaseFileException
Thrown when an error relating to the shapefile occurs
DbaseFileHeader
Class to represent the header of a Dbase III file.
DbaseFileReader
A DbaseFileReader is used to read a dbase III format file.
DbaseFileWriter
A DbaseFileReader is used to read a dbase III format file.
DbaseFileWriter.FieldFormatter
Utility for formatting Dbase fields.
DBFDriver
Manage DBFReader and DBFWriter
DBFDriverFunction
DBFEngine
SHP Table factory.
DBFRead
DBFWrite
DelaunayData
This class is used to collect all data used to compute a mesh based on a Delaunay triangulation
DelaunayData.MODE
DoubleRange
DriverManager
Manage additional table engines in H2.
DummyIndex
When linked files are not available, this table index defines an empty table
DummyMVTable
When linked files are not available, this table defines an empty MV table
EditUtilities
Common utilities used by the edit functions
EPSGTuple
A simple tuple to manage both input and output CRSes used to build a `CoordinateOperation`
ExtrudeMode
Extrude mode specifies whether to connect the geometry to the ground.
FileEngine<Driver extends org.h2gis.api.FileDriver>
Implement theses abstract methods in order to define a file engine.
FindGeometryMetadata
FullConvexHull
Computes the convex hull of a `Geometry`.
GeoJsonDriverFunction
GeoJSON driver to import a GeoJSON file and export a spatial table in a GeoJSON 1.0 file.
GeoJsonField
GeoJson fields used by the standard.
GeoJsonRead
SQL function to read a GeoJSON file an creates the corresponding spatial table.
GeoJsonReaderDriver
Driver to import a GeoJSON file into a spatial table.
GeoJsonWrite
SQL function to write a spatial table to a GeoJSON file.
GeoJsonWriteDriver
A simple GeoJSON driver to write a spatial table to a GeoJSON file.
GeometryCoordinateDimension
This class is used to force the coordinate dimension of a geometry
GeometryExtrude
This class is used to extrude a polygon or a linestring to a set of walls, roof, or floor using a height.
GeometryExtrude.UpdateZValue
Update the z value.
GJGeometryReader
This class is used to convert a geojon geometry to a JTS geometry.
GPXCoordinate
This class is used to convert a waypoint to a coordinate
GPXDriverFunction
This class is used to read a GPX file
GPXLine
This class giving is used to manage route and track data
GpxMetadata
This class stores field information for a standard GPX file.
GpxParser
Default parser.
GpxParserRte
Specific parser for routes.
GpxParserTrk
Specific parser for tracks.
GpxParserWpt
Specific parser for waypoints.
GPXPoint
This class gives bvalues for every types of points (waypoint, routepoint and trackpoint).
GpxPreparser
GpxPreparser class just reads the document.
GPXRead
SQL Function to copy GPX File data into a Table.
GPXTablesFactory
A factory to create the tables that are used to import GPX data
GPXTags
A class to manage all GPXTags used to parse the GPX and create the tables
GridRowSet
GridRowSet is used to populate a result set with all grid cells.
H2GISDBFactory
Used to create quickly a database on unit tests.
H2GISFunctions
Add H2GIS features to an H2 database Execute the following sql to init spatial features :
H2GISversion
Return the current version of H2GIS stored in the manifest
H2MVTable
A MV table linked with a `FileDriver`
H2TableIndex
ScanIndex of `FileDriver`, the key is the row index [1-n].
H2TableIndex.DriverRow
This class is requiring only field value on demand instead of gathering the full row values from drivers
HexToVarBinary
Convert Hexadecimal string into an array of byte.
IndexFile
IndexFile parser for .shx files.
For now, the creation of index files is done in the ShapefileWriter.
IntegerRange
IOMethods
Utility methods to : - import, export a file in a database (H2GIS, POSTGIS) - export a table from another database (H2GIS, POSTGIS) - link a file or table (H2GIS only)
JsonDriverFunction
JsonWrite
SQL function to write a table to a JSON file.
JsonWriteDriver
JSON class to write a table or a resultset to a file
JTSVersion
Return the current version of JTS
KMLDriverFunction
A driver to export spatial table to kml 2.2 file.
KMLGeometry
Tools to convert JTS geometry to KML representation
KMLWrite
SQL Function to export a spatial table to a KML file.
KMLWriterDriver
KML writer
MakeValidOp
Operator to make a geometry valid.
MaxDistanceOp
An operation to compute the maximum distance between two geometries.
MultiLineHandler
The default JTS handler for shapefile.
MultiPointHandler
NodeOSMElement
A class to manage the node element properties.
OSMDriverFunction
OSMElement
A class to manage all common element properties.
OSMParser
Parse an OSM file and store the elements into a database.
OSMPreParser
OSMPreParser class just reads the document.
OSMRead
SQL Function to copy OSM File data into a set of tables.
OSMTablesFactory
Class to create the tables to import osm data An OSM file is stored in 10 tables
OSMTags
Commons elments used by the OSM format
PointHandler
Wrapper for a Shapefile point.
PolygonHandler
Wrapper for a Shapefile polygon.
PRJUtil
A class to manage PRJ file
ReadBufferManager
ShapefileException
Thrown when an error relating to the shapefile occures
ShapefileHeader
ShapefileReader
The general use of this class is: FileChannel in = new FileInputStream("thefile.dbf").getChannel(); ShapefileReader r = new ShapefileReader( in ) while (r.hasNext()) { Geometry shape = (Geometry) r.nextRecord().shape() // do stuff } r.close(); You don't have to immediately ask for the shape from the record.
ShapefileWriter
ShapefileWriter allows for the storage of geometries in esris shp format.
ShapeHandler
A ShapeHandler defines what is needed to construct and persist geometries based upon the shapefile specification.
ShapeType
Not much but a type safe enumeration of file types as ints and names.
SHPDriver
Merge ShapeFileReader and DBFReader.
SHPDriverFunction
Read/Write Shape files
SHPEngine
SHP Table factory.
SHPRead
SQL Function to copy Shape File data into a Table.
SHPWrite
SQL Function to read a table and write it into a shape file.
SpatialRefRegistry
This class builds a registry based on a spatial_ref_sys table stored in the H2 database.
ST_3DArea
Compute the 3D area of a polygon or a multiolygon.
ST_3DLength
ST_3DLength returns the 3D length (of a LineString) or the 3D perimeter (of a Polygon).
ST_3DPerimeter
ST_3DPerimeter returns the 3D perimeter of a polygon or a multipolygon.
ST_Accum
Construct an array of Geometries.
ST_AddPoint
ST_AddZ
This function add a z value to the z component of (each vertex of) the geometric parameter to the corresponding value given by a field.
ST_AddZ.AddZCoordinateSequenceFilter
Add a z value to each vertex of the Geometry.
ST_Area
Compute geometry area
ST_AsBinary
Convert a geometry into Well Known Binary..
ST_AsGeoJSON
Transform a JTS geometry to a GeoJSON geometry representation.
ST_AsGML
Store a geometry as a GML representation
ST_AsKml
Convert a JTS geometry to a KML geometry representation.
ST_AsText
Alias for `ST_AsWKT`
ST_AsWKT
Convert a Geometry value into a Well Known Text value.
ST_Azimuth
Returns the azimuth of the segment defined by the given Point geometries.
ST_Boundary
Get geometry boundary as geometry.
ST_BoundingCircle
Compute the minimum bounding circle of a geometry.
ST_BoundingCircleCenter
Compute the minimum bounding circle center of a geometry
ST_Buffer
ST_Buffer computes a buffer around a Geometry.
ST_Centroid
Computes the centroid of this Geometry.
ST_ClosestCoordinate
ST_ClosestCoordinate computes the closest coordinate(s) contained in the given geometry starting from the given point, using the 2D distance.
ST_ClosestPoint
ST_ClosestPoint returns the 2D point on geometry A that is closest to geometry B.
ST_Collect
Construct an array of Geometries.
ST_CollectionExtract
ST_CompactnessRatio
ST_CompactnessRatio computes the perimeter of a circle whose area is equal to the given polygon's area, and returns the ratio of this computed perimeter to the given polygon's perimeter.
ST_ConstrainedDelaunay
Returns polygons or lines that represent a Delaunay triangulation constructed from a geometry.
ST_Contains
Return true if Geometry A contains Geometry B.
ST_ConvexHull
Computes the smallest convex POLYGON that contains all the points in the Geometry.
ST_CoordDim
ST_CoordDim returns the dimension of the coordinates of the given geometry.
ST_Covers
ST_Covers returns true if no point in geometry B is outside geometry A.
ST_Crosses
Return true if Geometry A crosses Geometry B.
ST_Delaunay
Returns polygons that represent a Delaunay triangulation constructed from a collection of points.
ST_Densify
Densifies a geometry using the given distance tolerance.
ST_Difference
Compute the difference between two Geometries.
ST_Dimension
Get dimension of a geometry 0 for a Point, 1 for a line and 2 for a polygon.
ST_Disjoint
Return true if the two Geometries are disjoint.
ST_Distance
For geometry type returns the 2-dimensional minimum Cartesian distance between two geometries in projected units (spatial ref units)
ST_DistanceSphere
For geometry type returns minimum distance in meters between two geometries
ST_Drape
This function could be used to drape a geometry to a set of triangles
ST_DWithin
ST_DWithin returns true if the geometries are within the specified distance of one another.
ST_EndPoint
Returns the last coordinate of a Geometry as a POINT, given that the Geometry is a LINESTRING or a MULTILINESTRING containing only one LINESTRING; Returns NULL for all other Geometries.
ST_Envelope
Get geometry envelope as geometry.
ST_EnvelopesIntersect
Return true if the envelope of Geometry A intersects the envelope of Geometry B.
ST_Equals
Return true if Geometry A is equal to Geometry B.
ST_EstimatedExtent
Estimated extent function based on the internal H2 ESTIMATED_ENVELOPE
ST_Expand
Expands a geometry's envelope by the given delta X and delta Y.
ST_Explode
This table function explode Geometry Collection into multiple geometries
ST_Explode.ExplodeResultSet
Explode fields only on request
ST_Explode.ExplodeResultSetQuery
Explode fields only on request The input data must be a SELECT expression that contains a geometry column
ST_Extent
ST_Extent returns an `Envelope` that cover all aggregated geometries.
ST_ExteriorRing
Returns a LinearRing instance or Null if parameter is not a Polygon.
ST_Extrude
ST_Extrude takes a LINESTRING or POLYGON as input and extends it to a 3D representation, returning a geometry collection containing floor, ceiling and wall geometries.
ST_FindUTMSRID
Find the UTM SRID code
ST_FlipCoordinates
Flip the X and Y coordinates of the geometry
ST_FlipCoordinates.FlipCoordinateSequenceFilter
Returns a version of the given geometry with X and Y axis flipped.
ST_Force2D
Forces a Geometry into 2D mode by returning a copy with its z-coordinate set to NaN.
ST_Force3D
Forces a Geometry into 3D mode. z-coordinates set to 0 when z value is NaN, other z-coordinates are left untouched.
ST_Force3DM
Forces a Geometry into 3DM mode by returning a copy with If a geometry has no M component, then a 0 M coordinate is tacked on.
ST_Force4D
Forces a Geometry into 4D mode by returning a copy with z set to 0 (other z-measure are left untouched).
ST_FurthestCoordinate
ST_FurthestCoordinate computes the furthest coordinate(s) contained in the given geometry starting from the given point, using the 2D distance.
ST_GeneratePoints
This function is used to generate pseudo-random points until the requested number are found within the input area (polygon or multipolygon)
ST_GeneratePointsInGrid
This function is used to generate pseudo-random points until the requested number are found within the input area (polygon or multipolygon)
ST_GeometryN
Return Geometry number n from the given GeometryCollection.
ST_GeometryShadow
Compute the shadow footprint for a single geometry.
ST_GeometryType
Return the type of geometry : ST_POINT, ST_LINESTRING, ST_POLYGON...
ST_GeometryTypeCode
Returns the OGC SFS `GeometryTypeCodes` of a Geometry.
ST_GeomFromGeoJSON
ST_GeomFromGML
Read a GML representation and convert it to a geometry.
ST_GeomFromText
Convert a Well Known Text String into a Geometry instance.
ST_GeomFromWKB
Convert a WKB object to a geometry
ST_GoogleMapLink
ST_GoogleMapLink.LayerType
List of supported layers for Google Map
ST_Graph
Assigns integer node and edge ids to LINESTRING or MULTILINESTRING geometries from a table named input, resulting in two new tables: input_nodes and input_edges.
ST_Holes
ST_Holes returns the given geometry or geometry collection's holes as a GeometryCollection.
ST_InsertPoint
This function insert a point on geometry looking for the nearest coordinate segment
ST_InteriorRingN
Returns a LinearRing instance or Null if parameter is not a Polygon.
ST_Interpolate3DLine
Interpolate a 1 dimension geometry according its start and end z values.
ST_Intersection
Compute the intersection of two Geometries.
ST_Intersects
Return true if the geometry A intersects the geometry B
ST_Is3D
Returns 1 if a geometry has a z-coordinate, otherwise 0.
ST_IsClosed
Return TRUE if the provided geometry is a closed LINESTRING or MULTILINESTRING, null otherwise.
ST_IsEmpty
Test if the provided geometry is empty.
ST_Isovist
ST_Isovist ST_Isovist takes LINESTRING(S) or POLYGON(S) as input and a maximum distance (spatial ref units).
ST_IsRectangle
ST_IsRectangle returns true if the given geometry is a rectangle.
ST_IsRing
Return TRUE if the provided geometry is a closed and simple LINESTRING or MULTILINESTRING; NULL otherwise.
ST_IsSimple
Test if the provided geometry is simple.
ST_IsValid
ST_IsValid returns true if the given geometry is valid.
ST_IsValidDetail
Returns a valid_detail (valid,reason,location) as an array of objects.
ST_IsValidReason
Returns text stating if a geometry is valid or not an if not valid, a reason why
ST_Length
Compute the geometry length.
ST_LineFromText
Convert a WKT String into a LINESTRING.
ST_LineFromWKB
Convert Well Known Binary into a LINESTRING.
ST_LineIntersector
LineIntersector is used to split an input geometry (LineString or MultiLineString) by a set of geometries.
ST_LineMerge
Merges a collection of linear components to form maximal-length linestrings.
ST_LocateAlong
ST_LocateAlong returns a MULTIPOINT containing points along the line segments of the given geometry matching the specified segment length fraction and offset distance.
ST_LongestLine
Returns the 2-dimensional longest line between the points of two geometries.
ST_M
Get the first M(easure) coordinate
ST_MakeEllipse
ST_MakeEllipse constructs an elliptical POLYGON with the given width and height centered at the given point.
ST_MakeEnvelope
Creates a rectangular POLYGON formed from the given x and y minima.
ST_MakeGrid
Create a regular grid based on a table or a geometry envelope.
ST_MakeGridPoints
Create a regular grid of points based on a table or a geometry envelope.
ST_MakeLine
ST_MakeLine constructs a LINESTRING from POINT and MULTIPOINT geometries.
ST_MakePoint
ST_MakePoint constructs POINT from two or three doubles.
ST_MakePolygon
Class to create a polygon
ST_MakeValid
Function to make a geometry valid.
ST_MaxDistance
Compute the maximum distance between two geometries.
ST_MemSize
Compute the amount of memory space (in bytes) for the input value
ST_MinimumBoundingCircle
PostGIS compatibility function alias.
ST_MinimumDiameter
Compute a minimum diameter for a given geometry
ST_MinimumRectangle
Gets the minimum rectangular POLYGON which encloses the input geometry.
ST_MLineFromText
Convert a WKT String into a MULTILINESTRING.
ST_MPointFromText
Convert a WKT String into a MULTIPOINT.
ST_MPolyFromText
Convert a WKT String into a MULTIPOLYGON.
ST_MultiplyZ
ST_MultiplyZ.MultiplyZCoordinateSequenceFilter
Multiply the z value of each vertex of the Geometry by a double value.
ST_Node
ST_Normalize
Converts this Geometry to normal form (canonical form)
ST_NPoints
ST_NumGeometries
Get the number of geometries inside a geometry collection
ST_NumInteriorRing
Alias for ST_NumInteriorRings.
ST_NumInteriorRings
Return the number of holes in a geometry
ST_NumPoints
Get the number of points inside a geometry
ST_OctogonalEnvelope
Computes the octogonal envelope of a geometry.
ST_OffSetCurve
Return an offset line at a given distance and side from an input geometry.
ST_OrderingEquals
ST_OrderingEquals compares two geometries and t (TRUE) if the geometries are equal and the coordinates are in the same order; otherwise it returns f (FALSE).
ST_OrientedEnvelope
Alias for PostGIS
ST_OSMDownloader
This function is used to download data from the osm api using a bounding box.
ST_OSMMapLink
This class is used to generate an OSM map link URL from a geometry.
ST_Overlaps
Return true if the geometry A overlaps the geometry B
ST_Perimeter
ST_Perimeter returns the perimeter of a polygon or a multipolygon.
ST_Point
ST_Point constructs POINT from two or three doubles.
ST_PointFromText
Convert a WKT String into a Point.
ST_PointFromWKB
Convert Well Known Binary into a POINT.
ST_PointN
Returns the nth point of a LINESTRING or a MULTILINESTRING containing exactly one LINESTRING; NULL otherwise.
ST_PointOnSurface
Get a Point that lie on the surface of a Surface Geometry.
ST_PolyFromText
Convert a WKT String into a POLYGON.
ST_PolyFromWKB
Convert Well Known Binary into Geometry then check that it is a Polygon
ST_Polygonize
ST_PrecisionReducer
ST_ProjectPoint
ST_Relate
This function is used to compute the relation between two geometries, as described in the SFS specification.
ST_RemoveDuplicatedCoordinates
Remove duplicate coordinates in a geometry
ST_RemoveHoles
Removes any holes from a polygon or multipolygon
ST_RemovePoints
Remove all points on a geometry that are located within a polygon.
ST_RemoveRepeatedPoints
Remove duplicated points on a geometry
ST_Reverse
Returns the geometry with vertex order reversed.
ST_Reverse3DLine
Returns a 1 dimension geometry with vertex order reversed according the start and the end z values.
ST_RingBuffer
Compute a ring buffer around a geometry.
ST_RingSideBuffer
Compute a ring buffer on one side
ST_Rotate
ST_Rotate rotates a geometry by a given angle (in radians) about the geometry's center.
ST_Scale
ST_Scale scales the given geometry by multiplying the coordinates by the indicated scale factors.
ST_SetSRID
Return a new geometry with a replaced spatial reference id.
ST_ShortestLine
Returns the 2-dimensional shortest line between two geometries.
ST_SideBuffer
Compute a single buffer on one side.
ST_Simplify
Returns a simplified version of the given geometry using the Douglas-Peuker algorithm.
ST_SimplifyPreserveTopology
ST_Snap
Snaps two geometries together with a given tolerance
ST_Split
This function split a line by a line a line by a point a polygon by a line
ST_SRID
Retrieve the SRID from an EWKB encoded geometry.
ST_StartPoint
Returns the first coordinate of a Geometry as a POINT, given that the Geometry is a LINESTRING or a MULTILINESTRING containing only one LINESTRING; Returns NULL for all other Geometries.
ST_SubDivide
ST_SunPosition
Compute the sun position and return a new coordinate with x = azimuth and y = altitude
ST_Svf
This function will be used to compute the Sky View Factor based on geometries
ST_SymDifference
Compute the symmetric difference between two Geometries.
ST_Tessellate
Tessellate a set of Polygon with adaptive triangles.
ST_ToMultiLine
ST_ToMultiLine constructs a MultiLineString from the given geometry's coordinates.
ST_ToMultiPoint
ST_ToMultiPoint constructs a MultiPoint from the given geometry's coordinates.
ST_ToMultiSegments
ST_ToMultiSegments converts a geometry into a set of distinct segments stored in a MultiLineString.
ST_Touches
Return true if the geometry A touches the geometry B
ST_Transform
This class is used to transform a geometry from one CRS to another.
ST_Transform.CopCache
A simple cache to manage `CoordinateOperation`
ST_Transform.CRSTransformFilter
This method is used to apply a `CoordinateOperation` to a geometry.
ST_Translate
Translates a geometry using X, Y (and possibly Z) offsets.
ST_TriangleAspect
This function is used to compute the aspect of a triangle.
ST_TriangleContouring
Split triangle into area within the specified range values. ********************************* ANR EvalPDU IFSTTAR 11_05_2011
ST_TriangleDirection
This function is used to compute the main slope direction on a triangle.
ST_TriangleSlope
This function is used to compute the slope direction of a triangle.
ST_Union
Compute the union of two or more Geometries.
ST_UpdateZ
This function replace the z component of (each vertex of) the geometric parameter to the corresponding value given by a field.
ST_VariableBuffer
ST_VariableBuffer computes a buffer around a Geometry with a start and end distance
ST_Voronoi
ST_Within
Return true if the geometry A is within the geometry B
ST_X
Get the first X coordinate
ST_XMax
ST_XMax returns the maximal x-value of the given geometry.
ST_XMin
ST_XMin returns the minimal x-value of the given geometry.
ST_Y
Get the first Y coordinate
ST_YMax
ST_YMax returns the maximal y-value of the given geometry.
ST_YMin
ST_YMin returns the minimal y-value of the given geometry.
ST_Z
Get the first Z coordinate
ST_ZMax
ST_ZMax returns the maximal z-value of the given geometry.
ST_ZMin
ST_ZMin returns the minimal z-value of the given geometry.
ST_ZUpdateLineExtremities
StringStack
This class is a stack to keep in memory the structure of the GPX file.
SunCalc
This class is a partial Java port of SunCalc.
TAG_LOCATION
A class to specify the category of the element.
TINFeatureFactory
A factory used to create triangles from JTS geometries.
TSVDriverFunction
This driver allow to import and export the Tab Separated Values (TSV): a format for tabular data exchange A file in TSV format consists of lines.
TSVRead
Read a Tab-separated values file
TSVWrite
Write a Tab-separated values file
UpdateGeometrySRID
Function to update the SRID of a geometry column
UpdateGeometryZ
This class is used to force the coordinate dimension of a geometry to 3 and update the z value
WayOSMElement
A class to manage the way element properties.
WriteBufferManager
Class to write files using nio.
ZAffineTransformation
Applies a 3D affine transformation to a geometry.