Package adams.data.io.input

Class ASCSpectrumReader

java.lang.Object

adams.core.logging.LoggingObject

adams.core.logging.CustomLoggingLevelObject

adams.core.option.AbstractOptionHandler

adams.data.io.input.AbstractDataContainerReader<Spectrum>

adams.data.io.input.AbstractSpectrumReader

adams.data.io.input.AbstractTextBasedSpectrumReader

adams.data.io.input.ASCSpectrumReader

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.management.LocaleSupporter, adams.core.option.OptionHandler, adams.core.ShallowCopySupporter<adams.data.io.input.DataContainerReader>, adams.core.SizeOfHandler, adams.core.Stoppable, adams.data.io.input.DataContainerReader<Spectrum>, adams.data.io.input.StreamableDataContainerReader<Spectrum>, adams.data.io.input.StreamableTextBasedDataContainerReader<Spectrum>, Serializable, Comparable

public class ASCSpectrumReader
extends AbstractTextBasedSpectrumReader
implements adams.core.management.LocaleSupporter, adams.data.io.input.StreamableTextBasedDataContainerReader<Spectrum>

Reads spectra in BLGG ASC format.

Valid options are:

-D (property: debug)
         If set to true, scheme may output additional info to the console.
 

-input <java.io.File> (property: input)
         The file to read and turn into a spectrum.
         default: .
 

Author:

fracpete (fracpete at waikato dot ac dot nz)

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
protected class	ASCSpectrumReader.ParsedFile	Class for parsing an ASC file.

Field Summary

Fields

Modifier and Type	Field	Description
protected Locale	m_Locale	the locale to use.

Fields inherited from class adams.data.io.input.AbstractSpectrumReader

m_Format, m_Instrument, m_KeepFormat, m_Stopped, m_UseAbsoluteSource, OPTION_OUTPUTDIR

Fields inherited from class adams.data.io.input.AbstractDataContainerReader

m_CreateDummyReport, m_Input, m_InputIsFile, m_Processed, m_ReadData

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

Method Summary

Modifier and Type	Method	Description
void	defineOptions()	Adds options to the internal list of options.
protected String	fixKey(String key)	Turns the key into a proper SampleData constant.
String	getFormatDescription()	Returns a string describing the format (used in the file chooser).
String[]	getFormatExtensions()	Returns the extension(s) of the format.
Locale	getLocale()	Returns the locale in use.
String	globalInfo()	Returns a string describing the object.
String	localeTipText()	Returns the tip text for this property.
static void	main(String[] args)	Runs the reader from the command-line.
protected void	readData(List<String> content)	Performs the actual reading.
void	setLocale(Locale value)	Sets the locale to use.

Methods inherited from class adams.data.io.input.AbstractTextBasedSpectrumReader

read, readData

Methods inherited from class adams.data.io.input.AbstractSpectrumReader

checkData, createDummyReport, formatTipText, getDefaultFormat, getDefaultInstrument, getDefaultKeepFormat, getDefaultUseAbsoluteSource, getFormat, getInstrument, getKeepFormat, getReaders, getUseAbsoluteSource, instrumentTipText, keepFormatTipText, postProcessData, runReader, setFormat, setInstrument, setKeepFormat, setUseAbsoluteSource, stopExecution, useAbsoluteSourceTipText

Methods inherited from class adams.data.io.input.AbstractDataContainerReader

cleanUp, compareTo, createDummyReportTipText, destroy, doRead, equals, getAdditionalInformation, getCreateDummyReport, getDefaultFormatExtension, getInput, initialize, inputTipText, isInputFile, read, reset, setCreateDummyReport, setInput, shallowCopy, shallowCopy

Methods inherited from class adams.core.option.AbstractOptionHandler

cleanUpOptions, finishInit, getDefaultLoggingLevel, getOptionManager, 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.AdditionalInformationHandler

getAdditionalInformation

Methods inherited from interface adams.core.CleanUpHandler

cleanUp

Methods inherited from interface java.lang.Comparable

compareTo

Methods inherited from interface adams.data.io.input.DataContainerReader

createDummyReportTipText, getCreateDummyReport, getInput, inputTipText, isInputFile, read, setCreateDummyReport, setInput

Methods inherited from interface adams.core.Destroyable

destroy

Methods inherited from interface adams.core.io.FileFormatHandler

getDefaultFormatExtension

Methods inherited from interface adams.core.logging.LoggingLevelHandler

getLoggingLevel

Methods inherited from interface adams.core.option.OptionHandler

cleanUpOptions, getOptionManager, toCommandLine

Methods inherited from interface adams.core.ShallowCopySupporter

shallowCopy, shallowCopy

Methods inherited from interface adams.data.io.input.StreamableDataContainerReader

read

Field Detail

m_Locale

protected Locale m_Locale

the locale to use.

Constructor Detail

ASCSpectrumReader

public ASCSpectrumReader()

Method Detail

globalInfo

public String globalInfo()

Returns a string describing the object.

Specified by:

globalInfo in interface adams.core.GlobalInfoSupporter

Specified by:

globalInfo in class adams.core.option.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 adams.core.option.OptionHandler

Overrides:

defineOptions in class AbstractSpectrumReader

getFormatDescription

public String getFormatDescription()

Returns a string describing the format (used in the file chooser).

Specified by:

getFormatDescription in interface adams.core.io.FileFormatHandler

Specified by:

getFormatDescription in class adams.data.io.input.AbstractDataContainerReader<Spectrum>

Returns:

a description suitable for displaying in the file chooser

getFormatExtensions

public String[] getFormatExtensions()

Returns the extension(s) of the format.

Specified by:

getFormatExtensions in interface adams.core.io.FileFormatHandler

Specified by:

getFormatExtensions in class adams.data.io.input.AbstractDataContainerReader<Spectrum>

Returns:

the extension(s) (without the dot!)

setLocale

public void setLocale(Locale value)

Sets the locale to use.

Specified by:

setLocale in interface adams.core.management.LocaleSupporter

Parameters:

value - the locale

getLocale

public Locale getLocale()

Returns the locale in use.

Specified by:

getLocale in interface adams.core.management.LocaleSupporter

Returns:

the locale

localeTipText

public String localeTipText()

Returns the tip text for this property.

Returns:

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

fixKey

protected String fixKey(String key)

Turns the key into a proper SampleData constant.

Parameters:

key - the key to transform if necessary

Returns:

the fixed key

readData

protected void readData(List<String> content)

Performs the actual reading.

Specified by:

readData in class AbstractTextBasedSpectrumReader

Parameters:

content - the content to read from

main

public static void main(String[] args)

Runs the reader from the command-line. If the option AbstractSpectrumReader.OPTION_OUTPUTDIR is specified then the read spectra get output as .spec files in that directory.

Parameters:

args - the command-line options to use