|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectorg.apache.lucene.index.IndexReader
org.apache.lucene.index.MultiReader
public class MultiReader
An IndexReader which reads multiple indexes, appending their content.
Nested Class Summary |
---|
Nested classes/interfaces inherited from class org.apache.lucene.index.IndexReader |
---|
IndexReader.FieldOption |
Constructor Summary | |
---|---|
MultiReader(IndexReader[] subReaders)
Construct a MultiReader aggregating the named set of (sub)readers. |
Method Summary | |
---|---|
int |
docFreq(Term t)
Returns the number of documents containing the term t . |
protected void |
doClose()
Implements close. |
protected void |
doCommit()
Implements commit. |
Document |
document(int n,
FieldSelector fieldSelector)
Get the Document at the n th position. |
protected void |
doDelete(int n)
Implements deletion of the document numbered docNum . |
protected void |
doSetNorm(int n,
java.lang.String field,
byte value)
Implements setNorm in subclass. |
protected void |
doUndeleteAll()
Implements actual undeleteAll() in subclass. |
java.util.Collection |
getFieldNames(IndexReader.FieldOption fieldNames)
Get a list of unique field names that exist in this index and have the specified field option information. |
TermFreqVector |
getTermFreqVector(int n,
java.lang.String field)
Return a term frequency vector for the specified document and field. |
TermFreqVector[] |
getTermFreqVectors(int n)
Return an array of term frequency vectors for the specified document. |
boolean |
hasDeletions()
Returns true if any documents have been deleted |
boolean |
hasNorms(java.lang.String field)
Returns true if there are norms stored for this field. |
boolean |
isDeleted(int n)
Returns true if document n has been deleted |
int |
maxDoc()
Returns one greater than the largest possible document number. |
byte[] |
norms(java.lang.String field)
Returns the byte-encoded normalization factor for the named field of every document. |
void |
norms(java.lang.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. |
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. |
Methods inherited from class org.apache.lucene.index.IndexReader |
---|
close, commit, deleteDocument, deleteDocuments, directory, document, ensureOpen, finalize, getCurrentVersion, getCurrentVersion, getCurrentVersion, getVersion, indexExists, indexExists, indexExists, isCurrent, isLocked, isLocked, isOptimized, lastModified, lastModified, lastModified, main, open, open, open, open, setNorm, setNorm, termDocs, termPositions, undeleteAll, unlock |
Methods inherited from class java.lang.Object |
---|
clone, equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Constructor Detail |
---|
public MultiReader(IndexReader[] subReaders) throws java.io.IOException
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
java.io.IOException
Method Detail |
---|
public TermFreqVector[] getTermFreqVectors(int n) throws java.io.IOException
IndexReader
getTermFreqVectors
in class IndexReader
n
- document for which term frequency vectors are returned
java.io.IOException
- if index cannot be accessedField.TermVector
public TermFreqVector getTermFreqVector(int n, java.lang.String field) throws java.io.IOException
IndexReader
getTermFreqVector
in class IndexReader
n
- document for which the term frequency vector is returnedfield
- field for which the term frequency vector is returned.
java.io.IOException
- if index cannot be accessedField.TermVector
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, java.io.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.
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 position
CorruptIndexException
- if the index is corrupt
java.io.IOException
- 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
protected void doDelete(int n) throws CorruptIndexException, java.io.IOException
IndexReader
docNum
.
Applications should call IndexReader.deleteDocument(int)
or IndexReader.deleteDocuments(Term)
.
doDelete
in class IndexReader
CorruptIndexException
java.io.IOException
protected void doUndeleteAll() throws CorruptIndexException, java.io.IOException
IndexReader
doUndeleteAll
in class IndexReader
CorruptIndexException
java.io.IOException
public boolean hasNorms(java.lang.String field) throws java.io.IOException
IndexReader
hasNorms
in class IndexReader
java.io.IOException
public byte[] norms(java.lang.String field) throws java.io.IOException
IndexReader
norms
in class IndexReader
java.io.IOException
AbstractField.setBoost(float)
public void norms(java.lang.String field, byte[] result, int offset) throws java.io.IOException
IndexReader
norms
in class IndexReader
java.io.IOException
AbstractField.setBoost(float)
protected void doSetNorm(int n, java.lang.String field, byte value) throws CorruptIndexException, java.io.IOException
IndexReader
doSetNorm
in class IndexReader
CorruptIndexException
java.io.IOException
public TermEnum terms() throws java.io.IOException
IndexReader
TermEnum.next()
must be called
on the resulting enumeration before calling other methods such as
TermEnum.term()
.
terms
in class IndexReader
java.io.IOException
- if there is a low-level IO errorpublic TermEnum terms(Term term) throws java.io.IOException
IndexReader
terms
in class IndexReader
java.io.IOException
- if there is a low-level IO errorpublic int docFreq(Term t) throws java.io.IOException
IndexReader
t
.
docFreq
in class IndexReader
java.io.IOException
- if there is a low-level IO errorpublic TermDocs termDocs() throws java.io.IOException
IndexReader
TermDocs
enumerator.
termDocs
in class IndexReader
java.io.IOException
- if there is a low-level IO errorpublic TermPositions termPositions() throws java.io.IOException
IndexReader
TermPositions
enumerator.
termPositions
in class IndexReader
java.io.IOException
- if there is a low-level IO errorprotected void doCommit() throws java.io.IOException
IndexReader
doCommit
in class IndexReader
java.io.IOException
protected void doClose() throws java.io.IOException
IndexReader
doClose
in class IndexReader
java.io.IOException
public java.util.Collection getFieldNames(IndexReader.FieldOption fieldNames)
IndexReader
getFieldNames
in class IndexReader
fieldNames
- specifies which field option should be available for the returned fields
IndexReader.FieldOption
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |