net.talvi.puffinplot.data.file

Class Jr6Loader

java.lang.Object

net.talvi.puffinplot.data.file.Jr6Loader

All Implemented Interfaces:

FileLoader

public class Jr6Loader
extends java.lang.Object
implements FileLoader

A loader for the JR6 format developed by Agico and used by the REMA6W program.

Constructor Summary

Constructors

Constructor and Description
Jr6Loader()

Method Summary

Modifier and Type	Method and Description
java.util.List<OptionDefinition>	getOptionDefinitions()
LoadedData	readFile(java.io.File file, java.util.Map<java.lang.String,java.lang.Object> importOptions) Returns a JR6 loader for the specified file.
LoadedData	readStream(java.io.InputStream inputStream, java.lang.String fileIdentifier, TreatmentType defaultTreatmentType) Reads JR6 data from a specified input stream.

Methods inherited from class java.lang.Object

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

Methods inherited from interface net.talvi.puffinplot.data.file.FileLoader

checkOptions, readFile

Constructor Detail

Jr6Loader

public Jr6Loader()

Method Detail

readStream

public LoadedData readStream(java.io.InputStream inputStream,
                             java.lang.String fileIdentifier,
                             TreatmentType defaultTreatmentType)

Reads JR6 data from a specified input stream.

Parameters:

inputStream - a stream of JR6 file contents

fileIdentifier - an identifier for the file (only used in load messages)

defaultTreatmentType - the treatment type to use for lines which don't specify one explicitly

Returns:

the data read from the stream

readFile

public LoadedData readFile(java.io.File file,
                           java.util.Map<java.lang.String,java.lang.Object> importOptions)

Returns a JR6 loader for the specified file.

Currently one load option can be supplied: if the option map contains the key default_treatment_type with an associated value of type TreatmentType, that value will be used as the default treatment type for the data in the file. Otherwise, treatment type will default to 3-axis AF. The default treatment type is only used for data lines which do not explicitly specify a treatment type.

Specified by:

readFile in interface FileLoader

Parameters:

file - a JR6 file to read

importOptions - load options (see method description for details)

Returns:

a JR6 loader for the specified file

getOptionDefinitions

public java.util.List<OptionDefinition> getOptionDefinitions()

Specified by:

getOptionDefinitions in interface FileLoader

Returns:

a list defining the options supported by this loader