prajna.io

Class TabbedRecordReader

java.lang.Object

prajna.io.TabbedRecordReader

All Implemented Interfaces:

FormatReader<DataRecord>

public class TabbedRecordReader
extends java.lang.Object
implements FormatReader<DataRecord>

Reads record data from tab delimited files or input streams. The first line of the file should be the field names, also separated by tabs. A DataRecord is created for each line after the first.

Author:

Edward Swing

Constructor Summary

Constructors

Constructor and Description
TabbedRecordReader(java.lang.String source) Constructor, specifying the file to load.
TabbedRecordReader(java.net.URL dataUrl) Construct a TabbedRecordReader to read from the specified URL stream.

Method Summary

Methods

Modifier and Type	Method and Description
boolean	canRead() Return whether this reader is in a state where it can attempt to read data.
void	close() Close the current reader stream.
java.lang.String	getFilters() Get the filters for this reader.
int	getMaxRecordsRead() Get the maximum number of records read by each call to readData().
java.util.List<DataRecord>	getRecords() Returns all records read in by the Reader.
java.lang.String	getSource() Get the source for this reader
boolean	hasMoreData() returns whether the reader has more data to read.
java.util.List<DataRecord>	readData() Read data from the input stream.
void	setFilters(java.lang.String filters) Set the filters for this reader
void	setInputStream(java.io.InputStream inStream) Sets the input stream.
void	setMaxRecordsRead(int maxRecordsRead) Set the maximum number of records read by each call to readData().
void	setSource(java.lang.String source) Set the source for this reader.

Methods inherited from class java.lang.Object

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

Constructor Detail

TabbedRecordReader

public TabbedRecordReader(java.lang.String source)
                   throws java.io.FileNotFoundException

Constructor, specifying the file to load. The reader assumes the file is in the local directory. The imageField is set to "image".

Parameters:

source - the filename of the tabbed File

Throws:

java.io.FileNotFoundException - if the file is not available

TabbedRecordReader

public TabbedRecordReader(java.net.URL dataUrl)
                   throws java.io.IOException

Construct a TabbedRecordReader to read from the specified URL stream.

Parameters:

dataUrl - the URL for the data stream

Throws:

java.io.IOException - if there is a problem reading the URL

Method Detail

canRead

public boolean canRead()

Return whether this reader is in a state where it can attempt to read data. This call checks to make sure the reader is initialized, and has read field names.

Specified by:

canRead in interface FormatReader<DataRecord>

Returns:

true if it can read data, false otherwise

close

public void close()

Close the current reader stream.

Specified by:

close in interface FormatReader<DataRecord>

getFilters

public java.lang.String getFilters()

Get the filters for this reader. Currently only returns null, as the setFilters method does nothing

Specified by:

getFilters in interface FormatReader<DataRecord>

Returns:

null

getMaxRecordsRead

public int getMaxRecordsRead()

Get the maximum number of records read by each call to readData().

Returns:

the maximum records read

getRecords

public java.util.List<DataRecord> getRecords()

Returns all records read in by the Reader. This returns an accumulated list of DataRecords which is the concatenation of all records returned from calls to readData().

Returns:

a list of all records read in by the Reader

getSource

public java.lang.String getSource()

Get the source for this reader

Specified by:

getSource in interface FormatReader<DataRecord>

Returns:

the source for this reader

hasMoreData

public boolean hasMoreData()

returns whether the reader has more data to read.

Specified by:

hasMoreData in interface FormatReader<DataRecord>

Returns:

true if the reader has more data to read, false otherwise

readData

public java.util.List<DataRecord> readData()

Read data from the input stream. This method returns the list of records read. The records will be read until either the number of records read reaches the maximum, or until all records have been read from the stream.

Specified by:

readData in interface FormatReader<DataRecord>

Returns:

the list of records read by this method.

setFilters

public void setFilters(java.lang.String filters)

Set the filters for this reader

Specified by:

setFilters in interface FormatReader<DataRecord>

Parameters:

filters -

setInputStream

public void setInputStream(java.io.InputStream inStream)

Sets the input stream.

Parameters:

inStream - the input stream

setMaxRecordsRead

public void setMaxRecordsRead(int maxRecordsRead)

Set the maximum number of records read by each call to readData(). If this is not explicitly set, the maximum records is set to -1, which signifies no limit.

Parameters:

maxRecordsRead - the maximum records read

setSource

public void setSource(java.lang.String source)

Set the source for this reader. The source should be the filename of the file to be read

Specified by:

setSource in interface FormatReader<DataRecord>

Parameters:

source - the source (file) for the reader