org.apache.lucene.index

Class AllDeletedFilterReader

java.lang.Object

org.apache.lucene.index.IndexReader

org.apache.lucene.index.LeafReader

org.apache.lucene.index.FilterLeafReader

org.apache.lucene.index.AllDeletedFilterReader

All Implemented Interfaces:

Closeable, AutoCloseable

public class AllDeletedFilterReader
extends FilterLeafReader

Filters the incoming reader and makes all documents appear deleted.

Nested Class Summary

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.LeafReader

LeafReader.CoreClosedListener

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

IndexReader.ReaderClosedListener

Field Summary

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

in

Constructor Summary

Constructors

Constructor and Description
AllDeletedFilterReader(LeafReader in)

Method Summary

Modifier and Type	Method and Description
Bits	getLiveDocs() Returns the Bits representing live (not deleted) docs.
int	numDocs() Returns the number of documents in this index.

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

addCoreClosedListener, checkIntegrity, doClose, document, fields, getBinaryDocValues, getDelegate, getDocsWithField, getFieldInfos, getNormValues, getNumericDocValues, getSortedDocValues, getSortedNumericDocValues, getSortedSetDocValues, getTermVectors, maxDoc, removeCoreClosedListener, toString, unwrap

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

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

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

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

Methods inherited from class java.lang.Object

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

Constructor Detail

AllDeletedFilterReader

public AllDeletedFilterReader(LeafReader in)

Method Detail

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

numDocs

public int numDocs()

Description copied from class: IndexReader

Returns the number of documents in this index.

Overrides:

numDocs in class FilterLeafReader