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 SearchAfter(ScoreDoc, Query, Filter, Int32, Sort)
• Filling sort field values is not yet supported.

Note

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

Inheritance

System.Object

Lucene.Net.Search.FieldComparerSource

BlockJoinComparerSource

Inherited Members

System.Object.Equals(System.Object)

System.Object.Equals(System.Object, System.Object)

System.Object.GetHashCode()

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 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
Lucene.Net.Search.Filter	parentsFilter	Filter identifying parent documents
Lucene.Net.Search.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
Lucene.Net.Search.Filter	parentsFilter	Filter identifying parent documents
Lucene.Net.Search.Sort	parentSort	Sort for parent documents
Lucene.Net.Search.Sort	childSort	Sort for child documents in the same block

Methods

NewComparer(String, Int32, Int32, Boolean)

Declaration

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

Parameters

Type	Name	Description
System.String	fieldname
System.Int32	numHits
System.Int32	sortPos
System.Boolean	reversed

Returns

Type	Description
Lucene.Net.Search.FieldComparer

Overrides

FieldComparerSource.NewComparer(String, Int32, Int32, Boolean)

ToString()

Declaration

public override string ToString()

Returns

Type	Description
System.String

Overrides

System.Object.ToString()