net.sf.mmm.search.indexer.api.config

Interface SearchIndexerConfigurationLoader

All Superinterfaces:

SearchConfigurationLoader

All Known Implementing Classes:

SearchIndexerConfigurationLoaderImpl

@ComponentSpecification
public interface SearchIndexerConfigurationLoader
extends SearchConfigurationLoader

This is the SearchConfigurationLoader for the SearchIndexerConfiguration.

Since:

1.0.0

Author:

Joerg Hohwiller (hohwille at users.sourceforge.net)

Method Summary

Modifier and Type	Method and Description
SearchIndexerConfigurationHolder	loadConfiguration() This method reads the configuration from SearchConfiguration.DEFAULT_CONFIGURATION_URL.
SearchIndexerConfigurationHolder	loadConfiguration(String locationUrl) This method reads the configuration from the given location.
void	validateConfiguration(SearchIndexerConfiguration configuration) This method validates the given configuration according to logical constraints.

Method Detail

loadConfiguration

SearchIndexerConfigurationHolder loadConfiguration()

This method reads the configuration from SearchConfiguration.DEFAULT_CONFIGURATION_URL.

Specified by:

loadConfiguration in interface SearchConfigurationLoader

Returns:

the JaxbBeanHolder.

loadConfiguration

SearchIndexerConfigurationHolder loadConfiguration(String locationUrl)

This method reads the configuration from the given location. The configuration data is parsed according to its format (typically XML) and returned as JaxbBeanHolder.

Specified by:

loadConfiguration in interface SearchConfigurationLoader

Parameters:

locationUrl - is the location where the SearchConfiguration data shall be read from. This is typically a path into the filesystem (e.g. "file://~/.mmm/search.xml"). Please note that "file://" can be omitted.

Returns:

the JaxbBeanHolder.

validateConfiguration

void validateConfiguration(SearchIndexerConfiguration configuration)
                    throws RuntimeException

This method validates the given configuration according to logical constraints.

Parameters:

configuration - is the SearchIndexerConfiguration to validate.

Throws:

RuntimeException - if the configuration is invalid.