[SOLR-8114] Grouping.java: sort variable names confusion

• Type: Wish
• Status: Closed
• Priority: Minor
• Resolution: Fixed
• Fix Version/s: 5.4, 6.0
• Assignee: Christine Poerschke
• Reporter: Christine Poerschke
• Created: 02/Oct/15 11:16
• Updated: 09/May/16 18:57
• Resolved: 19/Oct/15 13:39

Description

The undistributed case i.e. solr/Grouping.java's variable names confusingly differ from the names used by lucene (and by the distributed case).

Specifically the name groupSort in lucene (and in the distributed case) means between-groups-sort but in the Grouping.java it means within-group-sort.

lucene:

TermFirstPassGroupingCollector(... Sort groupSort ...)
TermSecondPassGroupingCollector(... Sort groupSort, Sort withinGroupSort ...)

solr:

SearchGroupsFieldCommand.java: firstPassGroupingCollector = new TermFirstPassGroupingCollector(field.getName(), groupSort, topNGroups);
TopGroupsFieldCommand.java: secondPassCollector = new TermSecondPassGroupingCollector(... groupSort, sortWithinGroup ...);

Grouping.java:    public Sort groupSort;   // the sort of the documents *within* a single group.
Grouping.java:    public Sort sort;        // the sort between groups
Grouping.java:  firstPass = new TermFirstPassGroupingCollector(groupBy, sort, actualGroupsToFind);
Grouping.java: secondPass = new TermSecondPassGroupingCollector(... sort, groupSort ...);

This JIRA proposes to rename the Grouping.java variables to remove the confusion:

• part 1: in Grouping.java rename groupSort to withinGroupSort
• part 2: in Grouping.java rename sort to groupSort