Package adams.core.io.filesearch

Class AbstractMetaFileSearchHandler

java.lang.Object

adams.core.logging.LoggingObject

adams.core.logging.CustomLoggingLevelObject

adams.core.option.AbstractOptionHandler

adams.core.io.filesearch.AbstractFileSearchHandler

adams.core.io.filesearch.AbstractMetaFileSearchHandler

All Implemented Interfaces:

Destroyable, GlobalInfoSupporter, FileSearchHandler, LoggingLevelHandler, LoggingSupporter, OptionHandler, ShallowCopySupporter<FileSearchHandler>, SizeOfHandler, Stoppable, StoppableWithFeedback, Serializable

Direct Known Subclasses:

AbstractMetaFileSearchHandlerWithEncoding

public abstract class AbstractMetaFileSearchHandler
extends AbstractFileSearchHandler

Ancestor for file search handlers that use the base handler to do the actual search.

Author:

FracPete (fracpete at waikato dot ac dot nz)

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field	Description
protected StreamableFileSearchHandler	m_Handler	the base handler.

Fields inherited from class adams.core.io.filesearch.AbstractFileSearchHandler

LOGGER, m_Handlers, m_Stopped

Fields inherited from class adams.core.option.AbstractOptionHandler

m_OptionManager

Fields inherited from class adams.core.logging.LoggingObject

m_Logger, m_LoggingIsEnabled, m_LoggingLevel

Constructor Summary

Constructors

Constructor	Description
AbstractMetaFileSearchHandler()

Method Summary

Modifier and Type	Method	Description
void	defineOptions()	Adds options to the internal list of options.
protected StreamableFileSearchHandler	getDefaultHandler()	Returns the default handler.
StreamableFileSearchHandler	getHandler()	Returns the handler to use.
String	handlerTipText()	Returns the tip text for this property.
void	setHandler(StreamableFileSearchHandler value)	Sets the handler to use.
void	stopExecution()	Stops the execution.

Methods inherited from class adams.core.io.filesearch.AbstractFileSearchHandler

getHandlerForFile, isStopped, shallowCopy, shallowCopy

Methods inherited from class adams.core.option.AbstractOptionHandler

cleanUpOptions, destroy, finishInit, getDefaultLoggingLevel, getOptionManager, globalInfo, initialize, loggingLevelTipText, newOptionManager, reset, setLoggingLevel, toCommandLine, toString

Methods inherited from class adams.core.logging.LoggingObject

configureLogger, getLogger, getLoggingLevel, initializeLogging, isLoggingEnabled, sizeOf

Methods inherited from class java.lang.Object

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

Methods inherited from interface adams.core.io.filesearch.FileSearchHandler

handles, searchFile

Methods inherited from interface adams.core.logging.LoggingLevelHandler

getLoggingLevel

Field Detail

m_Handler

protected StreamableFileSearchHandler m_Handler

the base handler.

Constructor Detail

AbstractMetaFileSearchHandler

public AbstractMetaFileSearchHandler()

Method Detail

defineOptions

public void defineOptions()

Adds options to the internal list of options.

Specified by:

defineOptions in interface OptionHandler

Overrides:

defineOptions in class AbstractOptionHandler

getDefaultHandler

protected StreamableFileSearchHandler getDefaultHandler()

Returns the default handler.

Returns:

the default

setHandler

public void setHandler(StreamableFileSearchHandler value)

Sets the handler to use.

Parameters:

value - the handler

getHandler

public StreamableFileSearchHandler getHandler()

Returns the handler to use.

Returns:

the handler

handlerTipText

public String handlerTipText()

Returns the tip text for this property.

Returns:

tip text for this property suitable for displaying in the GUI or for listing the options.

stopExecution

public void stopExecution()

Stops the execution.

Specified by:

stopExecution in interface Stoppable

Overrides:

stopExecution in class AbstractFileSearchHandler