de.tudarmstadt.ukp.dkpro.core.frequency.tfidf.util

Class TermIterator

java.lang.Object

de.tudarmstadt.ukp.dkpro.core.frequency.tfidf.util.TermIterator

All Implemented Interfaces:

Iterable<String>, Iterator<String>

public class TermIterator
extends Object
implements Iterable<String>, Iterator<String>

Iterator over terms (Strings) in the JCas.

Method Summary

Modifier and Type	Method and Description
static TermIterator	create(org.apache.uima.jcas.JCas jcas, String featurePath, boolean convertToLowercase) Create a Iterator over all represented strings (specified with the featurePath) in the JCas.
boolean	hasNext()
Iterator<String>	iterator()
String	next()
void	remove()

Methods inherited from class java.lang.Object

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

Methods inherited from interface java.lang.Iterable

forEach, spliterator

Methods inherited from interface java.util.Iterator

forEachRemaining

Method Detail

create

public static TermIterator create(org.apache.uima.jcas.JCas jcas,
                                  String featurePath,
                                  boolean convertToLowercase)
                           throws org.apache.uima.analysis_engine.AnalysisEngineProcessException

Create a Iterator over all represented strings (specified with the featurePath) in the JCas.

Parameters:

jcas - Iterate over all specified Annotations in this jcas

featurePath - Specifies the annotation and its string representation method.

convertToLowercase - The terms are converted as specified with this parameter

Returns:

an iterator.

Throws:

org.apache.uima.analysis_engine.AnalysisEngineProcessException - if the feature path is invalid.

iterator

public Iterator<String> iterator()

Specified by:

iterator in interface Iterable<String>

hasNext

public boolean hasNext()

Specified by:

hasNext in interface Iterator<String>

next

public String next()

Specified by:

next in interface Iterator<String>

remove

public void remove()

Specified by:

remove in interface Iterator<String>