Class GroupedCutOffLimiter

java.lang.Object
de.cxp.ocs.smartsuggest.limiter.GroupedCutOffLimiter
All Implemented Interfaces:
Limiter

public class GroupedCutOffLimiter extends Object implements Limiter

This limiter groups the result by the specified payload entry and limits each group to the specified size. If the final list is longer than the requested limit, the least important group is truncated accordingly.

If the final list is shorter as the requested limit, nothing is done, so it will stay short! Only exception: if there are suggestions from a group that was not configured, they are appended to the final list, but not more than specified by the "defaultLimit".

With the optional given "groupDeduplicationOrder", the suggestions will be deduplicated. The array defines preferred groups. Suggestions of the groups defined first will be preferred over suggestions from other groups.