Package adams.data.io.output

Class AbstractSpectrumWriter

java.lang.Object

adams.core.logging.LoggingObject

adams.core.logging.CustomLoggingLevelObject

adams.core.option.AbstractOptionHandler

adams.data.io.output.AbstractDataContainerWriter<Spectrum>

adams.data.io.output.AbstractSpectrumWriter

All Implemented Interfaces:

adams.core.AdditionalInformationHandler, adams.core.CleanUpHandler, adams.core.Destroyable, adams.core.GlobalInfoSupporter, adams.core.io.FileFormatHandler, adams.core.logging.LoggingLevelHandler, adams.core.logging.LoggingSupporter, adams.core.option.OptionHandler, adams.core.ShallowCopySupporter<adams.data.io.output.DataContainerWriter>, adams.core.SizeOfHandler, adams.data.io.output.DataContainerWriter<Spectrum>, Serializable, Comparable

Direct Known Subclasses:

AbstractTextBasedSpectrumWriter, FilteredSpectrumWriter, JCampDX2SpectrumWriter, NIRSpectrumWriter, SimpleSpectrumWriter, SpectrumImageWriter, SpreadSheetSpectrumWriter, ZippedSpectrumWriter

public abstract class AbstractSpectrumWriter
extends adams.data.io.output.AbstractDataContainerWriter<Spectrum>

Abstract ancestor for writers that write spectra to files in various formats.

Author:

fracpete (fracpete at waikato dot ac dot nz)

See Also:

Serialized Form

Field Summary

Fields inherited from class adams.data.io.output.AbstractDataContainerWriter

m_Output, m_OutputIsFile

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

Method Summary

Modifier and Type	Method	Description
boolean	canWriteMultiple()	Returns whether writing of multiple containers is supported.
static String[]	getWriters()	Returns a list with classnames of writers.
String	outputTipText()	Returns the tip text for this property.

Methods inherited from class adams.data.io.output.AbstractDataContainerWriter

checkData, cleanUp, compareTo, defineOptions, destroy, equals, forCommandLine, forName, getAdditionalInformation, getDefaultFormatExtension, getFormatDescription, getFormatExtensions, getOutput, isOutputFile, reset, setOutput, shallowCopy, shallowCopy, write, write, writeData

Methods inherited from class adams.core.option.AbstractOptionHandler

cleanUpOptions, finishInit, getDefaultLoggingLevel, getOptionManager, globalInfo, initialize, loggingLevelTipText, newOptionManager, 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, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface adams.core.logging.LoggingLevelHandler

getLoggingLevel

Methods inherited from interface adams.core.option.OptionHandler

cleanUpOptions, getOptionManager, toCommandLine

Constructor Detail

AbstractSpectrumWriter

public AbstractSpectrumWriter()

Method Detail

canWriteMultiple

public boolean canWriteMultiple()

Returns whether writing of multiple containers is supported.

Specified by:

canWriteMultiple in interface adams.data.io.output.DataContainerWriter<Spectrum>

Specified by:

canWriteMultiple in class adams.data.io.output.AbstractDataContainerWriter<Spectrum>

Returns:

true if multiple containers are supported

outputTipText

public String outputTipText()

Returns the tip text for this property.

Specified by:

outputTipText in interface adams.data.io.output.DataContainerWriter<Spectrum>

Overrides:

outputTipText in class adams.data.io.output.AbstractDataContainerWriter<Spectrum>

Returns:

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

getWriters

public static String[] getWriters()

Returns a list with classnames of writers.

Returns:

the writer classnames