Package adams.core.io.filesearch

Class TextFileSearchHandler

java.lang.Object

adams.core.logging.LoggingObject

adams.core.logging.CustomLoggingLevelObject

adams.core.option.AbstractOptionHandler

adams.core.io.filesearch.AbstractFileSearchHandler

adams.core.io.filesearch.AbstractFileSearchHandlerWithEncoding

adams.core.io.filesearch.TextFileSearchHandler

All Implemented Interfaces:

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

public class TextFileSearchHandler
extends AbstractFileSearchHandlerWithEncoding
implements RegExpFileSearchHandler, StreamableFileSearchHandler

Searches text files, skips binary files.

Author:

FracPete (fracpete at waikato dot ac dot nz)

See Also:

Serialized Form

Field Summary

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

m_Encoding

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
TextFileSearchHandler()

Method Summary

Modifier and Type	Method	Description
String	globalInfo()	Returns a string describing the object.
boolean	handles(String file)	Checks whether the handler can manage this file.
boolean	searchFile(String file, String searchText, boolean caseSensitive, ExceptionHandler handler)	Searches the specified file.
boolean	searchRegExp(String file, String searchText, boolean caseSensitive, ExceptionHandler handler)	Searches the specified file using regular expressions.
boolean	searchStream(Reader reader, String searchText, boolean caseSensitive, ExceptionHandler handler)	Searches the specified character stream.

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

defineOptions, encodingTipText, getEncoding, setEncoding

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

getHandlerForFile, isStopped, shallowCopy, shallowCopy, stopExecution

Methods inherited from class adams.core.option.AbstractOptionHandler

cleanUpOptions, destroy, finishInit, getDefaultLoggingLevel, getOptionManager, 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.logging.LoggingLevelHandler

getLoggingLevel

Methods inherited from interface adams.core.Stoppable

stopExecution

Methods inherited from interface adams.core.StoppableWithFeedback

isStopped

Constructor Detail

TextFileSearchHandler

public TextFileSearchHandler()

Method Detail

globalInfo

public String globalInfo()

Returns a string describing the object.

Specified by:

globalInfo in interface GlobalInfoSupporter

Specified by:

globalInfo in class AbstractOptionHandler

Returns:

a description suitable for displaying in the gui

handles

public boolean handles(String file)

Checks whether the handler can manage this file.

Specified by:

handles in interface FileSearchHandler

Parameters:

file - the file to check

Returns:

true if handler can search this type of file

searchFile

public boolean searchFile(String file,
                          String searchText,
                          boolean caseSensitive,
                          ExceptionHandler handler)

Searches the specified file.

Specified by:

searchFile in interface FileSearchHandler

Parameters:

file - the file to search

searchText - the search text

handler - for handling exceptions, can be null

Returns:

true if the search text was found

searchRegExp

public boolean searchRegExp(String file,
                            String searchText,
                            boolean caseSensitive,
                            ExceptionHandler handler)

Searches the specified file using regular expressions.

Specified by:

searchRegExp in interface RegExpFileSearchHandler

Parameters:

file - the file to search

searchText - the search text

handler - for handling exceptions, can be null

Returns:

true if the search text was found

searchStream

public boolean searchStream(Reader reader,
                            String searchText,
                            boolean caseSensitive,
                            ExceptionHandler handler)

Searches the specified character stream.

Specified by:

searchStream in interface StreamableFileSearchHandler

Parameters:

reader - the reader to search

searchText - the search text

handler - for handling exceptions, can be null

Returns:

true if the search text was found