|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object org.apache.lucene.index.IndexReader org.apache.lucene.index.AtomicReader org.apache.lucene.index.FilterAtomicReader
public class FilterAtomicReader
A FilterAtomicReader
contains another AtomicReader, which it
uses as its basic source of data, possibly transforming the data along the
way or providing additional functionality. The class
FilterAtomicReader
itself simply implements all abstract methods
of IndexReader
with versions that pass all requests to the
contained index reader. Subclasses of FilterAtomicReader
may
further override some of these methods and may also provide additional
methods and fields.
Nested Class Summary | |
---|---|
static class |
FilterAtomicReader.FilterDocsAndPositionsEnum
Base class for filtering DocsAndPositionsEnum implementations. |
static class |
FilterAtomicReader.FilterDocsEnum
Base class for filtering DocsEnum implementations. |
static class |
FilterAtomicReader.FilterFields
Base class for filtering Fields
implementations. |
static class |
FilterAtomicReader.FilterTerms
Base class for filtering Terms
implementations. |
static class |
FilterAtomicReader.FilterTermsEnum
Base class for filtering TermsEnum implementations. |
Nested classes/interfaces inherited from class org.apache.lucene.index.IndexReader |
---|
IndexReader.ReaderClosedListener |
Field Summary | |
---|---|
protected AtomicReader |
in
The underlying AtomicReader. |
Constructor Summary | |
---|---|
FilterAtomicReader(AtomicReader in)
Construct a FilterAtomicReader based on the specified base reader. |
Method Summary | |
---|---|
protected void |
doClose()
Implements close. |
void |
document(int docID,
StoredFieldVisitor visitor)
Expert: visits the fields of a stored document, for custom processing/loading of each field. |
DocValues |
docValues(String field)
Returns DocValues for this field. |
Fields |
fields()
Returns Fields for this reader. |
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. |
FieldInfos |
getFieldInfos()
Get the FieldInfos describing all fields in
this reader. |
Bits |
getLiveDocs()
Returns the Bits representing live (not
deleted) docs. |
Fields |
getTermVectors(int docID)
Retrieve term vectors for this document, or null if term vectors were not indexed. |
boolean |
hasDeletions()
Returns true if any documents have been deleted |
int |
maxDoc()
Returns one greater than the largest possible document number. |
DocValues |
normValues(String field)
Returns DocValues for this field's normalization values. |
int |
numDocs()
Returns the number of documents in this index. |
String |
toString()
|
Methods inherited from class org.apache.lucene.index.AtomicReader |
---|
docFreq, getContext, hasNorms, termDocsEnum, termPositionsEnum, terms, totalTermFreq |
Methods inherited from class org.apache.lucene.index.IndexReader |
---|
addReaderClosedListener, close, decRef, document, document, ensureOpen, equals, getRefCount, getTermVector, 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 |
Field Detail |
---|
protected final AtomicReader in
Constructor Detail |
---|
public FilterAtomicReader(AtomicReader in)
Construct a FilterAtomicReader based on the specified base reader.
Note that base reader is closed if this FilterAtomicReader is closed.
in
- specified base reader.Method Detail |
---|
public Bits getLiveDocs()
AtomicReader
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.
getLiveDocs
in class AtomicReader
public FieldInfos getFieldInfos()
AtomicReader
FieldInfos
describing all fields in
this reader.
getFieldInfos
in class AtomicReader
public Fields getTermVectors(int docID) throws IOException
IndexReader
getTermVectors
in class IndexReader
IOException
public int numDocs()
IndexReader
numDocs
in class IndexReader
public int maxDoc()
IndexReader
maxDoc
in class IndexReader
public void document(int docID, StoredFieldVisitor visitor) throws IOException
IndexReader
IndexReader.document(int)
. If you want to load a subset, use
DocumentStoredFieldVisitor
.
document
in class IndexReader
IOException
public boolean hasDeletions()
IndexReader
hasDeletions
in class IndexReader
protected void doClose() throws IOException
IndexReader
doClose
in class IndexReader
IOException
public Fields fields() throws IOException
AtomicReader
Fields
for this reader.
This method may return null if the reader has no
postings.
fields
in class AtomicReader
IOException
public Object getCoreCacheKey()
If the subclass of FilteredIndexReader modifies the contents (but not liveDocs) of the index, you must override this method to provide a different key.
getCoreCacheKey
in class IndexReader
public Object getCombinedCoreAndDeletesKey()
If the subclass of FilteredIndexReader modifies the liveDocs, you must override this method to provide a different key.
getCombinedCoreAndDeletesKey
in class IndexReader
public String toString()
toString
in class Object
public DocValues docValues(String field) throws IOException
AtomicReader
DocValues
for this field.
This method may return null if the reader has no per-document
values stored.
docValues
in class AtomicReader
IOException
public DocValues normValues(String field) throws IOException
AtomicReader
DocValues
for this field's normalization values.
This method may return null if the field has no norms.
normValues
in class AtomicReader
IOException
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |