org.apache.lucene.util.fst

Class BytesRefFSTEnum<T>

java.lang.Object

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

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

public final class BytesRefFSTEnum<T>
extends FSTEnum<T>

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.

Field Summary

Fields

Modifier and Type	Field and Description
private BytesRef	current
private BytesRefFSTEnum.InputOutput<T>	result
private BytesRef	target

Fields inherited from class org.apache.lucene.util.fst.FSTEnum

arcs, fst, fstReader, NO_OUTPUT, output, scratchArc, targetLength, upto

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()
protected int	getCurrentLabel()
protected int	getTargetLabel()
protected void	grow()
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.
protected void	setCurrentLabel(int label)
private BytesRefFSTEnum.InputOutput<T>	setResult()

Methods inherited from class org.apache.lucene.util.fst.FSTEnum

doNext, doSeekCeil, doSeekExact, doSeekFloor

Methods inherited from class java.lang.Object

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

Field Detail

current

private final BytesRef current

result

private final BytesRefFSTEnum.InputOutput<T> result

target

private BytesRef target

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 java.io.IOException

Throws:

java.io.IOException

seekCeil

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

Seeks to smallest term that's >= target.

Throws:

java.io.IOException

seekFloor

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

Seeks to biggest term that's <= target.

Throws:

java.io.IOException

seekExact

public BytesRefFSTEnum.InputOutput<T> seekExact(BytesRef target)
                                         throws java.io.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:

java.io.IOException

getTargetLabel

protected int getTargetLabel()

Specified by:

getTargetLabel in class FSTEnum<T>

getCurrentLabel

protected int getCurrentLabel()

Specified by:

getCurrentLabel in class FSTEnum<T>

setCurrentLabel

protected void setCurrentLabel(int label)

Specified by:

setCurrentLabel in class FSTEnum<T>

grow

protected void grow()

Specified by:

grow in class FSTEnum<T>

setResult

private BytesRefFSTEnum.InputOutput<T> setResult()