Package adams.gui.scripting

Class AbstractFileReaderScriptlet

java.lang.Object

adams.core.logging.LoggingObject

adams.gui.scripting.AbstractScriptlet

adams.gui.scripting.AbstractUndoScriptlet

adams.gui.scripting.AbstractDataContainerPanelScriptlet

adams.gui.scripting.AbstractFileReaderScriptlet

All Implemented Interfaces:

LoggingSupporter, SizeOfHandler, Stoppable, StoppableWithFeedback, UndoHandler, Serializable, Comparable

Direct Known Subclasses:

AddDataFile, AddDataFiles, SetData

public abstract class AbstractFileReaderScriptlet
extends AbstractDataContainerPanelScriptlet

Ancestor for scriptlets that use a reader for loading files. The reader setup will be added to the report of the data containers.

Author:

FracPete (fracpete at waikato dot ac dot nz)

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field	Description
static String	READER_SETUP	the key in the report for storing the reader setup.

Fields inherited from class adams.gui.scripting.AbstractScriptlet

m_DataProvider, m_Owner, m_Parameters, m_Stopped

Fields inherited from class adams.core.logging.LoggingObject

m_Logger, m_LoggingIsEnabled, m_LoggingLevel

Constructor Summary

Constructors

Constructor	Description
AbstractFileReaderScriptlet()

Method Summary

Modifier and Type	Method	Description
protected void	storeReaderData(List<DataContainer> data, OptionHandler reader)	Adds the reader setup and the file to the report.

Methods inherited from class adams.gui.scripting.AbstractDataContainerPanelScriptlet

getDataContainerPanel, getRequirements

Methods inherited from class adams.gui.scripting.AbstractUndoScriptlet

addUndoPoint, getUndo, isUndoSupported, setUndo

Methods inherited from class adams.gui.scripting.AbstractScriptlet

compareTo, doProcess, equals, forName, getAction, getBasePanel, getDataProvider, getDescription, getOptionsDescription, getOwner, getParameter, getParameterDescription, getScriptlets, hashCode, hasOwner, hasParameter, initialize, isStopped, process, setDataProvider, setOwner, setParameter, showStatus, stopExecution, toString

Methods inherited from class adams.core.logging.LoggingObject

configureLogger, getLogger, getLoggingLevel, initializeLogging, isLoggingEnabled, sizeOf

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Detail

READER_SETUP

public static final String READER_SETUP

the key in the report for storing the reader setup.

See Also:

Constant Field Values

Constructor Detail

AbstractFileReaderScriptlet

public AbstractFileReaderScriptlet()

Method Detail

storeReaderData

protected void storeReaderData(List<DataContainer> data,
                               OptionHandler reader)

Adds the reader setup and the file to the report.

Parameters:

data - the list of containers to process

reader - the reader to store