|
||||||||||
| 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.FilterIndexReader
org.apache.lucene.index.PruningReader
public class PruningReader
This class produces a subset of the input index, by removing some postings
data according to rules implemented in a TermPruningPolicy, and
optionally it can also remove stored fields of documents according to rules
implemented in a StorePruningPolicy.
| Nested Class Summary |
|---|
| Nested classes/interfaces inherited from class org.apache.lucene.index.FilterIndexReader |
|---|
FilterIndexReader.FilterTermDocs, FilterIndexReader.FilterTermEnum, FilterIndexReader.FilterTermPositions |
| Nested classes/interfaces inherited from class org.apache.lucene.index.IndexReader |
|---|
IndexReader.ReaderClosedListener |
| Field Summary | |
|---|---|
protected int |
delTermCount
|
protected int |
delVecCount
|
protected int |
docCount
|
protected int |
prunedVecCount
|
protected StorePruningPolicy |
storePolicy
|
protected int |
termCount
|
protected TermPruningPolicy |
termPolicy
|
protected int |
vecCount
|
| Fields inherited from class org.apache.lucene.index.FilterIndexReader |
|---|
in |
| Fields inherited from class org.apache.lucene.index.IndexReader |
|---|
hasChanges |
| Constructor Summary | |
|---|---|
PruningReader(IndexReader in,
StorePruningPolicy storePolicy,
TermPruningPolicy termPolicy)
Constructor. |
|
| Method Summary | |
|---|---|
Document |
document(int n,
FieldSelector fieldSelector)
Applies a StorePruningPolicy to stored fields of a document. |
FieldInfos |
getFieldInfos()
Applies a StorePruningPolicy to the list of available field infos. |
IndexReader[] |
getSequentialSubReaders()
Expert: returns the sequential sub readers that this reader is logically composed of. |
TermFreqVector[] |
getTermFreqVectors(int docNumber)
Applies TermPruningPolicy to terms inside term vectors. |
TermPositions |
termPositions()
Applies TermPruningPolicy to term positions. |
TermEnum |
terms()
Applies TermPruningPolicy to term enum. |
| Methods inherited from class org.apache.lucene.index.FilterIndexReader |
|---|
directory, docFreq, doClose, doCommit, doDelete, doSetNorm, doUndeleteAll, getCommitUserData, getCoreCacheKey, getDeletesCacheKey, getIndexCommit, getTermFreqVector, getTermFreqVector, getTermFreqVector, getTermInfosIndexDivisor, getUniqueTermCount, getVersion, hasDeletions, hasNorms, isCurrent, isDeleted, isOptimized, maxDoc, norms, norms, numDocs, termDocs, termDocs, terms, toString |
| Methods inherited from class org.apache.lucene.index.IndexReader |
|---|
acquireWriteLock, addReaderClosedListener, clone, clone, close, commit, commit, decRef, deleteDocument, deleteDocuments, document, doOpenIfChanged, doOpenIfChanged, doOpenIfChanged, doOpenIfChanged, ensureOpen, flush, flush, getCommitUserData, getCurrentVersion, getRefCount, 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, undeleteAll |
| Methods inherited from class java.lang.Object |
|---|
equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait |
| Field Detail |
|---|
protected int docCount
protected int vecCount
protected int termCount
protected int delTermCount
protected int prunedVecCount
protected int delVecCount
protected TermPruningPolicy termPolicy
protected StorePruningPolicy storePolicy
| Constructor Detail |
|---|
public PruningReader(IndexReader in,
StorePruningPolicy storePolicy,
TermPruningPolicy termPolicy)
in - input readerstorePolicy - implementation of StorePruningPolicy - if null
then stored values will be retained as is.termPolicy - implementation of TermPruningPolicy, must not
be null.| Method Detail |
|---|
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 FilterIndexReader
public Document document(int n,
FieldSelector fieldSelector)
throws CorruptIndexException,
IOException
StorePruningPolicy to stored fields of a document.
document in class FilterIndexReadern - 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 position
CorruptIndexException - if the index is corrupt
IOException - if there is a low-level IO errorFieldable,
FieldSelector,
SetBasedFieldSelector,
LoadFirstFieldSelectorpublic FieldInfos getFieldInfos()
StorePruningPolicy to the list of available field infos.
getFieldInfos in class FilterIndexReader
public TermFreqVector[] getTermFreqVectors(int docNumber)
throws IOException
TermPruningPolicy to terms inside term vectors.
getTermFreqVectors in class FilterIndexReaderdocNumber - document for which term frequency vectors are returned
IOException - if index cannot be accessedField.TermVector
public TermPositions termPositions()
throws IOException
TermPruningPolicy to term positions.
termPositions in class FilterIndexReaderIOException - if there is a low-level IO error
public TermEnum terms()
throws IOException
TermPruningPolicy to term enum.
terms in class FilterIndexReaderIOException - if there is a low-level IO error
|
||||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||