org.canova.api.records.reader

Interface RecordReader

All Superinterfaces:

AutoCloseable, Closeable, Configurable, Serializable

All Known Subinterfaces:

SequenceRecordReader

All Known Implementing Classes:

CollectionRecordReader, ComposableRecordReader, CSVRecordReader, CSVSequenceRecordReader, FileRecordReader, JacksonRecordReader, LibSvmRecordReader, LineRecordReader, MatlabRecordReader, RegexLineRecordReader, RegexSequenceRecordReader, SVMLightRecordReader

public interface RecordReader
extends Closeable, Serializable, Configurable

Record reader

Author:

Adam Gibson

Field Summary

Fields

Modifier and Type	Field and Description
static String	APPEND_LABEL
static String	LABELS
static String	NAME_SPACE

Method Summary

Modifier and Type	Method and Description
List<String>	getLabels() List of label strings
boolean	hasNext() Whether there are anymore records
void	initialize(Configuration conf, InputSplit split) Called once at initialization.
void	initialize(InputSplit split) Called once at initialization.
Collection<Writable>	next() Get the next record
Collection<Writable>	record(URI uri, DataInputStream dataInputStream) Load the record from the given DataInputStream Unlike next() the internal state of the RecordReader is not modified Implementations of this method should not close the DataInputStream
void	reset() Reset record reader iterator

Methods inherited from interface java.io.Closeable

close

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

getConf, setConf

Field Detail

NAME_SPACE

static final String NAME_SPACE

APPEND_LABEL

static final String APPEND_LABEL

LABELS

static final String LABELS

Method Detail

initialize

void initialize(InputSplit split)
         throws IOException,
                InterruptedException

Called once at initialization.

Parameters:

split - the split that defines the range of records to read

Throws:

IOException

InterruptedException

initialize

void initialize(Configuration conf,
                InputSplit split)
         throws IOException,
                InterruptedException

Called once at initialization.

Parameters:

conf - a configuration for initialization

split - the split that defines the range of records to read

Throws:

IOException

InterruptedException

next

Collection<Writable> next()

Get the next record

Returns:

hasNext

boolean hasNext()

Whether there are anymore records

Returns:

getLabels

List<String> getLabels()

List of label strings

Returns:

reset

void reset()

Reset record reader iterator

record

Collection<Writable> record(URI uri,
                            DataInputStream dataInputStream)
                     throws IOException

Load the record from the given DataInputStream Unlike 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