com.communote.server.core.database.config

Class FulltextSupportingDatabaseConfiguration

java.lang.Object

com.communote.server.core.database.config.StandardDatabaseConfiguration

com.communote.server.core.database.config.FulltextSupportingDatabaseConfiguration

All Implemented Interfaces:

DatabaseConfiguration

Direct Known Subclasses:

MSSQLServerDatabaseConfiguration, OracleDatabaseConfiguration, PostgreSQLDatabaseConfiguration

public abstract class FulltextSupportingDatabaseConfiguration
extends StandardDatabaseConfiguration

Abstract DatabaseConfiguration for database having some fulltext specific stuff. Depending on if setUseFulltextFeature(boolean) has been set to true it will use the database getSpecificFulltextSQLFunction() for rendering the fulltext query. Otherwise the simple 'like' will be used.

Author:

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

Field Summary

Fields inherited from class com.communote.server.core.database.config.StandardDatabaseConfiguration

COMMUNOTE_CONNECTION_PROVIDER_CLASS

Constructor Summary

Constructors

Constructor and Description
FulltextSupportingDatabaseConfiguration()

Method Summary

Modifier and Type	Method and Description
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.
protected abstract String	getSpecificFulltextParameterValue(String pattern, org.hibernate.criterion.MatchMode matchMode) Take the pattern and match mode an return the parameter value to be used in the fulltext query.
protected abstract org.hibernate.dialect.function.SQLFunction	getSpecificFulltextSQLFunction()
static String	getWildcardPattern(String pattern, org.hibernate.criterion.MatchMode matchMode, String wildcard, String prefix, String suffix) Take the pattern and match mode an return the parameter value to be used in the fulltext query.
static String	getWildcardPattern(String pattern, org.hibernate.criterion.MatchMode matchMode, String wildcardStart, String wildcardEnd, String prefix, String suffix) Take the pattern and match mode an return the parameter value to be used in the fulltext query.
boolean	isUseFulltextFeature()
void	setUseFulltextFeature(boolean useFulltextFeature) Enable or disable the fulltext feature of configuration that supports the fulltext function

Methods inherited from class com.communote.server.core.database.config.StandardDatabaseConfiguration

getConnectionProviderClassName, getDatepartSQLFunction, getFulltextParameterValue, isExtendSubselectsWithOuterConditions

Methods inherited from class java.lang.Object

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

Constructor Detail

FulltextSupportingDatabaseConfiguration

public FulltextSupportingDatabaseConfiguration()

Method Detail

getWildcardPattern

public static String getWildcardPattern(String pattern,
                                        org.hibernate.criterion.MatchMode matchMode,
                                        String wildcard,
                                        String prefix,
                                        String suffix)

Take the pattern and match mode an return the parameter value to be used in the fulltext query.

Parameters:

pattern - the search string

matchMode - the match mode to use

wildcard - the wildcard

prefix - some additional string to prepend

suffix - some additional string to append

Returns:

the parameter value

getWildcardPattern

public static String getWildcardPattern(String pattern,
                                        org.hibernate.criterion.MatchMode matchMode,
                                        String wildcardStart,
                                        String wildcardEnd,
                                        String prefix,
                                        String suffix)

Take the pattern and match mode an return the parameter value to be used in the fulltext query.

Parameters:

pattern - the search string

matchMode - the match mode to use

wildcardStart - the wildcard

wildcardEnd - the wildcard

prefix - some additional string to prepend

suffix - some additional string to append

Returns:

the parameter value

getFulltextParameterValue

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

Get the (database specific) parameter value for the given pattern Evaluates to the % syntax

Specified by:

getFulltextParameterValue in interface DatabaseConfiguration

Overrides:

getFulltextParameterValue in class StandardDatabaseConfiguration

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

public 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 DatabaseConfiguration.getFulltextParameterValue(String, MatchMode) to set the parameter values because the syntax differs per database

The like function will be returned

Specified by:

getFulltextSQLFunction in interface DatabaseConfiguration

Overrides:

getFulltextSQLFunction in class StandardDatabaseConfiguration

Returns:

The SQLFunction that will render the HQL 'fulltext' function

getSpecificFulltextParameterValue

protected abstract String getSpecificFulltextParameterValue(String pattern,
                                                            org.hibernate.criterion.MatchMode matchMode)

Take the pattern and match mode an return the parameter value to be used in the fulltext query.

Parameters:

pattern - the search string

matchMode - the match mode to use

Returns:

the parameter value

getSpecificFulltextSQLFunction

protected abstract org.hibernate.dialect.function.SQLFunction getSpecificFulltextSQLFunction()

Returns:

the database specific fulltext SQL function (subclass will implement)

isUseFulltextFeature

public boolean isUseFulltextFeature()

Specified by:

isUseFulltextFeature in interface DatabaseConfiguration

Overrides:

isUseFulltextFeature in class StandardDatabaseConfiguration

Returns:

true if the fulltext feature was not disabled with a call to setUseFulltextFeature(boolean)

setUseFulltextFeature

public void setUseFulltextFeature(boolean useFulltextFeature)

Enable or disable the fulltext feature of configuration that supports the fulltext function

Parameters:

useFeature - true to use the feature