org.deeplearning4j.text.sentenceiterator

Class BasicLineIterator

java.lang.Object

org.deeplearning4j.text.sentenceiterator.BasicLineIterator

All Implemented Interfaces:

java.lang.Iterable<java.lang.String>, SentenceIterator

public class BasicLineIterator
extends java.lang.Object
implements SentenceIterator, java.lang.Iterable<java.lang.String>

Primitive single-line iterator, without any options involved. Can be used over InputStream or File. Please note: for reset functionality, mark/reset should be supported by underlying InputStream.

Constructor Summary

Constructors

Constructor and Description
BasicLineIterator(java.io.File file)
BasicLineIterator(java.io.InputStream stream)
BasicLineIterator(java.lang.String filePath)

Method Summary

Modifier and Type	Method and Description
protected void	finalize()
void	finish() Allows for any finishing (closing of input streams or the like)
SentencePreProcessor	getPreProcessor()
boolean	hasNext() Same idea as Iterator
java.util.Iterator<java.lang.String>	iterator() Implentation for Iterable interface.
java.lang.String	nextSentence() Gets the next sentence or null if there's nothing left (Do yourself a favor and check hasNext() )
void	reset() Resets the iterator to the beginning
void	setPreProcessor(SentencePreProcessor preProcessor)

Methods inherited from class java.lang.Object

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

Methods inherited from interface java.lang.Iterable

forEach, spliterator

Constructor Detail

BasicLineIterator

public BasicLineIterator(@NonNull
                         java.io.File file)
                  throws java.io.FileNotFoundException

Throws:

java.io.FileNotFoundException

BasicLineIterator

public BasicLineIterator(@NonNull
                         java.io.InputStream stream)

BasicLineIterator

public BasicLineIterator(@NonNull
                         java.lang.String filePath)
                  throws java.io.FileNotFoundException

Throws:

java.io.FileNotFoundException

Method Detail

nextSentence

public java.lang.String nextSentence()

Description copied from interface: SentenceIterator

Gets the next sentence or null if there's nothing left (Do yourself a favor and check hasNext() )

Specified by:

nextSentence in interface SentenceIterator

Returns:

the next sentence in the iterator

hasNext

public boolean hasNext()

Description copied from interface: SentenceIterator

Same idea as Iterator

Specified by:

hasNext in interface SentenceIterator

Returns:

whether there's anymore sentences left

reset

public void reset()

Description copied from interface: SentenceIterator

Resets the iterator to the beginning

Specified by:

reset in interface SentenceIterator

finish

public void finish()

Description copied from interface: SentenceIterator

Allows for any finishing (closing of input streams or the like)

Specified by:

finish in interface SentenceIterator

getPreProcessor

public SentencePreProcessor getPreProcessor()

Specified by:

getPreProcessor in interface SentenceIterator

setPreProcessor

public void setPreProcessor(SentencePreProcessor preProcessor)

Specified by:

setPreProcessor in interface SentenceIterator

finalize

protected void finalize()
                 throws java.lang.Throwable

Overrides:

finalize in class java.lang.Object

Throws:

java.lang.Throwable

iterator

public java.util.Iterator<java.lang.String> iterator()

Implentation for Iterable interface. Please note: each call for iterator() resets underlying SentenceIterator to the beginning;

Specified by:

iterator in interface java.lang.Iterable<java.lang.String>

Returns: