public class ParallelReader extends IndexReader
This is useful, e.g., with collections that have large fields which change rarely and small fields that change more frequently. The smaller fields may be re-indexed in a new index and both indexes may be searched together.
Warning: It is up to you to make sure all indexes are created and modified the same way. For example, if you add documents to one index, you need to add the same documents in the same order to the other indexes. Failure to do so will result in undefined behavior.
IndexReader.ReaderClosedListenerhasChanges| Constructor and Description |
|---|
ParallelReader()
Construct a ParallelReader.
|
ParallelReader(boolean closeSubReaders)
Construct a ParallelReader.
|
| Modifier and Type | Method and Description |
|---|---|
void |
add(IndexReader reader)
Add an IndexReader.
|
void |
add(IndexReader reader,
boolean ignoreStoredFields)
Add an IndexReader whose stored fields will not be returned.
|
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 term)
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. |
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.
|
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.
|
String |
toString() |
acquireWriteLock, addReaderClosedListener, close, commit, commit, decRef, deleteDocument, deleteDocuments, directory, document, doOpenIfChanged, doOpenIfChanged, ensureOpen, flush, flush, getCommitUserData, getCommitUserData, getCoreCacheKey, getCurrentVersion, getDeletesCacheKey, getIndexCommit, getRefCount, getSequentialSubReaders, 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, tryIncRef, undeleteAllpublic ParallelReader()
throws IOException
Note that all subreaders are closed if this ParallelReader is closed.
IOExceptionpublic ParallelReader(boolean closeSubReaders)
throws IOException
closeSubReaders - indicates whether the subreaders should be closed
when this ParallelReader is closedIOExceptionpublic String toString()
toString in class IndexReaderpublic void add(IndexReader reader) throws IOException
IOException - if there is a low-level IO errorpublic void add(IndexReader reader, boolean ignoreStoredFields) throws IOException
IllegalArgumentException - if not all indexes contain the same number
of documentsIllegalArgumentException - if not all indexes have the same value
of IndexReader.maxDoc()IOException - if there is a low-level IO errorpublic FieldInfos getFieldInfos()
IndexReaderFieldInfos describing all fields in
this reader. NOTE: do not make any changes to the
returned FieldInfos!getFieldInfos in class IndexReaderprotected IndexReader doOpenIfChanged() throws CorruptIndexException, IOException
IndexReadernull.doOpenIfChanged in class IndexReaderCorruptIndexExceptionIOExceptionIndexReader.openIfChanged(IndexReader)@Deprecated protected IndexReader doOpenIfChanged(boolean openReadOnly) throws CorruptIndexException, IOException
doOpenIfChanged() instead.IndexReadernull.doOpenIfChanged in class IndexReaderUnsupportedOperationException - ParallelReaders cannot support changing the readOnly flagCorruptIndexExceptionIOExceptionIndexReader.openIfChanged(IndexReader, boolean)public Object clone()
IndexReaderOn 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.IndexReaderclone in class IndexReaderUnsupportedOperationException - ParallelReaders cannot support changing the readOnly flagCorruptIndexException - if the index is corruptIOException - if there is a low-level IO errorpublic int numDocs()
IndexReadernumDocs in class IndexReaderpublic int maxDoc()
IndexReadermaxDoc in class IndexReaderpublic boolean hasDeletions()
IndexReaderhasDeletions in class IndexReaderpublic boolean isDeleted(int n)
IndexReaderisDeleted 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 IndexReaderCorruptIndexExceptionIOException@Deprecated protected void doUndeleteAll() throws CorruptIndexException, IOException
doUndeleteAll in class IndexReaderCorruptIndexExceptionIOExceptionpublic Document document(int n, FieldSelector fieldSelector) throws CorruptIndexException, IOException
IndexReaderDocument at the n
th position. The FieldSelector may be used to determine
what Fields 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 IndexReadern - Get the document at the nth 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,
LoadFirstFieldSelectorpublic TermFreqVector[] getTermFreqVectors(int n) throws IOException
IndexReaderTermFreqVector
or of type TermPositionVector if
positions or offsets have been stored.getTermFreqVectors in class IndexReadern - document for which term frequency vectors are returnedIOException - if index cannot be accessedField.TermVectorpublic TermFreqVector getTermFreqVector(int n, String field) throws IOException
IndexReaderTermPositionVector is returned.getTermFreqVector in class IndexReadern - document for which the term frequency vector is returnedfield - field for which the term frequency vector is returned.IOException - if index cannot be accessedField.TermVectorpublic void getTermFreqVector(int docNumber,
String field,
TermVectorMapper mapper)
throws IOException
IndexReaderTermFreqVector.getTermFreqVector in class IndexReaderdocNumber - 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
IndexReadergetTermFreqVector in class IndexReaderdocNumber - 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.public boolean hasNorms(String field) throws IOException
IndexReaderhasNorms in class IndexReaderIOExceptionpublic byte[] norms(String field) throws IOException
IndexReadernorms in class IndexReaderIOExceptionAbstractField.setBoost(float)public void norms(String field, byte[] result, int offset) throws IOException
IndexReadernorms in class IndexReaderIOExceptionAbstractField.setBoost(float)@Deprecated protected void doSetNorm(int n, String field, byte value) throws CorruptIndexException, IOException
doSetNorm in class IndexReaderCorruptIndexExceptionIOExceptionpublic TermEnum terms() throws IOException
IndexReaderTermEnum.next() must be called
on the resulting enumeration before calling other methods such as
TermEnum.term().terms in class IndexReaderIOException - if there is a low-level IO errorpublic TermEnum terms(Term term) throws IOException
IndexReaderterms in class IndexReaderIOException - if there is a low-level IO errorpublic int docFreq(Term term) throws IOException
IndexReadert.docFreq in class IndexReaderIOException - if there is a low-level IO errorpublic TermDocs termDocs(Term term) throws IOException
IndexReaderterm. 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 IndexReaderIOException - if there is a low-level IO errorpublic TermDocs termDocs() throws IOException
IndexReaderTermDocs 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 IndexReaderIOException - if there is a low-level IO errorpublic TermPositions termPositions() throws IOException
IndexReaderTermPositions enumerator.termPositions in class IndexReaderIOException - if there is a low-level IO errorpublic boolean isCurrent()
throws CorruptIndexException,
IOException
isCurrent in class IndexReaderCorruptIndexException - if the index is corruptIOException - if there is a low-level IO error@Deprecated public boolean isOptimized()
isOptimized in class IndexReaderpublic long getVersion()
getVersion in class IndexReaderUnsupportedOperationException@Deprecated protected void doCommit(Map<String,String> commitUserData) throws IOException
doCommit in class IndexReaderIOExceptionprotected void doClose()
throws IOException
IndexReaderdoClose in class IndexReaderIOException