net.sf.mmm.search.indexer.base

Class AbstractSearchIndexerMain

java.lang.Object

net.sf.mmm.util.component.base.AbstractLoggableObject

net.sf.mmm.util.cli.api.AbstractMain

net.sf.mmm.util.cli.api.AbstractVersionedMain

net.sf.mmm.search.indexer.base.AbstractSearchIndexerMain

Direct Known Subclasses:

SearchIndexerMain

@CliMode(id="default",
         usage="Perform search-indexing according to the configuration.")
public abstract class AbstractSearchIndexerMain
extends AbstractVersionedMain

This is the abstract base-class for a fully integrated main program that triggers the search-indexer according to a given configuration. It allows to do complex indexing of files from arbitrary sources.

Since:

1.0.0

Author:

Joerg Hohwiller (hohwille at users.sourceforge.net)

Field Summary

Fields

Modifier and Type	Field and Description
private String	configurationUrl The optional filename of the configuration XML-file.
private Boolean	optimize The option to optimize the index at the end of indexing.
private boolean	overwrite The option to overwrite the search-index and re-index from scratch.
private List<String>	sources The option defining an optional List of source-IDs that should be updated in index rather than all sources.

Fields inherited from class net.sf.mmm.util.cli.api.AbstractMain

EXIT_CODE_CONSTRAINT_VIOLATION, EXIT_CODE_ILLEGAL_SYNTAX, EXIT_CODE_OK, EXIT_CODE_UNEXPECTED

Constructor Summary

Constructors

Constructor and Description
AbstractSearchIndexerMain() The constructor.

Method Summary

Modifier and Type	Method and Description
protected abstract IocContainer	getIocContainer() An IocContainer is required.
protected int	runDefaultMode() This method is called from AbstractVersionedMain.run(CliModeObject) if the program is executed in default mode.

Methods inherited from class net.sf.mmm.util.cli.api.AbstractVersionedMain

getVersion, run

Methods inherited from class net.sf.mmm.util.cli.api.AbstractMain

getOutputSettings, getParserBuilder, getStandardError, getStandardOutput, getStreamUtil, handleError, printHelp, run, runAndExit, setStandardError, setStandardOutput, validate

Methods inherited from class net.sf.mmm.util.component.base.AbstractLoggableObject

getLogger

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

configurationUrl

@CliOption(name="--config",
           aliases="-c",
           required=false,
           operand="FILE",
           usage="The XML-configuration file. The default is {default}.")
private String configurationUrl

The optional filename of the configuration XML-file.

overwrite

@CliOption(name="--overwrite",
           required=false,
           usage="Overwrite the search-index and reindex from scratch. If combined with --source, only the entries of the specified source(s) are overwritten.")
private boolean overwrite

The option to overwrite the search-index and re-index from scratch.

optimize

@CliOption(name="--optimized",
           required=false,
           usage="Optimize the search-index after indexing. This will cause some performance overhead after indexing but will typically speed up your searches. Default is {default}.")
private Boolean optimize

The option to optimize the index at the end of indexing.

sources

@CliOption(name="--source",
           required=false,
           operand="SOURCE",
           usage="Only update the specified source-ID(s) in the index.")
private List<String> sources

The option defining an optional List of source-IDs that should be updated in index rather than all sources.

Constructor Detail

AbstractSearchIndexerMain

public AbstractSearchIndexerMain()

The constructor.

Method Detail

getIocContainer

protected abstract IocContainer getIocContainer()

An IocContainer is required. Override this method to provide it. This method gets the IocContainer used to manage components with their implementation. It should be created and initialized on the first call of this method.
This default implementation simply returns null to avoid dependencies on a IocContainer implementation. Override this method to use proper component management.

Overrides:

getIocContainer in class AbstractMain

Returns:

the IocContainer.

See Also:

SpringContainer

runDefaultMode

protected int runDefaultMode()

This method is called from AbstractVersionedMain.run(CliModeObject) if the program is executed in default mode.

Specified by:

runDefaultMode in class AbstractVersionedMain

Returns:

the error-code or AbstractMain.EXIT_CODE_OK on success.