Package adams.gui.visualization.multiobjectexport

Class DirectoryExport

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

adams.gui.visualization.multiobjectexport.DirectoryExport

All Implemented Interfaces:

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

public class DirectoryExport
extends AbstractMultiObjectExportWithPreferredExtensions

Exports the objects to a directory.

Version:

$Revision$

Author:

FracPete (fracpete at waikato dot ac dot nz)

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field	Description
protected PlaceholderDirectory	m_OutputDir	the directory to export the objects to.
protected String	m_Prefix	the prefix for the files.

Fields inherited from class adams.gui.visualization.multiobjectexport.AbstractMultiObjectExportWithPreferredExtensions

m_PreferredExtensions

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

Method Summary

Modifier and Type	Method	Description
protected String	check(String[] names, Object[] objects)	Checks the data.
void	defineOptions()	Adds options to the internal list of options.
protected String	doExport(String[] names, Object[] objects)	Performs the actual export of the objects using the given names.
PlaceholderDirectory	getOutputDir()	Returns the output directory for the files generated from the objects.
String	getPrefix()	Returns the optional prefix for the file names.
String	globalInfo()	Returns a string describing the object.
String	outputDirTipText()	Returns the tip text for this property.
String	prefixTipText()	Returns the tip text for this property.
void	setOutputDir(PlaceholderDirectory value)	Sets the output directory for the files generated from the objects.
void	setPrefix(String value)	Sets the optional prefix for the file names.

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

determineExporters, determineExtension, getDefaultPreferredExtensions, getPreferredExtensions, preferredExtensionsTipText, setPreferredExtensions

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

disambiguateNames, export, pruneExporters

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_OutputDir

protected PlaceholderDirectory m_OutputDir

the directory to export the objects to.

m_Prefix

protected String m_Prefix

the prefix for the files.

Constructor Detail

DirectoryExport

public DirectoryExport()

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 AbstractMultiObjectExportWithPreferredExtensions

setOutputDir

public void setOutputDir(PlaceholderDirectory value)

Sets the output directory for the files generated from the objects.

Parameters:

value - the directory

getOutputDir

public PlaceholderDirectory getOutputDir()

Returns the output directory for the files generated from the objects.

Returns:

the directory

outputDirTipText

public String outputDirTipText()

Returns the tip text for this property.

Returns:

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

setPrefix

public void setPrefix(String value)

Sets the optional prefix for the file names.

Parameters:

value - the prefix

getPrefix

public String getPrefix()

Returns the optional prefix for the file names.

Returns:

the prefix

prefixTipText

public String prefixTipText()

Returns the tip text for this property.

Returns:

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

check

protected String check(String[] names,
                       Object[] objects)

Checks the data.

Overrides:

check in class AbstractMultiObjectExport

Parameters:

names - the names for the objects

objects - the objects

Returns:

null if successful, otherwise error message

doExport

protected String doExport(String[] names,
                          Object[] objects)

Performs the actual export of the objects using the given names.

Specified by:

doExport in class AbstractMultiObjectExport

Parameters:

names - the names for the objects

objects - the objects

Returns:

null if successful, otherwise error message