java.lang.Object | ||
↳ | org.apache.lucene.index.IndexReader | |
↳ | org.apache.lucene.index.MultiReader |
An IndexReader which reads multiple indexes, appending their content.
Fields | |||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|
subReaders |
[Expand]
Inherited Fields | |||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|
From class
org.apache.lucene.index.IndexReader
|
Public Constructors | |||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|
Construct a MultiReader aggregating the named set of (sub)readers. | |||||||||||
Construct a MultiReader aggregating the named set of (sub)readers. |
Public Methods | |||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|
Expert: adds a
IndexReader.ReaderFinishedListener . | |||||||||||
Clones the subreaders.
| |||||||||||
Returns the number of documents containing the term
t . | |||||||||||
Get the
Document at the n
th position. | |||||||||||
Get a list of unique field names that exist in this index and have the specified
field option information.
| |||||||||||
Expert: returns the sequential sub readers that this
reader is logically composed of.
| |||||||||||
Load the Term Vector into a user-defined data structure instead of relying on the parallel arrays of
the
TermFreqVector . | |||||||||||
Map all the term vectors for all fields in a Document
| |||||||||||
Return a term frequency vector for the specified document and field.
| |||||||||||
Return an array of term frequency vectors for the specified document.
| |||||||||||
Not implemented.
| |||||||||||
Returns true if any documents have been deleted
| |||||||||||
Returns true if there are norms stored for this field.
| |||||||||||
Checks recursively if all subreaders are up to date.
| |||||||||||
Returns true if document n has been deleted
| |||||||||||
Checks is the index is optimized (if it has a single segment and
no deletions).
| |||||||||||
Returns one greater than the largest possible document number.
| |||||||||||
Returns the byte-encoded normalization factor for the named field of
every document.
| |||||||||||
Reads the byte-encoded normalization factor for the named field of every
document.
| |||||||||||
Returns the number of documents in this index.
| |||||||||||
Expert: remove a previously added
IndexReader.ReaderFinishedListener . | |||||||||||
Tries to reopen the subreaders.
| |||||||||||
Returns an unpositioned
TermDocs enumerator. | |||||||||||
Returns an enumeration of all the documents which contain
term . | |||||||||||
Returns an unpositioned
TermPositions enumerator. | |||||||||||
Returns an enumeration of all terms starting at a given term.
| |||||||||||
Returns an enumeration of all the terms in the index.
|
Protected Methods | |||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|
Implements close.
| |||||||||||
Implements commit.
| |||||||||||
Implements deletion of the document numbered
docNum . | |||||||||||
If clone is true then we clone each of the subreaders
| |||||||||||
Implements setNorm in subclass.
| |||||||||||
Implements actual undeleteAll() in subclass.
|
[Expand]
Inherited Methods | |||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|
From class
org.apache.lucene.index.IndexReader
| |||||||||||
From class
java.lang.Object
| |||||||||||
From interface
java.io.Closeable
|
Construct a MultiReader aggregating the named set of (sub)readers. Directory locking for delete, undeleteAll, and setNorm operations is left to the subreaders.
Note that all subreaders are closed if this Multireader is closed.
subReaders | set of (sub)readers |
---|
Construct a MultiReader aggregating the named set of (sub)readers. Directory locking for delete, undeleteAll, and setNorm operations is left to the subreaders.
subReaders | set of (sub)readers |
---|---|
closeSubReaders | indicates whether the subreaders should be closed when this MultiReader is closed |
Expert: adds a IndexReader.ReaderFinishedListener
. The
provided listener is also added to any sub-readers, if
this is a composite reader. Also, any reader reopened
or cloned from this one will also copy the listeners at
the time of reopen.
Clones the subreaders.
(see clone()
).
If subreaders are shared, then the reference count of those readers is increased to ensure that the subreaders remain open until the last referring reader is closed.
Returns the number of documents containing the term t
.
IOException |
---|
Get the Document
at the n
th position. The FieldSelector
may be used to determine
what Field
s to load and how they should
be loaded. NOTE: If this Reader (more specifically, the underlying
FieldsReader
) is closed before the lazy
Field
is loaded an exception may be
thrown. If you want the value of a lazy
Field
to be available after closing you
must explicitly load it or fetch the Document again with a new loader.
NOTE: for performance reasons, this method does not check if the
requested document is deleted, and therefore asking for a deleted document
may yield unspecified results. Usually this is not required, however you
can call isDeleted(int)
with the requested document ID to verify
the document is not deleted.
n | Get the document at the n th position |
---|---|
fieldSelector | The FieldSelector to use to determine what
Fields should be loaded on the Document. May be null, in which case
all Fields will be loaded. |
Document
at the nth positionCorruptIndexException | |
---|---|
IOException |
Get a list of unique field names that exist in this index and have the specified field option information.
fieldNames | specifies which field option should be available for the returned fields |
---|
Expert: returns the sequential sub readers that this reader is logically composed of. For example, IndexSearcher uses this API to drive searching by one sub reader at a time. If this reader is not composed of sequential child readers, it should return null. If this method returns an empty array, that means this reader is a null reader (for example a MultiReader that has no sub readers).
NOTE: You should not try using sub-readers returned by
this method to make any changes (setNorm, deleteDocument,
etc.). While this might succeed for one composite reader
(like MultiReader), it will most likely lead to index
corruption for other readers (like DirectoryReader obtained
through open(IndexCommit, boolean)
. Use the parent reader directly.
Load the Term Vector into a user-defined data structure instead of relying on the parallel arrays of
the TermFreqVector
.
docNumber | The number of the document to load the vector for |
---|---|
field | The name of the field to load |
mapper | The TermVectorMapper to process the vector. Must not be null |
IOException |
---|
Map all the term vectors for all fields in a Document
docNumber | The number of the document to load the vector for |
---|---|
mapper | The TermVectorMapper to process the vector. Must not be null |
IOException |
---|
Return a term frequency vector for the specified document and field. The
returned vector contains terms and frequencies for the terms in
the specified field of this document, if the field had the storeTermVector
flag set. If termvectors had been stored with positions or offsets, a
TermPositionVector
is returned.
n | document for which the term frequency vector is returned |
---|---|
field | field for which the term frequency vector is returned. |
IOException |
---|
Return an array of term frequency vectors for the specified document.
The array contains a vector for each vectorized field in the document.
Each vector contains terms and frequencies for all terms in a given vectorized field.
If no such fields existed, the method returns null. The term vectors that are
returned may either be of type TermFreqVector
or of type TermPositionVector
if
positions or offsets have been stored.
n | document for which term frequency vectors are returned |
---|
IOException |
---|
Returns true if any documents have been deleted
Returns true if there are norms stored for this field.
IOException |
---|
Checks recursively if all subreaders are up to date.
CorruptIndexException | |
---|---|
IOException |
Returns true if document n has been deleted
Checks is the index is optimized (if it has a single segment and no deletions). Not implemented in the IndexReader base class.
true
if the index is optimized; false
otherwiseReturns one greater than the largest possible document number. This may be used to, e.g., determine how big to allocate an array which will have an element for every document number in an index.
Returns the byte-encoded normalization factor for the named field of every document. This is used by the search code to score documents. Returns null if norms were not indexed for this field.
IOException |
---|
Reads the byte-encoded normalization factor for the named field of every document. This is used by the search code to score documents.
IOException |
---|
Returns the number of documents in this index.
Expert: remove a previously added IndexReader.ReaderFinishedListener
.
Tries to reopen the subreaders.
If one or more subreaders could be re-opened (i. e. subReader.reopen()
returned a new instance != subReader), then a new MultiReader instance
is returned, otherwise this instance is returned.
A re-opened instance might share one or more subreaders with the old
instance. Index modification operations result in undefined behavior
when performed before the old instance is closed.
(see reopen()
).
If subreaders are shared, then the reference count of those readers is increased to ensure that the subreaders remain open until the last referring reader is closed.
CorruptIndexException | if the index is corrupt |
---|---|
IOException | if there is a low-level IO error |
Returns an unpositioned TermDocs
enumerator.
Note: the TermDocs returned is unpositioned. Before using it, ensure
that you first position it with seek(Term)
or
seek(TermEnum)
.
IOException |
---|
Returns an enumeration of all the documents which contain
term
. For each document, the document number, the frequency of
the term in that document is also provided, for use in
search scoring. If term is null, then all non-deleted
docs are returned with freq=1.
Thus, this method implements the mapping:
The enumeration is ordered by document number. Each document number is greater than all that precede it in the enumeration.
IOException |
---|
Returns an unpositioned TermPositions
enumerator.
IOException |
---|
Returns an enumeration of all terms starting at a given term. If the given term does not exist, the enumeration is positioned at the first term greater than the supplied term. The enumeration is ordered by Term.compareTo(). Each term is greater than all that precede it in the enumeration.
IOException |
---|
Returns an enumeration of all the terms in the index. The
enumeration is ordered by Term.compareTo(). Each term is greater
than all that precede it in the enumeration. Note that after
calling terms(), next()
must be called
on the resulting enumeration before calling other methods such as
term()
.
IOException |
---|
Implements deletion of the document numbered docNum
.
Applications should call deleteDocument(int)
or deleteDocuments(Term)
.
CorruptIndexException | |
---|---|
IOException |
If clone is true then we clone each of the subreaders
CorruptIndexException | |
IOException | |
CorruptIndexException |
Implements setNorm in subclass.
CorruptIndexException | |
---|---|
IOException |
Implements actual undeleteAll() in subclass.
CorruptIndexException | |
---|---|
IOException |