net.sf.mmm.search.api.config

Interface SearchConfiguration

All Known Subinterfaces:

SearchEngineConfiguration, SearchIndexerConfiguration

All Known Implementing Classes:

AbstractSearchConfigurationBean, SearchConfigurationBean, SearchEngineConfigurationBean, SearchIndexerConfigurationBean

public interface SearchConfiguration

This is the interface for the configuration of the entire search (e.g. for the SearchEngine).
You will typically provide your configuration as XML in the default configuration file. The base-implementation comes with an according (un)marshaler.

Since:

1.0.0

Author:

Joerg Hohwiller (hohwille at users.sourceforge.net)

Field Summary

Fields

Modifier and Type	Field and Description
static String	DEFAULT_CONFIGURATION_URL The default location of the configuration for the search.

Method Summary

Modifier and Type	Method and Description
SearchFields	getFields() This method gets the SearchFields.
SearchProperties	getProperties() This method gets the general purpose SearchProperties.
SearchIndexConfiguration	getSearchIndex() This method gets the SearchIndexConfiguration.
SearchSource	getSource(String id) This method gets the SearchSource with the given ID.
Collection<? extends SearchSource>	getSources() This method gets the Collection of sources.

Field Detail

DEFAULT_CONFIGURATION_URL

static final String DEFAULT_CONFIGURATION_URL

The default location of the configuration for the search.

See Also:

Constant Field Values

Method Detail

getSearchIndex

SearchIndexConfiguration getSearchIndex()

This method gets the SearchIndexConfiguration.

Returns:

the SearchIndexConfiguration.

getSources

Collection<? extends SearchSource> getSources()

This method gets the Collection of sources.

Returns:

the SearchSources.

getSource

SearchSource getSource(String id)

This method gets the SearchSource with the given ID.

Parameters:

id - is the ID of the requested SearchSource.

Returns:

the requested SearchSource or null if none is configured for the given id.

getProperties

SearchProperties getProperties()

This method gets the general purpose SearchProperties.

Returns:

the SearchProperties.

getFields

SearchFields getFields()

This method gets the SearchFields.

Returns:

the SearchFields.