Package org.hibernate.spatial

Interface SpatialDialect

All Superinterfaces:

java.io.Serializable

All Known Subinterfaces:

CockroachSpatialDialectTrait, MariaDBSpatialDialectTrait

All Known Implementing Classes:

CockroachDB202SpatialDialect, CockroachDBSpatialSupport, DB2SpatialDialect, GeoDBDialect, HANASpatialDialect, MariaDB103SpatialDialect, MySQL56InnoDBSpatialDialect, MySQL56SpatialDialect, MySQL5InnoDBSpatialDialect, MySQL5SpatialDialect, MySQL8SpatialDialect, MySQLSpatialDialect, OracleSpatial10gDialect, OracleSpatialSDO10gDialect, PostgisDialect, PostgisNoSQLMM, PostgisPG10Dialect, PostgisPG82Dialect, PostgisPG91Dialect, PostgisPG92Dialect, PostgisPG93Dialect, PostgisPG94Dialect, PostgisPG95Dialect, PostgisPG9Dialect, PostgisSupport, SqlServer2008SpatialDialect, SqlServer2012SpatialDialect

public interface SpatialDialect
extends java.io.Serializable

Describes the features of a spatially enabled dialect.

Method Summary

Modifier and Type	Method	Description
java.lang.String	getDWithinSQL(java.lang.String columnName)	Returns The SQL fragment when parsing a DWithinExpression.
java.lang.String	getHavingSridSQL(java.lang.String columnName)	Returns the SQL fragment when parsing a HavingSridExpression.
java.lang.String	getIsEmptySQL(java.lang.String columnName, boolean isEmpty)	Returns the SQL fragment when parsing a IsEmptyExpression or IsNotEmpty expression.
java.lang.String	getSpatialAggregateSQL(java.lang.String columnName, int aggregation)	Returns the SQL fragment for the specfied Spatial aggregate expression.
java.lang.String	getSpatialFilterExpression(java.lang.String columnName)	Returns the SQL fragment for the SQL WHERE-expression when parsing org.hibernate.spatial.criterion.SpatialFilterExpressions into prepared statements.
java.lang.String	getSpatialRelateSQL(java.lang.String columnName, int spatialRelation)	Returns the SQL fragment for the SQL WHERE-clause when parsing org.hibernatespatial.criterion.SpatialRelateExpressions into prepared statements.
boolean	supports(SpatialFunction function)	Does this dialect supports the specified SpatialFunction.
boolean	supportsFiltering()	Returns true if this SpatialDialect supports a specific filtering function.

Method Detail

getSpatialRelateSQL

java.lang.String getSpatialRelateSQL(java.lang.String columnName,
                                     int spatialRelation)

Returns the SQL fragment for the SQL WHERE-clause when parsing org.hibernatespatial.criterion.SpatialRelateExpressions into prepared statements.

Parameters:

columnName - The name of the geometry-typed column to which the relation is applied

spatialRelation - The type of spatial relation (as defined in SpatialRelation).

Returns:

SQL fragment SpatialRelateExpression

getSpatialFilterExpression

java.lang.String getSpatialFilterExpression(java.lang.String columnName)

Returns the SQL fragment for the SQL WHERE-expression when parsing org.hibernate.spatial.criterion.SpatialFilterExpressions into prepared statements.

Parameters:

columnName - The name of the geometry-typed column to which the filter is be applied

Returns:

Rhe SQL fragment for the SpatialFilterExpression

getSpatialAggregateSQL

java.lang.String getSpatialAggregateSQL(java.lang.String columnName,
                                        int aggregation)

Returns the SQL fragment for the specfied Spatial aggregate expression.

Parameters:

columnName - The name of the Geometry property

aggregation - The type of SpatialAggregate

Returns:

The SQL fragment for the projection

getDWithinSQL

java.lang.String getDWithinSQL(java.lang.String columnName)

Returns The SQL fragment when parsing a DWithinExpression.

Parameters:

columnName - The geometry column to test against

Returns:

The SQL fragment when parsing a DWithinExpression.

getHavingSridSQL

java.lang.String getHavingSridSQL(java.lang.String columnName)

Returns the SQL fragment when parsing a HavingSridExpression.

Parameters:

columnName - The geometry column to test against

Returns:

The SQL fragment for a HavingSridExpression.

getIsEmptySQL

java.lang.String getIsEmptySQL(java.lang.String columnName,
                               boolean isEmpty)

Returns the SQL fragment when parsing a IsEmptyExpression or IsNotEmpty expression.

Parameters:

columnName - The geometry column

isEmpty - Whether the geometry is tested for empty or non-empty

Returns:

The SQL fragment for the isempty function

supportsFiltering

boolean supportsFiltering()

Returns true if this SpatialDialect supports a specific filtering function.

This is intended to signal DB-support for fast window queries, or MBR-overlap queries.

Returns:

True if filtering is supported

supports

boolean supports(SpatialFunction function)

Does this dialect supports the specified SpatialFunction.

Parameters:

function - SpatialFunction

Returns:

True if this SpatialDialect supports the spatial function specified by the function parameter.