Package pulse.io.readers

Class ReaderManager

java.lang.Object

pulse.io.readers.ReaderManager

public class ReaderManager
extends Object

A ReaderManager is a single class that manages most input operations.

ReaderManager can dynamically access all available readers using their Reflexive interfaces. It can also dynamically assign a file with a recognised format to a specific reader. Note that MetaFilePopulator is not covered by this class, as there is only one Metadata format which is internal to PULsE.

This class heavily relies on the stream API from the Java SDK.

See Also:

Reflexive, CurveReader, DatasetReader

Method Summary

Modifier and Type	Method	Description
static List<CurveReader>	curveReaders()	Finds all classes assignable from CurveReader within this package.
static List<DatasetReader>	datasetReaders()	Finds all classes assignable from DatasetReader within this package.
static List<CurveReader>	findCurveReaders(String pckgname)	Finds all classes assignable from CurveReader within the pckgname package.
static List<DatasetReader>	findDatasetReaders(String pckgname)	Finds all classes assignable from DatasetReader within the pckgname package.
static List<PulseDataReader>	findPulseReaders(String pckgname)
static List<String>	getCurveExtensions()	Returns a list of extensions recognised by the available CurveReaders.
static List<String>	getDatasetExtensions()	Returns a list of extensions recognised by the available DatasetReaders.
static List<String>	getPulseExtensions()
static <T> Set<T>	load(AbstractReader<T> reader, String location, String listName)	This method is specifically introduced to handle multiple files in a resources folder enclosed within the jar archive.
static List<PulseDataReader>	pulseReaders()
static <T> T	read(List<? extends AbstractReader<T>> readers, File file)	Attempts to find a DatasetReader for processing file.
static <T> Set<T>	readDirectory(List<AbstractReader<T>> readers, File directory)	Obtains a set of files in directory and attemps to convert each file to T using readers.
static Version	readVersion()

Methods inherited from class java.lang.Object

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

Method Detail

getCurveExtensions

public static List<String> getCurveExtensions()

Returns a list of extensions recognised by the available CurveReaders.

Returns:

a List of {

getPulseExtensions

public static List<String> getPulseExtensions()

getDatasetExtensions

public static List<String> getDatasetExtensions()

Returns a list of extensions recognised by the available DatasetReaders.

Returns:

a List of {

findCurveReaders

public static List<CurveReader> findCurveReaders(String pckgname)

Finds all classes assignable from CurveReader within the pckgname package.

Parameters:

pckgname - the name of the package to conduct search in.

Returns:

a list of CurveReaders in pckgname

findPulseReaders

public static List<PulseDataReader> findPulseReaders(String pckgname)

curveReaders

public static List<CurveReader> curveReaders()

Finds all classes assignable from CurveReader within this package.

Returns:

a list of CurveReaders in this package

pulseReaders

public static List<PulseDataReader> pulseReaders()

findDatasetReaders

public static List<DatasetReader> findDatasetReaders(String pckgname)

Finds all classes assignable from DatasetReader within the pckgname package.

Parameters:

pckgname - the name of the package to conduct search in.

Returns:

a list of DatasetReaders in pckgname

datasetReaders

public static List<DatasetReader> datasetReaders()

Finds all classes assignable from DatasetReader within this package.

Returns:

a list of DatasetReaders in this package

read

public static <T> T read(List<? extends AbstractReader<T>> readers,
                         File file)

Attempts to find a DatasetReader for processing file.

Type Parameters:

T -

Parameters:

readers -

file - the target file supposedly containing data for an InterpolationDataset.

Returns:

an InterpolationDataset extracted from {

Throws:

IllegalArgumentException - if the file has an unsupported extension

readDirectory

public static <T> Set<T> readDirectory(List<AbstractReader<T>> readers,
                                       File directory)
                                throws IllegalArgumentException

Obtains a set of files in directory and attemps to convert each file to T using readers.

Type Parameters:

T - a type recognised by readers

Parameters:

readers - a list of AbstractReaders capable of processing T

directory - a directory

Returns:

the set of converted T objects

Throws:

IllegalArgumentException - if second argument is not a directory

load

public static <T> Set<T> load(AbstractReader<T> reader,
                              String location,
                              String listName)

This method is specifically introduced to handle multiple files in a resources folder enclosed within the jar archive. A list of files is required to be included in the same location, which is scanned and each entry is added to a temporary list of names. A combination of these names with the relative location allows reading separate files and collating the result in a unique Set.

Type Parameters:

T - a type recognised by the reader

Parameters:

reader - the reader specifically targetted at T

location - the relative location of files

listName - the name of the list-file

Returns:

a unique Set of T

readVersion

public static Version readVersion()