org.apache.solr.search.grouping

## Interface Command<T>

- All Known Implementing Classes:
    QueryCommand, SearchGroupsFieldCommand, TopGroupsFieldCommand

      public interface Command<T>

  Defines a grouping command. This is an abstraction on how the `Collector` instances are created and how the results are retrieved from the `Collector` instances.
  WARNING: This API is experimental and might change in incompatible ways in the next release.

- - ### Method Summary

    All Methods Instance Methods Abstract Methods
    Modifier and Type | Method and Description
    --- | ---
    `List<Collector>` | `create()` Returns a list of `Collector` instances to be included in the search based on the .
    `Sort` | `getGroupSort()`
    `String` | `getKey()`
    `Sort` | `getSortWithinGroup()`
    `T` | `result()` Returns the results that the collectors created by `create()` contain after a search has been executed.

- - ### Method Detail

    - #### create

          List<Collector> create()
                          throws IOException

      Returns a list of `Collector` instances to be included in the search based on the .
      Returns:
        a list of `Collector` instances
      Throws:
        `IOException` - If I/O related errors occur

    - #### result

          T result()

      Returns the results that the collectors created by `create()` contain after a search has been executed.
      Returns:
        The results of the collectors

    - #### getKey

          String getKey()

      Returns:
        The key of this command to uniquely identify itself

    - #### getGroupSort

          Sort getGroupSort()

      Returns:
        The group sort (overall sort)

    - #### getSortWithinGroup

          Sort getSortWithinGroup()

      Returns:
        The sort inside a group

Copyright © 2000-2016 Apache Software Foundation. All Rights Reserved.