Package org.basex.util.ft

Class FTIterator

java.lang.Object

org.basex.util.ft.FTIterator

All Implemented Interfaces:

Iterator<FTSpan>

Direct Known Subclasses:

FTLexer, Stemmer, Tokenizer

public abstract class FTIterator
extends Object
implements Iterator<FTSpan>

Full-text iterator.

Author:

BaseX Team 2005-21, BSD License, Christian Gruen

Constructor Summary

Constructors

Constructor	Description
FTIterator()

Method Summary

Modifier and Type	Method	Description
abstract FTIterator	init(byte[] text)	Initializes the iterator.
abstract byte[]	nextToken()	Returns the next token.
final 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.util.Iterator

forEachRemaining, hasNext, next

Constructor Details

FTIterator

public FTIterator()

Method Details

init

public abstract FTIterator init(byte[] text)

Initializes the iterator.

Parameters:

text - text

Returns:

self reference

nextToken

public abstract byte[] nextToken()

Returns the next token. May be called as an alternative to Iterator.next() to avoid the creation of new FTSpan instances.

Returns:

token

remove

public final void remove()

Specified by:

remove in interface Iterator<FTSpan>