Module org.apache.lucene.core

Package org.apache.lucene.index

Class TermsEnumIndex

java.lang.Object

org.apache.lucene.index.TermsEnumIndex

Direct Known Subclasses:

MultiTermsEnum.TermsEnumWithSlice

class TermsEnumIndex
extends Object

Wrapper around a TermsEnum and an integer that identifies it. All operations that move the current position of the TermsEnum must be performed via this wrapper class, not directly on the wrapped TermsEnum.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
(package private) static class	TermsEnumIndex.TermState	Wrapper around a term that allows for quick equals comparisons.

Field Summary

Fields

Modifier and Type	Field	Description
private BytesRef	currentTerm
private long	currentTermPrefix8
(package private) static final TermsEnumIndex[]	EMPTY_ARRAY
(package private) final int	subIndex
(package private) TermsEnum	termsEnum

Constructor Summary

Constructors

Constructor	Description
TermsEnumIndex(TermsEnum termsEnum, int subIndex)

Method Summary

Modifier and Type	Method	Description
(package private) int	compareTermTo(TermsEnumIndex that)
(package private) BytesRef	next()
(package private) static long	prefix8ToComparableUnsignedLong(BytesRef term)	Copy the first 8 bytes of the given term as a comparable unsigned long.
(package private) void	reset(TermsEnumIndex tei)
(package private) TermsEnum.SeekStatus	seekCeil(BytesRef term)
(package private) void	seekExact(long ord)
(package private) boolean	seekExact(BytesRef term)
private void	setTerm(BytesRef term)
(package private) BytesRef	term()
(package private) boolean	termEquals(TermsEnumIndex.TermState that)
String	toString()

Methods inherited from class java.lang.Object

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

Field Details

EMPTY_ARRAY

static final TermsEnumIndex[] EMPTY_ARRAY

subIndex

final int subIndex

termsEnum

TermsEnum termsEnum

currentTerm

private BytesRef currentTerm

currentTermPrefix8

private long currentTermPrefix8

Constructor Details

TermsEnumIndex

TermsEnumIndex(TermsEnum termsEnum,
 int subIndex)

Method Details

prefix8ToComparableUnsignedLong

static long prefix8ToComparableUnsignedLong(BytesRef term)

Copy the first 8 bytes of the given term as a comparable unsigned long. In case the term has less than 8 bytes, missing bytes will be replaced with zeroes. Note that two terms that produce the same long could still be different due to the fact that missing bytes are replaced with zeroes, e.g. [1, 0] and [1] get mapped to the same long.

term

BytesRef term()

setTerm

private void setTerm(BytesRef term)

next

BytesRef next()
       throws IOException

Throws:

IOException

seekCeil

TermsEnum.SeekStatus seekCeil(BytesRef term)
                       throws IOException

Throws:

IOException

seekExact

boolean seekExact(BytesRef term)
           throws IOException

Throws:

IOException

seekExact

void seekExact(long ord)
        throws IOException

Throws:

IOException

reset

void reset(TermsEnumIndex tei)
    throws IOException

Throws:

IOException

compareTermTo

int compareTermTo(TermsEnumIndex that)

toString

public String toString()

Overrides:

toString in class Object

termEquals

boolean termEquals(TermsEnumIndex.TermState that)