Class BlockJoinComparerSource

Helper class to sort readers that contain blocks of documents.

Note that this class is intended to used with SortingMergePolicy, and for other purposes has some limitations:

• Cannot yet be used with IndexSearcher.SearchAfter
• Filling sort field values is not yet supported.

Note

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

Inheritance

object

FieldComparerSource

BlockJoinComparerSource

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

Namespace: Lucene.Net.Index.Sorter

Assembly: Lucene.Net.Misc.dll

Syntax

public class BlockJoinComparerSource : FieldComparerSource

Constructors

BlockJoinComparerSource(Filter, Sort)

Create a new BlockJoinComparerSource, sorting only blocks of documents with parentSort and not reordering children with a block.

Declaration

public BlockJoinComparerSource(Filter parentsFilter, Sort parentSort)

Parameters

Type	Name	Description
Filter	parentsFilter	Filter identifying parent documents
Sort	parentSort	Sort for parent documents

BlockJoinComparerSource(Filter, Sort, Sort)

Create a new BlockJoinComparerSource, specifying the sort order for both blocks of documents and children within a block.

Declaration

public BlockJoinComparerSource(Filter parentsFilter, Sort parentSort, Sort childSort)

Parameters

Type	Name	Description
Filter	parentsFilter	Filter identifying parent documents
Sort	parentSort	Sort for parent documents
Sort	childSort	Sort for child documents in the same block

Methods

NewComparer(string, int, int, bool)

Creates a comparer for the field in the given index.

Declaration

public override FieldComparer NewComparer(string fieldname, int numHits, int sortPos, bool reversed)

Parameters

Type	Name	Description
string	fieldname	Name of the field to create comparer for.
int	numHits
int	sortPos
bool	reversed

Returns

Type	Description
FieldComparer	Lucene.Net.Search.FieldComparer.

Overrides

FieldComparerSource.NewComparer(string, int, int, bool)

Exceptions

Type	Condition
IOException	If an error occurs reading the index.

ToString()

Returns a string that represents the current object.

Declaration

public override string ToString()

Returns

Type	Description
string	A string that represents the current object.

Overrides

object.ToString()