public class MultiReader extends IndexReader implements Cloneable
IndexReader.ReaderClosedListener
Modifier and Type | Field and Description |
---|---|
protected int[] |
starts |
protected IndexReader[] |
subReaders |
hasChanges
Constructor and Description |
---|
MultiReader(IndexReader... subReaders)
Construct a MultiReader aggregating the named set of (sub)readers.
|
MultiReader(IndexReader[] subReaders,
boolean closeSubReaders)
Construct a MultiReader aggregating the named set of (sub)readers.
|
Modifier and Type | Method and Description |
---|---|
Object |
clone()
Efficiently clones the IndexReader (sharing most
internal state).
|
IndexReader |
clone(boolean openReadOnly)
Deprecated.
Write support will be removed in Lucene 4.0.
Use
clone() instead. |
int |
docFreq(Term t)
Returns the number of documents containing the term
t . |
protected void |
doClose()
Implements close.
|
protected void |
doCommit(Map<String,String> commitUserData)
Deprecated.
|
Document |
document(int n,
FieldSelector fieldSelector)
Get the
Document at the n
th position. |
protected void |
doDelete(int n)
Deprecated.
|
protected IndexReader |
doOpenIfChanged()
If the index has changed since it was opened, open and return a new reader;
else, return
null . |
protected IndexReader |
doOpenIfChanged(boolean openReadOnly)
Deprecated.
Write support will be removed in Lucene 4.0.
Use
doOpenIfChanged() instead. |
protected void |
doSetNorm(int n,
String field,
byte value)
Deprecated.
|
protected void |
doUndeleteAll()
Deprecated.
|
FieldInfos |
getFieldInfos()
Get the
FieldInfos describing all fields in
this reader. |
IndexReader[] |
getSequentialSubReaders()
Expert: returns the sequential sub readers that this
reader is logically composed of.
|
TermFreqVector |
getTermFreqVector(int n,
String field)
Return a term frequency vector for the specified document and field.
|
void |
getTermFreqVector(int docNumber,
String field,
TermVectorMapper mapper)
Load the Term Vector into a user-defined data structure instead of relying on the parallel arrays of
the
TermFreqVector . |
void |
getTermFreqVector(int docNumber,
TermVectorMapper mapper)
Map all the term vectors for all fields in a Document
|
TermFreqVector[] |
getTermFreqVectors(int n)
Return an array of term frequency vectors for the specified document.
|
long |
getVersion()
Not implemented.
|
boolean |
hasDeletions()
Returns true if any documents have been deleted
|
boolean |
hasNorms(String field)
Returns true if there are norms stored for this field.
|
boolean |
isCurrent()
Checks recursively if all subreaders are up to date.
|
boolean |
isDeleted(int n)
Returns true if document n has been deleted
|
boolean |
isOptimized()
Deprecated.
|
int |
maxDoc()
Returns one greater than the largest possible document number.
|
byte[] |
norms(String field)
Returns the byte-encoded normalization factor for the named field of
every document.
|
void |
norms(String field,
byte[] result,
int offset)
Reads the byte-encoded normalization factor for the named field of every
document.
|
int |
numDocs()
Returns the number of documents in this index.
|
protected int |
readerIndex(int n) |
TermDocs |
termDocs()
Returns an unpositioned
TermDocs enumerator. |
TermDocs |
termDocs(Term term)
Returns an enumeration of all the documents which contain
term . |
TermPositions |
termPositions()
Returns an unpositioned
TermPositions enumerator. |
TermEnum |
terms()
Returns an enumeration of all the terms in the index.
|
TermEnum |
terms(Term term)
Returns an enumeration of all terms starting at a given term.
|
acquireWriteLock, addReaderClosedListener, close, commit, commit, decRef, deleteDocument, deleteDocuments, directory, document, doOpenIfChanged, doOpenIfChanged, ensureOpen, flush, flush, getCommitUserData, getCommitUserData, getCoreCacheKey, getCurrentVersion, getDeletesCacheKey, getIndexCommit, getRefCount, getTermInfosIndexDivisor, getUniqueTermCount, incRef, indexExists, lastModified, listCommits, numDeletedDocs, open, open, open, open, open, open, open, open, open, open, open, openIfChanged, openIfChanged, openIfChanged, openIfChanged, removeReaderClosedListener, reopen, reopen, reopen, reopen, setNorm, setNorm, termPositions, toString, tryIncRef, undeleteAll
protected final IndexReader[] subReaders
protected final int[] starts
public MultiReader(IndexReader... subReaders)
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)readerspublic MultiReader(IndexReader[] subReaders, boolean closeSubReaders)
Construct a MultiReader aggregating the named set of (sub)readers. Directory locking for delete, undeleteAll, and setNorm operations is left to the subreaders.
closeSubReaders
- indicates whether the subreaders should be closed
when this MultiReader is closedsubReaders
- set of (sub)readerspublic FieldInfos getFieldInfos()
IndexReader
FieldInfos
describing all fields in
this reader. NOTE: do not make any changes to the
returned FieldInfos!getFieldInfos
in class IndexReader
protected IndexReader doOpenIfChanged() throws CorruptIndexException, IOException
IndexReader
null
.doOpenIfChanged
in class IndexReader
CorruptIndexException
IOException
IndexReader.openIfChanged(IndexReader)
@Deprecated protected IndexReader doOpenIfChanged(boolean openReadOnly) throws CorruptIndexException, IOException
doOpenIfChanged()
instead.IndexReader
null
.doOpenIfChanged
in class IndexReader
UnsupportedOperationException
- MultiReaders cannot support changing the readOnly flagCorruptIndexException
IOException
IndexReader.openIfChanged(IndexReader, boolean)
public Object clone()
IndexReader
On cloning a reader with pending changes (deletions, norms), the original reader transfers its write lock to the cloned reader. This means only the cloned reader may make further changes to the index, and commit the changes to the index on close, but the old reader still reflects all changes made up until it was cloned.
Like IndexReader.openIfChanged(IndexReader)
, it's safe to make changes to
either the original or the cloned reader: all shared
mutable state obeys "copy on write" semantics to ensure
the changes are not seen by other readers.
clone
in class IndexReader
@Deprecated public IndexReader clone(boolean openReadOnly) throws CorruptIndexException, IOException
clone()
instead.IndexReader
clone
in class IndexReader
UnsupportedOperationException
- MultiReaders cannot support changing the readOnly flagCorruptIndexException
- if the index is corruptIOException
- if there is a low-level IO errorpublic TermFreqVector[] getTermFreqVectors(int n) throws IOException
IndexReader
TermFreqVector
or of type TermPositionVector
if
positions or offsets have been stored.getTermFreqVectors
in class IndexReader
n
- document for which term frequency vectors are returnedIOException
- if index cannot be accessedField.TermVector
public TermFreqVector getTermFreqVector(int n, String field) throws IOException
IndexReader
TermPositionVector
is returned.getTermFreqVector
in class IndexReader
n
- document for which the term frequency vector is returnedfield
- field for which the term frequency vector is returned.IOException
- if index cannot be accessedField.TermVector
public void getTermFreqVector(int docNumber, String field, TermVectorMapper mapper) throws IOException
IndexReader
TermFreqVector
.getTermFreqVector
in class IndexReader
docNumber
- The number of the document to load the vector forfield
- The name of the field to loadmapper
- The TermVectorMapper
to process the vector. Must not be nullIOException
- if term vectors cannot be accessed or if they do not exist on the field and doc. specified.public void getTermFreqVector(int docNumber, TermVectorMapper mapper) throws IOException
IndexReader
getTermFreqVector
in class IndexReader
docNumber
- The number of the document to load the vector formapper
- The TermVectorMapper
to process the vector. Must not be nullIOException
- if term vectors cannot be accessed or if they do not exist on the field and doc. specified.@Deprecated public boolean isOptimized()
isOptimized
in class IndexReader
public int numDocs()
IndexReader
numDocs
in class IndexReader
public int maxDoc()
IndexReader
maxDoc
in class IndexReader
public Document document(int n, FieldSelector fieldSelector) throws CorruptIndexException, IOException
IndexReader
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 IndexReader.isDeleted(int)
with the requested document ID to verify
the document is not deleted.
document
in class IndexReader
n
- Get the document at the n
th positionfieldSelector
- 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
- if the index is corruptIOException
- if there is a low-level IO errorFieldable
,
FieldSelector
,
SetBasedFieldSelector
,
LoadFirstFieldSelector
public boolean isDeleted(int n)
IndexReader
isDeleted
in class IndexReader
public boolean hasDeletions()
IndexReader
hasDeletions
in class IndexReader
@Deprecated protected void doDelete(int n) throws CorruptIndexException, IOException
docNum
.
Applications should call IndexReader.deleteDocument(int)
or IndexReader.deleteDocuments(Term)
.doDelete
in class IndexReader
CorruptIndexException
IOException
@Deprecated protected void doUndeleteAll() throws CorruptIndexException, IOException
doUndeleteAll
in class IndexReader
CorruptIndexException
IOException
protected int readerIndex(int n)
public boolean hasNorms(String field) throws IOException
IndexReader
hasNorms
in class IndexReader
IOException
public byte[] norms(String field) throws IOException
IndexReader
norms
in class IndexReader
IOException
AbstractField.setBoost(float)
public void norms(String field, byte[] result, int offset) throws IOException
IndexReader
norms
in class IndexReader
IOException
AbstractField.setBoost(float)
@Deprecated protected void doSetNorm(int n, String field, byte value) throws CorruptIndexException, IOException
doSetNorm
in class IndexReader
CorruptIndexException
IOException
public TermEnum terms() throws IOException
IndexReader
TermEnum.next()
must be called
on the resulting enumeration before calling other methods such as
TermEnum.term()
.terms
in class IndexReader
IOException
- if there is a low-level IO errorpublic TermEnum terms(Term term) throws IOException
IndexReader
terms
in class IndexReader
IOException
- if there is a low-level IO errorpublic int docFreq(Term t) throws IOException
IndexReader
t
.docFreq
in class IndexReader
IOException
- if there is a low-level IO errorpublic TermDocs termDocs() throws IOException
IndexReader
TermDocs
enumerator.
Note: the TermDocs returned is unpositioned. Before using it, ensure
that you first position it with TermDocs.seek(Term)
or
TermDocs.seek(TermEnum)
.
termDocs
in class IndexReader
IOException
- if there is a low-level IO errorpublic TermDocs termDocs(Term term) throws IOException
IndexReader
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.
termDocs
in class IndexReader
IOException
- if there is a low-level IO errorpublic TermPositions termPositions() throws IOException
IndexReader
TermPositions
enumerator.termPositions
in class IndexReader
IOException
- if there is a low-level IO error@Deprecated protected void doCommit(Map<String,String> commitUserData) throws IOException
doCommit
in class IndexReader
IOException
protected void doClose() throws IOException
IndexReader
doClose
in class IndexReader
IOException
public boolean isCurrent() throws CorruptIndexException, IOException
isCurrent
in class IndexReader
CorruptIndexException
- if the index is corruptIOException
- if there is a low-level IO errorpublic long getVersion()
getVersion
in class IndexReader
UnsupportedOperationException
public IndexReader[] getSequentialSubReaders()
IndexReader
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 IndexReader.open(org.apache.lucene.store.Directory)
. Use the parent reader directly.
getSequentialSubReaders
in class IndexReader