org.apache.lucene.index

Class AssertingLeafReader.AssertingPostingsEnum

java.lang.Object

org.apache.lucene.search.DocIdSetIterator

org.apache.lucene.index.PostingsEnum

org.apache.lucene.index.FilterLeafReader.FilterPostingsEnum

org.apache.lucene.index.AssertingLeafReader.AssertingPostingsEnum

Enclosing class:

AssertingLeafReader

public static class AssertingLeafReader.AssertingPostingsEnum
extends FilterLeafReader.FilterPostingsEnum

Wraps a docsenum with additional checks

Field Summary

Fields inherited from class org.apache.lucene.index.FilterLeafReader.FilterPostingsEnum

in

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

ALL, FREQS, NONE, OFFSETS, PAYLOADS, POSITIONS

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

NO_MORE_DOCS

Constructor Summary

Constructors

Constructor and Description
AssertingPostingsEnum(PostingsEnum in)

Method Summary

Modifier and Type	Method and Description
int	advance(int target) Advances to the first beyond the current whose document number is greater than or equal to target, and returns the document number itself.
int	docID() Returns the following: -1 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, or 1 if the field was indexed with IndexOptions.DOCS.
BytesRef	getPayload() Returns the payload at this position, or null if no payload was indexed.
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, or -1 if positions were not indexed.
int	startOffset() Returns start offset for the current position, or -1 if offsets were not indexed.

Methods inherited from class org.apache.lucene.index.FilterLeafReader.FilterPostingsEnum

attributes, cost

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

featureRequested

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

all, empty, range, slowAdvance

Methods inherited from class java.lang.Object

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

Constructor Detail

AssertingPostingsEnum

public AssertingPostingsEnum(PostingsEnum in)

Method Detail

nextDoc

public int nextDoc()
            throws java.io.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.

Overrides:

nextDoc in class FilterLeafReader.FilterPostingsEnum

Throws:

java.io.IOException

advance

public int advance(int target)
            throws java.io.IOException

Description copied from class: DocIdSetIterator

Advances to the first beyond the current whose document number is greater than or equal to target, and returns the document number itself. Exhausts the iterator and returns DocIdSetIterator.NO_MORE_DOCS if target is greater than the highest document number in the set.

The behavior of this method is undefined when called with target ≤ current, or after the iterator has exhausted. Both cases may result in unpredicted behavior.

When target > current it 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: 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.

Overrides:

advance in class FilterLeafReader.FilterPostingsEnum

Throws:

java.io.IOException

docID

public int docID()

Description copied from class: DocIdSetIterator

Returns the following:

• -1 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.

Overrides:

docID in class FilterLeafReader.FilterPostingsEnum

freq

public int freq()
         throws java.io.IOException

Description copied from class: PostingsEnum

Returns term frequency in the current document, or 1 if the field was indexed with IndexOptions.DOCS. Do not call this before DocIdSetIterator.nextDoc() is first called, nor after DocIdSetIterator.nextDoc() returns DocIdSetIterator.NO_MORE_DOCS.

NOTE: if the PostingsEnum was obtain with PostingsEnum.NONE, the result of this method is undefined.

Overrides:

freq in class FilterLeafReader.FilterPostingsEnum

Throws:

java.io.IOException

nextPosition

public int nextPosition()
                 throws java.io.IOException

Description copied from class: PostingsEnum

Returns the next position, or -1 if positions were not indexed. Calling this more than PostingsEnum.freq() times is undefined.

Overrides:

nextPosition in class FilterLeafReader.FilterPostingsEnum

Throws:

java.io.IOException

startOffset

public int startOffset()
                throws java.io.IOException

Description copied from class: PostingsEnum

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

Overrides:

startOffset in class FilterLeafReader.FilterPostingsEnum

Throws:

java.io.IOException

endOffset

public int endOffset()
              throws java.io.IOException

Description copied from class: PostingsEnum

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

Overrides:

endOffset in class FilterLeafReader.FilterPostingsEnum

Throws:

java.io.IOException

getPayload

public BytesRef getPayload()
                    throws java.io.IOException

Description copied from class: PostingsEnum

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

Overrides:

getPayload in class FilterLeafReader.FilterPostingsEnum

Throws:

java.io.IOException