org.datavec.api.records.reader.impl.collection

Class ListStringRecordReader

java.lang.Object

org.datavec.api.records.reader.BaseRecordReader

org.datavec.api.records.reader.impl.collection.ListStringRecordReader

All Implemented Interfaces:

Closeable, Serializable, AutoCloseable, Configurable, RecordReader

public class ListStringRecordReader
extends BaseRecordReader

Iterates through a list of strings return a record. Only accepts an @link {ListStringInputSplit} as input.

Author:

Adam Gibson

See Also:

Serialized Form

Field Summary

Fields inherited from class org.datavec.api.records.reader.BaseRecordReader

listeners

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

APPEND_LABEL, LABELS, NAME_SPACE

Constructor Summary

Constructors

Constructor and Description
ListStringRecordReader()

Method Summary

Modifier and Type	Method and Description
void	close() Closes this stream and releases any system resources associated with it.
Configuration	getConf() Return the configuration used by this object.
List<String>	getLabels() List of label strings
boolean	hasNext() Check whether there are anymore records
void	initialize(Configuration conf, InputSplit split) Called once at initialization.
void	initialize(InputSplit split) Called once at initialization.
List<Record>	loadFromMetaData(List<RecordMetaData> recordMetaDatas) Load multiple records from the given a list of RecordMetaData instances
Record	loadFromMetaData(RecordMetaData recordMetaData) Load a single 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 RecordReader.loadFromMetaData(List)
List<Writable>	next() Get the next record
Record	nextRecord() Similar to RecordReader.next(), but returns a Record object, that may include metadata such as the source of the data
List<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
void	setConf(Configuration conf) Set the configuration to be used by this object.

Methods inherited from class org.datavec.api.records.reader.BaseRecordReader

batchesSupported, getListeners, invokeListeners, next, setListeners, setListeners

Methods inherited from class java.lang.Object

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

Constructor Detail

ListStringRecordReader

public ListStringRecordReader()

Method Detail

initialize

public 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

public 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

public List<Writable> next()

Get the next record

Returns:

The list of next record

hasNext

public boolean hasNext()

Check whether there are anymore records

Returns:

Whether there are more records

getLabels

public List<String> getLabels()

List of label strings

Returns:

reset

public void reset()

Reset record reader iterator

record

public List<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

Parameters:

uri -

dataInputStream -

Throws:

IOException - if error occurs during reading from the input stream

nextRecord

public Record nextRecord()

Description copied from interface: RecordReader

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

Returns:

next record

loadFromMetaData

public Record loadFromMetaData(RecordMetaData recordMetaData)
                        throws IOException

Description copied from interface: RecordReader

Load a single 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 RecordReader.loadFromMetaData(List)

Parameters:

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

Returns:

Single record for the given RecordMetaData instance

Throws:

IOException - If I/O error occurs during loading

loadFromMetaData

public List<Record> loadFromMetaData(List<RecordMetaData> recordMetaDatas)
                              throws IOException

Description copied from interface: RecordReader

Load multiple records from the given a list of RecordMetaData instances

Parameters:

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

Returns:

Multiple records for the given RecordMetaData instances

Throws:

IOException - If I/O error occurs during loading

close

public void close()
           throws IOException

Closes this stream and releases any system resources associated with it. If the stream is already closed then invoking this method has no effect.

As noted in AutoCloseable.close(), cases where the close may fail require careful attention. It is strongly advised to relinquish the underlying resources and to internally mark the Closeable as closed, prior to throwing the IOException.

Throws:

IOException - if an I/O error occurs

setConf

public void setConf(Configuration conf)

Set the configuration to be used by this object.

Parameters:

conf -

getConf

public Configuration getConf()

Return the configuration used by this object.