org.deeplearning4j.text.sentenceiterator

Class UimaSentenceIterator

java.lang.Object

org.deeplearning4j.text.sentenceiterator.BaseSentenceIterator

org.deeplearning4j.text.sentenceiterator.UimaSentenceIterator

All Implemented Interfaces:

SentenceIterator

Direct Known Subclasses:

LabelAwareUimaSentenceIterator

public class UimaSentenceIterator
extends BaseSentenceIterator

Iterates over and returns sentences based on the passed in analysis engine

Field Summary

Fields

Modifier and Type	Field and Description
protected java.lang.String	path
protected org.apache.uima.collection.CollectionReader	reader
protected java.util.Iterator<java.lang.String>	sentences

Fields inherited from class org.deeplearning4j.text.sentenceiterator.BaseSentenceIterator

preProcessor

Constructor Summary

Constructors

Constructor and Description
UimaSentenceIterator(SentencePreProcessor preProcessor, org.apache.uima.collection.CollectionReader cr, UimaResource resource)
UimaSentenceIterator(SentencePreProcessor preProcessor, java.lang.String path, UimaResource resource)
UimaSentenceIterator(java.lang.String path, UimaResource resource)

Method Summary

Modifier and Type	Method and Description
static SentenceIterator	createWithPath(java.lang.String path) Creates a uima sentence iterator with the given path
UimaResource	getResource()
boolean	hasNext() Same idea as Iterator
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
static org.apache.uima.analysis_engine.AnalysisEngine	segmenter() Return a sentence segmenter

Methods inherited from class org.deeplearning4j.text.sentenceiterator.BaseSentenceIterator

finish, getPreProcessor, setPreProcessor

Methods inherited from class java.lang.Object

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

Field Detail

reader

protected volatile org.apache.uima.collection.CollectionReader reader

sentences

protected volatile java.util.Iterator<java.lang.String> sentences

path

protected java.lang.String path

Constructor Detail

UimaSentenceIterator

public UimaSentenceIterator(SentencePreProcessor preProcessor,
                            java.lang.String path,
                            UimaResource resource)

UimaSentenceIterator

public UimaSentenceIterator(SentencePreProcessor preProcessor,
                            org.apache.uima.collection.CollectionReader cr,
                            UimaResource resource)

UimaSentenceIterator

public UimaSentenceIterator(java.lang.String path,
                            UimaResource resource)

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() )

Returns:

the next sentence in the iterator

getResource

public UimaResource getResource()

createWithPath

public static SentenceIterator createWithPath(java.lang.String path)
                                       throws java.lang.Exception

Creates a uima sentence iterator with the given path

Parameters:

path - the path to the root directory or file to read from

Returns:

the uima sentence iterator for the given root dir or file

Throws:

java.lang.Exception

hasNext

public boolean hasNext()

Description copied from interface: SentenceIterator

Same idea as Iterator

Returns:

whether there's anymore sentences left

reset

public void reset()

Description copied from interface: SentenceIterator

Resets the iterator to the beginning

segmenter

public static org.apache.uima.analysis_engine.AnalysisEngine segmenter()

Return a sentence segmenter

Returns:

a sentence segmenter