org.apache.lucene.util.fst

Class BytesRefFSTEnum<T>

java.lang.Object

org.apache.lucene.util.fst.BytesRefFSTEnum<T>

public final class BytesRefFSTEnum<T>
extends Object

Enumerates all input (BytesRef) + output pairs in an FST.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	BytesRefFSTEnum.InputOutput<T> Holds a single input (BytesRef) + output pair.

Constructor Summary

Constructors

Constructor and Description
BytesRefFSTEnum(FST<T> fst) doFloor controls the behavior of advance: if it's true doFloor is true, advance positions to the biggest term before target.

Method Summary

Modifier and Type	Method and Description
BytesRefFSTEnum.InputOutput<T>	current()
BytesRefFSTEnum.InputOutput<T>	next()
BytesRefFSTEnum.InputOutput<T>	seekCeil(BytesRef target) Seeks to smallest term that's >= target.
BytesRefFSTEnum.InputOutput<T>	seekExact(BytesRef target) Seeks to exactly this term, returning null if the term doesn't exist.
BytesRefFSTEnum.InputOutput<T>	seekFloor(BytesRef target) Seeks to biggest term that's <= target.

Methods inherited from class java.lang.Object

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

Constructor Detail

BytesRefFSTEnum

public BytesRefFSTEnum(FST<T> fst)

doFloor controls the behavior of advance: if it's true doFloor is true, advance positions to the biggest term before target.

Method Detail

current

public BytesRefFSTEnum.InputOutput<T> current()

next

public BytesRefFSTEnum.InputOutput<T> next()
                                    throws IOException

Throws:

IOException

seekCeil

public BytesRefFSTEnum.InputOutput<T> seekCeil(BytesRef target)
                                        throws IOException

Seeks to smallest term that's >= target.

Throws:

IOException

seekFloor

public BytesRefFSTEnum.InputOutput<T> seekFloor(BytesRef target)
                                         throws IOException

Seeks to biggest term that's <= target.

Throws:

IOException

seekExact

public BytesRefFSTEnum.InputOutput<T> seekExact(BytesRef target)
                                         throws IOException

Seeks to exactly this term, returning null if the term doesn't exist. This is faster than using seekFloor(org.apache.lucene.util.BytesRef) or seekCeil(org.apache.lucene.util.BytesRef) because it short-circuits as soon the match is not found.

Throws:

IOException