org.apache.lucene.uninverting

Class DocTermOrds.Iterator

java.lang.Object

org.apache.lucene.index.SortedSetDocValues

org.apache.lucene.uninverting.DocTermOrds.Iterator

Enclosing class:

DocTermOrds

private class DocTermOrds.Iterator
extends SortedSetDocValues

Field Summary

Fields

Modifier and Type	Field and Description
private byte[]	arr
(package private) int[]	buffer
(package private) int	bufferLength
(package private) int	bufferUpto
(package private) LeafReader	reader
(package private) TermsEnum	te
private int	tnum
private int	upto

Fields inherited from class org.apache.lucene.index.SortedSetDocValues

NO_MORE_ORDS

Constructor Summary

Constructors

Constructor and Description
Iterator(LeafReader reader)

Method Summary

Modifier and Type	Method and Description
long	getValueCount() Returns the number of unique values.
BytesRef	lookupOrd(long ord) Retrieves the value for the specified ordinal.
long	lookupTerm(BytesRef key) If key exists, returns its ordinal, else returns -insertionPoint-1, like Arrays.binarySearch.
long	nextOrd() Returns the next ordinal for the current document (previously set by SortedSetDocValues.setDocument(int).
(package private) int	read(int[] buffer) Buffer must be at least 5 ints long.
void	setDocument(int docID) Sets iteration to the specified docID
TermsEnum	termsEnum() Returns a TermsEnum over the values.

Methods inherited from class java.lang.Object

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

Field Detail

reader

final LeafReader reader

te

final TermsEnum te

buffer

final int[] buffer

bufferUpto

int bufferUpto

bufferLength

int bufferLength

tnum

private int tnum

upto

private int upto

arr

private byte[] arr

Constructor Detail

Iterator

Iterator(LeafReader reader)
  throws java.io.IOException

Throws:

java.io.IOException

Method Detail

nextOrd

public long nextOrd()

Description copied from class: SortedSetDocValues

Returns the next ordinal for the current document (previously set by SortedSetDocValues.setDocument(int).

Specified by:

nextOrd in class SortedSetDocValues

Returns:

next ordinal for the document, or SortedSetDocValues.NO_MORE_ORDS. ordinals are dense, start at 0, then increment by 1 for the next value in sorted order.

read

int read(int[] buffer)

Buffer must be at least 5 ints long. Returns number of term ords placed into buffer; if this count is less than buffer.length then that is the end.

setDocument

public void setDocument(int docID)

Description copied from class: SortedSetDocValues

Sets iteration to the specified docID

Specified by:

setDocument in class SortedSetDocValues

Parameters:

docID - document ID

lookupOrd

public BytesRef lookupOrd(long ord)

Description copied from class: SortedSetDocValues

Retrieves the value for the specified ordinal. The returned BytesRef may be re-used across calls to lookupOrd so make sure to copy it if you want to keep it around.

Specified by:

lookupOrd in class SortedSetDocValues

Parameters:

ord - ordinal to lookup

See Also:

SortedSetDocValues.nextOrd()

getValueCount

public long getValueCount()

Description copied from class: SortedSetDocValues

Returns the number of unique values.

Specified by:

getValueCount in class SortedSetDocValues

Returns:

number of unique values in this SortedDocValues. This is also equivalent to one plus the maximum ordinal.

lookupTerm

public long lookupTerm(BytesRef key)

Description copied from class: SortedSetDocValues

If key exists, returns its ordinal, else returns -insertionPoint-1, like Arrays.binarySearch.

Overrides:

lookupTerm in class SortedSetDocValues

Parameters:

key - Key to look up

termsEnum

public TermsEnum termsEnum()

Description copied from class: SortedSetDocValues

Returns a TermsEnum over the values. The enum supports TermsEnum.ord() and TermsEnum.seekExact(long).

Overrides:

termsEnum in class SortedSetDocValues