ch.specchio.file.writer

Class SpectrumWriter

java.lang.Object

ch.specchio.file.writer.SpectrumWriter

Direct Known Subclasses:

CsvWriter, ENVIWriter

public abstract class SpectrumWriter
extends java.lang.Object

Abstract class for writing spectral data.

Constructor Summary

Constructors

Constructor and Description
SpectrumWriter(java.io.OutputStream osIn, int typeIn, int headerIn) Constructor.
SpectrumWriter(java.io.OutputStream osIn, int typeIn, int headerIn, SPECCHIOClient specchio_client) Constructor.

Method Summary

Modifier and Type	Method and Description
void	endSpace() Finish writing the current space.
void	endSpace(java.lang.Boolean combine) Finish writing the current space.
Space	getCurrentSpace() Get a reference to the Space object being written.
java.io.OutputStream	getOutputStream() Get a reference to the output stream.
int	getTimeFormat() Get the time format.
void	setTimeFormat(int timeFormatIn) Set the time format.
void	setUseSpectrumUnits(boolean useSpectrumUnitsIn) Set whether or not to use the units specified by the Spectrum objects.
void	startSpace(Space spaceIn) Start writing a new space.
boolean	useSpectrumUnits() Return whether or not to use the units specified by the Spectrum objects.
abstract void	writeSpectrum(Spectrum s) Write a spectrum to the output stream.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

SpectrumWriter

public SpectrumWriter(java.io.OutputStream osIn,
                      int typeIn,
                      int headerIn,
                      SPECCHIOClient specchio_client)

Constructor.

Parameters:

osIn - the output stream being written to

typeIn - the file type

headerIn - HeaderBody.Header or HeaderBody.Body

specchio_client - reference to the specchio client (used for e.g. taxonomy translations)

SpectrumWriter

public SpectrumWriter(java.io.OutputStream osIn,
                      int typeIn,
                      int headerIn)

Constructor.

Parameters:

osIn - the output stream being written to

typeIn - the file type

headerIn - HeaderBody.Header or HeaderBody.Body

Method Detail

endSpace

public void endSpace()
              throws java.io.IOException

Finish writing the current space.

Throws:

java.io.IOException - could not write to output

endSpace

public void endSpace(java.lang.Boolean combine)
              throws java.io.IOException

Finish writing the current space.

Parameters:

combine - indicates if the measurement should be appended at the end of the metadata and attribute columns

Throws:

java.io.IOException - could not write to output

getCurrentSpace

public Space getCurrentSpace()

Get a reference to the Space object being written.

Returns:

a reference to the current Space object

getOutputStream

public java.io.OutputStream getOutputStream()

Get a reference to the output stream.

Returns:

a reference to the output stream

getTimeFormat

public int getTimeFormat()

Get the time format.

Returns:

TimeFormat.Seconds or TimeFormats.Formatted

startSpace

public void startSpace(Space spaceIn)
                throws java.io.IOException

Start writing a new space.

Parameters:

spaceIn - the space

Throws:

java.io.IOException - could not write to output

setTimeFormat

public void setTimeFormat(int timeFormatIn)

Set the time format.

Parameters:

timeFormatIn - TimeFormats.Seconds or TimeFormats.Formatted

setUseSpectrumUnits

public void setUseSpectrumUnits(boolean useSpectrumUnitsIn)

Set whether or not to use the units specified by the Spectrum objects.

Parameters:

useSpectrumUnitsIn - true or false

useSpectrumUnits

public boolean useSpectrumUnits()

Return whether or not to use the units specified by the Spectrum objects.

Returns:

true or false

writeSpectrum

public abstract void writeSpectrum(Spectrum s)
                            throws java.io.IOException

Write a spectrum to the output stream.

Parameters:

s - the spectrum to be written

Throws:

java.io.IOException - could not write to the output stream