org.deeplearning4j.text.sentenceiterator

Interface SentenceIterator

All Known Subinterfaces:

LabelAwareSentenceIterator

All Known Implementing Classes:

BaseSentenceIterator, CollectionSentenceIterator, FileSentenceIterator, LabelAwareFileSentenceIterator, LabelAwareListSentenceIterator, LabelAwareUimaSentenceIterator, LineSentenceIterator, UimaSentenceIterator

public interface SentenceIterator

A sentence iterator that knows how to iterate over sentence. This can be used in conjunction with more advanced NLP techniques to clearly separate sentences out, or be simpler when as much complexity is not needed.

Author:

Adam Gibson

Method Summary

Modifier and Type	Method and Description
void	finish() Allows for any finishing (closing of input streams or the like)
SentencePreProcessor	getPreProcessor()
boolean	hasNext() Same idea as Iterator
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)

Method Detail

nextSentence

String nextSentence()

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

Returns:

the next sentence in the iterator

hasNext

boolean hasNext()

Same idea as Iterator

Returns:

whether there's anymore sentences left

reset

void reset()

Resets the iterator to the beginning

finish

void finish()

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

getPreProcessor

SentencePreProcessor getPreProcessor()

setPreProcessor

void setPreProcessor(SentencePreProcessor preProcessor)