Class SortingAtomicReader

An Lucene.Net.Index.AtomicReader which supports sorting documents by a given Lucene.Net.Search.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
AtomicReader sortingReader = SortingAtomicReader.Wrap(SlowCompositeReaderWrapper.Wrap(reader), sort);
writer.AddIndexes(reader);
reader.Dispose(); // alternatively, you can use a using block
writer.Dispose(); // alternatively, you can use a using block
Note

This API is experimental and might change in incompatible ways in the next release.

Inheritance
System.Object
Lucene.Net.Index.IndexReader
Lucene.Net.Index.AtomicReader
Lucene.Net.Index.FilterAtomicReader
SortingAtomicReader
Implements
System.IDisposable
Inherited Members
Lucene.Net.Index.FilterAtomicReader.Unwrap(Lucene.Net.Index.AtomicReader)
Lucene.Net.Index.FilterAtomicReader.m_input
Lucene.Net.Index.FilterAtomicReader.FieldInfos
Lucene.Net.Index.FilterAtomicReader.NumDocs
Lucene.Net.Index.FilterAtomicReader.MaxDoc
Lucene.Net.Index.FilterAtomicReader.DoClose()
Lucene.Net.Index.FilterAtomicReader.ToString()
Lucene.Net.Index.FilterAtomicReader.CheckIntegrity()
Lucene.Net.Index.AtomicReader.Context
Lucene.Net.Index.AtomicReader.AtomicContext
Lucene.Net.Index.AtomicReader.DocFreq(Lucene.Net.Index.Term)
Lucene.Net.Index.AtomicReader.TotalTermFreq(Lucene.Net.Index.Term)
Lucene.Net.Index.AtomicReader.GetTermDocsEnum(Lucene.Net.Index.Term)
Lucene.Net.Index.AtomicReader.GetTermPositionsEnum(Lucene.Net.Index.Term)
Lucene.Net.Index.IndexReader.AddReaderClosedListener(Lucene.Net.Index.IndexReader.IReaderClosedListener)
Lucene.Net.Index.IndexReader.RemoveReaderClosedListener(Lucene.Net.Index.IndexReader.IReaderClosedListener)
Lucene.Net.Index.IndexReader.RegisterParentReader(Lucene.Net.Index.IndexReader)
Lucene.Net.Index.IndexReader.RefCount
Lucene.Net.Index.IndexReader.IncRef()
Lucene.Net.Index.IndexReader.TryIncRef()
Lucene.Net.Index.IndexReader.DecRef()
Lucene.Net.Index.IndexReader.EnsureOpen()
Lucene.Net.Index.IndexReader.GetHashCode()
Lucene.Net.Index.IndexReader.Open(Lucene.Net.Store.Directory)
Lucene.Net.Index.IndexReader.Open(Lucene.Net.Index.IndexCommit)
Lucene.Net.Index.IndexReader.NumDeletedDocs
Lucene.Net.Index.IndexReader.HasDeletions
Lucene.Net.Index.IndexReader.Dispose()
Lucene.Net.Index.IndexReader.Leaves
Lucene.Net.Index.IndexReader.CoreCacheKey
Lucene.Net.Index.IndexReader.CombinedCoreAndDeletesKey
System.Object.Equals(System.Object, System.Object)
System.Object.GetType()
System.Object.MemberwiseClone()
System.Object.ReferenceEquals(System.Object, System.Object)
Namespace: Lucene.Net.Index.Sorter
Assembly: Lucene.Net.Misc.dll
Syntax
public class SortingAtomicReader : FilterAtomicReader, IDisposable

Properties

| Improve this Doc View Source

Fields

Declaration
public override Fields Fields { get; }
Property Value
Type Description
Lucene.Net.Index.Fields
Overrides
Lucene.Net.Index.FilterAtomicReader.Fields
| Improve this Doc View Source

LiveDocs

Declaration
public override IBits LiveDocs { get; }
Property Value
Type Description
Lucene.Net.Util.IBits
Overrides
Lucene.Net.Index.FilterAtomicReader.LiveDocs

Methods

| Improve this Doc View Source

Document(Int32, StoredFieldVisitor)

Declaration
public override void Document(int docID, StoredFieldVisitor visitor)
Parameters
Type Name Description
System.Int32 docID
Lucene.Net.Index.StoredFieldVisitor visitor
Overrides
| Improve this Doc View Source

GetBinaryDocValues(String)

Declaration
public override BinaryDocValues GetBinaryDocValues(string field)
Parameters
Type Name Description
System.String field
Returns
Type Description
Lucene.Net.Index.BinaryDocValues
Overrides
| Improve this Doc View Source

GetDocsWithField(String)

Declaration
public override IBits GetDocsWithField(string field)
Parameters
Type Name Description
System.String field
Returns
Type Description
Lucene.Net.Util.IBits
Overrides
| Improve this Doc View Source

GetNormValues(String)

Declaration
public override NumericDocValues GetNormValues(string field)
Parameters
Type Name Description
System.String field
Returns
Type Description
Lucene.Net.Index.NumericDocValues
Overrides
| Improve this Doc View Source

GetNumericDocValues(String)

Declaration
public override NumericDocValues GetNumericDocValues(string field)
Parameters
Type Name Description
System.String field
Returns
Type Description
Lucene.Net.Index.NumericDocValues
Overrides
| Improve this Doc View Source

GetSortedDocValues(String)

Declaration
public override SortedDocValues GetSortedDocValues(string field)
Parameters
Type Name Description
System.String field
Returns
Type Description
Lucene.Net.Index.SortedDocValues
Overrides
| Improve this Doc View Source

GetSortedSetDocValues(String)

Declaration
public override SortedSetDocValues GetSortedSetDocValues(string field)
Parameters
Type Name Description
System.String field
Returns
Type Description
Lucene.Net.Index.SortedSetDocValues
Overrides
| Improve this Doc View Source

GetTermVectors(Int32)

Declaration
public override Fields GetTermVectors(int docID)
Parameters
Type Name Description
System.Int32 docID
Returns
Type Description
Lucene.Net.Index.Fields
Overrides
| Improve this Doc View Source

Wrap(AtomicReader, Sort)

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.

Declaration
public static AtomicReader Wrap(AtomicReader reader, Sort sort)
Parameters
Type Name Description
Lucene.Net.Index.AtomicReader reader
Lucene.Net.Search.Sort sort
Returns
Type Description
Lucene.Net.Index.AtomicReader

Implements

System.IDisposable