org.apache.solr.search.grouping.distributed.command

## Class SearchGroupsFieldCommand

- java.lang.Object
- - org.apache.solr.search.grouping.distributed.command.SearchGroupsFieldCommand

- All Implemented Interfaces:
    Command<SearchGroupsFieldCommandResult>

      public class SearchGroupsFieldCommand
      extends Object
      implements Command<SearchGroupsFieldCommandResult>

  Creates all the collectors needed for the first phase and how to handle the results.

- - ### Nested Class Summary

    Nested Classes
    Modifier and Type | Class and Description
    --- | ---
    `static class` | `SearchGroupsFieldCommand.Builder`

  - ### Method Summary

    All Methods Instance Methods Concrete 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()`
    `SearchGroupsFieldCommandResult` | `result()` Returns the results that the collectors created by `Command.create()` contain after a search has been executed.

    - ### Methods inherited from class java.lang.Object

      `clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait`

- - ### Method Detail

    - #### create

          public List<Collector> create()
                                 throws IOException

      Description copied from interface: `Command`
      Returns a list of `Collector` instances to be included in the search based on the .
      Specified by:
        `create` in interface `Command<SearchGroupsFieldCommandResult>`
      Returns:
        a list of `Collector` instances
      Throws:
        `IOException` - If I/O related errors occur

    - #### result

          public SearchGroupsFieldCommandResult result()

      Description copied from interface: `Command`
      Returns the results that the collectors created by `Command.create()` contain after a search has been executed.
      Specified by:
        `result` in interface `Command<SearchGroupsFieldCommandResult>`
      Returns:
        The results of the collectors

    - #### getSortWithinGroup

          public Sort getSortWithinGroup()

      Specified by:
        `getSortWithinGroup` in interface `Command<SearchGroupsFieldCommandResult>`
      Returns:
        The sort inside a group

    - #### getGroupSort

          public Sort getGroupSort()

      Specified by:
        `getGroupSort` in interface `Command<SearchGroupsFieldCommandResult>`
      Returns:
        The group sort (overall sort)

    - #### getKey

          public String getKey()

      Specified by:
        `getKey` in interface `Command<SearchGroupsFieldCommandResult>`
      Returns:
        The key of this command to uniquely identify itself

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