Method GetTopGroups

GetTopGroups(ToParentBlockJoinQuery, Sort, Int32, Int32, Int32, Boolean)

Returns the ITopGroups<TGroupValue> for the specified BlockJoinQuery. The groupValue of each GroupDocs will be the parent docID for that group. The number of documents within each group is calculated as minimum of maxDocsPerGroup and number of matched child documents for that group. Returns null if no groups matched.

Declaration
public virtual ITopGroups<int> GetTopGroups(ToParentBlockJoinQuery query, Sort withinGroupSort, int offset, int maxDocsPerGroup, int withinGroupOffset, bool fillSortFields)
Parameters
Type Name Description
ToParentBlockJoinQuery query

Search query

Sort withinGroupSort

Sort criteria within groups

System.Int32 offset

Parent docs offset

System.Int32 maxDocsPerGroup

Upper bound of documents per group number

System.Int32 withinGroupOffset

Offset within each group of child docs

System.Boolean fillSortFields

Specifies whether to add sort fields or not

Returns
Type Description
ITopGroups<System.Int32>

ITopGroups<TGroupValue> for specified query