public class InstantiatedIndexReader extends IndexReader
Consider using InstantiatedIndex as if it was immutable.
IndexReader.FieldOption
hasChanges
Constructor and Description |
---|
InstantiatedIndexReader(InstantiatedIndex index) |
Modifier and Type | Method and Description |
---|---|
Directory |
directory() |
int |
docFreq(Term t) |
protected void |
doClose() |
protected void |
doCommit() |
Document |
document(int n)
Returns the stored fields of the
n th
Document in this index. |
Document |
document(int n,
FieldSelector fieldSelector)
Return the
Document at the n th
position. |
protected void |
doDelete(int docNum) |
protected void |
doSetNorm(int doc,
String field,
byte value) |
protected void |
doUndeleteAll() |
Collection |
getFieldNames(IndexReader.FieldOption fieldOption) |
InstantiatedIndex |
getIndex() |
TermFreqVector |
getTermFreqVector(int docNumber,
String field) |
void |
getTermFreqVector(int docNumber,
String field,
TermVectorMapper mapper) |
void |
getTermFreqVector(int docNumber,
TermVectorMapper mapper) |
TermFreqVector[] |
getTermFreqVectors(int docNumber) |
long |
getVersion()
An InstantiatedIndexReader is not a snapshot in time, it is completely in
sync with the latest commit to the store!
|
boolean |
hasDeletions() |
boolean |
isCurrent()
An InstantiatedIndexReader is always current!
Check whether this IndexReader is still using the current (i.e., most
recently committed) version of the index.
|
boolean |
isDeleted(int n) |
boolean |
isOptimized() |
int |
maxDoc() |
byte[] |
norms(String field)
never ever touch these values.
|
void |
norms(String field,
byte[] bytes,
int offset) |
int |
numDocs() |
TermDocs |
termDocs() |
TermPositions |
termPositions() |
TermEnum |
terms() |
TermEnum |
terms(Term t) |
acquireWriteLock, close, commit, decRef, deleteDocument, deleteDocuments, ensureOpen, flush, getCurrentVersion, getCurrentVersion, getCurrentVersion, getIndexCommit, getTermInfosIndexDivisor, hasNorms, incRef, indexExists, indexExists, indexExists, isLocked, isLocked, lastModified, lastModified, lastModified, listCommits, main, numDeletedDocs, open, open, open, open, open, open, open, open, open, reopen, setNorm, setNorm, setTermInfosIndexDivisor, termDocs, termPositions, undeleteAll, unlock
public InstantiatedIndexReader(InstantiatedIndex index)
public boolean isOptimized()
isOptimized
in class IndexReader
public long getVersion()
getVersion
in class IndexReader
InstantiatedIndex.getVersion()
in associated instantiated index.public Directory directory()
directory
in class IndexReader
public boolean isCurrent() throws IOException
false
, in which case you must open a new IndexReader in
order to see the changes. See the description of the autoCommit
flag
which controls when the IndexWriter
actually commits changes to the
index.isCurrent
in class IndexReader
CorruptIndexException
- if the index is corruptIOException
- if there is a low-level IO errorUnsupportedOperationException
- unless overridden in subclasspublic InstantiatedIndex getIndex()
public int numDocs()
numDocs
in class IndexReader
public int maxDoc()
maxDoc
in class IndexReader
public boolean isDeleted(int n)
isDeleted
in class IndexReader
public boolean hasDeletions()
hasDeletions
in class IndexReader
protected void doDelete(int docNum) throws IOException
doDelete
in class IndexReader
IOException
protected void doUndeleteAll() throws IOException
doUndeleteAll
in class IndexReader
IOException
protected void doCommit() throws IOException
doCommit
in class IndexReader
IOException
protected void doClose() throws IOException
doClose
in class IndexReader
IOException
public Collection getFieldNames(IndexReader.FieldOption fieldOption)
getFieldNames
in class IndexReader
public Document document(int n, FieldSelector fieldSelector) throws CorruptIndexException, IOException
Document
at the n
th
position.
Warning!
The resulting document is the actual stored document instance
and not a deserialized clone as retuned by an IndexReader
over a Directory
.
I.e., if you need to touch the document, clone it first!
This can also be seen as a feature for live canges of stored values,
but be carful! Adding a field with an name unknown to the index
or to a field with previously no stored values will make
getFieldNames(org.apache.lucene.index.IndexReader.FieldOption)
out of sync, causing problems for instance when merging the
instantiated index to another index.
This implementation ignores the field selector! All stored fields are always returned!
document
in class IndexReader
n
- document numberfieldSelector
- ignoredDocument
at the nth positionCorruptIndexException
- if the index is corruptIOException
- if there is a low-level IO errorFieldable
,
FieldSelector
,
SetBasedFieldSelector
,
LoadFirstFieldSelector
public Document document(int n) throws IOException
n
th
Document
in this index.
Warning!
The resulting document is the actual stored document instance
and not a deserialized clone as retuned by an IndexReader
over a Directory
.
I.e., if you need to touch the document, clone it first!
This can also be seen as a feature for live canges of stored values,
but be carful! Adding a field with an name unknown to the index
or to a field with previously no stored values will make
getFieldNames(org.apache.lucene.index.IndexReader.FieldOption)
out of sync, causing problems for instance when merging the
instantiated index to another index.
document
in class IndexReader
CorruptIndexException
- if the index is corruptIOException
- if there is a low-level IO errorpublic byte[] norms(String field) throws IOException
norms
in class IndexReader
IOException
public void norms(String field, byte[] bytes, int offset) throws IOException
norms
in class IndexReader
IOException
protected void doSetNorm(int doc, String field, byte value) throws IOException
doSetNorm
in class IndexReader
IOException
public int docFreq(Term t) throws IOException
docFreq
in class IndexReader
IOException
public TermEnum terms() throws IOException
terms
in class IndexReader
IOException
public TermEnum terms(Term t) throws IOException
terms
in class IndexReader
IOException
public TermDocs termDocs() throws IOException
termDocs
in class IndexReader
IOException
public TermPositions termPositions() throws IOException
termPositions
in class IndexReader
IOException
public TermFreqVector[] getTermFreqVectors(int docNumber) throws IOException
getTermFreqVectors
in class IndexReader
IOException
public TermFreqVector getTermFreqVector(int docNumber, String field) throws IOException
getTermFreqVector
in class IndexReader
IOException
public void getTermFreqVector(int docNumber, String field, TermVectorMapper mapper) throws IOException
getTermFreqVector
in class IndexReader
IOException
public void getTermFreqVector(int docNumber, TermVectorMapper mapper) throws IOException
getTermFreqVector
in class IndexReader
IOException
Copyright © 2000-2013 Apache Software Foundation. All Rights Reserved.