repicea.io

Class FormatReader<H extends FormatHeader>

java.lang.Object

repicea.io.FormatReader<H>

All Implemented Interfaces:

java.io.Closeable, java.lang.AutoCloseable

Direct Known Subclasses:

CSVReader, DBFReader, SQLReader

public abstract class FormatReader<H extends FormatHeader>
extends java.lang.Object
implements java.io.Closeable

Format reader is a general class for all the readers that exists (e.g. DBFReader).

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	FormatReader(java.lang.String filename)

Method Summary

Modifier and Type	Method and Description
static FormatReader	createFormatReader(java.lang.String... fileSpec) This method selects the appropriate FormatReader class.
protected FormatField	getField(int fieldIndex) This method returns the field information provided by the header.
int	getFieldCount() This method returns the number of fields of this file.
java.lang.String	getFilename() This method returns the name of the file this reader is supposed to read.
H	getHeader() This method returns the header of the file that is to be read.
int	getRecordCount() This method returns the number of records that contains the file read by the FormatReader instance.
protected boolean	isSystemResource() This method returns true if the reader is based on a system resource or false otherwise.
java.lang.Object[]	nextRecord() This method returns the next record in the file.
abstract java.lang.Object[]	nextRecord(int skipThisNumberOfLines) This method skips some lines and then reads a record in the file;
protected java.io.InputStream	openStream() This method opens the stream depending on its nature (a resource or a file)
protected void	setFormatHeader(H header)

Methods inherited from class java.lang.Object

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

Methods inherited from interface java.io.Closeable

close

Constructor Detail

FormatReader

protected FormatReader(java.lang.String filename)
                throws java.io.IOException

Throws:

java.io.IOException

Method Detail

openStream

protected java.io.InputStream openStream()
                                  throws java.io.IOException

This method opens the stream depending on its nature (a resource or a file)

Returns:

an InputStream instance

Throws:

java.io.IOException

getRecordCount

public int getRecordCount()

This method returns the number of records that contains the file read by the FormatReader instance.

Returns:

an integer

getField

protected FormatField getField(int fieldIndex)

This method returns the field information provided by the header.

Parameters:

fieldIndex - the index of the field

Returns:

a FormatField instance

getFieldCount

public int getFieldCount()

This method returns the number of fields of this file.

Returns:

an integer

nextRecord

public java.lang.Object[] nextRecord()
                              throws java.io.IOException

This method returns the next record in the file.

Returns:

an array of Object instances

Throws:

java.io.IOException

nextRecord

public abstract java.lang.Object[] nextRecord(int skipThisNumberOfLines)
                                       throws java.io.IOException

This method skips some lines and then reads a record in the file;

Parameters:

skipThisNumberOfLines - the number of lines to skip before reading the observation

Returns:

an Array of Object instances

Throws:

java.io.IOException

createFormatReader

public static FormatReader createFormatReader(java.lang.String... fileSpec)
                                       throws java.io.IOException

This method selects the appropriate FormatReader class.

Parameters:

fileSpec - a list of specification for the file to open (e.g. the filename, the table, etc...)

Returns:

a FormatReader instance

Throws:

java.io.IOException

getHeader

public H getHeader()

This method returns the header of the file that is to be read.

Returns:

a FormatHeader instance

setFormatHeader

protected void setFormatHeader(H header)

getFilename

public java.lang.String getFilename()

This method returns the name of the file this reader is supposed to read.

Returns:

a String

isSystemResource

protected boolean isSystemResource()

This method returns true if the reader is based on a system resource or false otherwise. The condition is tested in the constructor.

Returns:

a boolean