Class ToParentBlockJoinSortField

A special sort field that allows sorting parent docs based on nested / child level fields. Based on the sort order it either takes the document with the lowest or highest field value into account.

This is a Lucene.NET EXPERIMENTAL API, use at your own risk

Inheritance

System.Object

ToParentBlockJoinSortField

Namespace: Lucene.Net.Join

Assembly: Lucene.Net.Join.dll

Syntax

public class ToParentBlockJoinSortField : SortField

Constructors

ToParentBlockJoinSortField(String, SortFieldType, Boolean, Filter, Filter)

Create ToParentBlockJoinSortField. The parent document ordering is based on child document ordering (reverse).

Declaration

public ToParentBlockJoinSortField(string field, SortFieldType type, bool reverse, Filter parentFilter, Filter childFilter)

Parameters

Type	Name	Description
System.String	field	The sort field on the nested / child level.
SortFieldType	type	The sort type on the nested / child level.
System.Boolean	reverse	Whether natural order should be reversed on the nested / child level.
Filter	parentFilter	that identifies the parent documents.
Filter	childFilter	that defines which child documents participates in sorting.

ToParentBlockJoinSortField(String, SortFieldType, Boolean, Boolean, Filter, Filter)

Create ToParentBlockJoinSortField.

Declaration

public ToParentBlockJoinSortField(string field, SortFieldType type, bool reverse, bool order, Filter parentFilter, Filter childFilter)

Parameters

Type	Name	Description
System.String	field	The sort field on the nested / child level.
SortFieldType	type	The sort type on the nested / child level.
System.Boolean	reverse	Whether natural order should be reversed on the nested / child document level.
System.Boolean	order	Whether natural order should be reversed on the parent level.
Filter	parentFilter	that identifies the parent documents.
Filter	childFilter	that defines which child documents participates in sorting.

Methods

GetComparer(Int32, Int32)

Declaration

public override FieldComparer GetComparer(int numHits, int sortPos)

Parameters

Type	Name	Description
System.Int32	numHits
System.Int32	sortPos

Returns

Type	Description
FieldComparer