org.apache.lucene.index

Class AssertingLeafReader

java.lang.Object

org.apache.lucene.index.IndexReader

org.apache.lucene.index.LeafReader

org.apache.lucene.index.FilterLeafReader

org.apache.lucene.index.AssertingLeafReader

All Implemented Interfaces:

java.io.Closeable, java.lang.AutoCloseable

public class AssertingLeafReader
extends FilterLeafReader

A FilterLeafReader that can be used to apply additional checks for tests.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	AssertingLeafReader.AssertingBinaryDocValues Wraps a BinaryDocValues but with additional asserts
static class	AssertingLeafReader.AssertingBits Wraps a Bits but with additional asserts
static class	AssertingLeafReader.AssertingFields Wraps a Fields but with additional asserts
static class	AssertingLeafReader.AssertingNumericDocValues Wraps a NumericDocValues but with additional asserts
static class	AssertingLeafReader.AssertingPointValues Wraps a SortedSetDocValues but with additional asserts
static class	AssertingLeafReader.AssertingPostingsEnum Wraps a docsenum with additional checks
static class	AssertingLeafReader.AssertingSortedDocValues Wraps a SortedDocValues but with additional asserts
static class	AssertingLeafReader.AssertingSortedNumericDocValues Wraps a SortedNumericDocValues but with additional asserts
static class	AssertingLeafReader.AssertingSortedSetDocValues Wraps a SortedSetDocValues but with additional asserts
static class	AssertingLeafReader.AssertingTerms Wraps a Terms but with additional asserts

Nested classes/interfaces inherited from class org.apache.lucene.index.FilterLeafReader

FilterLeafReader.FilterFields, FilterLeafReader.FilterPostingsEnum, FilterLeafReader.FilterTerms, FilterLeafReader.FilterTermsEnum

Nested classes/interfaces inherited from class org.apache.lucene.index.IndexReader

IndexReader.CacheHelper, IndexReader.CacheKey, IndexReader.ClosedListener

Field Summary

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

in

Constructor Summary

Constructors

Constructor and Description
AssertingLeafReader(LeafReader in)

Method Summary

Modifier and Type	Method and Description
BinaryDocValues	getBinaryDocValues(java.lang.String field) Returns BinaryDocValues for this field, or null if no binary doc values were indexed for this field.
IndexReader.CacheHelper	getCoreCacheHelper() Optional method: Return a IndexReader.CacheHelper that can be used to cache based on the content of this leaf regardless of deletions.
Bits	getLiveDocs() Returns the Bits representing live (not deleted) docs.
NumericDocValues	getNormValues(java.lang.String field) Returns NumericDocValues representing norms for this field, or null if no NumericDocValues were indexed.
NumericDocValues	getNumericDocValues(java.lang.String field) Returns NumericDocValues for this field, or null if no numeric doc values were indexed for this field.
PointValues	getPointValues(java.lang.String field) Returns the PointValues used for numeric or spatial searches for the given field, or null if there are no point fields.
IndexReader.CacheHelper	getReaderCacheHelper() Optional method: Return a IndexReader.CacheHelper that can be used to cache based on the content of this reader.
SortedDocValues	getSortedDocValues(java.lang.String field) Returns SortedDocValues for this field, or null if no SortedDocValues were indexed for this field.
SortedNumericDocValues	getSortedNumericDocValues(java.lang.String field) Returns SortedNumericDocValues for this field, or null if no SortedNumericDocValues were indexed for this field.
SortedSetDocValues	getSortedSetDocValues(java.lang.String field) Returns SortedSetDocValues for this field, or null if no SortedSetDocValues were indexed for this field.
Fields	getTermVectors(int docID) Retrieve term vectors for this document, or null if term vectors were not indexed.
Terms	terms(java.lang.String field) Returns the Terms index for this field, or null if it has none.

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

checkIntegrity, doClose, document, getDelegate, getFieldInfos, getMetaData, maxDoc, numDocs, toString, unwrap

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

docFreq, getContext, getDocCount, getSumDocFreq, getSumTotalTermFreq, postings, postings, totalTermFreq

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

close, decRef, document, document, ensureOpen, equals, getRefCount, getTermVector, hasDeletions, hashCode, incRef, leaves, numDeletedDocs, registerParentReader, tryIncRef

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

AssertingLeafReader

public AssertingLeafReader(LeafReader in)

Method Detail

terms

public Terms terms(java.lang.String field)
            throws java.io.IOException

Description copied from class: LeafReader

Returns the Terms index for this field, or null if it has none.

Overrides:

terms in class FilterLeafReader

Throws:

java.io.IOException

getTermVectors

public Fields getTermVectors(int docID)
                      throws java.io.IOException

Description copied from class: IndexReader

Retrieve term vectors for this document, or null if term vectors were not indexed. The returned Fields instance acts like a single-document inverted index (the docID will be 0).

Overrides:

getTermVectors in class FilterLeafReader

Throws:

java.io.IOException

getNumericDocValues

public NumericDocValues getNumericDocValues(java.lang.String field)
                                     throws java.io.IOException

Description copied from class: LeafReader

Returns NumericDocValues for this field, or null if no numeric doc values were indexed for this field. The returned instance should only be used by a single thread.

Overrides:

getNumericDocValues in class FilterLeafReader

Throws:

java.io.IOException

getBinaryDocValues

public BinaryDocValues getBinaryDocValues(java.lang.String field)
                                   throws java.io.IOException

Description copied from class: LeafReader

Returns BinaryDocValues for this field, or null if no binary doc values were indexed for this field. The returned instance should only be used by a single thread.

Overrides:

getBinaryDocValues in class FilterLeafReader

Throws:

java.io.IOException

getSortedDocValues

public SortedDocValues getSortedDocValues(java.lang.String field)
                                   throws java.io.IOException

Description copied from class: LeafReader

Returns SortedDocValues for this field, or null if no SortedDocValues were indexed for this field. The returned instance should only be used by a single thread.

Overrides:

getSortedDocValues in class FilterLeafReader

Throws:

java.io.IOException

getSortedNumericDocValues

public SortedNumericDocValues getSortedNumericDocValues(java.lang.String field)
                                                 throws java.io.IOException

Description copied from class: LeafReader

Returns SortedNumericDocValues for this field, or null if no SortedNumericDocValues were indexed for this field. The returned instance should only be used by a single thread.

Overrides:

getSortedNumericDocValues in class FilterLeafReader

Throws:

java.io.IOException

getSortedSetDocValues

public SortedSetDocValues getSortedSetDocValues(java.lang.String field)
                                         throws java.io.IOException

Description copied from class: LeafReader

Returns SortedSetDocValues for this field, or null if no SortedSetDocValues were indexed for this field. The returned instance should only be used by a single thread.

Overrides:

getSortedSetDocValues in class FilterLeafReader

Throws:

java.io.IOException

getNormValues

public NumericDocValues getNormValues(java.lang.String field)
                               throws java.io.IOException

Description copied from class: LeafReader

Returns NumericDocValues representing norms for this field, or null if no NumericDocValues were indexed. The returned instance should only be used by a single thread.

Overrides:

getNormValues in class FilterLeafReader

Throws:

java.io.IOException

getPointValues

public PointValues getPointValues(java.lang.String field)
                           throws java.io.IOException

Description copied from class: LeafReader

Returns the PointValues used for numeric or spatial searches for the given field, or null if there are no point fields.

Overrides:

getPointValues in class FilterLeafReader

Throws:

java.io.IOException

getLiveDocs

public Bits getLiveDocs()

Description copied from class: LeafReader

Returns the Bits representing live (not deleted) docs. A set bit indicates the doc ID has not been deleted. If this method returns null it means there are no deleted documents (all documents are live). The returned instance has been safely published for use by multiple threads without additional synchronization.

Overrides:

getLiveDocs in class FilterLeafReader

getCoreCacheHelper

public IndexReader.CacheHelper getCoreCacheHelper()

Description copied from class: LeafReader

Optional method: Return a IndexReader.CacheHelper that can be used to cache based on the content of this leaf regardless of deletions. Two readers that have the same data but different sets of deleted documents or doc values updates may be considered equal. Consider using IndexReader.getReaderCacheHelper() if you need deletions or dv updates to be taken into account.

A return value of null indicates that this reader is not suited for caching, which is typically the case for short-lived wrappers that alter the content of the wrapped leaf reader.

Specified by:

getCoreCacheHelper in class LeafReader

getReaderCacheHelper

public IndexReader.CacheHelper getReaderCacheHelper()

Description copied from class: IndexReader

Optional method: Return a IndexReader.CacheHelper that can be used to cache based on the content of this reader. Two readers that have different data or different sets of deleted documents will be considered different.

A return value of null indicates that this reader is not suited for caching, which is typically the case for short-lived wrappers that alter the content of the wrapped reader.

Specified by:

getReaderCacheHelper in class IndexReader