org.deeplearning4j.text.documentiterator

Class SimpleLabelAwareIterator

java.lang.Object

org.deeplearning4j.text.documentiterator.SimpleLabelAwareIterator

All Implemented Interfaces:

java.util.Iterator<LabelledDocument>, LabelAwareIterator

public class SimpleLabelAwareIterator
extends java.lang.Object
implements LabelAwareIterator

This class provide option to build LabelAwareIterator from Iterable or Iterator objects PLEASE NOTE: This iterator is meant to be used with externally-originated data via Java Iterable/Iterator interface. It IS possible to use Collection/List object here, but it's NOT recommended, since huge List with data might cause significant performance penalty due to JVM Garbage Collection mechanics.

Field Summary

Fields

Modifier and Type	Field and Description
protected java.util.Iterator<LabelledDocument>	currentIterator
protected LabelsSource	labels
protected java.lang.Iterable<LabelledDocument>	underlyingIterable

Constructor Summary

Constructors

Constructor and Description
SimpleLabelAwareIterator(java.lang.Iterable<LabelledDocument> iterable) Builds LabelAwareIterator instance using Iterable object
SimpleLabelAwareIterator(java.util.Iterator<LabelledDocument> iterator) Builds LabelAwareIterator instance using Iterator object PLEASE NOTE: If instance is built using Iterator object, reset() method becomes unavailable

Method Summary

Modifier and Type	Method and Description
LabelsSource	getLabelsSource() This method returns LabelsSource instance, containing all labels derived from this iterator
boolean	hasNext()
boolean	hasNextDocument() This method checks, if there's more LabelledDocuments in underlying iterator
LabelledDocument	next()
LabelledDocument	nextDocument() This method returns next LabelledDocument from underlying iterator
void	remove()
void	reset() This methods resets LabelAwareIterator by creating new Iterator from Iterable internally
void	shutdown()

Methods inherited from class java.lang.Object

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

Methods inherited from interface java.util.Iterator

forEachRemaining

Field Detail

underlyingIterable

protected transient java.lang.Iterable<LabelledDocument> underlyingIterable

currentIterator

protected transient java.util.Iterator<LabelledDocument> currentIterator

labels

protected LabelsSource labels

Constructor Detail

SimpleLabelAwareIterator

public SimpleLabelAwareIterator(@NonNull
                                java.lang.Iterable<LabelledDocument> iterable)

Builds LabelAwareIterator instance using Iterable object

Parameters:

iterable -

SimpleLabelAwareIterator

public SimpleLabelAwareIterator(@NonNull
                                java.util.Iterator<LabelledDocument> iterator)

Builds LabelAwareIterator instance using Iterator object PLEASE NOTE: If instance is built using Iterator object, reset() method becomes unavailable

Parameters:

iterator -

Method Detail

hasNextDocument

public boolean hasNextDocument()

This method checks, if there's more LabelledDocuments in underlying iterator

Specified by:

hasNextDocument in interface LabelAwareIterator

Returns:

nextDocument

public LabelledDocument nextDocument()

This method returns next LabelledDocument from underlying iterator

Specified by:

nextDocument in interface LabelAwareIterator

Returns:

hasNext

public boolean hasNext()

Specified by:

hasNext in interface java.util.Iterator<LabelledDocument>

next

public LabelledDocument next()

Specified by:

next in interface java.util.Iterator<LabelledDocument>

remove

public void remove()

Specified by:

remove in interface java.util.Iterator<LabelledDocument>

shutdown

public void shutdown()

Specified by:

shutdown in interface LabelAwareIterator

reset

public void reset()

This methods resets LabelAwareIterator by creating new Iterator from Iterable internally

Specified by:

reset in interface LabelAwareIterator

getLabelsSource

public LabelsSource getLabelsSource()

This method returns LabelsSource instance, containing all labels derived from this iterator

Specified by:

getLabelsSource in interface LabelAwareIterator

Returns: