## Uses of Class
org.apache.solr.handler.component.ResponseBuilder

- Packages that use ResponseBuilder
  Package | Description
  --- | ---
  org.apache.solr.handler.component | `SearchComponent` implementations for use in `SearchHandler`
  org.apache.solr.request | APIs and classes for dealing with Solr requests
  org.apache.solr.response | API and implementations of `QueryResponseWriter` for formatting Solr request responses
  org.apache.solr.search | APIs and classes for parsing and processing search requests
  org.apache.solr.search.facet | APIs and classes for the JSON Facet API.
  org.apache.solr.search.grouping.distributed | Internal classes used to implement distributed result grouping
  org.apache.solr.search.grouping.distributed.requestfactory | Internal classes used to implement distributed result grouping
  org.apache.solr.search.grouping.distributed.responseprocessor | Internal classes used to implement distributed result grouping
  org.apache.solr.search.grouping.distributed.shardresultserializer | Internal classes used to implement distributed result grouping
  org.apache.solr.search.grouping.endresulttransformer | APIs and classes for transforming result grouping results into the appropriate response format
  org.apache.solr.search.join | Classes related to joins.
  org.apache.solr.search.stats | APIs and Classes implementing the Stats component used for document frequency calculations.
  org.apache.solr.spelling | APIs and classes used by the `SpellCheckComponent`
  org.apache.solr.util | Common utility classes used throughout Solr

- - ### Uses of ResponseBuilder in org.apache.solr.handler.component

    Methods in org.apache.solr.handler.component with parameters of type ResponseBuilder
    Modifier and Type | Method and Description
    --- | ---
    `protected void` | SpellCheckComponent.`addCollationsToResponse(SolrParams params, SpellingResult spellingResult, ResponseBuilder rb, String q, NamedList response, boolean suggestionsMayOverlap)`
    `void` | PivotFacetField.`contributeFromShard(int shardNumber, ResponseBuilder rb, List<NamedList<Object>> response)` Recursively merges the contributions from the specified shard for each `PivotFacetValue` represended in the `response`.
    `protected void` | QueryComponent.`createDistributedStats(ResponseBuilder rb)`
    `static PivotFacetField` | PivotFacetField.`createFromListOfNamedLists(int shardNumber, ResponseBuilder rb, PivotFacetValue owner, List<NamedList<Object>> pivotValues)` A recursive method to construct a new `PivotFacetField` object from the contents of the `NamedList`s provided by the specified shard, relative to a parent value (if this is not the top field in the pivot hierarchy) The associated child `PivotFacetValue`s will be recursively built as well.
    `static PivotFacetValue` | PivotFacetValue.`createFromNamedList(int shardNumber, ResponseBuilder rb, PivotFacetField parentField, NamedList<Object> pivotData)` A recursive method to construct a new `PivotFacetValue` object from the contents of the `NamedList` provided by the specified shard, relative to the specified field.
    `protected void` | QueryComponent.`createMainQuery(ResponseBuilder rb)`
    `protected void` | QueryComponent.`createRetrieveDocs(ResponseBuilder rb)`
    `int` | RealTimeGetComponent.`createSubRequests(ResponseBuilder rb)`
    `static NamedList` | SpatialHeatmapFacets.`distribFinish(LinkedHashMap<String,SpatialHeatmapFacets.HeatmapFacet> heatmapInfos, ResponseBuilder rb)` Called by FacetComponent's impl of `SearchComponent.finishStage(ResponseBuilder)`.
    `static LinkedHashMap<String,SpatialHeatmapFacets.HeatmapFacet>` | SpatialHeatmapFacets.`distribParse(SolrParams params, ResponseBuilder rb)` Parses request to "HeatmapFacet" instances.
    `int` | ExpandComponent.`distributedProcess(ResponseBuilder rb)`
    `int` | TermsComponent.`distributedProcess(ResponseBuilder rb)`
    `int` | QueryComponent.`distributedProcess(ResponseBuilder rb)`
    `int` | FacetComponent.`distributedProcess(ResponseBuilder rb)`
    `int` | RealTimeGetComponent.`distributedProcess(ResponseBuilder rb)`
    `int` | SuggestComponent.`distributedProcess(ResponseBuilder rb)` Dispatch shard request in `STAGE_EXECUTE_QUERY` stage
    `int` | StatsComponent.`distributedProcess(ResponseBuilder rb)`
    `int` | SearchComponent.`distributedProcess(ResponseBuilder rb)` Process for a distributed search.
    `protected void` | QueryComponent.`doFieldSortValues(ResponseBuilder rb, SolrIndexSearcher searcher)`
    `protected void` | QueryComponent.`doPrefetch(ResponseBuilder rb)`
    `protected void` | FacetComponent.FieldFacet.`fillParams(ResponseBuilder rb, SolrParams params, String field)`
    `protected void` | FacetComponent.DistribFieldFacet.`fillParams(ResponseBuilder rb, SolrParams params, String field)`
    `void` | ExpandComponent.`finishStage(ResponseBuilder rb)`
    `void` | TermsComponent.`finishStage(ResponseBuilder rb)`
    `void` | DebugComponent.`finishStage(ResponseBuilder rb)`
    `void` | QueryComponent.`finishStage(ResponseBuilder rb)`
    `void` | SpellCheckComponent.`finishStage(ResponseBuilder rb)`
    `void` | FacetComponent.`finishStage(ResponseBuilder rb)`
    `void` | RealTimeGetComponent.`finishStage(ResponseBuilder rb)` private void handleRegularResponses(ResponseBuilder rb, ShardRequest sreq) { }
    `void` | SuggestComponent.`finishStage(ResponseBuilder rb)` Used in Distributed Search, merges the suggestion results from every shard
    `void` | MoreLikeThisComponent.`finishStage(ResponseBuilder rb)`
    `void` | StatsComponent.`finishStage(ResponseBuilder rb)`
    `void` | TermVectorComponent.`finishStage(ResponseBuilder rb)`
    `void` | HighlightComponent.`finishStage(ResponseBuilder rb)`
    `void` | SearchComponent.`finishStage(ResponseBuilder rb)` Called after all responses have been received for this stage.
    `static NamedList<Object>` | SpatialHeatmapFacets.`getHeatmapForField(String fieldKey, String fieldName, ResponseBuilder rb, SolrParams params, DocSet docSet)` Called by `SimpleFacets` to compute heatmap facets.
    `protected int` | QueryComponent.`groupedDistributedProcess(ResponseBuilder rb)`
    `protected void` | QueryComponent.`groupedFinishStage(ResponseBuilder rb)`
    `protected void` | QueryComponent.`handleGroupedResponses(ResponseBuilder rb, ShardRequest sreq)`
    `void` | MergeStrategy.`handleMergeFields(ResponseBuilder rb, SolrIndexSearcher searcher)` Implement handleMergeFields(ResponseBuilder rb, SolrIndexSearch searcher) if your merge strategy needs more complex data then the sort fields provide.
    `void` | IterativeMergeStrategy.`handleMergeFields(ResponseBuilder rb, SolrIndexSearcher searcher)`
    `protected void` | QueryComponent.`handleRegularResponses(ResponseBuilder rb, ShardRequest sreq)`
    `void` | ExpandComponent.`handleResponses(ResponseBuilder rb, ShardRequest sreq)`
    `void` | TermsComponent.`handleResponses(ResponseBuilder rb, ShardRequest sreq)`
    `void` | DebugComponent.`handleResponses(ResponseBuilder rb, ShardRequest sreq)`
    `void` | QueryComponent.`handleResponses(ResponseBuilder rb, ShardRequest sreq)`
    `void` | FacetComponent.`handleResponses(ResponseBuilder rb, ShardRequest sreq)`
    `void` | MoreLikeThisComponent.`handleResponses(ResponseBuilder rb, ShardRequest sreq)`
    `void` | StatsComponent.`handleResponses(ResponseBuilder rb, ShardRequest sreq)`
    `void` | HighlightComponent.`handleResponses(ResponseBuilder rb, ShardRequest sreq)`
    `void` | SearchComponent.`handleResponses(ResponseBuilder rb, ShardRequest sreq)` Called after all responses for a single request were received
    `static void` | FacetComponent.FacetContext.`initContext(ResponseBuilder rb)` Initializes FacetContext using request parameters and saves it in the request context which can be retrieved via `FacetComponent.FacetContext.getFacetContext(SolrQueryRequest)`
    `void` | MergeStrategy.`merge(ResponseBuilder rb, ShardRequest sreq)` merge defines the merging behaving of results that are collected from the shards during a distributed search.
    `void` | IterativeMergeStrategy.`merge(ResponseBuilder rb, ShardRequest sreq)`
    `void` | PivotFacetValue.`mergeContributionFromShard(int shardNumber, ResponseBuilder rb, NamedList<Object> value)` Merges in the count contributions from the specified shard for each.
    `protected void` | QueryComponent.`mergeIds(ResponseBuilder rb, ShardRequest sreq)`
    `void` | PivotFacet.`mergeResponseFromShard(int shardNumber, ResponseBuilder rb, List<NamedList<Object>> response)` Recursively merges the response from the specified shard, tracking the known shards.
    `void` | ExpandComponent.`modifyRequest(ResponseBuilder rb, SearchComponent who, ShardRequest sreq)`
    `void` | DebugComponent.`modifyRequest(ResponseBuilder rb, SearchComponent who, ShardRequest sreq)`
    `void` | SpellCheckComponent.`modifyRequest(ResponseBuilder rb, SearchComponent who, ShardRequest sreq)`
    `void` | FacetComponent.`modifyRequest(ResponseBuilder rb, SearchComponent who, ShardRequest sreq)`
    `void` | StatsComponent.`modifyRequest(ResponseBuilder rb, SearchComponent who, ShardRequest sreq)`
    `void` | HighlightComponent.`modifyRequest(ResponseBuilder rb, SearchComponent who, ShardRequest sreq)`
    `void` | SearchComponent.`modifyRequest(ResponseBuilder rb, SearchComponent who, ShardRequest sreq)` Called after another component adds a request
    `protected void` | QueryComponent.`populateNextCursorMarkFromMergedShards(ResponseBuilder rb)` Inspects the state of the `ResponseBuilder` and populates the next `setNextCursorMark(org.apache.solr.search.CursorMark)` as appropriate based on the merged sort values from individual shards
    `void` | ExpandComponent.`prepare(ResponseBuilder rb)`
    `void` | TermsComponent.`prepare(ResponseBuilder rb)`
    `void` | ResponseLogComponent.`prepare(ResponseBuilder rb)`
    `void` | DebugComponent.`prepare(ResponseBuilder rb)`
    `void` | QueryComponent.`prepare(ResponseBuilder rb)`
    `void` | SpellCheckComponent.`prepare(ResponseBuilder rb)`
    `void` | FacetComponent.`prepare(ResponseBuilder rb)`
    `void` | QueryElevationComponent.`prepare(ResponseBuilder rb)`
    `void` | RealTimeGetComponent.`prepare(ResponseBuilder rb)`
    `void` | SuggestComponent.`prepare(ResponseBuilder rb)` Responsible for issuing build and rebuild command to the specified `SolrSuggester`
    `void` | MoreLikeThisComponent.`prepare(ResponseBuilder rb)`
    `void` | StatsComponent.`prepare(ResponseBuilder rb)`
    `void` | TermVectorComponent.`prepare(ResponseBuilder rb)`
    `void` | HighlightComponent.`prepare(ResponseBuilder rb)`
    `abstract void` | SearchComponent.`prepare(ResponseBuilder rb)` Prepare the response.
    `protected void` | QueryComponent.`prepareGrouping(ResponseBuilder rb)`
    `void` | HttpShardHandler.`prepDistributed(ResponseBuilder rb)`
    `abstract void` | ShardHandler.`prepDistributed(ResponseBuilder rb)`
    `void` | ExpandComponent.`process(ResponseBuilder rb)`
    `void` | TermsComponent.`process(ResponseBuilder rb)`
    `void` | ResponseLogComponent.`process(ResponseBuilder rb)`
    `void` | DebugComponent.`process(ResponseBuilder rb)`
    `void` | QueryComponent.`process(ResponseBuilder rb)` Actually run the query
    `void` | SpellCheckComponent.`process(ResponseBuilder rb)`
    `void` | FacetComponent.`process(ResponseBuilder rb)` Actually run the query
    `void` | QueryElevationComponent.`process(ResponseBuilder rb)`
    `void` | RealTimeGetComponent.`process(ResponseBuilder rb)`
    `void` | SuggestComponent.`process(ResponseBuilder rb)` Responsible for using the specified suggester to get the suggestions for the query and write the results
    `void` | MoreLikeThisComponent.`process(ResponseBuilder rb)`
    `void` | StatsComponent.`process(ResponseBuilder rb)`
    `void` | TermVectorComponent.`process(ResponseBuilder rb)`
    `void` | HighlightComponent.`process(ResponseBuilder rb)`
    `abstract void` | SearchComponent.`process(ResponseBuilder rb)` Process the request for this component
    `protected abstract void` | IterativeMergeStrategy.`process(ResponseBuilder rb, ShardRequest sreq)`
    `void` | RealTimeGetComponent.`processGetFingeprint(ResponseBuilder rb)`
    `void` | RealTimeGetComponent.`processGetUpdates(ResponseBuilder rb)`
    `void` | RealTimeGetComponent.`processGetVersions(ResponseBuilder rb)`
    `protected void` | ResponseLogComponent.`processIds(ResponseBuilder rb, DocList dl, IndexSchema schema, SolrIndexSearcher searcher)`
    `protected void` | ResponseLogComponent.`processScores(ResponseBuilder rb, DocList dl, IndexSchema schema, SolrIndexSearcher searcher)`
    `void` | RealTimeGetComponent.`processSync(ResponseBuilder rb, int nVersions, String sync)`
    `protected int` | QueryComponent.`regularDistributedProcess(ResponseBuilder rb)`
    `protected void` | QueryComponent.`regularFinishStage(ResponseBuilder rb)`
    `protected void` | QueryComponent.`returnFields(ResponseBuilder rb, ShardRequest sreq)`
    `protected void` | QueryComponent.`updateStats(ResponseBuilder rb, ShardRequest sreq)`

    Constructors in org.apache.solr.handler.component with parameters of type ResponseBuilder
    Constructor and Description
    `FacetBase(ResponseBuilder rb, String facetType, String facetStr)`
    `FieldFacet(ResponseBuilder rb, String facetStr)`
    `HeatmapFacet(ResponseBuilder rb, String facetStr)`
    `PivotFacet(ResponseBuilder rb, String facetStr)`
    `PivotFacetProcessor(SolrQueryRequest req, DocSet docs, SolrParams params, ResponseBuilder rb)`
    `QueryFacet(ResponseBuilder rb, String facetStr)`
    `RangeFacetProcessor(SolrQueryRequest req, DocSet docs, SolrParams params, ResponseBuilder rb)`
    `RangeFacetRequest(ResponseBuilder rb, String f)`
    `StatsField(ResponseBuilder rb, String statsParam)`

  - ### Uses of ResponseBuilder in org.apache.solr.request

    Fields in org.apache.solr.request declared as ResponseBuilder
    Modifier and Type | Field and Description
    --- | ---
    `protected ResponseBuilder` | SolrRequestInfo.`rb`
    `protected ResponseBuilder` | SimpleFacets.`rb`

    Methods in org.apache.solr.request that return ResponseBuilder
    Modifier and Type | Method and Description
    --- | ---
    `ResponseBuilder` | SolrRequestInfo.`getResponseBuilder()` May return null if the request handler is not based on SearchHandler
    `ResponseBuilder` | SimpleFacets.`getResponseBuilder()`

    Methods in org.apache.solr.request with parameters of type ResponseBuilder
    Modifier and Type | Method and Description
    --- | ---
    `void` | SolrRequestInfo.`setResponseBuilder(ResponseBuilder rb)`

    Constructors in org.apache.solr.request with parameters of type ResponseBuilder
    Constructor and Description
    `SimpleFacets(SolrQueryRequest req, DocSet docs, SolrParams params, ResponseBuilder rb)`

  - ### Uses of ResponseBuilder in org.apache.solr.response

    Constructors in org.apache.solr.response with parameters of type ResponseBuilder
    Constructor and Description
    `BasicResultContext(ResponseBuilder rb)`
    `BasicResultContext(ResponseBuilder rb, DocList docList)`

  - ### Uses of ResponseBuilder in org.apache.solr.search

    Methods in org.apache.solr.search with parameters of type ResponseBuilder
    Modifier and Type | Method and Description
    --- | ---
    `abstract DelegatingCollector` | AnalyticsQuery.`getAnalyticsCollector(ResponseBuilder rb, IndexSearcher searcher)`

  - ### Uses of ResponseBuilder in org.apache.solr.search.facet

    Methods in org.apache.solr.search.facet with parameters of type ResponseBuilder
    Modifier and Type | Method and Description
    --- | ---
    `int` | FacetModule.`distributedProcess(ResponseBuilder rb)`
    `void` | FacetModule.`finishStage(ResponseBuilder rb)`
    `org.apache.solr.search.facet.FacetComponentState` | FacetModule.`getFacetComponentState(ResponseBuilder rb)`
    `void` | FacetModule.`handleResponses(ResponseBuilder rb, ShardRequest sreq)`
    `void` | FacetModule.`modifyRequest(ResponseBuilder rb, SearchComponent who, ShardRequest sreq)`
    `void` | FacetModule.`prepare(ResponseBuilder rb)`
    `void` | FacetModule.`process(ResponseBuilder rb)`

  - ### Uses of ResponseBuilder in org.apache.solr.search.grouping.distributed

    Methods in org.apache.solr.search.grouping.distributed with parameters of type ResponseBuilder
    Modifier and Type | Method and Description
    --- | ---
    `ShardRequest[]` | ShardRequestFactory.`constructRequest(ResponseBuilder rb)` Returns `ShardRequest` instances.
    `void` | ShardResponseProcessor.`process(ResponseBuilder rb, ShardRequest shardRequest)` Processes the responses from the specified shardRequest.

  - ### Uses of ResponseBuilder in org.apache.solr.search.grouping.distributed.requestfactory

    Methods in org.apache.solr.search.grouping.distributed.requestfactory with parameters of type ResponseBuilder
    Modifier and Type | Method and Description
    --- | ---
    `ShardRequest[]` | SearchGroupsRequestFactory.`constructRequest(ResponseBuilder rb)` Returns `ShardRequest` instances.
    `ShardRequest[]` | TopGroupsShardRequestFactory.`constructRequest(ResponseBuilder rb)` Returns `ShardRequest` instances.
    `ShardRequest[]` | StoredFieldsShardRequestFactory.`constructRequest(ResponseBuilder rb)`

  - ### Uses of ResponseBuilder in org.apache.solr.search.grouping.distributed.responseprocessor

    Methods in org.apache.solr.search.grouping.distributed.responseprocessor with parameters of type ResponseBuilder
    Modifier and Type | Method and Description
    --- | ---
    `void` | SearchGroupShardResponseProcessor.`process(ResponseBuilder rb, ShardRequest shardRequest)` Processes the responses from the specified shardRequest.
    `void` | StoredFieldsShardResponseProcessor.`process(ResponseBuilder rb, ShardRequest shardRequest)` Processes the responses from the specified shardRequest.
    `void` | TopGroupsShardResponseProcessor.`process(ResponseBuilder rb, ShardRequest shardRequest)` Processes the responses from the specified shardRequest.

  - ### Uses of ResponseBuilder in org.apache.solr.search.grouping.distributed.shardresultserializer

    Constructors in org.apache.solr.search.grouping.distributed.shardresultserializer with parameters of type ResponseBuilder
    Constructor and Description
    `TopGroupsResultTransformer(ResponseBuilder rb)`

  - ### Uses of ResponseBuilder in org.apache.solr.search.grouping.endresulttransformer

    Methods in org.apache.solr.search.grouping.endresulttransformer with parameters of type ResponseBuilder
    Modifier and Type | Method and Description
    --- | ---
    `void` | EndResultTransformer.`transform(Map<String,?> result, ResponseBuilder rb, EndResultTransformer.SolrDocumentSource solrDocumentSource)` Transforms the specified result into its final form and puts it into the specified response.
    `void` | GroupedEndResultTransformer.`transform(Map<String,?> result, ResponseBuilder rb, EndResultTransformer.SolrDocumentSource solrDocumentSource)` Transforms the specified result into its final form and puts it into the specified response.
    `void` | SimpleEndResultTransformer.`transform(Map<String,?> result, ResponseBuilder rb, EndResultTransformer.SolrDocumentSource solrDocumentSource)` Transforms the specified result into its final form and puts it into the specified response.
    `void` | MainEndResultTransformer.`transform(Map<String,?> result, ResponseBuilder rb, EndResultTransformer.SolrDocumentSource solrDocumentSource)` Transforms the specified result into its final form and puts it into the specified response.

  - ### Uses of ResponseBuilder in org.apache.solr.search.join

    Methods in org.apache.solr.search.join with parameters of type ResponseBuilder
    Modifier and Type | Method and Description
    --- | ---
    `void` | BlockJoinDocSetFacetComponent.`prepare(ResponseBuilder rb)`
    `void` | BlockJoinDocSetFacetComponent.`process(ResponseBuilder rb)`

  - ### Uses of ResponseBuilder in org.apache.solr.search.stats

    Methods in org.apache.solr.search.stats with parameters of type ResponseBuilder
    Modifier and Type | Method and Description
    --- | ---
    `protected Map<String,CollectionStats>` | ExactSharedStatsCache.`getPerShardColStats(ResponseBuilder rb, String shard)`
    `protected Map<String,CollectionStats>` | LRUStatsCache.`getPerShardColStats(ResponseBuilder rb, String shard)`
    `protected Map<String,CollectionStats>` | ExactStatsCache.`getPerShardColStats(ResponseBuilder rb, String shard)`
    `abstract ShardRequest` | StatsCache.`retrieveStatsRequest(ResponseBuilder rb)` Creates a `ShardRequest` to retrieve per-shard stats related to the current query and the current state of the requester's `StatsCache`.
    `ShardRequest` | LocalStatsCache.`retrieveStatsRequest(ResponseBuilder rb)`
    `ShardRequest` | ExactStatsCache.`retrieveStatsRequest(ResponseBuilder rb)`
    `abstract void` | StatsCache.`returnLocalStats(ResponseBuilder rb, SolrIndexSearcher searcher)` Prepare a local (from the local shard) response to a "retrieve stats" shard request.
    `void` | LocalStatsCache.`returnLocalStats(ResponseBuilder rb, SolrIndexSearcher searcher)`
    `void` | ExactStatsCache.`returnLocalStats(ResponseBuilder rb, SolrIndexSearcher searcher)`
    `abstract void` | StatsCache.`sendGlobalStats(ResponseBuilder rb, ShardRequest outgoing)` Prepare global stats data to be sent out to shards in this request.
    `void` | LocalStatsCache.`sendGlobalStats(ResponseBuilder rb, ShardRequest outgoing)`
    `void` | ExactStatsCache.`sendGlobalStats(ResponseBuilder rb, ShardRequest outgoing)`

  - ### Uses of ResponseBuilder in org.apache.solr.spelling

    Methods in org.apache.solr.spelling with parameters of type ResponseBuilder
    Modifier and Type | Method and Description
    --- | ---
    `List<SpellCheckCollation>` | SpellCheckCollator.`collate(SpellingResult result, String originalQuery, ResponseBuilder ultimateResponse)`

  - ### Uses of ResponseBuilder in org.apache.solr.util

    Methods in org.apache.solr.util with parameters of type ResponseBuilder
    Modifier and Type | Method and Description
    --- | ---
    `static Set<String>` | SolrPluginUtils.`getDebugInterests(String[] params, ResponseBuilder rb)`
    `static void` | SolrPluginUtils.`optimizePreFetchDocs(ResponseBuilder rb, DocList docs, Query query, SolrQueryRequest req, SolrQueryResponse res)` Pre-fetch documents into the index searcher's document cache.

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