org.apache.lucene.index

Class SortingLeafReader

java.lang.Object

org.apache.lucene.index.IndexReader

org.apache.lucene.index.LeafReader

org.apache.lucene.index.FilterLeafReader

org.apache.lucene.index.SortingLeafReader

All Implemented Interfaces:

java.io.Closeable, java.lang.AutoCloseable

public class SortingLeafReader
extends FilterLeafReader

An LeafReader which supports sorting documents by a given Sort. 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
 Sort sort; // determines how the documents are sorted
 LeafReader sortingReader = SortingLeafReader.wrap(SlowCompositeReaderWrapper.wrap(reader), sort);
 writer.addIndexes(reader);
 writer.close();
 reader.close();
 

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
private static class	SortingLeafReader.SortingBinaryDocValues
private static class	SortingLeafReader.SortingBits
(package private) static class	SortingLeafReader.SortingDocsEnum
private static class	SortingLeafReader.SortingFields
private static class	SortingLeafReader.SortingNumericDocValues
private static class	SortingLeafReader.SortingPointValues
(package private) static class	SortingLeafReader.SortingPostingsEnum
private static class	SortingLeafReader.SortingSortedDocValues
private static class	SortingLeafReader.SortingSortedNumericDocValues
private static class	SortingLeafReader.SortingSortedSetDocValues
private static class	SortingLeafReader.SortingTerms
private static class	SortingLeafReader.SortingTermsEnum

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

FilterLeafReader.FilterFields, FilterLeafReader.FilterPostingsEnum, FilterLeafReader.FilterTerms, FilterLeafReader.FilterTermsEnum

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

LeafReader.CoreClosedListener

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

IndexReader.ReaderClosedListener

Field Summary

Fields

Modifier and Type	Field and Description
(package private) Sorter.DocMap	docMap

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

in

Constructor Summary

Constructors

Modifier	Constructor and Description
private	SortingLeafReader(LeafReader in, Sorter.DocMap docMap)

Method Summary

Modifier and Type	Method and 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(java.lang.String field) Returns BinaryDocValues for this field, or null if no BinaryDocValues were indexed for this field.
Bits	getDocsWithField(java.lang.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(java.lang.String field) Returns NumericDocValues representing norms for this field, or null if no NumericDocValues were indexed.
NumericDocValues	getNumericDocValues(java.lang.String field) Returns NumericDocValues for this field, or null if no NumericDocValues were indexed for this field.
PointValues	getPointValues() Returns the PointValues used for numeric or spatial searches, or null if there are no point fields.
SortedDocValues	getSortedDocValues(java.lang.String field) Returns SortedDocValues for this field, or null if no SortedDocValues were indexed for this field.
SortedNumericDocValues	getSortedNumericDocValues(java.lang.String field) Returns SortedNumericDocValues for this field, or null if no SortedNumericDocValues were indexed for this field.
SortedSetDocValues	getSortedSetDocValues(java.lang.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.
java.lang.String	toString()
static LeafReader	wrap(LeafReader reader, Sort sort) Return a sorted view of reader according to the order defined by sort.
(package private) static LeafReader	wrap(LeafReader reader, Sorter.DocMap docMap) Expert: same as wrap(org.apache.lucene.index.LeafReader, Sort) but operates directly on a Sorter.DocMap.

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

addCoreClosedListener, checkIntegrity, doClose, getDelegate, getFieldInfos, maxDoc, numDocs, removeCoreClosedListener, unwrap

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

addCoreClosedListenerAsReaderClosedListener, docFreq, getContext, getDocCount, getSumDocFreq, getSumTotalTermFreq, postings, postings, removeCoreClosedListenerAsReaderClosedListener, terms, totalTermFreq

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

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

Methods inherited from class java.lang.Object

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

Field Detail

docMap

final Sorter.DocMap docMap

Constructor Detail

SortingLeafReader

private SortingLeafReader(LeafReader in,
                          Sorter.DocMap docMap)

Method Detail

wrap

public static LeafReader wrap(LeafReader reader,
                              Sort sort)
                       throws java.io.IOException

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

Throws:

java.io.IOException

wrap

static LeafReader wrap(LeafReader reader,
                       Sorter.DocMap docMap)

Expert: same as wrap(org.apache.lucene.index.LeafReader, Sort) but operates directly on a Sorter.DocMap.

document

public void document(int docID,
                     StoredFieldVisitor visitor)
              throws java.io.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 FilterLeafReader

Throws:

java.io.IOException

fields

public Fields fields()
              throws java.io.IOException

Description copied from class: LeafReader

Returns Fields for this reader. This method will not return null.

Overrides:

fields in class FilterLeafReader

Throws:

java.io.IOException

getBinaryDocValues

public BinaryDocValues getBinaryDocValues(java.lang.String field)
                                   throws java.io.IOException

Description copied from class: LeafReader

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 FilterLeafReader

Throws:

java.io.IOException

getLiveDocs

public Bits getLiveDocs()

Description copied from class: LeafReader

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 FilterLeafReader

getPointValues

public PointValues getPointValues()

Description copied from class: LeafReader

Returns the PointValues used for numeric or spatial searches, or null if there are no point fields.

Overrides:

getPointValues in class FilterLeafReader

getNormValues

public NumericDocValues getNormValues(java.lang.String field)
                               throws java.io.IOException

Description copied from class: LeafReader

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 FilterLeafReader

Throws:

java.io.IOException

getNumericDocValues

public NumericDocValues getNumericDocValues(java.lang.String field)
                                     throws java.io.IOException

Description copied from class: LeafReader

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 FilterLeafReader

Throws:

java.io.IOException

getSortedNumericDocValues

public SortedNumericDocValues getSortedNumericDocValues(java.lang.String field)
                                                 throws java.io.IOException

Description copied from class: LeafReader

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

Overrides:

getSortedNumericDocValues in class FilterLeafReader

Throws:

java.io.IOException

getSortedDocValues

public SortedDocValues getSortedDocValues(java.lang.String field)
                                   throws java.io.IOException

Description copied from class: LeafReader

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 FilterLeafReader

Throws:

java.io.IOException

getSortedSetDocValues

public SortedSetDocValues getSortedSetDocValues(java.lang.String field)
                                         throws java.io.IOException

Description copied from class: LeafReader

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 FilterLeafReader

Throws:

java.io.IOException

getDocsWithField

public Bits getDocsWithField(java.lang.String field)
                      throws java.io.IOException

Description copied from class: LeafReader

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 FilterLeafReader

Throws:

java.io.IOException

getTermVectors

public Fields getTermVectors(int docID)
                      throws java.io.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 FilterLeafReader

Throws:

java.io.IOException

toString

public java.lang.String toString()

Overrides:

toString in class FilterLeafReader