net.sf.mmm.search.indexer.api

Interface ConfiguredSearchIndexer

All Known Implementing Classes:

AbstractConfiguredSearchIndexer, ConfiguredSearchIndexerImpl

@ComponentSpecification
public interface ConfiguredSearchIndexer

This is the interface for a high-level SearchIndexer. It recursively crawls directories, performs filtering, URI-transformations. It will use the ResourceSearchIndexer for indexing of single resources.

Since:

1.0.0

Author:

Joerg Hohwiller (hohwille at users.sourceforge.net)

Method Summary

Modifier and Type	Method and Description
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.

Method Detail

index

void index(String configurationLocation)

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

Parameters:

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

See Also:

index(SearchIndexerConfigurationHolder), SearchIndexerConfigurationLoader.loadConfiguration(String)

index

void index(String configurationLocation,
           ConfiguredSearchIndexerOptions options)

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

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:

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

index

void index(SearchIndexerConfigurationHolder configurationHolder)

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

Parameters:

configurationHolder - is the SearchIndexerConfigurationHolder.

See Also:

SearchIndexerSource.getLocations()

index

void index(SearchIndexerConfigurationHolder configurationHolder,
           ConfiguredSearchIndexerOptions options)

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

Parameters:

configurationHolder - is the SearchIndexerConfigurationHolder.

options - are the ConfiguredSearchIndexerOptions.

See Also:

index(SearchIndexerConfigurationHolder), ConfiguredSearchIndexerOptions.getSourceIds()

index

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

This method performs the indexing for the given source.

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()