de.ipcon.db.fulltext.compass

Class MyTISMGpsDevice

java.lang.Object

org.compass.gps.device.AbstractGpsDevice

org.compass.gps.device.support.parallel.AbstractParallelGpsDevice

de.ipcon.db.fulltext.compass.MyTISMGpsDevice

All Implemented Interfaces:

IndexingListenerI, org.compass.gps.CompassGpsDevice, org.compass.gps.MirrorDataChangesGpsDevice, org.compass.gps.PassiveMirrorGpsDevice

public class MyTISMGpsDevice
extends org.compass.gps.device.support.parallel.AbstractParallelGpsDevice
implements IndexingListenerI, org.compass.gps.PassiveMirrorGpsDevice

A CompassGpsDevice for MyTISM.

Constructor Summary

Constructors

Constructor and Description
MyTISMGpsDevice(DBManLocalI _dbm, int _fetchSize, int _maxThreads)
MyTISMGpsDevice(DBManLocalI _dbm, int _fetchSize, int _maxThreads, boolean _indexDeletedBOs)
MyTISMGpsDevice(DBManLocalI _dbm, int _fetchSize, int _maxThreads, boolean _indexDeletedBOs, SchemaMappingBuilder _mappingBuilder)

Method Summary

Modifier and Type	Method and Description
void	boHandled(BO _bo, org.compass.core.CompassIndexSession _session) From interface IndexingListenerI; called by MyTISMIndexEntitiesIndexer.index(...) for every BO that was saved to or deleted from the FTS index.
static java.util.Set	copyIndex(org.compass.core.Compass _compassFrom, org.compass.core.Compass _compassTo) Copies the index of one Compass instance to another.
org.compass.gps.device.support.parallel.IndexEntity[]	doGetIndexEntities() Overwritten from AbstractParallelGpsDevice.
org.compass.gps.device.support.parallel.IndexEntitiesIndexer	doGetIndexEntitiesIndexer() Overwritten from AbstractParallelGpsDevice.
org.compass.gps.spi.CompassGpsInterfaceDevice	getGpsID() Convenience method that returns the CompassGpsInterfaceDevice associated with this GpsDevice.
long	getHighestBPId()
MyTISMIndexEntitiesIndexer	getIndexEntitiesIndexer()
java.util.Date	getIndexLmod(EntityI _entity) From interface IndexingListenerI.
MetaDataHolder	getMetaData() Retrieves and returns the custom meta data stored in the index by the MyTISM fulltext system; null if none could be found.
void	index(org.compass.gps.IndexPlan _indexPlan)
void	indexingFinished(EntityI _entity, org.compass.core.CompassIndexSession _session, int _cSaved, int _cDeleted, int _cError) From interface IndexingListenerI; called by MyTISMIndexEntitiesIndexer.index(...) when all (relevant) BOs of EntityI _entity have sucessfully indexed.
void	indexingStarted(EntityI _entity, org.compass.core.CompassIndexSession _session) From interface IndexingListenerI; called by MyTISMIndexEntitiesIndexer.index(...) before starting to index the BOs of EntityI _entity.
boolean	isMirrorDataChanges()
java.util.Set	removeObsoleteSubIndexes(org.compass.core.Compass _compassFrom, SchemaVsIndexDiff _diff) Deletes sub indexes which are no longer needed.
void	safeSetMaxId(long _id)
void	saveMetaData(org.compass.core.CompassIndexSession _session) Stores the MetaDataHolder data in the index using the given session.
void	setMirrorDataChanges(boolean $17)
void	updateIndexPositionMetadata(org.compass.core.CompassIndexSession _session, long _lastBPId)

Methods inherited from class org.compass.gps.device.support.parallel.AbstractParallelGpsDevice

setIndexEntitiesPartitioner, setParallelIndexExecutor, start

Methods inherited from class org.compass.gps.device.AbstractGpsDevice

buildMessage, getGps, getName, injectGps, isFilteredForIndex, isPerformingIndexOperation, isRunning, refresh, setFilteredEntitiesForIndex, setName, shouldMirrorDataChanges, stop

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.compass.gps.CompassGpsDevice

getGps, getName, injectGps, isPerformingIndexOperation, isRunning, refresh, setName, shouldMirrorDataChanges, start, stop

Constructor Detail

MyTISMGpsDevice

public MyTISMGpsDevice(DBManLocalI _dbm,
                       int _fetchSize,
                       int _maxThreads)

Parameters:

_dbm - the DBManLocalI instance with which to load the BOs.

_fetchSize - the "chunk size" which determines how many BOs (of a given Entity) are loaded from the DB for indexing; should not be set to high to avoid queries running to long and being automatically aborted. Default is 50.000.

_maxThreads - the maximum number of concurrent Threads that is used when indexing. Should not be set to high, to avoid the connection limit of the database being exceeded. Default is number of CPUs initially available to the JVM.

_indexDeletedBOs - if false deleted BOs will not be loaded and indexed and if necessary be removed from the index; if true (the default) all BOs will be loaded and indexed.

MyTISMGpsDevice

public MyTISMGpsDevice(DBManLocalI _dbm,
                       int _fetchSize,
                       int _maxThreads,
                       boolean _indexDeletedBOs)

MyTISMGpsDevice

public MyTISMGpsDevice(DBManLocalI _dbm,
                       int _fetchSize,
                       int _maxThreads,
                       boolean _indexDeletedBOs,
                       SchemaMappingBuilder _mappingBuilder)

Method Detail

getGpsID

public org.compass.gps.spi.CompassGpsInterfaceDevice getGpsID()

Convenience method that returns the CompassGpsInterfaceDevice associated with this GpsDevice. This method only returns getGps() cast to CompassGpsInterfaceDevice. Everything implementing CompassGPS (which is returned from getGps()) must also implement CompassGpsInterfaceDevice; see "15.2. CompassGps" in the Compass reference manual, so we can safely do this cast. No, don't ask me what the reason is then for having two interfaces instead of just one if both must always be implemented anyway...

Returns:

getGps() cast to CompassGpsInterfaceDevice.

doGetIndexEntitiesIndexer

public org.compass.gps.device.support.parallel.IndexEntitiesIndexer doGetIndexEntitiesIndexer()

Overwritten from AbstractParallelGpsDevice. Called from the start() method of that class and should not be called otherwise/again. Use getIndexEntitiesIndexer() to access the IEI instead.

Specified by:

doGetIndexEntitiesIndexer in class org.compass.gps.device.support.parallel.AbstractParallelGpsDevice

getIndexEntitiesIndexer

public MyTISMIndexEntitiesIndexer getIndexEntitiesIndexer()

index

public void index(org.compass.gps.IndexPlan _indexPlan)
           throws org.compass.gps.CompassGpsException

Specified by:

index in interface org.compass.gps.CompassGpsDevice

Overrides:

index in class org.compass.gps.device.support.parallel.AbstractParallelGpsDevice

Throws:

org.compass.gps.CompassGpsException

getHighestBPId

public long getHighestBPId()

safeSetMaxId

public void safeSetMaxId(long _id)

getMetaData

public MetaDataHolder getMetaData()

Retrieves and returns the custom meta data stored in the index by the MyTISM fulltext system; null if none could be found.

removeObsoleteSubIndexes

public java.util.Set removeObsoleteSubIndexes(org.compass.core.Compass _compassFrom,
                                              SchemaVsIndexDiff _diff)
                                       throws java.lang.IllegalStateException

Deletes sub indexes which are no longer needed.

Returns:

a Set which contains the sub indexes that could not be deleted; this should not happen and normally the Set should be empty.

Throws:

java.lang.IllegalStateException - if the Compass instance does not use a LuceneSearchEngineIndexManager.

copyIndex

public static java.util.Set copyIndex(org.compass.core.Compass _compassFrom,
                                      org.compass.core.Compass _compassTo)
                               throws java.lang.IllegalStateException

Copies the index of one Compass instance to another.

Parameters:

_compassFrom - the Compass instance whose index should be copied.

_compassTo - the Compass instance to which the index should be copied.

Returns:

a Set which contains the sub indexes that could not be copied; this should not happen and normally the Set should be empty.

Throws:

java.lang.IllegalStateException - if one of the Compass instances does not use a LuceneSearchEngineIndexManager.

doGetIndexEntities

public org.compass.gps.device.support.parallel.IndexEntity[] doGetIndexEntities()
                                                                         throws org.compass.gps.CompassGpsException

Overwritten from AbstractParallelGpsDevice. Called from the index() method of that class and should not be called otherwise.

Specified by:

doGetIndexEntities in class org.compass.gps.device.support.parallel.AbstractParallelGpsDevice

Throws:

org.compass.gps.CompassGpsException

indexingStarted

public void indexingStarted(EntityI _entity,
                            org.compass.core.CompassIndexSession _session)

From interface IndexingListenerI; called by MyTISMIndexEntitiesIndexer.index(...) before starting to index the BOs of EntityI _entity.

Specified by:

indexingStarted in interface IndexingListenerI

boHandled

public void boHandled(BO _bo,
                      org.compass.core.CompassIndexSession _session)

From interface IndexingListenerI; called by MyTISMIndexEntitiesIndexer.index(...) for every BO that was saved to or deleted from the FTS index.

Specified by:

boHandled in interface IndexingListenerI

indexingFinished

public void indexingFinished(EntityI _entity,
                             org.compass.core.CompassIndexSession _session,
                             int _cSaved,
                             int _cDeleted,
                             int _cError)

From interface IndexingListenerI; called by MyTISMIndexEntitiesIndexer.index(...) when all (relevant) BOs of EntityI _entity have sucessfully indexed.

Specified by:

indexingFinished in interface IndexingListenerI

updateIndexPositionMetadata

public void updateIndexPositionMetadata(org.compass.core.CompassIndexSession _session,
                                        long _lastBPId)

Specified by:

updateIndexPositionMetadata in interface IndexingListenerI

getIndexLmod

public java.util.Date getIndexLmod(EntityI _entity)

From interface IndexingListenerI.

Specified by:

getIndexLmod in interface IndexingListenerI

saveMetaData

public void saveMetaData(org.compass.core.CompassIndexSession _session)

Stores the MetaDataHolder data in the index using the given session.

isMirrorDataChanges

public boolean isMirrorDataChanges()

Specified by:

isMirrorDataChanges in interface org.compass.gps.MirrorDataChangesGpsDevice

setMirrorDataChanges

public void setMirrorDataChanges(boolean $17)

Specified by:

setMirrorDataChanges in interface org.compass.gps.MirrorDataChangesGpsDevice