Package org.apache.lucene.index.sorter

Class SortingAtomicReader

java.lang.Object

org.apache.lucene.index.IndexReader

org.apache.lucene.index.AtomicReader

org.apache.lucene.index.FilterAtomicReader

org.apache.lucene.index.sorter.SortingAtomicReader

All Implemented Interfaces:

Closeable, AutoCloseable

public class SortingAtomicReader
extends FilterAtomicReader

An AtomicReader which supports sorting documents by a given Sorter. You can use this class to sort an index as follows:

 IndexWriter writer; // writer to which the sorted index will be added
 DirectoryReader reader; // reader on the input index
 Sorter sorter; // determines how the documents are sorted
 AtomicReader sortingReader = SortingAtomicReader.wrap(SlowCompositeReaderWrapper.wrap(reader), sorter);
 writer.addIndexes(reader);
 writer.close();
 reader.close();
 

Nested Class Summary

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

FilterAtomicReader.FilterDocsAndPositionsEnum, FilterAtomicReader.FilterDocsEnum, FilterAtomicReader.FilterFields, FilterAtomicReader.FilterTerms, FilterAtomicReader.FilterTermsEnum

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

IndexReader.ReaderClosedListener

Method Summary

Modifier and Type	Method	Description
void	document(int docID, StoredFieldVisitor visitor)	Expert: visits the fields of a stored document, for custom processing/loading of each field.
Fields	fields()	Returns Fields for this reader.
BinaryDocValues	getBinaryDocValues(String field)	Returns BinaryDocValues for this field, or null if no BinaryDocValues were indexed for this field.
Bits	getDocsWithField(String field)	Returns a Bits at the size of reader.maxDoc(), with turned on bits for each docid that does have a value for this field, or null if no DocValues were indexed for this field.
Bits	getLiveDocs()	Returns the Bits representing live (not deleted) docs.
NumericDocValues	getNormValues(String field)	Returns NumericDocValues representing norms for this field, or null if no NumericDocValues were indexed.
NumericDocValues	getNumericDocValues(String field)	Returns NumericDocValues for this field, or null if no NumericDocValues were indexed for this field.
SortedDocValues	getSortedDocValues(String field)	Returns SortedDocValues for this field, or null if no SortedDocValues were indexed for this field.
SortedSetDocValues	getSortedSetDocValues(String field)	Returns SortedSetDocValues for this field, or null if no SortedSetDocValues were indexed for this field.
Fields	getTermVectors(int docID)	Retrieve term vectors for this document, or null if term vectors were not indexed.
static AtomicReader	wrap(AtomicReader reader, Sorter sorter)	Return a sorted view of reader according to the order defined by sorter.
static AtomicReader	wrap(AtomicReader reader, Sorter.DocMap docMap)	Expert: same as wrap(AtomicReader, Sorter) but operates directly on a Sorter.DocMap.

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

getFieldInfos, maxDoc, numDocs, toString

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

docFreq, getContext, getDocCount, getSumDocFreq, getSumTotalTermFreq, hasNorms, termDocsEnum, termPositionsEnum, terms, totalTermFreq

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

addReaderClosedListener, close, decRef, document, document, equals, getCombinedCoreAndDeletesKey, getCoreCacheKey, getRefCount, getTermVector, hasDeletions, hashCode, incRef, leaves, numDeletedDocs, open, open, open, open, open, registerParentReader, removeReaderClosedListener, tryIncRef

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Method Details

wrap

public static AtomicReader wrap(AtomicReader reader,
 Sorter sorter)
                         throws IOException

Return a sorted view of reader according to the order defined by sorter. If the reader is already sorted, this method might return the reader as-is.

Throws:

IOException

wrap

public static AtomicReader wrap(AtomicReader reader,
 Sorter.DocMap docMap)

Expert: same as wrap(AtomicReader, Sorter) but operates directly on a Sorter.DocMap.

document

public void document(int docID,
 StoredFieldVisitor visitor)
              throws IOException

Description copied from class: IndexReader

Expert: visits the fields of a stored document, for custom processing/loading of each field. If you simply want to load all fields, use IndexReader.document(int). If you want to load a subset, use DocumentStoredFieldVisitor.

Overrides:

document in class FilterAtomicReader

Throws:

IOException

fields

public Fields fields()
              throws IOException

Description copied from class: AtomicReader

Returns Fields for this reader. This method may return null if the reader has no postings.

Overrides:

fields in class FilterAtomicReader

Throws:

IOException

getBinaryDocValues

public BinaryDocValues getBinaryDocValues(String field)
                                   throws IOException

Description copied from class: AtomicReader

Returns BinaryDocValues for this field, or null if no BinaryDocValues were indexed for this field. The returned instance should only be used by a single thread.

Overrides:

getBinaryDocValues in class FilterAtomicReader

Throws:

IOException

getLiveDocs

public Bits getLiveDocs()

Description copied from class: AtomicReader

Returns the Bits representing live (not deleted) docs. A set bit indicates the doc ID has not been deleted. If this method returns null it means there are no deleted documents (all documents are live). The returned instance has been safely published for use by multiple threads without additional synchronization.

Overrides:

getLiveDocs in class FilterAtomicReader

getNormValues

public NumericDocValues getNormValues(String field)
                               throws IOException

Description copied from class: AtomicReader

Returns NumericDocValues representing norms for this field, or null if no NumericDocValues were indexed. The returned instance should only be used by a single thread.

Overrides:

getNormValues in class FilterAtomicReader

Throws:

IOException

getNumericDocValues

public NumericDocValues getNumericDocValues(String field)
                                     throws IOException

Description copied from class: AtomicReader

Returns NumericDocValues for this field, or null if no NumericDocValues were indexed for this field. The returned instance should only be used by a single thread.

Overrides:

getNumericDocValues in class FilterAtomicReader

Throws:

IOException

getSortedDocValues

public SortedDocValues getSortedDocValues(String field)
                                   throws IOException

Description copied from class: AtomicReader

Returns SortedDocValues for this field, or null if no SortedDocValues were indexed for this field. The returned instance should only be used by a single thread.

Overrides:

getSortedDocValues in class FilterAtomicReader

Throws:

IOException

getSortedSetDocValues

public SortedSetDocValues getSortedSetDocValues(String field)
                                         throws IOException

Description copied from class: AtomicReader

Returns SortedSetDocValues for this field, or null if no SortedSetDocValues were indexed for this field. The returned instance should only be used by a single thread.

Overrides:

getSortedSetDocValues in class FilterAtomicReader

Throws:

IOException

getDocsWithField

public Bits getDocsWithField(String field)
                      throws IOException

Description copied from class: AtomicReader

Returns a Bits at the size of reader.maxDoc(), with turned on bits for each docid that does have a value for this field, or null if no DocValues were indexed for this field. The returned instance should only be used by a single thread

Overrides:

getDocsWithField in class FilterAtomicReader

Throws:

IOException

getTermVectors

public Fields getTermVectors(int docID)
                      throws IOException

Description copied from class: IndexReader

Retrieve term vectors for this document, or null if term vectors were not indexed. The returned Fields instance acts like a single-document inverted index (the docID will be 0).

Overrides:

getTermVectors in class FilterAtomicReader

Throws:

IOException