de.ipcon.db.fulltext.compass

Class CompassFTSModule

java.lang.Object

de.ipcon.db.module.KernelModule

de.ipcon.db.module.ListeningKernelModule

de.ipcon.db.fulltext.compass.CompassFTSModule

All Implemented Interfaces:

DatabaseConnectionProviderI, KernelDatabaseAccessorI, KernelDatabaseSaverI, ConfChangeEventListenerI, DBManEventListenerI, FeatureListenerI, FulltextSearcherI, java.util.concurrent.ThreadFactory

public class CompassFTSModule
extends ListeningKernelModule
implements DBManEventListenerI, FulltextSearcherI

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	INI_SECTION_NAME
static java.lang.String	iniVariableNameActivateFts
static java.lang.String	iniVariableNameCompassCfg
static java.lang.String	iniVariableNameCompassMaxFieldLength
static java.lang.String	iniVariableNameCompassUnlimitedFieldLength
static java.lang.String	iniVariableNameFetchSize
static java.lang.String	iniVariableNameIndexAllByDefault
static java.lang.String	iniVariableNameIndexDeletedBOs
static java.lang.String	iniVariableNameIndexPath
static java.lang.String	iniVariableNameMaxThreads
static java.lang.String	iniVariableNameSpellcheck
static org.apache.log4j.Logger	log

Fields inherited from class de.ipcon.db.module.KernelModule

STR_IF_POSSIBLE, STR_MANDATORY, STR_NEVER

Fields inherited from interface de.ipcon.db.core.KernelDatabaseSaverI

SAVE_RETRIES, SAVE_RETRY_DELAY_MS_MAX, SAVE_RETRY_DELAY_MS_MIN

Constructor Summary

Constructors

Constructor and Description
CompassFTSModule(DBManLocalI _dbm)

Method Summary

Modifier and Type	Method and Description
void	doStart() Contains the actual code to be executed when starting the module, without the general boilerplate code from start().
void	doStart(boolean _startup)
org.compass.core.Compass	getCompass()
int	getCount(java.lang.String _ftClause) Returns only the number of objects that match the given search clause.
int	getCount(java.lang.String _ftClause, java.lang.String _classname)
org.compass.gps.CompassGps	getGps()
MyTISMGpsDevice	getGpsDevice()
long[]	getIdList(java.lang.String _ftClause) Searches for BOs using a fulltext search and returns the IDs of matching BOs as an array of longs.
long[]	getIdList(java.lang.String _ftClause, java.lang.String _classname)
java.lang.String	getIdListAsString(java.lang.String _ftClause) Searches for BOs using a fulltext search and returns the IDs of matching BOs.
java.lang.String	getIdListAsString(java.lang.String _ftClause, java.lang.String _classname)
java.util.concurrent.atomic.AtomicBoolean	getIsInbetweenRunning()
SchemaMappingBuilder	getMappingBuilder()
java.lang.String	getShouldStartSetting(DBManConfigurationHelperI _conf) Retrieves and returns if this module should actually be started from the MyTISM configuration.
TermInfoI[]	getTerms() Allows to get information about most frequently occuring (search) terms in/from the fulltext search index.
TermInfoI[]	getTerms(EntityI _entity)
TermInfoI[]	getTerms(EntityI _entity, java.lang.String _regex)
TermInfoI[]	getTerms(EntityI _entity, java.lang.String _regex, int _size)
TermInfoI[]	getTerms(EntityI _entity, java.lang.String _regex, int _size, boolean _includeDeleted)
TermInfoI[]	getTerms(EntityI _entity, java.lang.String _regex, int _size, boolean _includeDeleted, java.lang.String[] _propertyNames)
TermInfoI[]	getTerms(EntityI _entity, java.lang.String _regex, int _size, boolean _includeDeleted, java.lang.String[] _propertyNames, boolean _sortByName)
TermInfoI[]	getTerms(EntityI _entity, java.lang.String _regex, int _size, boolean _includeDeleted, java.lang.String[] _propertyNames, boolean _sortByName, boolean _withSubEntities)
java.lang.String[]	getTermSuggestions(EntityI _entity, java.lang.String _term) Returns terms that exist in the index that are similar to the given _term.
java.lang.String[]	getTermSuggestions(EntityI _entity, java.lang.String _term, int _size)
java.lang.String[]	getTermSuggestions(EntityI _entity, java.lang.String _term, int _size, boolean _includeDeleted)
java.lang.String[]	getTermSuggestions(EntityI _entity, java.lang.String _term, int _size, boolean _includeDeleted, boolean _morePopular)
java.lang.String[]	getTermSuggestions(EntityI _entity, java.lang.String _term, int _size, boolean _includeDeleted, boolean _morePopular, float _accuracy)
java.lang.String[]	getTermSuggestions(EntityI _entity, java.lang.String _term, int _size, boolean _includeDeleted, boolean _morePopular, float _accuracy, java.lang.String _propertyName)
java.lang.String[]	getTermSuggestions(EntityI _entity, java.lang.String _term, int _size, boolean _includeDeleted, boolean _morePopular, float _accuracy, java.lang.String _propertyName, boolean _withSubEntities)
boolean	isFTSActive()
boolean	isIndexAllByDefault()
void	setCompass(org.compass.core.Compass $14)
void	setGps(org.compass.gps.CompassGps $15)
void	setGpsDevice(MyTISMGpsDevice $16)
void	setIndexAllByDefault(boolean $18)
void	setIsInbetweenRunning(java.util.concurrent.atomic.AtomicBoolean $17)
void	setMappingBuilder(SchemaMappingBuilder $19)
void	shutdown(int shutdownWaitTimeoutInSecs) Shuts this module down in a clean fashion, normally called during server shutdown.

Methods inherited from class de.ipcon.db.module.ListeningKernelModule

decrementPending, featureBecameAvailable, featureNoLongerAvailable, getCPending, getEventFilter, getNameForLog, getPendingShowLimit, incrementPending, initialize, isActive, isMandatory, isOrWillBeInactive, isWanted, newThread, processConfChangeEvent, processDBManEvent, setActive, setCPending, setEventFilter, setNameForLog, setPendingShowLimit, shutdown, start, start, stop, stop, stop

Methods inherited from class de.ipcon.db.module.KernelModule

getBOLoader, getConfiguration, getConnection, getDbm, getJDBCConnection, getNewCachingBOLoader, getNodeNumber, getSchema, getUser, isAuthoritativeSyncServer, isShutdown, loadBO, loadBO, query, query, query, query, query, query, query, query, query, query, runsAsUser, save, save, save, save, save, save, save, save, save, save, save, save, setDbm, setShutdown, setUser

Methods inherited from class java.lang.Object

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

Methods inherited from interface de.ipcon.db.event.DBManEventListenerI

processDBManEvent

Methods inherited from interface de.ipcon.db.core.KernelDatabaseSaverI

handleSaveResultForRetry

Methods inherited from interface de.ipcon.db.core.DatabaseConnectionProviderI

wantsConnectionsClosed

Field Detail

INI_SECTION_NAME

public static final java.lang.String INI_SECTION_NAME

See Also:

Constant Field Values

iniVariableNameActivateFts

public static final java.lang.String iniVariableNameActivateFts

See Also:

Constant Field Values

iniVariableNameIndexPath

public static final java.lang.String iniVariableNameIndexPath

See Also:

Constant Field Values

iniVariableNameFetchSize

public static final java.lang.String iniVariableNameFetchSize

See Also:

Constant Field Values

iniVariableNameMaxThreads

public static final java.lang.String iniVariableNameMaxThreads

See Also:

Constant Field Values

iniVariableNameIndexDeletedBOs

public static final java.lang.String iniVariableNameIndexDeletedBOs

See Also:

Constant Field Values

iniVariableNameSpellcheck

public static final java.lang.String iniVariableNameSpellcheck

See Also:

Constant Field Values

iniVariableNameCompassCfg

public static final java.lang.String iniVariableNameCompassCfg

See Also:

Constant Field Values

iniVariableNameCompassMaxFieldLength

public static final java.lang.String iniVariableNameCompassMaxFieldLength

See Also:

Constant Field Values

iniVariableNameCompassUnlimitedFieldLength

public static final java.lang.String iniVariableNameCompassUnlimitedFieldLength

See Also:

Constant Field Values

iniVariableNameIndexAllByDefault

public static final java.lang.String iniVariableNameIndexAllByDefault

See Also:

Constant Field Values

log

public static final org.apache.log4j.Logger log

Constructor Detail

CompassFTSModule

public CompassFTSModule(DBManLocalI _dbm)

Method Detail

getShouldStartSetting

public java.lang.String getShouldStartSetting(DBManConfigurationHelperI _conf)

Description copied from class: ListeningKernelModule

Retrieves and returns if this module should actually be started from the MyTISM configuration.

Specified by:

getShouldStartSetting in class ListeningKernelModule

Returns:

one of STR_NEVER, STR_IF_POSSIBLE or STR_MANDATORY

doStart

public void doStart()

Description copied from class: ListeningKernelModule

Contains the actual code to be executed when starting the module, without the general boilerplate code from start(). Does nothing by default, must be overwritten by subclasses. Executed asynchronously in the StartThread.

doStart

public void doStart(boolean _startup)

shutdown

public void shutdown(int shutdownWaitTimeoutInSecs)

Description copied from class: KernelModule

Shuts this module down in a clean fashion, normally called during server shutdown.

Overrides:

shutdown in class KernelModule

Parameters:

shutdownWaitTimeoutInSecs - time in seconds the DBMan will wait at most for this module to perform its shutdown

isFTSActive

public boolean isFTSActive()

Specified by:

isFTSActive in interface FulltextSearcherI

Returns:

true if the FTS system is active and ready for use; false if its initialization is still in progress.

getIdListAsString

public java.lang.String getIdListAsString(java.lang.String _ftClause)

Searches for BOs using a fulltext search and returns the IDs of matching BOs.

Specified by:

getIdListAsString in interface FulltextSearcherI

Parameters:

_ftClause - a fulltext search string in Compass query syntax.

_classname - if not null only Ids of BOs of this class and its subclasses will be included in the result.

Returns:

a String consisting of a comma separated list of Ids of BOs matching the given fulltext search clause. If no matching BO can be found via fulltext search, the returned list will consist solely of the MyTISMConstantsI.INVALID_ID.

getIdListAsString

public java.lang.String getIdListAsString(java.lang.String _ftClause,
                                          java.lang.String _classname)

Specified by:

getIdListAsString in interface FulltextSearcherI

getIdList

public long[] getIdList(java.lang.String _ftClause)

Searches for BOs using a fulltext search and returns the IDs of matching BOs as an array of longs.

Specified by:

getIdList in interface FulltextSearcherI

getIdList

public long[] getIdList(java.lang.String _ftClause,
                        java.lang.String _classname)

Specified by:

getIdList in interface FulltextSearcherI

getCount

public int getCount(java.lang.String _ftClause)

Returns only the number of objects that match the given search clause.

getCount

public int getCount(java.lang.String _ftClause,
                    java.lang.String _classname)

getTerms

public TermInfoI[] getTerms()

Allows to get information about most frequently occuring (search) terms in/from the fulltext search index.

Specified by:

getTerms in interface FulltextSearcherI

Parameters:

_entity - if not null, only terms coming from data of this Entity will be included; otherwise (the default) data from all BOs will be included.

_regex - if not null, only terms matching this regex will be included; otherwise (the default) all found terms are included.

_size - gives the number of terms that should be returned (default is 10).

_includeDeleted - if false (the default), the returned terms will not count term occurences from deleted BOs; if true term occurences from all BOs will be included.

_propertyNames - if not null, only terms coming from data of these attributes will be included; otherwise (the default) data from all attributes will be included.

_sortByName - if false (the default), the returned terms will be sorted from most frequently occuring to least frequently occuring; if true the terms will be sorted by name instead.

_withSubEntities - if true (the default), not only data from BOs of the given Entity will be included but also data from BOs of all subclasses.

Returns:

an array of at most _size TermInfoI objects, sorted as determined by _sortByName; null if _entity is not indexed.

getTerms

public TermInfoI[] getTerms(EntityI _entity)

Specified by:

getTerms in interface FulltextSearcherI

getTerms

public TermInfoI[] getTerms(EntityI _entity,
                            java.lang.String _regex)

Specified by:

getTerms in interface FulltextSearcherI

getTerms

public TermInfoI[] getTerms(EntityI _entity,
                            java.lang.String _regex,
                            int _size)

Specified by:

getTerms in interface FulltextSearcherI

getTerms

public TermInfoI[] getTerms(EntityI _entity,
                            java.lang.String _regex,
                            int _size,
                            boolean _includeDeleted)

Specified by:

getTerms in interface FulltextSearcherI

getTerms

public TermInfoI[] getTerms(EntityI _entity,
                            java.lang.String _regex,
                            int _size,
                            boolean _includeDeleted,
                            java.lang.String[] _propertyNames)

Specified by:

getTerms in interface FulltextSearcherI

getTerms

public TermInfoI[] getTerms(EntityI _entity,
                            java.lang.String _regex,
                            int _size,
                            boolean _includeDeleted,
                            java.lang.String[] _propertyNames,
                            boolean _sortByName)

Specified by:

getTerms in interface FulltextSearcherI

getTerms

public TermInfoI[] getTerms(EntityI _entity,
                            java.lang.String _regex,
                            int _size,
                            boolean _includeDeleted,
                            java.lang.String[] _propertyNames,
                            boolean _sortByName,
                            boolean _withSubEntities)

Specified by:

getTerms in interface FulltextSearcherI

getTermSuggestions

public java.lang.String[] getTermSuggestions(EntityI _entity,
                                             java.lang.String _term)

Returns terms that exist in the index that are similar to the given _term.

Specified by:

getTermSuggestions in interface FulltextSearcherI

Parameters:

_entity - if not null, only terms coming from data of this Entity will be included; otherwise (the default) data from all BOs will be included.

_term - the term for which similar terms from the index should be found.

_size - gives the number of terms that should be returned (default is 10).

_includeDeleted - if false (the default), the returned terms will not count term occurences from deleted BOs; if true term occurences from all BOs will be included.

_morePopular - if false (the default) all fitting term suggestions will be returned; if true only terms that are more frequently occuring than the given _term will be included.

_accuracy - a float value 0.0 <= 1.0 that will determine how close terms must be to _term to be suggested. Default is 0.5.

_propertyName - if not null, only terms coming from data of these attribute will be included; otherwise (the default) data from all attribute will be included.

_withSubEntities - if true (the default), not only data from BOs of the given Entity will be included but also data from BOs of all subclasses.

Returns:

an array of at most _size term Strings, starting with the one matching the given _term most closely. null if spellcheck functionality is not available or the _entity is not indexed.

getTermSuggestions

public java.lang.String[] getTermSuggestions(EntityI _entity,
                                             java.lang.String _term,
                                             int _size)

Specified by:

getTermSuggestions in interface FulltextSearcherI

getTermSuggestions

public java.lang.String[] getTermSuggestions(EntityI _entity,
                                             java.lang.String _term,
                                             int _size,
                                             boolean _includeDeleted)

Specified by:

getTermSuggestions in interface FulltextSearcherI

getTermSuggestions

public java.lang.String[] getTermSuggestions(EntityI _entity,
                                             java.lang.String _term,
                                             int _size,
                                             boolean _includeDeleted,
                                             boolean _morePopular)

Specified by:

getTermSuggestions in interface FulltextSearcherI

getTermSuggestions

public java.lang.String[] getTermSuggestions(EntityI _entity,
                                             java.lang.String _term,
                                             int _size,
                                             boolean _includeDeleted,
                                             boolean _morePopular,
                                             float _accuracy)

Specified by:

getTermSuggestions in interface FulltextSearcherI

getTermSuggestions

public java.lang.String[] getTermSuggestions(EntityI _entity,
                                             java.lang.String _term,
                                             int _size,
                                             boolean _includeDeleted,
                                             boolean _morePopular,
                                             float _accuracy,
                                             java.lang.String _propertyName)

Specified by:

getTermSuggestions in interface FulltextSearcherI

getTermSuggestions

public java.lang.String[] getTermSuggestions(EntityI _entity,
                                             java.lang.String _term,
                                             int _size,
                                             boolean _includeDeleted,
                                             boolean _morePopular,
                                             float _accuracy,
                                             java.lang.String _propertyName,
                                             boolean _withSubEntities)

Specified by:

getTermSuggestions in interface FulltextSearcherI

getCompass

public org.compass.core.Compass getCompass()

setCompass

public void setCompass(org.compass.core.Compass $14)

getGps

public org.compass.gps.CompassGps getGps()

setGps

public void setGps(org.compass.gps.CompassGps $15)

getGpsDevice

public MyTISMGpsDevice getGpsDevice()

setGpsDevice

public void setGpsDevice(MyTISMGpsDevice $16)

getIsInbetweenRunning

public java.util.concurrent.atomic.AtomicBoolean getIsInbetweenRunning()

setIsInbetweenRunning

public void setIsInbetweenRunning(java.util.concurrent.atomic.AtomicBoolean $17)

isIndexAllByDefault

public boolean isIndexAllByDefault()

setIndexAllByDefault

public void setIndexAllByDefault(boolean $18)

getMappingBuilder

public SchemaMappingBuilder getMappingBuilder()

setMappingBuilder

public void setMappingBuilder(SchemaMappingBuilder $19)