org.apache.solr.search

Class SolrIndexReader

java.lang.Object

org.apache.lucene.index.IndexReader

org.apache.lucene.index.FilterIndexReader

org.apache.solr.search.SolrIndexReader

All Implemented Interfaces:

java.io.Closeable, java.lang.AutoCloseable, java.lang.Cloneable

public class SolrIndexReader
extends org.apache.lucene.index.FilterIndexReader

Solr wrapper for IndexReader that contains extra context. This is currently experimental, for internal use only, and subject to change.

Nested Class Summary

Nested classes/interfaces inherited from class org.apache.lucene.index.FilterIndexReader

org.apache.lucene.index.FilterIndexReader.FilterTermDocs, org.apache.lucene.index.FilterIndexReader.FilterTermEnum, org.apache.lucene.index.FilterIndexReader.FilterTermPositions

Nested classes/interfaces inherited from class org.apache.lucene.index.IndexReader

org.apache.lucene.index.IndexReader.ReaderClosedListener

Field Summary

Fields

Modifier and Type	Field and Description
private int	base
private SolrReaderInfo	info
private int[]	leafOffsets
private SolrIndexReader[]	leafReaders
private SolrIndexReader	parent
(package private) SolrIndexSearcher	searcher
private SolrIndexReader[]	subReaders
private static int[]	zeroIntArray

Fields inherited from class org.apache.lucene.index.FilterIndexReader

in

Fields inherited from class org.apache.lucene.index.IndexReader

hasChanges

Constructor Summary

Constructors

Constructor and Description
SolrIndexReader(org.apache.lucene.index.IndexReader in, SolrIndexReader parent, int base) Recursively wrap an IndexReader in SolrIndexReader instances.

Method Summary

Modifier and Type	Method and Description
void	associateInfo(SolrIndexReader source) Copies SolrReaderInfo instances from the source to this SolrIndexReader
private static void	buildInfoMap(SolrIndexReader other, java.util.HashMap<org.apache.lucene.index.IndexReader,SolrReaderInfo> map)
java.lang.Object	clone()
org.apache.lucene.index.IndexReader	clone(boolean openReadOnly)
org.apache.lucene.store.Directory	directory()
int	docFreq(org.apache.lucene.index.Term t)
protected void	doClose()
org.apache.lucene.document.Document	document(int n, org.apache.lucene.document.FieldSelector fieldSelector)
protected void	doDelete(int n)
protected void	doSetNorm(int d, java.lang.String f, byte b)
protected void	doUndeleteAll()
boolean	equals(java.lang.Object o)
int	getBase() returns the docid offset within the parent reader
java.util.Map	getCommitUserData()
java.lang.Object	getCoreCacheKey()
org.apache.lucene.index.FieldInfos	getFieldInfos()
org.apache.lucene.index.IndexCommit	getIndexCommit()
int[]	getLeafOffsets() Return the doc id offsets for each leaf reader.
SolrIndexReader[]	getLeafReaders() return the leaf readers in this reader tree, or an array of size 1 containing "this" if "this" is a leaf
private SolrIndexReader[]	getLeaves(int numLeaves)
SolrIndexReader	getParent() returns the parent reader, or null of none
SolrIndexReader[]	getSequentialSubReaders()
org.apache.lucene.index.TermFreqVector	getTermFreqVector(int docNumber, java.lang.String field)
void	getTermFreqVector(int docNumber, java.lang.String field, org.apache.lucene.index.TermVectorMapper mapper)
void	getTermFreqVector(int docNumber, org.apache.lucene.index.TermVectorMapper mapper)
org.apache.lucene.index.TermFreqVector[]	getTermFreqVectors(int docNumber)
int	getTermInfosIndexDivisor()
long	getUniqueTermCount()
long	getVersion()
org.apache.lucene.index.IndexReader	getWrappedReader()
boolean	hasDeletions()
int	hashCode()
boolean	hasNorms(java.lang.String field)
boolean	isCurrent()
boolean	isDeleted(int n)
boolean	isOptimized()
int	maxDoc()
byte[]	norms(java.lang.String f)
void	norms(java.lang.String f, byte[] bytes, int offset)
int	numDocs()
static int	readerIndex(int doc, int[] offsets) Given an array of IndexReader offsets, find which contains the given doc
SolrIndexReader	reopen()
SolrIndexReader	reopen(boolean openReadOnly)
org.apache.lucene.index.IndexReader	reopen(org.apache.lucene.index.IndexCommit commit)
private static void	setInfo(SolrIndexReader target, java.util.HashMap<org.apache.lucene.index.IndexReader,SolrReaderInfo> map)
(package private) static void	setSearcher(SolrIndexReader sr, SolrIndexSearcher searcher)
(package private) static java.lang.String	shortName(java.lang.Object o)
org.apache.lucene.index.TermDocs	termDocs()
org.apache.lucene.index.TermDocs	termDocs(org.apache.lucene.index.Term term)
org.apache.lucene.index.TermPositions	termPositions()
org.apache.lucene.index.TermEnum	terms()
org.apache.lucene.index.TermEnum	terms(org.apache.lucene.index.Term t)
java.lang.String	toString()

Methods inherited from class org.apache.lucene.index.FilterIndexReader

doCommit, getDeletesCacheKey

Methods inherited from class org.apache.lucene.index.IndexReader

acquireWriteLock, addReaderClosedListener, 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, setNorm, setNorm, termPositions, tryIncRef, undeleteAll

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, wait, wait, wait

Field Detail

subReaders

private final SolrIndexReader[] subReaders

leafReaders

private final SolrIndexReader[] leafReaders

leafOffsets

private int[] leafOffsets

parent

private final SolrIndexReader parent

base

private final int base

zeroIntArray

private static int[] zeroIntArray

searcher

SolrIndexSearcher searcher

info

private SolrReaderInfo info

Constructor Detail

SolrIndexReader

public SolrIndexReader(org.apache.lucene.index.IndexReader in,
                       SolrIndexReader parent,
                       int base)

Recursively wrap an IndexReader in SolrIndexReader instances.

Parameters:

in - the reader to wrap

parent - the parent, if any (null if none)

base - the docid offset in the parent (0 if top level)

Method Detail

getLeaves

private SolrIndexReader[] getLeaves(int numLeaves)

getLeafReaders

public SolrIndexReader[] getLeafReaders()

return the leaf readers in this reader tree, or an array of size 1 containing "this" if "this" is a leaf

getLeafOffsets

public int[] getLeafOffsets()

Return the doc id offsets for each leaf reader. This will be different than getBase() for any leaf reader who is not a direct descendant of "this".

readerIndex

public static int readerIndex(int doc,
                              int[] offsets)

Given an array of IndexReader offsets, find which contains the given doc

shortName

static java.lang.String shortName(java.lang.Object o)

toString

public java.lang.String toString()

Overrides:

toString in class org.apache.lucene.index.FilterIndexReader

setSearcher

static void setSearcher(SolrIndexReader sr,
                        SolrIndexSearcher searcher)

buildInfoMap

private static void buildInfoMap(SolrIndexReader other,
                                 java.util.HashMap<org.apache.lucene.index.IndexReader,SolrReaderInfo> map)

setInfo

private static void setInfo(SolrIndexReader target,
                            java.util.HashMap<org.apache.lucene.index.IndexReader,SolrReaderInfo> map)

associateInfo

public void associateInfo(SolrIndexReader source)

Copies SolrReaderInfo instances from the source to this SolrIndexReader

getWrappedReader

public org.apache.lucene.index.IndexReader getWrappedReader()

getParent

public SolrIndexReader getParent()

returns the parent reader, or null of none

getBase

public int getBase()

returns the docid offset within the parent reader

directory

public org.apache.lucene.store.Directory directory()

Overrides:

directory in class org.apache.lucene.index.FilterIndexReader

getTermFreqVectors

public org.apache.lucene.index.TermFreqVector[] getTermFreqVectors(int docNumber)
                                                            throws java.io.IOException

Overrides:

getTermFreqVectors in class org.apache.lucene.index.FilterIndexReader

Throws:

java.io.IOException

getTermFreqVector

public org.apache.lucene.index.TermFreqVector getTermFreqVector(int docNumber,
                                                                java.lang.String field)
                                                         throws java.io.IOException

Overrides:

getTermFreqVector in class org.apache.lucene.index.FilterIndexReader

Throws:

java.io.IOException

getTermFreqVector

public void getTermFreqVector(int docNumber,
                              java.lang.String field,
                              org.apache.lucene.index.TermVectorMapper mapper)
                       throws java.io.IOException

Overrides:

getTermFreqVector in class org.apache.lucene.index.FilterIndexReader

Throws:

java.io.IOException

getTermFreqVector

public void getTermFreqVector(int docNumber,
                              org.apache.lucene.index.TermVectorMapper mapper)
                       throws java.io.IOException

Overrides:

getTermFreqVector in class org.apache.lucene.index.FilterIndexReader

Throws:

java.io.IOException

numDocs

public int numDocs()

Overrides:

numDocs in class org.apache.lucene.index.FilterIndexReader

maxDoc

public int maxDoc()

Overrides:

maxDoc in class org.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,
                                                    java.io.IOException

Overrides:

document in class org.apache.lucene.index.FilterIndexReader

Throws:

org.apache.lucene.index.CorruptIndexException

java.io.IOException

isDeleted

public boolean isDeleted(int n)

Overrides:

isDeleted in class org.apache.lucene.index.FilterIndexReader

hasDeletions

public boolean hasDeletions()

Overrides:

hasDeletions in class org.apache.lucene.index.FilterIndexReader

doUndeleteAll

protected void doUndeleteAll()
                      throws org.apache.lucene.index.CorruptIndexException,
                             java.io.IOException

Overrides:

doUndeleteAll in class org.apache.lucene.index.FilterIndexReader

Throws:

org.apache.lucene.index.CorruptIndexException

java.io.IOException

hasNorms

public boolean hasNorms(java.lang.String field)
                 throws java.io.IOException

Overrides:

hasNorms in class org.apache.lucene.index.FilterIndexReader

Throws:

java.io.IOException

norms

public byte[] norms(java.lang.String f)
             throws java.io.IOException

Overrides:

norms in class org.apache.lucene.index.FilterIndexReader

Throws:

java.io.IOException

norms

public void norms(java.lang.String f,
                  byte[] bytes,
                  int offset)
           throws java.io.IOException

Overrides:

norms in class org.apache.lucene.index.FilterIndexReader

Throws:

java.io.IOException

doSetNorm

protected void doSetNorm(int d,
                         java.lang.String f,
                         byte b)
                  throws org.apache.lucene.index.CorruptIndexException,
                         java.io.IOException

Overrides:

doSetNorm in class org.apache.lucene.index.FilterIndexReader

Throws:

org.apache.lucene.index.CorruptIndexException

java.io.IOException

terms

public org.apache.lucene.index.TermEnum terms()
                                       throws java.io.IOException

Overrides:

terms in class org.apache.lucene.index.FilterIndexReader

Throws:

java.io.IOException

terms

public org.apache.lucene.index.TermEnum terms(org.apache.lucene.index.Term t)
                                       throws java.io.IOException

Overrides:

terms in class org.apache.lucene.index.FilterIndexReader

Throws:

java.io.IOException

docFreq

public int docFreq(org.apache.lucene.index.Term t)
            throws java.io.IOException

Overrides:

docFreq in class org.apache.lucene.index.FilterIndexReader

Throws:

java.io.IOException

termDocs

public org.apache.lucene.index.TermDocs termDocs()
                                          throws java.io.IOException

Overrides:

termDocs in class org.apache.lucene.index.FilterIndexReader

Throws:

java.io.IOException

termDocs

public org.apache.lucene.index.TermDocs termDocs(org.apache.lucene.index.Term term)
                                          throws java.io.IOException

Overrides:

termDocs in class org.apache.lucene.index.FilterIndexReader

Throws:

java.io.IOException

termPositions

public org.apache.lucene.index.TermPositions termPositions()
                                                    throws java.io.IOException

Overrides:

termPositions in class org.apache.lucene.index.FilterIndexReader

Throws:

java.io.IOException

doDelete

protected void doDelete(int n)
                 throws org.apache.lucene.index.CorruptIndexException,
                        java.io.IOException

Overrides:

doDelete in class org.apache.lucene.index.FilterIndexReader

Throws:

org.apache.lucene.index.CorruptIndexException

java.io.IOException

doClose

protected void doClose()
                throws java.io.IOException

Overrides:

doClose in class org.apache.lucene.index.FilterIndexReader

Throws:

java.io.IOException

getFieldInfos

public org.apache.lucene.index.FieldInfos getFieldInfos()

Overrides:

getFieldInfos in class org.apache.lucene.index.FilterIndexReader

getVersion

public long getVersion()

Overrides:

getVersion in class org.apache.lucene.index.FilterIndexReader

isCurrent

public boolean isCurrent()
                  throws org.apache.lucene.index.CorruptIndexException,
                         java.io.IOException

Overrides:

isCurrent in class org.apache.lucene.index.FilterIndexReader

Throws:

org.apache.lucene.index.CorruptIndexException

java.io.IOException

isOptimized

public boolean isOptimized()

Overrides:

isOptimized in class org.apache.lucene.index.FilterIndexReader

getSequentialSubReaders

public SolrIndexReader[] getSequentialSubReaders()

Overrides:

getSequentialSubReaders in class org.apache.lucene.index.FilterIndexReader

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object

equals

public boolean equals(java.lang.Object o)

Overrides:

equals in class java.lang.Object

reopen

public org.apache.lucene.index.IndexReader reopen(org.apache.lucene.index.IndexCommit commit)
                                           throws org.apache.lucene.index.CorruptIndexException,
                                                  java.io.IOException

Overrides:

reopen in class org.apache.lucene.index.IndexReader

Throws:

org.apache.lucene.index.CorruptIndexException

java.io.IOException

clone

public java.lang.Object clone()

Overrides:

clone in class org.apache.lucene.index.IndexReader

clone

public org.apache.lucene.index.IndexReader clone(boolean openReadOnly)
                                          throws org.apache.lucene.index.CorruptIndexException,
                                                 java.io.IOException

Overrides:

clone in class org.apache.lucene.index.IndexReader

Throws:

org.apache.lucene.index.CorruptIndexException

java.io.IOException

getCommitUserData

public java.util.Map getCommitUserData()

Overrides:

getCommitUserData in class org.apache.lucene.index.FilterIndexReader

getUniqueTermCount

public long getUniqueTermCount()
                        throws java.io.IOException

Overrides:

getUniqueTermCount in class org.apache.lucene.index.FilterIndexReader

Throws:

java.io.IOException

reopen

public SolrIndexReader reopen(boolean openReadOnly)
                       throws java.io.IOException

Overrides:

reopen in class org.apache.lucene.index.IndexReader

Throws:

java.io.IOException

reopen

public SolrIndexReader reopen()
                       throws org.apache.lucene.index.CorruptIndexException,
                              java.io.IOException

Overrides:

reopen in class org.apache.lucene.index.IndexReader

Throws:

org.apache.lucene.index.CorruptIndexException

java.io.IOException

getIndexCommit

public org.apache.lucene.index.IndexCommit getIndexCommit()
                                                   throws java.io.IOException

Overrides:

getIndexCommit in class org.apache.lucene.index.FilterIndexReader

Throws:

java.io.IOException

getCoreCacheKey

public java.lang.Object getCoreCacheKey()

Overrides:

getCoreCacheKey in class org.apache.lucene.index.FilterIndexReader

getTermInfosIndexDivisor

public int getTermInfosIndexDivisor()

Overrides:

getTermInfosIndexDivisor in class org.apache.lucene.index.FilterIndexReader