Package org.datavec.api.records.reader

Class BaseRecordReader

java.lang.Object

org.datavec.api.records.reader.BaseRecordReader

All Implemented Interfaces:

Closeable, Serializable, AutoCloseable, Configurable, RecordReader

Direct Known Subclasses:

CollectionRecordReader, CollectionSequenceRecordReader, ComposableRecordReader, ConcatenatingRecordReader, FileRecordReader, JacksonRecordReader, LineRecordReader, ListStringRecordReader

public abstract class BaseRecordReader
extends Object
implements RecordReader

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field	Description
protected InputSplit	inputSplit
protected List<RecordListener>	listeners
protected Function<URI,InputStream>	streamCreatorFn

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

APPEND_LABEL, LABELS, NAME_SPACE

Constructor Summary

Constructors

Constructor	Description
BaseRecordReader()

Method Summary

Modifier and Type	Method	Description
boolean	batchesSupported()	This method returns true, if next(int) signature is supported by this RecordReader implementation.
List<RecordListener>	getListeners()	Get the record listeners for this record reader.
void	initialize(InputSplit split)	Called once at initialization.
protected void	invokeListeners(Object record)	Invokes RecordListener.recordRead(RecordReader, Object) on all listeners.
List<List<Writable>>	next(int num)	This method will be used, if batchesSupported() returns true.
void	setListeners(Collection<RecordListener> listeners)	Set the record listeners for this record reader.
void	setListeners(RecordListener... listeners)	Set the record listeners for this record reader.

Methods inherited from class java.lang.Object

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

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

getLabels, hasNext, initialize, loadFromMetaData, loadFromMetaData, next, nextRecord, record, reset, resetSupported

Field Detail

inputSplit

protected InputSplit inputSplit

listeners

protected List<RecordListener> listeners

streamCreatorFn

protected Function<URI,InputStream> streamCreatorFn

Constructor Detail

BaseRecordReader

public BaseRecordReader()

Method Detail

invokeListeners

protected void invokeListeners(Object record)

Invokes RecordListener.recordRead(RecordReader, Object) on all listeners.

initialize

public void initialize(InputSplit split)
                throws IOException,
                       InterruptedException

Description copied from interface: RecordReader

Called once at initialization.

Specified by:

initialize in interface RecordReader

Parameters:

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

Throws:

IOException

InterruptedException

getListeners

public List<RecordListener> getListeners()

Description copied from interface: RecordReader

Get the record listeners for this record reader.

Specified by:

getListeners in interface RecordReader

setListeners

public void setListeners(Collection<RecordListener> listeners)

Description copied from interface: RecordReader

Set the record listeners for this record reader.

Specified by:

setListeners in interface RecordReader

setListeners

public void setListeners(RecordListener... listeners)

Description copied from interface: RecordReader

Set the record listeners for this record reader.

Specified by:

setListeners in interface RecordReader

batchesSupported

public boolean batchesSupported()

Description copied from interface: RecordReader

This method returns true, if next(int) signature is supported by this RecordReader implementation.

Specified by:

batchesSupported in interface RecordReader

Returns:

next

public List<List<Writable>> next(int num)

Description copied from interface: RecordReader

This method will be used, if batchesSupported() returns true.

Specified by:

next in interface RecordReader

Returns: