org.apache.lucene.index

Class MultiDocsAndPositionsEnum

java.lang.Object

org.apache.lucene.search.DocIdSetIterator

org.apache.lucene.index.DocsEnum

org.apache.lucene.index.DocsAndPositionsEnum

org.apache.lucene.index.MultiDocsAndPositionsEnum

public final class MultiDocsAndPositionsEnum
extends DocsAndPositionsEnum

Exposes flex API, merged from flex API of sub-segments.

WARNING: This API is experimental and might change in incompatible ways in the next release.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	MultiDocsAndPositionsEnum.EnumWithSlice

Field Summary

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

FLAG_OFFSETS, FLAG_PAYLOADS

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

FLAG_FREQS

Fields inherited from class org.apache.lucene.search.DocIdSetIterator

NO_MORE_DOCS

Constructor Summary

Constructors

Constructor and Description
MultiDocsAndPositionsEnum(MultiTermsEnum parent, int subReaderCount)

Method Summary

Methods

Modifier and Type	Method and Description
int	advance(int target) Advances to the first beyond (see NOTE below) the current whose document number is greater than or equal to target.
boolean	canReuse(MultiTermsEnum parent)
int	docID() Returns the following: -1 or DocIdSetIterator.NO_MORE_DOCS if DocIdSetIterator.nextDoc() or DocIdSetIterator.advance(int) were not called yet.
int	endOffset() Returns end offset for the current position, or -1 if offsets were not indexed.
int	freq() Returns term frequency in the current document.
int	getNumSubs()
BytesRef	getPayload() Returns the payload at this position, or null if no payload was indexed.
MultiDocsAndPositionsEnum.EnumWithSlice[]	getSubs()
boolean	hasPayload()
int	nextDoc() Advances to the next document in the set and returns the doc it is currently on, or DocIdSetIterator.NO_MORE_DOCS if there are no more docs in the set. NOTE: after the iterator has exhausted you should not call this method, as it may result in unpredicted behavior.
int	nextPosition() Returns the next position.
MultiDocsAndPositionsEnum	reset(MultiDocsAndPositionsEnum.EnumWithSlice[] subs, int numSubs)
int	startOffset() Returns start offset for the current position, or -1 if offsets were not indexed.
String	toString()

Methods inherited from class org.apache.lucene.index.DocsEnum

attributes

Methods inherited from class java.lang.Object

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

Constructor Detail

MultiDocsAndPositionsEnum

public MultiDocsAndPositionsEnum(MultiTermsEnum parent,
                         int subReaderCount)

Method Detail

canReuse

public boolean canReuse(MultiTermsEnum parent)

reset

public MultiDocsAndPositionsEnum reset(MultiDocsAndPositionsEnum.EnumWithSlice[] subs,
                              int numSubs)

getNumSubs

public int getNumSubs()

getSubs

public MultiDocsAndPositionsEnum.EnumWithSlice[] getSubs()

freq

public int freq()
         throws IOException

Description copied from class: DocsEnum

Returns term frequency in the current document. Do not call this before DocIdSetIterator.nextDoc() is first called, nor after DocIdSetIterator.nextDoc() returns NO_MORE_DOCS.

Specified by:

freq in class DocsEnum

Throws:

IOException

docID

public int docID()

Description copied from class: DocIdSetIterator

Returns the following:

• -1 or DocIdSetIterator.NO_MORE_DOCS if DocIdSetIterator.nextDoc() or DocIdSetIterator.advance(int) were not called yet.
• DocIdSetIterator.NO_MORE_DOCS if the iterator has exhausted.
• Otherwise it should return the doc ID it is currently on.

Specified by:

docID in class DocIdSetIterator

advance

public int advance(int target)
            throws IOException

Description copied from class: DocIdSetIterator

Advances to the first beyond (see NOTE below) the current whose document number is greater than or equal to target. Returns the current document number or DocIdSetIterator.NO_MORE_DOCS if there are no more docs in the set.

Behaves as if written:

 int advance(int target) {
   int doc;
   while ((doc = nextDoc()) < target) {
   }
   return doc;
 }
 

Some implementations are considerably more efficient than that.

NOTE: when target ≤ current implementations may opt not to advance beyond their current DocIdSetIterator.docID().

NOTE: this method may be called with DocIdSetIterator.NO_MORE_DOCS for efficiency by some Scorers. If your implementation cannot efficiently determine that it should exhaust, it is recommended that you check for that value in each call to this method.

NOTE: after the iterator has exhausted you should not call this method, as it may result in unpredicted behavior.

Specified by:

advance in class DocIdSetIterator

Throws:

IOException

nextDoc

public int nextDoc()
            throws IOException

Description copied from class: DocIdSetIterator

Advances to the next document in the set and returns the doc it is currently on, or DocIdSetIterator.NO_MORE_DOCS if there are no more docs in the set.
NOTE: after the iterator has exhausted you should not call this method, as it may result in unpredicted behavior.

Specified by:

nextDoc in class DocIdSetIterator

Throws:

IOException

nextPosition

public int nextPosition()
                 throws IOException

Description copied from class: DocsAndPositionsEnum

Returns the next position. You should only call this up to DocsEnum.freq() times else the behavior is not defined. If positions were not indexed this will return -1; this only happens if offsets were indexed and you passed needsOffset=true when pulling the enum.

Specified by:

nextPosition in class DocsAndPositionsEnum

Throws:

IOException

startOffset

public int startOffset()
                throws IOException

Description copied from class: DocsAndPositionsEnum

Returns start offset for the current position, or -1 if offsets were not indexed.

Specified by:

startOffset in class DocsAndPositionsEnum

Throws:

IOException

endOffset

public int endOffset()
              throws IOException

Description copied from class: DocsAndPositionsEnum

Returns end offset for the current position, or -1 if offsets were not indexed.

Specified by:

endOffset in class DocsAndPositionsEnum

Throws:

IOException

hasPayload

public boolean hasPayload()

Specified by:

hasPayload in class DocsAndPositionsEnum

getPayload

public BytesRef getPayload()
                    throws IOException

Description copied from class: DocsAndPositionsEnum

Returns the payload at this position, or null if no payload was indexed. Only call this once per position. You should not modify anything (neither members of the returned BytesRef nor bytes in the byte[]).

Specified by:

getPayload in class DocsAndPositionsEnum

Throws:

IOException

toString

public String toString()

Overrides:

toString in class Object