Package adams.core.io.filesearch

Class RarFileSearchHandler

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

adams.core.io.filesearch.AbstractMetaFileSearchHandlerWithEncoding

adams.core.io.filesearch.RarFileSearchHandler

All Implemented Interfaces:

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

public class RarFileSearchHandler
extends AbstractMetaFileSearchHandlerWithEncoding

Searches rar-compressed (text) files.

Author:

FracPete (fracpete at waikato dot ac dot nz)

See Also:

Serialized Form

Field Summary

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

m_Encoding

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

m_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
RarFileSearchHandler()

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.

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

defineOptions, encodingTipText, getEncoding, setEncoding

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

getDefaultHandler, getHandler, handlerTipText, setHandler, stopExecution

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, 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

Constructor Detail

RarFileSearchHandler

public RarFileSearchHandler()

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.

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.

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