net.sf.mmm.search.engine.base.config

Class SearchEngineConfigurationLoaderImpl

java.lang.Object

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

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

net.sf.mmm.util.xml.base.jaxb.XmlBeanMapper<SearchEngineConfigurationBean>

net.sf.mmm.search.engine.base.config.SearchEngineConfigurationLoaderImpl

All Implemented Interfaces:

ValidationEventHandler, SearchConfigurationLoader, SearchEngineConfigurationLoader

public class SearchEngineConfigurationLoaderImpl
extends XmlBeanMapper<SearchEngineConfigurationBean>
implements SearchEngineConfigurationLoader

This is the implementation of the SearchEngineConfigurationLoader interface.

Since:

1.0.0

Author:

Joerg Hohwiller (hohwille at users.sourceforge.net)

Constructor Summary

Constructors

Constructor and Description
SearchEngineConfigurationLoaderImpl() The constructor.

Method Summary

Modifier and Type	Method and Description
protected boolean	isIgnoreUndefinedNodes()
SearchEngineConfigurationHolder	loadConfiguration() This method reads the configuration from SearchConfiguration.DEFAULT_CONFIGURATION_URL.
SearchEngineConfigurationHolder	loadConfiguration(String locationUrl) This method reads the configuration from the given location.

Methods inherited from class net.sf.mmm.util.xml.base.jaxb.XmlBeanMapper

doInitialize, getJaxbContext, getOrCreateMarshaller, getOrCreateUnmarshaller, getResourceFactory, getStaxUtil, handleEvent, isXIncludeAware, loadXml, loadXml, loadXml, loadXml, saveXml, saveXml, saveXml, setResourceFactory, setStaxUtil, setXIncludeAware, validate

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

Constructor Detail

SearchEngineConfigurationLoaderImpl

public SearchEngineConfigurationLoaderImpl()

The constructor.

Method Detail

isIgnoreUndefinedNodes

protected boolean isIgnoreUndefinedNodes()

Overrides:

isIgnoreUndefinedNodes in class XmlBeanMapper<SearchEngineConfigurationBean>

Returns:

true if undefined tags and attributes should be ignored (may be useful for compatibility), false if they shall cause an exception (default is false).

loadConfiguration

public SearchEngineConfigurationHolder loadConfiguration()

This method reads the configuration from SearchConfiguration.DEFAULT_CONFIGURATION_URL.

Specified by:

loadConfiguration in interface SearchConfigurationLoader

Specified by:

loadConfiguration in interface SearchEngineConfigurationLoader

Returns:

the JaxbBeanHolder.

loadConfiguration

public SearchEngineConfigurationHolder 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

Specified by:

loadConfiguration in interface SearchEngineConfigurationLoader

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.