idare.imagenode.internal.DataSetReaders.CSVReader

Class CSVReader

java.lang.Object

idare.imagenode.Interfaces.DataSetReaders.IDAREDatasetReader

idare.imagenode.internal.DataSetReaders.CSVReader.CSVReader

All Implemented Interfaces:

IDAREService

Direct Known Subclasses:

TSVReader

public class CSVReader
extends IDAREDatasetReader

The CSV Reader assumes, that

Author:

Thomas Pfau

Field Summary

Fields inherited from class idare.imagenode.Interfaces.DataSetReaders.IDAREDatasetReader

IS_READY, IS_SET_UP

Constructor Summary

Constructors

Constructor and Description
CSVReader()

Method Summary

Modifier and Type	Method and Description
boolean	fileTypeAccepted(File inputfile) Test, whether the file can potentially be read by this reader.
protected String	getSeparator() Get the column separator used in this reader
IDAREReaderSetupTask	getSetupTask(File inputfile, boolean twocolumn) The Reader should provide a Task that can be used to set up the reader for future use on the given inputFile.
IDAREWorkbook	readData(File inputfile) Read an input File and create an IDARE compatible Workbook structure.
void	resetReader() Reset the reader, clearing any temporary fields.

Methods inherited from class idare.imagenode.Interfaces.DataSetReaders.IDAREDatasetReader

getStatusMessage, reset, setStatusMessage

Methods inherited from class java.lang.Object

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

Constructor Detail

CSVReader

public CSVReader()

Method Detail

readData

public IDAREWorkbook readData(File inputfile)
                       throws WrongFormat,
                              IOException

Description copied from class: IDAREDatasetReader

Read an input File and create an IDARE compatible Workbook structure.

Specified by:

readData in class IDAREDatasetReader

Parameters:

inputfile - the file to read.

Returns:

A workbook containing the data from the file

Throws:

WrongFormat - If the format cannot be read by this Reader, or if the file provided is not the file the reader was set up for.

IOException - If there are problems with the IO of the file

fileTypeAccepted

public boolean fileTypeAccepted(File inputfile)

Description copied from class: IDAREDatasetReader

Test, whether the file can potentially be read by this reader. THis only checks the File extension, and not the content.

Specified by:

fileTypeAccepted in class IDAREDatasetReader

Parameters:

inputfile - The file to check

Returns:

whether this parser can be used to read the file.

getSeparator

protected String getSeparator()

Get the column separator used in this reader

Returns:

he string representing the column separator

getSetupTask

public IDAREReaderSetupTask getSetupTask(File inputfile,
                                         boolean twocolumn)

Description copied from class: IDAREDatasetReader

The Reader should provide a Task that can be used to set up the reader for future use on the given inputFile. if null is returned, it is assumed, that no Task is needed

Specified by:

getSetupTask in class IDAREDatasetReader

Parameters:

inputfile - the input file to generate the setup task. This file can be read to extract information for options.

twocolumn - whether a IDAREWorkbook with label and id or a set with only an id is requested.

Returns:

a Task that can obtain input from the user via Tunables, or null if no setup information is necessary

resetReader

public void resetReader()

Description copied from class: IDAREDatasetReader

Reset the reader, clearing any temporary fields. after this call the reader status should be "IS_READY" When extending the class, this Method should be overwritten but the reset method from the abstract class should also be called,

Specified by:

resetReader in class IDAREDatasetReader