net.sf.mmm.search.api.config

Interface SearchConfigurationLoader

All Known Subinterfaces:

SearchEngineConfigurationLoader, SearchIndexerConfigurationLoader

All Known Implementing Classes:

SearchEngineConfigurationLoaderImpl, SearchIndexerConfigurationLoaderImpl

public interface SearchConfigurationLoader

This is the abstract interface for reading the SearchConfiguration for a given data location. The implementation shall at least support reading the configuration from the filesystem as XML.

Since:

1.0.0

Author:

Joerg Hohwiller (hohwille at users.sourceforge.net)

Method Summary

Modifier and Type	Method and Description
JaxbBeanHolder<? extends SearchConfiguration>	loadConfiguration() This method reads the configuration from SearchConfiguration.DEFAULT_CONFIGURATION_URL.
JaxbBeanHolder<? extends SearchConfiguration>	loadConfiguration(String locationUrl) This method reads the configuration from the given location.

Method Detail

loadConfiguration

JaxbBeanHolder<? extends SearchConfiguration> loadConfiguration()

This method reads the configuration from SearchConfiguration.DEFAULT_CONFIGURATION_URL.

Returns:

the JaxbBeanHolder.

loadConfiguration

JaxbBeanHolder<? extends SearchConfiguration> 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.

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.