AbstractResponse (pipeline-javadocs 5.7 API)

java.lang.Object
- com.lucidworks.apollo.solr.response.AbstractResponse

All Implemented Interfaces:

WriteableResponse

Direct Known Subclasses:

QueryableResponse, RawResponse
```
public abstract class AbstractResponse
extends Object
implements WriteableResponse
```

Field Summary

Fields
Modifier and Type Field and Description

static String FUSION_NODE
- Fields inherited from interface com.lucidworks.apollo.solr.response.WriteableResponse
  DEFAULT_CHARSET

Fields
Modifier and Type	Field and Description
`static String`	`FUSION_NODE`

Constructor Summary

Constructors
Constructor and Description

AbstractResponse()

Constructors
Constructor and Description
`AbstractResponse()`

Method Summary

All Methods Instance Methods Abstract Methods Concrete Methods Deprecated Methods
Modifier and Type	Method and Description
`abstract void`	`appendMultiMap(String name, MultivaluedMap<String,String> params)`
`abstract void`	`appendString(String name, String value)`
`abstract void`	`appendStringList(String name, List<String> values)`
`abstract Optional<String>`	`getCursorMark()`
`List<String>`	`getDocIds()` Convenience method for returning all doc ids
`abstract List<String>`	`getDocIds(String id)`
`abstract List<Map<String,Object>>`	`getDocumentFieldValuesForCollapseExpandGroupValue(String groupField, String groupValue)` Return documents of a specific group value under both "response/doc" and "expanded" sections in response Makes defensive copies, detached from underlying response object.
`abstract List<Map<String,Object>>`	`getDocumentFieldValuesForGroupValue(String groupField, String groupValue)`
`List<ResponseDocument>`	`getDocuments()` Returns documents.
`List<ResponseDocument>`	`getDocumentsForGroupValue(String groupValue)` Deprecated. use `getDocumentsForGroupValue(String, String)`
`List<ResponseDocument>`	`getDocumentsForGroupValue(String groupField, String groupValue)` Returns documents (corresponding to groupValue) Makes defensive copies, detached from underlying response object.
`abstract Map<String,Map<String,Object>>`	`getExpandedResults()` Returns all collapse expanded results as a map of collapse field name to grouping data that includes list of docs
`abstract Map<String,Map<String,Object>>`	`getFacets()` Return facet info as nested objects: {facet type -> field name -> facet count entries} NOTE: The actual Java type of facet count entries may differ between implementations.
`abstract Map<String,Map<String,Object>>`	`getGroupedResults()` Returns all grouped results as a map of string grouped expression (a field name or a query) to grouping data that includes list of groups For comparison getGroups(String groupField) returns a list of groups for a particular grouping expresion
`abstract List<Map<String,Object>>`	`getGroups(String groupField)` Return groups in the response with all accompanying document data Each list entry contains information about the groupValue and the Solr doclist (which includes the docs as well as numFound and rows info).
`abstract List<String>`	`getGroupValues()` Deprecated. use `getGroupValues(String)`
`abstract List<String>`	`getGroupValues(String groupField)` If group=true, return an ordered list of group values
`abstract Map<String,Map<String,Object>>`	`getHighlighting()` Return highlighting info as nested objects: {Doc ID -> Field name -> Snippets} Makes defensive copies, detached from underlying response object.
`abstract Map<String,Object>`	`getJsonFacets()`
`abstract Optional<Double>`	`getMaxScore()` Return Solr maxScore
`abstract Optional<Long>`	`getNumFound()` Return Solr numFound
`abstract Optional<Long>`	`getQTime()` Return Solr QTime
`abstract Map<String,Object>`	`getResponseHeaderParams()` Get params in responseHeader Makes defensive copies, detached from underlying response object.
`abstract Map<String,Object>`	`getSpellcheck()` Returns response of Solr spellcheck handler
`abstract Optional<Long>`	`getStart()`
`abstract Optional<Long>`	`getTotalTime()` Return Fusion Query Pipeline time
`abstract Object`	`getUnderlyingObject()`
`abstract boolean`	`isGrouped()` Checks to see if response is grouped (group=true Solr parameter) See https://lucene.apache.org/solr/guide/7_4/result-grouping.html
`abstract void`	`reorderGroupValues(String groupField, List<String> groupValues)` Reorder group values in the response.
`abstract void`	`setNumFound(Long numFound)`
`abstract void`	`setStart(Long start)`
`abstract boolean`	`setTotalTime(Long time)` Set Fusion Query Pipeline time if and only if the responseHeader object already exists.
`byte[]`	`toByteArray()`
`String`	`toString()`
`abstract void`	`updateDocumentFieldValuesForCollapseExpandGroupValue(String groupField, String groupValue, List<Map<String,Object>> updatedDocuments)` Update documents (corresponding to groupValue) in underlying response object The list of updatedDocuments should include all documents under the groupValue as this method updates both "response/doc" and "expanded" sections in response The list of updatedDocuments cannot be empty
`abstract void`	`updateDocumentFieldValuesForGroupValue(String groupField, String groupValue, List<Map<String,Object>> updatedDocuments)`
`void`	`updateDocuments(List<ResponseDocument> updatedDocuments)` Update documents in underlying response object Use this method to commit changes (like reordering, redactions, rewritings) made to document objects returned from `getDocuments()`
`void`	`updateDocumentsForGroupValue(String groupValue, List<ResponseDocument> updatedDocuments)` Deprecated. use `updateDocumentsForGroupValue(String, String, List)`
`void`	`updateDocumentsForGroupValue(String groupField, String groupValue, List<ResponseDocument> updatedDocuments)` Update documents (corresponding to groupValue) in underlying response object
`abstract void`	`updateFacets(Map<String,Map<String,Object>> facets)` Update facets in underlying response object
`abstract void`	`updateHighlighting(Map<String,Map<String,Object>> highlighting)` Update highlighting in underlying response object
`abstract boolean`	`updateResponseHeaderParams(Map<String,Object> responseHeaderParams)` Update responseHeader params if and only if responseHeader already exists.

Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface com.lucidworks.apollo.solr.response.WriteableResponse
getContentCharset, getContentType, getMediaType, write

- Field Detail
  - FUSION_NODE
```
public static final String FUSION_NODE
```
    See Also:
    
    Constant Field Values
- Constructor Detail
  - AbstractResponse
```
public AbstractResponse()
```
- Method Detail
  - appendString
```
public abstract void appendString(String name,
                                  String value)
```
  - appendStringList
```
public abstract void appendStringList(String name,
                                      List<String> values)
```
  - appendMultiMap
```
public abstract void appendMultiMap(String name,
                                    MultivaluedMap<String,String> params)
```
  - getUnderlyingObject
```
public abstract Object getUnderlyingObject()
```
  - getQTime
```
public abstract Optional<Long> getQTime()
```
    Return Solr QTime
    
    Returns:
  - getTotalTime
```
public abstract Optional<Long> getTotalTime()
```
    Return Fusion Query Pipeline time
    
    Returns:
  - setTotalTime
```
public abstract boolean setTotalTime(Long time)
```
    Set Fusion Query Pipeline time if and only if the responseHeader object already exists.
    
    Returns:
    
    true if update was successful
  - getNumFound
```
public abstract Optional<Long> getNumFound()
```
    Return Solr numFound
    
    Returns:
  - getMaxScore
```
public abstract Optional<Double> getMaxScore()
```
    Return Solr maxScore
    
    Returns:
  - setNumFound
```
public abstract void setNumFound(Long numFound)
```
  - getStart
```
public abstract Optional<Long> getStart()
```
  - getCursorMark
```
public abstract Optional<String> getCursorMark()
```
  - setStart
```
public abstract void setStart(Long start)
```
  - getResponseHeaderParams
```
public abstract Map<String,Object> getResponseHeaderParams()
```
    Get params in responseHeader Makes defensive copies, detached from underlying response object. Call updateResponseHeaderParams(Map) ()} to commit the changes to the actual underlying response object.
    
    Returns:
    
    responseHeader params
  - updateResponseHeaderParams
```
public abstract boolean updateResponseHeaderParams(Map<String,Object> responseHeaderParams)
```
    Update responseHeader params if and only if responseHeader already exists.
    
    Returns:
    
    true if update was successful
  - getDocuments
```
public List<ResponseDocument> getDocuments()
```
    Returns documents. Makes defensive copies, detached from underlying response object. Call updateDocuments(List) to commit the changes to the actual underlying response object.
    
    Returns:
    
    documents in Solr response
  - updateDocuments
```
public void updateDocuments(List<ResponseDocument> updatedDocuments)
```
    Update documents in underlying response object Use this method to commit changes (like reordering, redactions, rewritings) made to document objects returned from getDocuments()
    
    Parameters:
    
    updatedDocuments -
  - isGrouped
```
public abstract boolean isGrouped()
```
    Checks to see if response is grouped (group=true Solr parameter) See https://lucene.apache.org/solr/guide/7_4/result-grouping.html
    
    Returns:
  - getGroupValues
```
@Deprecated
public abstract List<String> getGroupValues()
```
    Deprecated. use getGroupValues(String)
    
    If group=true, return an ordered list of group values
    
    Returns:
  - getGroupValues
```
public abstract List<String> getGroupValues(String groupField)
```
    If group=true, return an ordered list of group values
    
    Parameters:
    
    groupField -
    
    Returns:
  - getDocumentsForGroupValue
```
@Deprecated
public List<ResponseDocument> getDocumentsForGroupValue(String groupValue)
```
    Deprecated. use getDocumentsForGroupValue(String, String)
    
    Returns documents (corresponding to groupValue) Makes defensive copies, detached from underlying response object. Call updateDocumentsForGroupValue(String, List) to commit the changes to the actual underlying response object.
    
    Parameters:
    
    groupValue -
    
    Returns:
  - getDocumentsForGroupValue
```
public List<ResponseDocument> getDocumentsForGroupValue(String groupField,
                                                        String groupValue)
```
    Returns documents (corresponding to groupValue) Makes defensive copies, detached from underlying response object. Call updateDocumentsForGroupValue(String, String, List) to commit the changes to the actual underlying response object.
    
    Parameters:
    
    groupField -
    
    groupValue -
    
    Returns:
  - getDocumentFieldValuesForGroupValue
```
public abstract List<Map<String,Object>> getDocumentFieldValuesForGroupValue(String groupField,
                                                                             String groupValue)
```
  - getDocumentFieldValuesForCollapseExpandGroupValue
```
public abstract List<Map<String,Object>> getDocumentFieldValuesForCollapseExpandGroupValue(String groupField,
                                                                                           String groupValue)
```
    Return documents of a specific group value under both "response/doc" and "expanded" sections in response Makes defensive copies, detached from underlying response object. Call updateDocumentFieldValuesForCollapseExpandGroupValue(String, String, List) to persist the changes to the actual underlying response object.
    
    Parameters:
    
    groupField -
    
    groupValue -
    
    Returns:
  - updateDocumentsForGroupValue
```
@Deprecated
public void updateDocumentsForGroupValue(String groupValue,
                                                     List<ResponseDocument> updatedDocuments)
```
    Deprecated. use updateDocumentsForGroupValue(String, String, List)
    
    Update documents (corresponding to groupValue) in underlying response object
    
    Parameters:
    
    groupValue -
    
    updatedDocuments -
  - updateDocumentsForGroupValue
```
public void updateDocumentsForGroupValue(String groupField,
                                         String groupValue,
                                         List<ResponseDocument> updatedDocuments)
```
    Update documents (corresponding to groupValue) in underlying response object
    
    Parameters:
    
    groupField -
    
    groupValue -
    
    updatedDocuments -
  - updateDocumentFieldValuesForCollapseExpandGroupValue
```
public abstract void updateDocumentFieldValuesForCollapseExpandGroupValue(String groupField,
                                                                          String groupValue,
                                                                          List<Map<String,Object>> updatedDocuments)
```
    Update documents (corresponding to groupValue) in underlying response object The list of updatedDocuments should include all documents under the groupValue as this method updates both "response/doc" and "expanded" sections in response The list of updatedDocuments cannot be empty
    
    Parameters:
    
    groupField -
    
    groupValue -
    
    updatedDocuments -
  - updateDocumentFieldValuesForGroupValue
```
public abstract void updateDocumentFieldValuesForGroupValue(String groupField,
                                                            String groupValue,
                                                            List<Map<String,Object>> updatedDocuments)
```
  - getGroupedResults
```
public abstract Map<String,Map<String,Object>> getGroupedResults()
```
    Returns all grouped results as a map of string grouped expression (a field name or a query) to grouping data that includes list of groups For comparison getGroups(String groupField) returns a list of groups for a particular grouping expresion
  - getExpandedResults
```
public abstract Map<String,Map<String,Object>> getExpandedResults()
```
    Returns all collapse expanded results as a map of collapse field name to grouping data that includes list of docs
  - getGroups
```
public abstract List<Map<String,Object>> getGroups(String groupField)
```
    Return groups in the response with all accompanying document data Each list entry contains information about the groupValue and the Solr doclist (which includes the docs as well as numFound and rows info).
  - reorderGroupValues
```
public abstract void reorderGroupValues(String groupField,
                                        List<String> groupValues)
```
    Reorder group values in the response.
    
    Parameters:
    
    groupField - group field
    
    groupValues - a list of all group values in the desired order
  - getHighlighting
```
public abstract Map<String,Map<String,Object>> getHighlighting()
```
    Return highlighting info as nested objects: {Doc ID -> Field name -> Snippets} Makes defensive copies, detached from underlying response object. Call updateHighlighting(Map) to commit the changes to the actual underlying response object.
    
    Returns:
  - updateHighlighting
```
public abstract void updateHighlighting(Map<String,Map<String,Object>> highlighting)
```
    Update highlighting in underlying response object
    
    Parameters:
    
    highlighting -
  - getFacets
```
public abstract Map<String,Map<String,Object>> getFacets()
```
    Return facet info as nested objects: {facet type -> field name -> facet count entries} NOTE: The actual Java type of facet count entries may differ between implementations. This is not ideal, but it would take a lot of work to support all the different variations of Solr responses that exist. At the time of this writing: - XMLResponse returns a LinkedHashMap - JSONResponse will return a List. The Java type of the list's contents will depend on what json.nl parameter was used in the Solr request. See https://lucene.apache.org/solr/guide/7_4/response-writers.html for complete list. We use Jackson to translate JSON -> Java types. Makes defensive copies, detached from underlying response object. Call updateFacets(Map) to commit the changes to the actual underlying response object.
    
    Returns:
  - getJsonFacets
```
public abstract Map<String,Object> getJsonFacets()
```
  - updateFacets
```
public abstract void updateFacets(Map<String,Map<String,Object>> facets)
```
    Update facets in underlying response object
    
    Parameters:
    
    facets -
  - getSpellcheck
```
public abstract Map<String,Object> getSpellcheck()
```
    Returns response of Solr spellcheck handler
    
    Returns:
    
    spellcheck results or empty map
  - getDocIds
```
public List<String> getDocIds()
```
    Convenience method for returning all doc ids
    
    Returns:
  - getDocIds
```
public abstract List<String> getDocIds(String id)
```
  - toByteArray
```
public byte[] toByteArray()
                   throws IOException
```
    Throws:
    
    IOException
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Object

Class AbstractResponse

Field Summary

Fields inherited from interface com.lucidworks.apollo.solr.response.WriteableResponse

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Methods inherited from interface com.lucidworks.apollo.solr.response.WriteableResponse

Field Detail

FUSION_NODE

Constructor Detail

AbstractResponse

Method Detail

appendString

appendStringList

appendMultiMap

getUnderlyingObject

getQTime

getTotalTime

setTotalTime

getNumFound

getMaxScore

setNumFound

getStart

getCursorMark

setStart

getResponseHeaderParams

updateResponseHeaderParams

getDocuments

updateDocuments

isGrouped

getGroupValues

getGroupValues

getDocumentsForGroupValue

getDocumentsForGroupValue

getDocumentFieldValuesForGroupValue

getDocumentFieldValuesForCollapseExpandGroupValue

updateDocumentsForGroupValue

updateDocumentsForGroupValue

updateDocumentFieldValuesForCollapseExpandGroupValue

updateDocumentFieldValuesForGroupValue

getGroupedResults

getExpandedResults

getGroups

reorderGroupValues

getHighlighting

updateHighlighting

getFacets

getJsonFacets

updateFacets

getSpellcheck

getDocIds

getDocIds

toByteArray

toString