Package org.hibernate.spatial.dialect.sqlserver

Class SqlServer2008SpatialDialect

java.lang.Object

org.hibernate.dialect.Dialect

org.hibernate.dialect.SQLServerDialect

org.hibernate.dialect.SQLServer2005Dialect

org.hibernate.dialect.SQLServer2008Dialect

org.hibernate.spatial.dialect.sqlserver.SqlServer2008SpatialDialect

All Implemented Interfaces:

java.io.Serializable, ConversionContext, SpatialDialect

public class SqlServer2008SpatialDialect
extends SQLServer2008Dialect
implements SpatialDialect

The SpatialDialect for Microsoft SQL Server (2008).

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field	Description
static java.lang.String	SHORT_NAME	The short name for this dialect

Fields inherited from class org.hibernate.dialect.Dialect

CLOSED_QUOTE, DEFAULT_BATCH_SIZE, LEGACY_LOB_MERGE_STRATEGY, NEW_LOCATOR_LOB_MERGE_STRATEGY, NO_BATCH, QUOTE, STANDARD_DEFAULT_BATCH_LOAD_SIZING_STRATEGY, STREAM_XFER_LOB_MERGE_STRATEGY

Constructor Summary

Constructors

Constructor	Description
SqlServer2008SpatialDialect()	Constructs an instance

Method Summary

Modifier and Type	Method	Description
java.lang.String	applyLocksToSql(java.lang.String sql, LockOptions aliasedLockOptions, java.util.Map<java.lang.String,java.lang.String[]> keyColumnNames)	Modifies the given SQL by applying the appropriate updates for the specified lock modes and key columns.
void	contributeTypes(TypeContributions typeContributions, ServiceRegistry serviceRegistry)	Allows the Dialect to contribute additional types
java.lang.String	getAddColumnString()	The syntax used to add a column to a table (optional).
MultiTableBulkIdStrategy	getDefaultMultiTableBulkIdStrategy()
java.lang.String	getDWithinSQL(java.lang.String columnName)	Returns The SQL fragment when parsing a DWithinExpression.
java.lang.String	getForUpdateString()	Get the string to append to SELECT statements to acquire locks for this dialect.
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	getNullColumnString()	The keyword used to specify a nullable column.
java.sql.ResultSet	getResultSet(java.sql.CallableStatement ps)	Given a callable statement previously processed by Dialect.registerResultSetOutParameter(java.sql.CallableStatement, int), extract the ResultSet from the OUT parameter.
java.lang.String	getSelectGUIDString()	Get the command used to select a GUID from the underlying database.
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	isCurrentTimestampSelectStringCallable()	Should the value returned by Dialect.getCurrentTimestampSelectString() be treated as callable.
boolean	qualifyIndexName()	Do we need to qualify index names with the schema name?
int	registerResultSetOutParameter(java.sql.CallableStatement statement, int col)	Registers a parameter (either OUT, or the new REF_CURSOR param type available in Java 8) capable of returning ResultSet *by position*.
boolean	supports(SpatialFunction function)	Does this dialect supports the specified SpatialFunction.
boolean	supportsCurrentTimestampSelection()	Does this dialect support a way to retrieve the database's current timestamp value?
boolean	supportsEmptyInList()	Does this dialect support empty IN lists?
boolean	supportsExistsInSelect()	Does the dialect support an exists statement in the select clause?
boolean	supportsFiltering()	Returns true if this SpatialDialect supports a specific filtering function.
boolean	supportsPartitionBy()	Does the underlying database support partition by
boolean	supportsTupleDistinctCounts()	Does this dialect support `count(distinct a,b)`?
boolean	supportsTuplesInSubqueries()	Does this dialect support tuples in subqueries? Ex: delete from Table1 where (col1, col2) in (select col1, col2 from Table2)
boolean	supportsUnionAll()	Does this dialect support UNION ALL, which is generally a faster variant of UNION?

Methods inherited from class org.hibernate.dialect.SQLServer2008Dialect

renderOrderByElement, supportsValuesList

Methods inherited from class org.hibernate.dialect.SQLServer2005Dialect

appendLockHint, buildSQLExceptionConversionDelegate, getDefaultLimitHandler, supportsNonQueryWithCTE, supportsNoWait, supportsSkipLocked

Methods inherited from class org.hibernate.dialect.SQLServerDialect

areStringComparisonsCaseInsensitive, closeQuote, doesReadCommittedCauseWritersToBlockReaders, doesRepeatableReadCauseReadersToBlockWriters, getCurrentSchemaCommand, getCurrentTimestampSelectString, getIdentityColumnSupport, getInExpressionCountLimit, getLimitHandler, getLimitString, getNoColumnsInsertString, getSqlTypeDescriptorOverride, openQuote, supportsCircularCascadeDeleteConstraints, supportsLimit, supportsLimitOffset, supportsLobValueChangePropogation, supportsResultSetPositionQueryMethodsOnForwardOnlyCursor, supportsVariableLimit, useMaxForLimit

Methods inherited from class org.hibernate.dialect.Dialect

addSqlHintOrComment, appendLockHint, augmentRecognizedTableTypes, bindLimitParametersFirst, bindLimitParametersInReverseOrder, buildIdentifierHelper, buildSQLExceptionConverter, canCreateCatalog, canCreateSchema, cast, cast, cast, convertToFirstRowValue, createCaseFragment, createOuterJoinFragment, defaultScrollMode, dropConstraints, escapeComment, escapeLiteral, forceLimitUsage, forceLobAsLastValue, forUpdateOfColumns, getAddColumnSuffixString, getAddForeignKeyConstraintString, getAddForeignKeyConstraintString, getAddPrimaryKeyConstraintString, getAddUniqueConstraintString, getAlterTableString, getAuxiliaryDatabaseObjectExporter, getCallableStatementSupport, getCascadeConstraintsString, getCaseInsensitiveLike, getCastTypeName, getColumnAliasExtractor, getColumnComment, getCreateCatalogCommand, getCreateMultisetTableString, getCreateSchemaCommand, getCreateSequenceString, getCreateSequenceString, getCreateSequenceStrings, getCreateSequenceStrings, getCreateTableString, getCrossJoinSeparator, getCurrentTimestampSQLFunctionName, getDefaultBatchLoadSizingStrategy, getDefaultProperties, getDialect, getDialect, getDropCatalogCommand, getDropForeignKeyString, getDropSchemaCommand, getDropSequenceString, getDropSequenceStrings, getDropTableString, getForeignKeyExporter, getForUpdateNowaitString, getForUpdateNowaitString, getForUpdateSkipLockedString, getForUpdateSkipLockedString, getForUpdateString, getForUpdateString, getForUpdateString, getForUpdateString, getFunctions, getHibernateTypeName, getHibernateTypeName, getIndexExporter, getKeywords, getLimitString, getLobMergeStrategy, getLockingStrategy, getLowercaseFunction, getMaxAliasLength, getNameQualifierSupport, getNativeIdentifierGeneratorClass, getNativeIdentifierGeneratorStrategy, getNotExpression, getQueryHintString, getQueryHintString, getQuerySequencesString, getReadLockString, getReadLockString, getResultSet, getResultSet, getSchemaNameResolver, getSelectClauseNullString, getSelectSequenceNextValString, getSequenceExporter, getSequenceInformationExtractor, getSequenceNextValString, getTableComment, getTableExporter, getTableTypeString, getTypeName, getTypeName, getUniqueDelegate, getUniqueKeyExporter, getViolatedConstraintNameExtracter, getWriteLockString, getWriteLockString, hasAlterTable, hasSelfReferentialForeignKeyBug, inlineLiteral, isJdbcLogWarningsEnabledByDefault, isLegacyLimitHandlerBehaviorEnabled, isLockTimeoutParameterized, isTypeNameRegistered, prependComment, quote, registerColumnType, registerColumnType, registerFunction, registerHibernateType, registerHibernateType, registerKeyword, registerResultSetOutParameter, remapSqlTypeDescriptor, replaceResultVariableInOrderByClauseWithPosition, requiresCastingOfParametersInSelectClause, requiresParensForTupleDistinctCounts, supportsBindAsCallableArgument, supportsCascadeDelete, supportsCaseInsensitiveLike, supportsColumnCheck, supportsCommentOn, supportsExpectedLobUsagePattern, supportsIfExistsAfterAlterTable, supportsIfExistsAfterConstraintName, supportsIfExistsAfterTableName, supportsIfExistsBeforeConstraintName, supportsIfExistsBeforeTableName, supportsLockTimeouts, supportsNamedParameters, supportsNationalizedTypes, supportsNotNullUnique, supportsOuterJoinForUpdate, supportsParametersInInsertSelect, supportsPooledSequences, supportsRowValueConstructorSyntax, supportsRowValueConstructorSyntaxInInList, supportsSequences, supportsSubqueryOnMutatingTable, supportsSubselectAsInPredicateLHS, supportsTableCheck, supportsTupleCounts, supportsUnboundedLobLocatorMaterialization, supportsUnique, supportsUniqueConstraintInCreateAlterTable, toBooleanValueString, toString, transformSelectString, useFollowOnLocking, useFollowOnLocking, useInputStreamToInsertBlob

Methods inherited from class java.lang.Object

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

Field Detail

SHORT_NAME

public static final java.lang.String SHORT_NAME

The short name for this dialect

See Also:

Constant Field Values

Constructor Detail

SqlServer2008SpatialDialect

public SqlServer2008SpatialDialect()

Constructs an instance

Method Detail

contributeTypes

public void contributeTypes(TypeContributions typeContributions,
                            ServiceRegistry serviceRegistry)

Description copied from class: Dialect

Allows the Dialect to contribute additional types

Overrides:

contributeTypes in class Dialect

Parameters:

typeContributions - Callback to contribute the types

serviceRegistry - The service registry

getSpatialRelateSQL

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

Description copied from interface: SpatialDialect

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

Specified by:

getSpatialRelateSQL in interface SpatialDialect

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

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

Description copied from interface: SpatialDialect

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

Specified by:

getSpatialFilterExpression in interface SpatialDialect

Parameters:

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

Returns:

Rhe SQL fragment for the SpatialFilterExpression

getSpatialAggregateSQL

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

Description copied from interface: SpatialDialect

Returns the SQL fragment for the specfied Spatial aggregate expression.

Specified by:

getSpatialAggregateSQL in interface SpatialDialect

Parameters:

columnName - The name of the Geometry property

aggregation - The type of SpatialAggregate

Returns:

The SQL fragment for the projection

getDWithinSQL

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

Description copied from interface: SpatialDialect

Returns The SQL fragment when parsing a DWithinExpression.

Specified by:

getDWithinSQL in interface SpatialDialect

Parameters:

columnName - The geometry column to test against

Returns:

The SQL fragment when parsing a DWithinExpression.

getHavingSridSQL

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

Description copied from interface: SpatialDialect

Returns the SQL fragment when parsing a HavingSridExpression.

Specified by:

getHavingSridSQL in interface SpatialDialect

Parameters:

columnName - The geometry column to test against

Returns:

The SQL fragment for a HavingSridExpression.

getIsEmptySQL

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

Description copied from interface: SpatialDialect

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

Specified by:

getIsEmptySQL in interface SpatialDialect

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

public boolean supportsFiltering()

Description copied from interface: SpatialDialect

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.

Specified by:

supportsFiltering in interface SpatialDialect

Returns:

True if filtering is supported

supports

public boolean supports(SpatialFunction function)

Description copied from interface: SpatialDialect

Does this dialect supports the specified SpatialFunction.

Specified by:

supports in interface SpatialDialect

Parameters:

function - SpatialFunction

Returns:

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

getAddColumnString

public java.lang.String getAddColumnString()

Description copied from class: Dialect

The syntax used to add a column to a table (optional).

Overrides:

getAddColumnString in class Dialect

Returns:

The "add column" fragment.

getNullColumnString

public java.lang.String getNullColumnString()

Description copied from class: Dialect

The keyword used to specify a nullable column.

Overrides:

getNullColumnString in class Dialect

Returns:

String

qualifyIndexName

public boolean qualifyIndexName()

Description copied from class: Dialect

Do we need to qualify index names with the schema name?

Overrides:

qualifyIndexName in class Dialect

Returns:

boolean

getForUpdateString

public java.lang.String getForUpdateString()

Description copied from class: Dialect

Get the string to append to SELECT statements to acquire locks for this dialect.

Overrides:

getForUpdateString in class Dialect

Returns:

The appropriate FOR UPDATE clause string.

applyLocksToSql

public java.lang.String applyLocksToSql(java.lang.String sql,
                                        LockOptions aliasedLockOptions,
                                        java.util.Map<java.lang.String,java.lang.String[]> keyColumnNames)

Description copied from class: Dialect

Modifies the given SQL by applying the appropriate updates for the specified lock modes and key columns.

The behavior here is that of an ANSI SQL SELECT FOR UPDATE. This method is really intended to allow dialects which do not support SELECT FOR UPDATE to achieve this in their own fashion.

Overrides:

applyLocksToSql in class Dialect

Parameters:

sql - the SQL string to modify

aliasedLockOptions - lock options indexed by aliased table names.

keyColumnNames - a map of key columns indexed by aliased table names.

Returns:

the modified SQL string.

registerResultSetOutParameter

public int registerResultSetOutParameter(java.sql.CallableStatement statement,
                                         int col)
                                  throws java.sql.SQLException

Description copied from class: Dialect

Registers a parameter (either OUT, or the new REF_CURSOR param type available in Java 8) capable of returning ResultSet *by position*. Pre-Java 8, registering such ResultSet-returning parameters varied greatly across database and drivers; hence its inclusion as part of the Dialect contract.

Overrides:

registerResultSetOutParameter in class Dialect

Parameters:

statement - The callable statement.

col - The bind position at which to register the output param.

Returns:

The number of (contiguous) bind positions used.

Throws:

java.sql.SQLException - Indicates problems registering the param.

getResultSet

public java.sql.ResultSet getResultSet(java.sql.CallableStatement ps)
                                throws java.sql.SQLException

Description copied from class: Dialect

Given a callable statement previously processed by Dialect.registerResultSetOutParameter(java.sql.CallableStatement, int), extract the ResultSet from the OUT parameter.

Overrides:

getResultSet in class Dialect

Parameters:

ps - The callable statement.

Returns:

The extracted result set.

Throws:

java.sql.SQLException - Indicates problems extracting the result set.

supportsCurrentTimestampSelection

public boolean supportsCurrentTimestampSelection()

Description copied from class: Dialect

Does this dialect support a way to retrieve the database's current timestamp value?

Overrides:

supportsCurrentTimestampSelection in class Dialect

Returns:

True if the current timestamp can be retrieved; false otherwise.

isCurrentTimestampSelectStringCallable

public boolean isCurrentTimestampSelectStringCallable()

Description copied from class: Dialect

Should the value returned by Dialect.getCurrentTimestampSelectString() be treated as callable. Typically this indicates that JDBC escape syntax is being used...

Overrides:

isCurrentTimestampSelectStringCallable in class Dialect

Returns:

True if the Dialect.getCurrentTimestampSelectString() return is callable; false otherwise.

getDefaultMultiTableBulkIdStrategy

public MultiTableBulkIdStrategy getDefaultMultiTableBulkIdStrategy()

Overrides:

getDefaultMultiTableBulkIdStrategy in class Dialect

getSelectGUIDString

public java.lang.String getSelectGUIDString()

Description copied from class: Dialect

Get the command used to select a GUID from the underlying database.

Optional operation.

Overrides:

getSelectGUIDString in class Dialect

Returns:

The appropriate command.

supportsEmptyInList

public boolean supportsEmptyInList()

Description copied from class: Dialect

Does this dialect support empty IN lists?

For example, is [where XYZ in ()] a supported construct?

Overrides:

supportsEmptyInList in class Dialect

Returns:

True if empty in lists are supported; false otherwise.

supportsUnionAll

public boolean supportsUnionAll()

Description copied from class: Dialect

Does this dialect support UNION ALL, which is generally a faster variant of UNION?

Overrides:

supportsUnionAll in class Dialect

Returns:

True if UNION ALL is supported; false otherwise.

supportsExistsInSelect

public boolean supportsExistsInSelect()

Description copied from class: Dialect

Does the dialect support an exists statement in the select clause?

Overrides:

supportsExistsInSelect in class Dialect

Returns:

True if exists checks are allowed in the select clause; false otherwise.

supportsTupleDistinctCounts

public boolean supportsTupleDistinctCounts()

Description copied from class: Dialect

Does this dialect support `count(distinct a,b)`?

Overrides:

supportsTupleDistinctCounts in class Dialect

Returns:

True if the database supports counting distinct tuples; false otherwise.

supportsTuplesInSubqueries

public boolean supportsTuplesInSubqueries()

Description copied from class: Dialect

Does this dialect support tuples in subqueries? Ex: delete from Table1 where (col1, col2) in (select col1, col2 from Table2)

Overrides:

supportsTuplesInSubqueries in class Dialect

Returns:

boolean

supportsPartitionBy

public boolean supportsPartitionBy()

Description copied from class: Dialect

Does the underlying database support partition by

Overrides:

supportsPartitionBy in class Dialect

Returns:

boolean