Package adams.gui.tools.previewbrowser

Class AbstractSpreadSheetHandler

java.lang.Object

adams.core.logging.LoggingObject

adams.core.logging.CustomLoggingLevelObject

adams.core.option.AbstractOptionHandler

adams.gui.tools.previewbrowser.AbstractContentHandler

adams.gui.tools.previewbrowser.AbstractSpreadSheetHandler

All Implemented Interfaces:

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

Direct Known Subclasses:

CsvSpreadSheetHandler, ExcelSpreadSheetHandler, ODFSpreadSheetHandler, TsvSpreadSheetHandler

public abstract class AbstractSpreadSheetHandler
extends AbstractContentHandler

Ancestor for handlers that display spreadsheets.

Author:

fracpete (fracpete at waikato dot ac dot nz)

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field	Description
protected CellRenderingCustomizer	m_CellRenderingCustomizer	for customizing the cell rendering.
static String	UNNAMED_SHEET_PREFIX	the prefix for unnamed sheets.

Fields inherited from class adams.gui.tools.previewbrowser.AbstractContentHandler

m_Relation

Fields inherited from class adams.core.option.AbstractOptionHandler

m_OptionManager

Fields inherited from class adams.core.logging.LoggingObject

m_Logger, m_LoggingIsEnabled, m_LoggingLevel

Fields inherited from interface adams.gui.tools.previewbrowser.ContentHandler

MATCH_ALL

Constructor Summary

Constructors

Constructor	Description
AbstractSpreadSheetHandler()

Method Summary

Modifier and Type	Method	Description
String	cellRenderingCustomizerTipText()	Returns the tip text for this property.
PreviewPanel	createPreview(File file)	Creates the actual view.
void	defineOptions()	Adds options to the internal list of options.
CellRenderingCustomizer	getCellRenderingCustomizer()	Returns the renderer.
String	globalInfo()	Returns a string describing the object.
protected abstract SpreadSheet[]	readAll(File file)	Reads all the individual spreadsheets from the file.
void	setCellRenderingCustomizer(CellRenderingCustomizer value)	Sets the renderer.

Methods inherited from class adams.gui.tools.previewbrowser.AbstractContentHandler

checkFile, getHandlers, getHandlersForFile, getHandlersForFile, getPreview, getRelation, hasHandler, hasHandler, reusePreview

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.gui.tools.previewbrowser.ContentHandler

getExtensions

Methods inherited from interface adams.core.Destroyable

destroy

Methods inherited from interface adams.core.logging.LoggingLevelHandler

getLoggingLevel

Methods inherited from interface adams.core.option.OptionHandler

cleanUpOptions, getOptionManager, toCommandLine

Field Detail

UNNAMED_SHEET_PREFIX

public static final String UNNAMED_SHEET_PREFIX

the prefix for unnamed sheets.

See Also:

Constant Field Values

m_CellRenderingCustomizer

protected CellRenderingCustomizer m_CellRenderingCustomizer

for customizing the cell rendering.

Constructor Detail

AbstractSpreadSheetHandler

public AbstractSpreadSheetHandler()

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

setCellRenderingCustomizer

public void setCellRenderingCustomizer(CellRenderingCustomizer value)

Sets the renderer.

Parameters:

value - the renderer

getCellRenderingCustomizer

public CellRenderingCustomizer getCellRenderingCustomizer()

Returns the renderer.

Returns:

the renderer

cellRenderingCustomizerTipText

public String cellRenderingCustomizerTipText()

Returns the tip text for this property.

Returns:

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

readAll

protected abstract SpreadSheet[] readAll(File file)

Reads all the individual spreadsheets from the file.

Parameters:

file - the file to read

Returns:

the spreadsheet objects that were read from the file

createPreview

public PreviewPanel createPreview(File file)

Creates the actual view.

Specified by:

createPreview in interface ContentHandler

Specified by:

createPreview in class AbstractContentHandler

Parameters:

file - the file to create the view for

Returns:

the view