Package org.apache.lucene.index
Class PruningReader
- java.lang.Object
-
- org.apache.lucene.index.IndexReader
-
- org.apache.lucene.index.FilterIndexReader
-
- org.apache.lucene.index.PruningReader
-
- All Implemented Interfaces:
Closeable
,AutoCloseable
,Cloneable
public class PruningReader extends org.apache.lucene.index.FilterIndexReader
This class produces a subset of the input index, by removing some postings data according to rules implemented in aTermPruningPolicy
, and optionally it can also remove stored fields of documents according to rules implemented in aStorePruningPolicy
.
-
-
Field Summary
Fields Modifier and Type Field Description protected int
delTermCount
protected int
delVecCount
protected int
docCount
protected int
prunedVecCount
protected StorePruningPolicy
storePolicy
protected int
termCount
protected TermPruningPolicy
termPolicy
protected int
vecCount
-
Constructor Summary
Constructors Constructor Description PruningReader(org.apache.lucene.index.IndexReader in, StorePruningPolicy storePolicy, TermPruningPolicy termPolicy)
Constructor.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description org.apache.lucene.document.Document
document(int n, org.apache.lucene.document.FieldSelector fieldSelector)
Applies aStorePruningPolicy
to stored fields of a document.org.apache.lucene.index.FieldInfos
getFieldInfos()
Applies aStorePruningPolicy
to the list of available field infos.org.apache.lucene.index.IndexReader[]
getSequentialSubReaders()
org.apache.lucene.index.TermFreqVector[]
getTermFreqVectors(int docNumber)
AppliesTermPruningPolicy
to terms inside term vectors.org.apache.lucene.index.TermPositions
termPositions()
AppliesTermPruningPolicy
to term positions.org.apache.lucene.index.TermEnum
terms()
AppliesTermPruningPolicy
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
-
-
-
-
Field Detail
-
docCount
protected int docCount
-
vecCount
protected int vecCount
-
termCount
protected int termCount
-
delTermCount
protected int delTermCount
-
prunedVecCount
protected int prunedVecCount
-
delVecCount
protected int delVecCount
-
termPolicy
protected TermPruningPolicy termPolicy
-
storePolicy
protected StorePruningPolicy storePolicy
-
-
Constructor Detail
-
PruningReader
public PruningReader(org.apache.lucene.index.IndexReader in, StorePruningPolicy storePolicy, TermPruningPolicy termPolicy)
Constructor.- Parameters:
in
- input readerstorePolicy
- implementation ofStorePruningPolicy
- if null then stored values will be retained as is.termPolicy
- implementation ofTermPruningPolicy
, must not be null.
-
-
Method Detail
-
getSequentialSubReaders
public org.apache.lucene.index.IndexReader[] getSequentialSubReaders()
- Overrides:
getSequentialSubReaders
in classorg.apache.lucene.index.FilterIndexReader
-
document
public org.apache.lucene.document.Document document(int n, org.apache.lucene.document.FieldSelector fieldSelector) throws org.apache.lucene.index.CorruptIndexException, IOException
Applies aStorePruningPolicy
to stored fields of a document.- Overrides:
document
in classorg.apache.lucene.index.FilterIndexReader
- Throws:
org.apache.lucene.index.CorruptIndexException
IOException
-
getFieldInfos
public org.apache.lucene.index.FieldInfos getFieldInfos()
Applies aStorePruningPolicy
to the list of available field infos.- Overrides:
getFieldInfos
in classorg.apache.lucene.index.FilterIndexReader
-
getTermFreqVectors
public org.apache.lucene.index.TermFreqVector[] getTermFreqVectors(int docNumber) throws IOException
AppliesTermPruningPolicy
to terms inside term vectors.- Overrides:
getTermFreqVectors
in classorg.apache.lucene.index.FilterIndexReader
- Throws:
IOException
-
termPositions
public org.apache.lucene.index.TermPositions termPositions() throws IOException
AppliesTermPruningPolicy
to term positions.- Overrides:
termPositions
in classorg.apache.lucene.index.FilterIndexReader
- Throws:
IOException
-
terms
public org.apache.lucene.index.TermEnum terms() throws IOException
AppliesTermPruningPolicy
to term enum.- Overrides:
terms
in classorg.apache.lucene.index.FilterIndexReader
- Throws:
IOException
-
-