net.sf.mmm.search.indexer.base

Class AbstractConfiguredSearchIndexer

java.lang.Object

net.sf.mmm.util.component.base.AbstractComponent

net.sf.mmm.util.component.base.AbstractLoggableComponent

net.sf.mmm.search.indexer.base.AbstractConfiguredSearchIndexer

All Implemented Interfaces:

ConfiguredSearchIndexer

Direct Known Subclasses:

ConfiguredSearchIndexerImpl

public abstract class AbstractConfiguredSearchIndexer
extends AbstractLoggableComponent
implements ConfiguredSearchIndexer

This is the implementation of the ConfiguredSearchIndexer.

Author:

Joerg Hohwiller (hohwille at users.sourceforge.net)

Field Summary

Fields

Modifier and Type	Field and Description
private GenericContextFactory	genericContextFactory
private SearchIndexerConfigurationLoader	searchIndexerConfigurationLoader
private SearchIndexerBuilder	searchIndexerManager
private SearchIndexerStateLoader	searchIndexerStateLoader
private SearchIndexerUpdateStrategyManager	searchIndexerUpdateStrategyManager

Constructor Summary

Constructors

Constructor and Description
AbstractConfiguredSearchIndexer() The constructor.

Method Summary

Modifier and Type	Method and Description
void	doInitialize() This method initializes this object.
protected GenericContextFactory	getGenericContextFactory() This method gets the GenericContextFactory.
protected SearchIndexerConfigurationLoader	getSearchIndexerConfigurationLoader()
protected SearchIndexerBuilder	getSearchIndexerManager()
protected SearchIndexerStateLoader	getSearchIndexerStateLoader()
protected SearchIndexerUpdateStrategyManager	getSearchIndexerUpdateStrategyManager()
void	index(SearchIndexerConfigurationHolder configurationHolder) This method performs the indexing of all sources given by configuration.
void	index(SearchIndexerConfigurationHolder configurationHolder, ConfiguredSearchIndexerOptions options) This method performs the indexing for the given configuration and options.
void	index(SearchIndexerSource source, ConfiguredSearchIndexerOptions options, SearchIndexerStateHolder stateHolder, SearchIndexer searchIndexer) This method performs the indexing for the given source.
void	index(String configurationLocation) This method reads the SearchIndexerConfiguration from the given configurationLocation and performs the indexing.
void	index(String configurationLocation, ConfiguredSearchIndexerOptions options) This method reads the SearchIndexerConfiguration from the given configurationLocation and performs the indexing.
void	setGenericContextFactory(GenericContextFactory genericContextFactory)
void	setSearchIndexerConfigurationLoader(SearchIndexerConfigurationLoader searchIndexerConfigurationLoader)
void	setSearchIndexerManager(SearchIndexerBuilder searchIndexerManager)
void	setSearchIndexerStateLoader(SearchIndexerStateLoader searchIndexerStateLoader)
void	setSearchIndexerUpdateStrategyManager(SearchIndexerUpdateStrategyManager searchIndexerUpdateStrategyManager)

Methods inherited from class net.sf.mmm.util.component.base.AbstractLoggableComponent

createLogger, getLogger

Methods inherited from class net.sf.mmm.util.component.base.AbstractComponent

doInitialized, getInitializationState, initialize

Methods inherited from class java.lang.Object

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

Field Detail

searchIndexerManager

private SearchIndexerBuilder searchIndexerManager

See Also:

getSearchIndexerManager()

searchIndexerConfigurationLoader

private SearchIndexerConfigurationLoader searchIndexerConfigurationLoader

See Also:

getSearchIndexerConfigurationLoader()

searchIndexerStateLoader

private SearchIndexerStateLoader searchIndexerStateLoader

See Also:

getSearchIndexerStateLoader()

searchIndexerUpdateStrategyManager

private SearchIndexerUpdateStrategyManager searchIndexerUpdateStrategyManager

See Also:

getSearchIndexerUpdateStrategyManager()

genericContextFactory

private GenericContextFactory genericContextFactory

See Also:

getGenericContextFactory()

Constructor Detail

AbstractConfiguredSearchIndexer

public AbstractConfiguredSearchIndexer()

The constructor.

Method Detail

getSearchIndexerManager

protected SearchIndexerBuilder getSearchIndexerManager()

Returns:

the searchIndexerManager

setSearchIndexerManager

@Inject
public void setSearchIndexerManager(SearchIndexerBuilder searchIndexerManager)

Parameters:

searchIndexerManager - is the searchIndexerManager to set

getSearchIndexerConfigurationLoader

protected SearchIndexerConfigurationLoader getSearchIndexerConfigurationLoader()

Returns:

the searchIndexerConfigurationReader

setSearchIndexerConfigurationLoader

@Inject
public void setSearchIndexerConfigurationLoader(SearchIndexerConfigurationLoader searchIndexerConfigurationLoader)

Parameters:

searchIndexerConfigurationLoader - is the searchIndexerConfigurationReader to set

getSearchIndexerStateLoader

protected SearchIndexerStateLoader getSearchIndexerStateLoader()

Returns:

the searchIndexStateManager

setSearchIndexerStateLoader

@Inject
public void setSearchIndexerStateLoader(SearchIndexerStateLoader searchIndexerStateLoader)

Parameters:

searchIndexerStateLoader - is the searchIndexStateManager to set

getSearchIndexerUpdateStrategyManager

protected SearchIndexerUpdateStrategyManager getSearchIndexerUpdateStrategyManager()

Returns:

the deltaSearchIndexerBuilder

setSearchIndexerUpdateStrategyManager

@Inject
public void setSearchIndexerUpdateStrategyManager(SearchIndexerUpdateStrategyManager searchIndexerUpdateStrategyManager)

Parameters:

searchIndexerUpdateStrategyManager - is the deltaSearchIndexerBuilder to set

getGenericContextFactory

protected GenericContextFactory getGenericContextFactory()

This method gets the GenericContextFactory.

Returns:

the GenericContextFactory.

setGenericContextFactory

@Inject
public void setGenericContextFactory(GenericContextFactory genericContextFactory)

Parameters:

genericContextFactory - is the genericContextFactory to set

doInitialize

public void doInitialize()

This method initializes this object.

Overrides:

doInitialize in class AbstractLoggableComponent

index

public void index(SearchIndexerSource source,
                  ConfiguredSearchIndexerOptions options,
                  SearchIndexerStateHolder stateHolder,
                  SearchIndexer searchIndexer)

This method performs the indexing for the given source.

Specified by:

index in interface ConfiguredSearchIndexer

Parameters:

source - is the source to index.

options - are the ConfiguredSearchIndexerOptions.

stateHolder - is the SearchIndexerStateHolder.

searchIndexer - is the SearchIndexer used for modifying the index.

See Also:

SearchIndexerSource.getLocations()

index

public void index(String configurationLocation)

This method reads the SearchIndexerConfiguration from the given configurationLocation and performs the indexing.

Specified by:

index in interface ConfiguredSearchIndexer

Parameters:

configurationLocation - is the location where the configuration data shall be read from. This is typically a path into the filesystem.

See Also:

ConfiguredSearchIndexer.index(SearchIndexerConfigurationHolder), SearchIndexerConfigurationLoader.loadConfiguration(String)

index

public void index(String configurationLocation,
                  ConfiguredSearchIndexerOptions options)

This method reads the SearchIndexerConfiguration from the given configurationLocation and performs the indexing.

Specified by:

index in interface ConfiguredSearchIndexer

Parameters:

configurationLocation - is the location where the configuration data shall be read from. This is typically a path into the filesystem.

options - are the ConfiguredSearchIndexerOptions.

See Also:

ConfiguredSearchIndexer.index(SearchIndexerConfigurationHolder, ConfiguredSearchIndexerOptions), SearchIndexerConfigurationLoader.loadConfiguration(String)

index

public void index(SearchIndexerConfigurationHolder configurationHolder)

This method performs the indexing of all sources given by configuration.

Specified by:

index in interface ConfiguredSearchIndexer

Parameters:

configurationHolder - is the SearchIndexerConfigurationHolder.

See Also:

SearchIndexerSource.getLocations()

index

public void index(SearchIndexerConfigurationHolder configurationHolder,
                  ConfiguredSearchIndexerOptions options)

This method performs the indexing for the given configuration and options.

Specified by:

index in interface ConfiguredSearchIndexer

Parameters:

configurationHolder - is the SearchIndexerConfigurationHolder.

options - are the ConfiguredSearchIndexerOptions.

See Also:

ConfiguredSearchIndexer.index(SearchIndexerConfigurationHolder), ConfiguredSearchIndexerOptions.getSourceIds()