org.apache.lucene.index

Class AssertingAtomicReader

java.lang.Object

org.apache.lucene.index.IndexReader

org.apache.lucene.index.AtomicReader

org.apache.lucene.index.FilterAtomicReader

org.apache.lucene.index.AssertingAtomicReader

All Implemented Interfaces:

Closeable, AutoCloseable

public class AssertingAtomicReader
extends FilterAtomicReader

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

Nested Class Summary

Nested Classes

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

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

FilterAtomicReader.FilterDocsAndPositionsEnum, FilterAtomicReader.FilterDocsEnum, FilterAtomicReader.FilterFields, FilterAtomicReader.FilterTerms, FilterAtomicReader.FilterTermsEnum

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

AtomicReader.CoreClosedListener

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

IndexReader.ReaderClosedListener

Field Summary

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

in

Constructor Summary

Constructors

Constructor and Description
AssertingAtomicReader(AtomicReader in)

Method Summary

Modifier and Type	Method and Description
Fields	fields() Returns Fields for this reader.
BinaryDocValues	getBinaryDocValues(String field) Returns BinaryDocValues for this field, or null if no BinaryDocValues were indexed for this field.
Object	getCombinedCoreAndDeletesKey() Expert: Returns a key for this IndexReader that also includes deletions, so FieldCache/CachingWrapperFilter can find it again.
Object	getCoreCacheKey() Expert: Returns a key for this IndexReader, so FieldCache/CachingWrapperFilter can find it again.
Bits	getDocsWithField(String field) Returns a Bits at the size of reader.maxDoc(), with turned on bits for each docid that does have a value for this field, or null if no DocValues were indexed for this field.
Bits	getLiveDocs() Returns the Bits representing live (not deleted) docs.
NumericDocValues	getNormValues(String field) Returns NumericDocValues representing norms for this field, or null if no NumericDocValues were indexed.
NumericDocValues	getNumericDocValues(String field) Returns NumericDocValues for this field, or null if no NumericDocValues were indexed for this field.
SortedDocValues	getSortedDocValues(String field) Returns SortedDocValues for this field, or null if no SortedDocValues were indexed for this field.
SortedNumericDocValues	getSortedNumericDocValues(String field) Returns SortedNumericDocValues for this field, or null if no SortedNumericDocValues were indexed for this field.
SortedSetDocValues	getSortedSetDocValues(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.

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

addCoreClosedListener, checkIntegrity, doClose, document, getFieldInfos, maxDoc, numDocs, removeCoreClosedListener, toString, unwrap

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

addCoreClosedListenerAsReaderClosedListener, docFreq, getContext, getDocCount, getSumDocFreq, getSumTotalTermFreq, hasNorms, removeCoreClosedListenerAsReaderClosedListener, termDocsEnum, termPositionsEnum, terms, totalTermFreq

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

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

Methods inherited from class java.lang.Object

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

Constructor Detail

AssertingAtomicReader

public AssertingAtomicReader(AtomicReader in)

Method Detail

fields

public Fields fields()
              throws IOException

Description copied from class: AtomicReader

Returns Fields for this reader. This method may return null if the reader has no postings.

Overrides:

fields in class FilterAtomicReader

Throws:

IOException

getTermVectors

public Fields getTermVectors(int docID)
                      throws 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 FilterAtomicReader

Throws:

IOException

getNumericDocValues

public NumericDocValues getNumericDocValues(String field)
                                     throws IOException

Description copied from class: AtomicReader

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

Overrides:

getNumericDocValues in class FilterAtomicReader

Throws:

IOException

getBinaryDocValues

public BinaryDocValues getBinaryDocValues(String field)
                                   throws IOException

Description copied from class: AtomicReader

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

Overrides:

getBinaryDocValues in class FilterAtomicReader

Throws:

IOException

getSortedDocValues

public SortedDocValues getSortedDocValues(String field)
                                   throws IOException

Description copied from class: AtomicReader

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 FilterAtomicReader

Throws:

IOException

getSortedNumericDocValues

public SortedNumericDocValues getSortedNumericDocValues(String field)
                                                 throws IOException

Description copied from class: AtomicReader

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 FilterAtomicReader

Throws:

IOException

getSortedSetDocValues

public SortedSetDocValues getSortedSetDocValues(String field)
                                         throws IOException

Description copied from class: AtomicReader

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 FilterAtomicReader

Throws:

IOException

getNormValues

public NumericDocValues getNormValues(String field)
                               throws IOException

Description copied from class: AtomicReader

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 FilterAtomicReader

Throws:

IOException

getLiveDocs

public Bits getLiveDocs()

Description copied from class: AtomicReader

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 FilterAtomicReader

getDocsWithField

public Bits getDocsWithField(String field)
                      throws IOException

Description copied from class: AtomicReader

Returns a Bits at the size of reader.maxDoc(), with turned on bits for each docid that does have a value for this field, or null if no DocValues were indexed for this field. The returned instance should only be used by a single thread

Overrides:

getDocsWithField in class FilterAtomicReader

Throws:

IOException

getCoreCacheKey

public Object getCoreCacheKey()

Description copied from class: IndexReader

Expert: Returns a key for this IndexReader, so FieldCache/CachingWrapperFilter can find it again. This key must not have equals()/hashCode() methods, so "equals" means "identical".

Overrides:

getCoreCacheKey in class IndexReader

getCombinedCoreAndDeletesKey

public Object getCombinedCoreAndDeletesKey()

Description copied from class: IndexReader

Expert: Returns a key for this IndexReader that also includes deletions, so FieldCache/CachingWrapperFilter can find it again. This key must not have equals()/hashCode() methods, so "equals" means "identical".

Overrides:

getCombinedCoreAndDeletesKey in class IndexReader