Package adams.gui.visualization.multiobjectexport

Class AbstractMultiObjectExportWithPreferredExtensions

java.lang.Object

adams.core.logging.LoggingObject

adams.core.logging.CustomLoggingLevelObject

adams.core.option.AbstractOptionHandler

adams.gui.visualization.multiobjectexport.AbstractMultiObjectExport

adams.gui.visualization.multiobjectexport.AbstractMultiObjectExportWithPreferredExtensions

All Implemented Interfaces:

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

Direct Known Subclasses:

DirectoryExport, EmailExport, PDFExport, ZipExport

public abstract class AbstractMultiObjectExportWithPreferredExtensions
extends AbstractMultiObjectExport

Ancestor for exporters that have preferred extensions in order to locate an AbstractObjectExporter.

Author:

FracPete (fracpete at waikato dot ac dot nz)

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field	Description
protected BaseString[]	m_PreferredExtensions	the preferred extensions.

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

Method Summary

Modifier and Type	Method	Description
void	defineOptions()	Adds options to the internal list of options.
protected List<AbstractObjectExporter>	determineExporters(String name, Object obj, MessageCollection errors)	Determines the exporters to use for the object.
protected String	determineExtension(AbstractObjectExporter exporter)	Returns the extension for the given exporter.
protected BaseString[]	getDefaultPreferredExtensions()	Returns the default extensions.
BaseString[]	getPreferredExtensions()	Returns the preferred extensions to look for when exporting objects.
String	preferredExtensionsTipText()	Returns the tip text for this property.
void	setPreferredExtensions(BaseString[] value)	Sets the preferred extensions to look for when exporting objects.

Methods inherited from class adams.gui.visualization.multiobjectexport.AbstractMultiObjectExport

check, disambiguateNames, doExport, export, pruneExporters

Methods inherited from class adams.core.option.AbstractOptionHandler

cleanUpOptions, destroy, finishInit, getDefaultLoggingLevel, getOptionManager, globalInfo, 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_PreferredExtensions

protected BaseString[] m_PreferredExtensions

the preferred extensions.

Constructor Detail

AbstractMultiObjectExportWithPreferredExtensions

public AbstractMultiObjectExportWithPreferredExtensions()

Method Detail

defineOptions

public void defineOptions()

Adds options to the internal list of options.

Specified by:

defineOptions in interface OptionHandler

Overrides:

defineOptions in class AbstractOptionHandler

getDefaultPreferredExtensions

protected BaseString[] getDefaultPreferredExtensions()

Returns the default extensions.

Returns:

the default

setPreferredExtensions

public void setPreferredExtensions(BaseString[] value)

Sets the preferred extensions to look for when exporting objects.

Parameters:

value - the extensions (no dot!)

getPreferredExtensions

public BaseString[] getPreferredExtensions()

Returns the preferred extensions to look for when exporting objects.

Returns:

the extensions (no dot!)

preferredExtensionsTipText

public String preferredExtensionsTipText()

Returns the tip text for this property.

Returns:

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

determineExporters

protected List<AbstractObjectExporter> determineExporters(String name,
                                                          Object obj,
                                                          MessageCollection errors)

Determines the exporters to use for the object.

Overrides:

determineExporters in class AbstractMultiObjectExport

Parameters:

name - the name of the object

obj - the object to determine the exporter for

errors - for storing errors

Returns:

the exporters

determineExtension

protected String determineExtension(AbstractObjectExporter exporter)

Returns the extension for the given exporter.

Overrides:

determineExtension in class AbstractMultiObjectExport

Parameters:

exporter - the exporter to get the extension for

Returns:

the extension to use