Package org.datavec.api.records.reader

Interface SequenceRecordReader

All Superinterfaces:

AutoCloseable, Closeable, Configurable, RecordReader, Serializable

All Known Implementing Classes:

CollectionSequenceRecordReader, CSVLineSequenceRecordReader, CSVMultiSequenceRecordReader, CSVNLinesSequenceRecordReader, CSVSequenceRecordReader, CSVVariableSlidingWindowRecordReader, FileBatchSequenceRecordReader, InMemorySequenceRecordReader, JacksonLineSequenceRecordReader, RegexSequenceRecordReader, TransformProcessSequenceRecordReader

public interface SequenceRecordReader
extends RecordReader

Field Summary

Fields inherited from interface org.datavec.api.records.reader.RecordReader

APPEND_LABEL, LABELS, NAME_SPACE

Method Summary

Modifier and Type	Method	Description
List<SequenceRecord>	loadSequenceFromMetaData(List<RecordMetaData> recordMetaDatas)	Load multiple sequence records from the given a list of RecordMetaData instances
SequenceRecord	loadSequenceFromMetaData(RecordMetaData recordMetaData)	Load a single sequence record from the given RecordMetaData instance Note: that for data that isn't splittable (i.e., text data that needs to be scanned/split), it is more efficient to load multiple records at once using loadSequenceFromMetaData(List)
SequenceRecord	nextSequence()	Similar to sequenceRecord(), but returns a Record object, that may include metadata such as the source of the data
List<List<Writable>>	sequenceRecord()	Returns a sequence record.
List<List<Writable>>	sequenceRecord(URI uri, DataInputStream dataInputStream)	Load a sequence record from the given DataInputStream Unlike RecordReader.next() the internal state of the RecordReader is not modified Implementations of this method should not close the DataInputStream

Methods inherited from interface java.io.Closeable

close

Methods inherited from interface org.datavec.api.conf.Configurable

getConf, setConf

Methods inherited from interface org.datavec.api.records.reader.RecordReader

batchesSupported, getLabels, getListeners, hasNext, initialize, initialize, loadFromMetaData, loadFromMetaData, next, next, nextRecord, record, reset, resetSupported, setListeners, setListeners

Method Detail

sequenceRecord

List<List<Writable>> sequenceRecord()

Returns a sequence record.

Returns:

a sequence of records

sequenceRecord

List<List<Writable>> sequenceRecord(URI uri,
                                    DataInputStream dataInputStream)
                             throws IOException

Load a sequence record from the given DataInputStream Unlike RecordReader.next() the internal state of the RecordReader is not modified Implementations of this method should not close the DataInputStream

Throws:

IOException - if error occurs during reading from the input stream

nextSequence

SequenceRecord nextSequence()

Similar to sequenceRecord(), but returns a Record object, that may include metadata such as the source of the data

Returns:

next sequence record

loadSequenceFromMetaData

SequenceRecord loadSequenceFromMetaData(RecordMetaData recordMetaData)
                                 throws IOException

Load a single sequence record from the given RecordMetaData instance
Note: that for data that isn't splittable (i.e., text data that needs to be scanned/split), it is more efficient to load multiple records at once using loadSequenceFromMetaData(List)

Parameters:

recordMetaData - Metadata for the sequence record that we want to load from

Returns:

Single sequence record for the given RecordMetaData instance

Throws:

IOException - If I/O error occurs during loading

loadSequenceFromMetaData

List<SequenceRecord> loadSequenceFromMetaData(List<RecordMetaData> recordMetaDatas)
                                       throws IOException

Load multiple sequence records from the given a list of RecordMetaData instances

Parameters:

recordMetaDatas - Metadata for the records that we want to load from

Returns:

Multiple sequence record for the given RecordMetaData instances

Throws:

IOException - If I/O error occurs during loading