com.communote.server.api.core.config.database

Interface DatabaseConfiguration

All Known Implementing Classes:

FulltextSupportingDatabaseConfiguration, MSSQLServerDatabaseConfiguration, OracleDatabaseConfiguration, PostgreSQLDatabaseConfiguration, StandardDatabaseConfiguration

public interface DatabaseConfiguration

Provides database specific implementations of certain additional features like the HQL 'fulltext' function.

Author:

Communote GmbH - http://www.communote.com/

Method Summary

Modifier and Type	Method and Description
String	getConnectionProviderClassName() Determine the class name of the connection provider to use.
org.hibernate.dialect.function.SQLFunction	getDatepartSQLFunction() Get the SQLFunction that will translate the HQL 'datepart' function to SQL.
String	getFulltextParameterValue(String pattern, org.hibernate.criterion.MatchMode matchMode) Get the (database specific) parameter value for the given pattern
String	getFulltextParameterValue(String pattern, org.hibernate.criterion.MatchMode matchMode, boolean doNotUseFulltext) Get the (database specific) parameter value for the given pattern
org.hibernate.dialect.function.SQLFunction	getFulltextSQLFunction() Return the SQL function that translates the HQL 'fulltext' function to SQL.
boolean	isExtendSubselectsWithOuterConditions() Determine if subselects should be extended by using conditions of the outer clause.
boolean	isUseFulltextFeature()

Method Detail

getConnectionProviderClassName

String getConnectionProviderClassName()

Determine the class name of the connection provider to use.

Returns:

the connection provider

getDatepartSQLFunction

org.hibernate.dialect.function.SQLFunction getDatepartSQLFunction()

Get the SQLFunction that will translate the HQL 'datepart' function to SQL.

Usage: day_of_date(dateField, alias) where dateField must be one of the DateField constants Example in HQL to return the year of the publication date of a note: "date_part(" + DateField.YEAR + ", note.publication_date)"

Returns:

the SQLFunction that will render the HQL 'datepart' function or null if not supported

getFulltextParameterValue

String getFulltextParameterValue(String pattern,
                                 org.hibernate.criterion.MatchMode matchMode)

Get the (database specific) parameter value for the given pattern

Parameters:

pattern - the pattern

matchMode - the hibernate match mode

Returns:

the parameter value to be used in the final query

getFulltextParameterValue

String getFulltextParameterValue(String pattern,
                                 org.hibernate.criterion.MatchMode matchMode,
                                 boolean doNotUseFulltext)

Get the (database specific) parameter value for the given pattern

Parameters:

pattern - the pattern

matchMode - the hibernate match mode

doNotUseFulltext - true if the parameter should use the like wildcards matching even if fulltext is enabled

Returns:

the parameter value to be used in the final query

getFulltextSQLFunction

org.hibernate.dialect.function.SQLFunction getFulltextSQLFunction()

Return the SQL function that translates the HQL 'fulltext' function to SQL.

The HQL 'fulltext' function takes two arguments: The field to be search and the string to search for. In HQL the fulltext function has always to be matched against 1, e.g. fulltext(content.content, 'mysearch') = 1. BUT if you want the negation use: not (fulltext(content.content,'mysearch'))

When building queries with the HQL fulltext function always use the getFulltextParameterValue(String, MatchMode) to set the parameter values because the syntax differs per database

Returns:

The SQLFunction that will render the HQL 'fulltext' function

isExtendSubselectsWithOuterConditions

boolean isExtendSubselectsWithOuterConditions()

Determine if subselects should be extended by using conditions of the outer clause.

See the MSSQL Implementation for an example.

Returns:

true if the subselect should be extended

isUseFulltextFeature

boolean isUseFulltextFeature()

Returns:

true if the fulltext feature is supported