org.openepics.cable.services.dl

Class RecordStream

java.lang.Object

org.openepics.cable.services.dl.RecordStream

public class RecordStream
extends Object

This represents a record stream. It reads from DataStream and packs the data into DSRecords.

Author:

Vasu Vuppala, Sunil Sah

Constructor Summary

Constructors

Constructor and Description
RecordStream(Iterable<String> urlColumnNames) Constructs a record stream.

Method Summary

Modifier and Type	Method and Description
void	close() Closes the stream releasing all resources associated to it.
String	getColumnLabel(String name) Returns the column label from header definition currently in use.
DSHeader	getHeader() Returns the last processed header.
DSRecord	getNextRecord() Reads and returns the next record.
boolean	hasNextRecord()
void	open(InputStream stream) Opens the given stream to read records from.

Methods inherited from class java.lang.Object

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

Constructor Detail

RecordStream

public RecordStream(Iterable<String> urlColumnNames)

Constructs a record stream.

Parameters:

urlColumnNames - The list of column names that can contain URL links, used for spreadsheet parsing optimization.

Method Detail

open

public void open(InputStream stream)

Opens the given stream to read records from. After this call, this object owns the stream.

Parameters:

stream - the stream to read from

getNextRecord

public DSRecord getNextRecord()

Reads and returns the next record.

Returns:

the record or null if no next record

hasNextRecord

public boolean hasNextRecord()

Returns:

true if there is next record, else false

close

public void close()

Closes the stream releasing all resources associated to it.

getColumnLabel

public String getColumnLabel(String name)

Returns the column label from header definition currently in use.

Parameters:

name - the name of the column

Returns:

the label

getHeader

public DSHeader getHeader()

Returns the last processed header. This method can be called after the stream closes.

Returns:

the header