Package adams.core.io.fileuse

Class TextReader

java.lang.Object

adams.core.logging.LoggingObject

adams.core.logging.CustomLoggingLevelObject

adams.core.option.AbstractOptionHandler

adams.core.io.fileuse.AbstractFileUseCheck

adams.core.io.fileuse.TextReader

All Implemented Interfaces:

Destroyable, GlobalInfoSupporter, LoggingLevelHandler, LoggingSupporter, OptionHandler, SizeOfHandler, Serializable

public class TextReader
extends AbstractFileUseCheck

Uses the specified text reader to load the file for checking the 'in use' state: if reading fails, then it is assumed the file is in use.

-logging-level <OFF|SEVERE|WARNING|INFO|CONFIG|FINE|FINER|FINEST> (property: loggingLevel)
    The logging level for outputting errors and debugging output.
    default: WARNING
 

-reader <adams.data.io.input.AbstractTextReader> (property: reader)
    The text reader to use for checking the 'in use' state.
    default: adams.data.io.input.LineArrayTextReader
 

Version:

$Revision$

Author:

FracPete (fracpete at waikato dot ac dot nz)

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field	Description
protected AbstractTextReader	m_Reader	the text reader to use.

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

Method Summary

Modifier and Type	Method	Description
void	defineOptions()	Adds options to the internal list of options.
AbstractTextReader	getReader()	Returns the text reader to use for checking the file use.
String	globalInfo()	Returns a string describing the object.
boolean	isInUse(File file)	Checks whether the file is in use.
String	readerTipText()	Returns the tip text for this property.
void	setReader(AbstractTextReader value)	Sets the text reader to use for checking the file use.

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

Field Detail

m_Reader

protected AbstractTextReader m_Reader

the text reader to use.

Constructor Detail

TextReader

public TextReader()

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

defineOptions

public void defineOptions()

Adds options to the internal list of options.

Specified by:

defineOptions in interface OptionHandler

Overrides:

defineOptions in class AbstractOptionHandler

setReader

public void setReader(AbstractTextReader value)

Sets the text reader to use for checking the file use.

Parameters:

value - the reader

getReader

public AbstractTextReader getReader()

Returns the text reader to use for checking the file use.

Returns:

the reader

readerTipText

public String readerTipText()

Returns the tip text for this property.

Returns:

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

isInUse

public boolean isInUse(File file)

Checks whether the file is in use.

Specified by:

isInUse in class AbstractFileUseCheck

Parameters:

file - the file to check

Returns:

true if in use