public class SegmentReader extends IndexReader implements Cloneable
Instances pointing to the same segment (but with different deletes, etc) may share the same core data.
Modifier and Type | Class and Description |
---|---|
static interface |
SegmentReader.CoreClosedListener
Called when the shared core for this SegmentReader
is closed.
|
IndexReader.ReaderClosedListener
Modifier and Type | Field and Description |
---|---|
protected boolean |
readOnly
Deprecated.
|
hasChanges
Constructor and Description |
---|
SegmentReader() |
Modifier and Type | Method and Description |
---|---|
void |
addCoreClosedListener(SegmentReader.CoreClosedListener listener)
Expert: adds a CoreClosedListener to this reader's shared core
|
Object |
clone()
Efficiently clones the IndexReader (sharing most
internal state).
|
IndexReader |
clone(boolean openReadOnly)
Deprecated.
|
protected BitVector |
cloneDeletedDocs(BitVector bv)
Deprecated.
|
protected byte[] |
cloneNormBytes(byte[] bytes)
Deprecated.
|
Directory |
directory()
Returns the directory this index resides in.
|
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 docNum)
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.
|
protected void |
doSetNorm(int doc,
String field,
byte value)
Deprecated.
|
protected void |
doUndeleteAll()
Deprecated.
|
static SegmentReader |
get(boolean readOnly,
Directory dir,
SegmentInfo si,
int readBufferSize,
boolean doOpenStores,
int termInfosIndexDivisor) |
static SegmentReader |
get(boolean readOnly,
SegmentInfo si,
int termInfosIndexDivisor) |
Object |
getCoreCacheKey()
Expert
|
Object |
getDeletesCacheKey()
Expert.
|
FieldInfos |
getFieldInfos()
Get the
FieldInfos describing all fields in
this reader. |
String |
getSegmentName()
Return the name of the segment this reader is reading.
|
TermFreqVector |
getTermFreqVector(int docNumber,
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 docNumber)
Return an array of term frequency vectors for the specified document.
|
int |
getTermInfosIndexDivisor()
For IndexReader implementations that use
TermInfosReader to read terms, this returns the
current indexDivisor as specified when the reader was
opened.
|
long |
getUniqueTermCount()
Returns the number of unique terms (across all fields)
in this reader.
|
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 |
isDeleted(int n)
Returns true if document n has been deleted
|
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[] bytes,
int offset)
Read norms into a pre-allocated array.
|
int |
numDocs()
Returns the number of documents in this index.
|
TermDocs |
rawTermDocs(Term term)
Expert: returns an enumeration of the documents that contain
term , including deleted documents (which
are normally filtered out). |
void |
removeCoreClosedListener(SegmentReader.CoreClosedListener listener)
Expert: removes a CoreClosedListener from this reader's shared core
|
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 t)
Returns an enumeration of all terms starting at a given term.
|
String |
toString() |
acquireWriteLock, addReaderClosedListener, close, commit, commit, decRef, deleteDocument, deleteDocuments, document, doOpenIfChanged, doOpenIfChanged, ensureOpen, flush, flush, getCommitUserData, getCommitUserData, getCurrentVersion, getIndexCommit, getRefCount, getSequentialSubReaders, getVersion, incRef, indexExists, isCurrent, isOptimized, 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, undeleteAll
@Deprecated protected boolean readOnly
public static SegmentReader get(boolean readOnly, SegmentInfo si, int termInfosIndexDivisor) throws CorruptIndexException, IOException
CorruptIndexException
- if the index is corruptIOException
- if there is a low-level IO errorpublic static SegmentReader get(boolean readOnly, Directory dir, SegmentInfo si, int readBufferSize, boolean doOpenStores, int termInfosIndexDivisor) throws CorruptIndexException, IOException
CorruptIndexException
- if the index is corruptIOException
- if there is a low-level IO error@Deprecated protected byte[] cloneNormBytes(byte[] bytes)
bytes
- Byte array to clone@Deprecated protected BitVector cloneDeletedDocs(BitVector bv)
bv
- BitVector to clonepublic final 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 final IndexReader clone(boolean openReadOnly) throws CorruptIndexException, IOException
clone
in class IndexReader
CorruptIndexException
- if the index is corruptIOException
- if there is a low-level IO errorprotected 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
null
.doOpenIfChanged
in class IndexReader
CorruptIndexException
IOException
IndexReader.openIfChanged(IndexReader, boolean)
@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 hasDeletions()
IndexReader
hasDeletions
in class IndexReader
@Deprecated protected void doDelete(int docNum)
docNum
.
Applications should call IndexReader.deleteDocument(int)
or IndexReader.deleteDocuments(Term)
.doDelete
in class IndexReader
@Deprecated protected void doUndeleteAll()
doUndeleteAll
in class IndexReader
public TermEnum terms()
IndexReader
TermEnum.next()
must be called
on the resulting enumeration before calling other methods such as
TermEnum.term()
.terms
in class IndexReader
public TermEnum terms(Term t) throws IOException
IndexReader
terms
in class IndexReader
IOException
- if there is a low-level IO errorpublic FieldInfos getFieldInfos()
IndexReader
FieldInfos
describing all fields in
this reader. NOTE: do not make any changes to the
returned FieldInfos!getFieldInfos
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 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 TermDocs rawTermDocs(Term term) throws IOException
term
, including deleted documents (which
are normally filtered out).IOException
public 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 TermPositions termPositions() throws IOException
IndexReader
TermPositions
enumerator.termPositions
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 int numDocs()
IndexReader
numDocs
in class IndexReader
public int maxDoc()
IndexReader
maxDoc
in class IndexReader
public boolean hasNorms(String field)
IndexReader
hasNorms
in class IndexReader
public byte[] norms(String field) throws IOException
IndexReader
norms
in class IndexReader
IOException
AbstractField.setBoost(float)
@Deprecated protected void doSetNorm(int doc, String field, byte value) throws IOException
doSetNorm
in class IndexReader
IOException
public void norms(String field, byte[] bytes, int offset) throws IOException
norms
in class IndexReader
IOException
AbstractField.setBoost(float)
public TermFreqVector getTermFreqVector(int docNumber, String field) throws IOException
getTermFreqVector
in class IndexReader
docNumber
- document for which the term frequency vector is returnedfield
- field for which the term frequency vector is returned.IOException
Field.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.public TermFreqVector[] getTermFreqVectors(int docNumber) throws IOException
getTermFreqVectors
in class IndexReader
docNumber
- document for which term frequency vectors are returnedIOException
Field.TermVector
public String toString()
toString
in class IndexReader
public String getSegmentName()
public Directory directory()
directory
in class IndexReader
public final Object getCoreCacheKey()
IndexReader
getCoreCacheKey
in class IndexReader
public Object getDeletesCacheKey()
IndexReader
getDeletesCacheKey
in class IndexReader
public long getUniqueTermCount()
IndexReader
getUniqueTermCount
in class IndexReader
public int getTermInfosIndexDivisor()
IndexReader
getTermInfosIndexDivisor
in class IndexReader
public void addCoreClosedListener(SegmentReader.CoreClosedListener listener)
public void removeCoreClosedListener(SegmentReader.CoreClosedListener listener)