XMLResponse (pipeline-javadocs 5.4 API)

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

All Implemented Interfaces:: WriteableResponse

public class XMLResponse
extends QueryableResponse

Field Summary
- Fields inherited from class com.lucidworks.apollo.solr.response.AbstractResponse
  FUSION_NODE
- Fields inherited from interface com.lucidworks.apollo.solr.response.WriteableResponse
  DEFAULT_CHARSET

Constructor Summary

Constructors
Constructor and Description

XMLResponse()

XMLResponse(Document document)

Constructors
Constructor and Description
`XMLResponse()`
`XMLResponse(Document document)`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`appendMultiMap(String name, MultivaluedMap<String,String> params)`
`void`	`appendString(String name, String value)`
`void`	`appendStringList(String name, List<String> values)`
`static XMLResponse`	`create(InputStream is)`
`static XMLResponse`	`create(String xml)`
`static XMLResponse`	`create(String xml, Charset charset)`
`Optional<String>`	`getContentCharset()`
`Optional<String>`	`getContentType()`
`Optional<String>`	`getCursorMark()`
`List<String>`	`getDocIds(String docIdField)`
`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.
`List<Map<String,Object>>`	`getDocumentFieldValuesForGroupValue(String groupField, String groupValue)`
`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
`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.
`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
`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).
`List<String>`	`getGroupValues()` If group=true, return an ordered list of group values
`List<String>`	`getGroupValues(String groupField)` If group=true, return an ordered list of group values
`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.
`Map<String,Object>`	`getJsonFacets()`
`Optional<Double>`	`getMaxScore()` Return Solr maxScore
`Optional<MediaType>`	`getMediaType()`
`Optional<Long>`	`getNumFound()` Return Solr numFound
`Optional<Long>`	`getQTime()` Return Solr QTime
`Map<String,Object>`	`getResponseHeaderParams()` Get params in responseHeader Makes defensive copies, detached from underlying response object.
`Map<String,Object>`	`getSpellcheck()` Returns response of Solr spellcheck handler
`Optional<Long>`	`getStart()`
`Optional<Long>`	`getTotalTime()` Return Fusion Query Pipeline time
`Document`	`getUnderlyingObject()`
`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
`void`	`reorderGroupValues(String groupField, List<String> groupValues)` Reorder group values in the response.
`void`	`setNumFound(Long numFound)`
`void`	`setStart(Long start)`
`boolean`	`setTotalTime(Long time)` Set Fusion Query Pipeline time if and only if the responseHeader object already exists.
`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
`void`	`updateDocumentFieldValuesForGroupValue(String groupField, String groupValue, List<Map<String,Object>> updatedDocuments)`
`void`	`updateFacets(Map<String,Map<String,Object>> facets)` Update facets in underlying response object
`void`	`updateHighlighting(Map<String,Map<String,Object>> highlighting)` Update highlighting in underlying response object
`boolean`	`updateResponseHeaderParams(Map<String,Object> responseHeaderParams)` Update responseHeader params if and only if responseHeader already exists.
`void`	`write(OutputStream os)`

Methods inherited from class com.lucidworks.apollo.solr.response.QueryableResponse
iterate, matches, query

Methods inherited from class com.lucidworks.apollo.solr.response.AbstractResponse
getDocIds, getDocuments, getDocumentsForGroupValue, getDocumentsForGroupValue, toByteArray, toString, updateDocuments, updateDocumentsForGroupValue, updateDocumentsForGroupValue

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

- Constructor Detail
  - XMLResponse
```
public XMLResponse(Document document)
```
  - XMLResponse
```
public XMLResponse()
```
- Method Detail
  - create
```
public static XMLResponse create(String xml)
                          throws ParserConfigurationException,
                                 IOException,
                                 SAXException
```
    Throws:
    
    ParserConfigurationException
    
    IOException
    
    SAXException
  - create
```
public static XMLResponse create(String xml,
                                 Charset charset)
                          throws ParserConfigurationException,
                                 IOException,
                                 SAXException
```
    Throws:
    
    ParserConfigurationException
    
    IOException
    
    SAXException
  - create
```
public static XMLResponse create(InputStream is)
                          throws ParserConfigurationException,
                                 IOException,
                                 SAXException
```
    Throws:
    
    ParserConfigurationException
    
    IOException
    
    SAXException
  - appendString
```
public void appendString(String name,
                         String value)
```
    Specified by:
    
    appendString in class AbstractResponse
  - appendStringList
```
public void appendStringList(String name,
                             List<String> values)
```
    Specified by:
    
    appendStringList in class AbstractResponse
  - appendMultiMap
```
public void appendMultiMap(String name,
                           MultivaluedMap<String,String> params)
```
    Specified by:
    
    appendMultiMap in class AbstractResponse
  - write
```
public void write(OutputStream os)
           throws IOException
```
    Throws:
    
    IOException
  - getUnderlyingObject
```
public Document getUnderlyingObject()
```
    Specified by:
    
    getUnderlyingObject in class AbstractResponse
  - getContentType
```
public Optional<String> getContentType()
```
  - getContentCharset
```
public Optional<String> getContentCharset()
```
  - getMediaType
```
public Optional<MediaType> getMediaType()
```
  - getQTime
```
public Optional<Long> getQTime()
```
    Description copied from class: AbstractResponse
    
    Return Solr QTime
    
    Specified by:
    
    getQTime in class AbstractResponse
    
    Returns:
  - getTotalTime
```
public Optional<Long> getTotalTime()
```
    Description copied from class: AbstractResponse
    
    Return Fusion Query Pipeline time
    
    Specified by:
    
    getTotalTime in class AbstractResponse
    
    Returns:
  - setTotalTime
```
public boolean setTotalTime(Long time)
```
    Description copied from class: AbstractResponse
    
    Set Fusion Query Pipeline time if and only if the responseHeader object already exists.
    
    Specified by:
    
    setTotalTime in class AbstractResponse
    
    Returns:
    
    true if update was successful
  - getNumFound
```
public Optional<Long> getNumFound()
```
    Description copied from class: AbstractResponse
    
    Return Solr numFound
    
    Specified by:
    
    getNumFound in class AbstractResponse
    
    Returns:
  - setNumFound
```
public void setNumFound(Long numFound)
```
    Specified by:
    
    setNumFound in class AbstractResponse
  - getMaxScore
```
public Optional<Double> getMaxScore()
```
    Description copied from class: AbstractResponse
    
    Return Solr maxScore
    
    Specified by:
    
    getMaxScore in class AbstractResponse
    
    Returns:
  - getStart
```
public Optional<Long> getStart()
```
    Specified by:
    
    getStart in class AbstractResponse
  - getCursorMark
```
public Optional<String> getCursorMark()
```
    Specified by:
    
    getCursorMark in class AbstractResponse
  - setStart
```
public void setStart(Long start)
```
    Specified by:
    
    setStart in class AbstractResponse
  - getResponseHeaderParams
```
public Map<String,Object> getResponseHeaderParams()
```
    Description copied from class: AbstractResponse
    
    Get params in responseHeader Makes defensive copies, detached from underlying response object. Call AbstractResponse.updateResponseHeaderParams(Map) ()} to commit the changes to the actual underlying response object.
    
    Specified by:
    
    getResponseHeaderParams in class AbstractResponse
    
    Returns:
    
    responseHeader params
  - updateResponseHeaderParams
```
public boolean updateResponseHeaderParams(Map<String,Object> responseHeaderParams)
```
    Description copied from class: AbstractResponse
    
    Update responseHeader params if and only if responseHeader already exists.
    
    Specified by:
    
    updateResponseHeaderParams in class AbstractResponse
    
    Returns:
    
    true if update was successful
  - isGrouped
```
public boolean isGrouped()
```
    Description copied from class: AbstractResponse
    
    Checks to see if response is grouped (group=true Solr parameter) See https://lucene.apache.org/solr/guide/7_4/result-grouping.html
    
    Specified by:
    
    isGrouped in class AbstractResponse
    
    Returns:
  - getGroupValues
```
public List<String> getGroupValues()
```
    Description copied from class: AbstractResponse
    
    If group=true, return an ordered list of group values
    
    Specified by:
    
    getGroupValues in class AbstractResponse
    
    Returns:
  - getGroupValues
```
public List<String> getGroupValues(String groupField)
```
    Description copied from class: AbstractResponse
    
    If group=true, return an ordered list of group values
    
    Specified by:
    
    getGroupValues in class AbstractResponse
    
    Returns:
  - getDocumentFieldValuesForGroupValue
```
public List<Map<String,Object>> getDocumentFieldValuesForGroupValue(String groupField,
                                                                    String groupValue)
```
    Specified by:
    
    getDocumentFieldValuesForGroupValue in class AbstractResponse
  - getDocumentFieldValuesForCollapseExpandGroupValue
```
public List<Map<String,Object>> getDocumentFieldValuesForCollapseExpandGroupValue(String groupField,
                                                                                  String groupValue)
```
    Description copied from class: AbstractResponse
    
    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 AbstractResponse.updateDocumentFieldValuesForCollapseExpandGroupValue(String, String, List) to persist the changes to the actual underlying response object.
    
    Specified by:
    
    getDocumentFieldValuesForCollapseExpandGroupValue in class AbstractResponse
    
    Returns:
  - updateDocumentFieldValuesForGroupValue
```
public void updateDocumentFieldValuesForGroupValue(String groupField,
                                                   String groupValue,
                                                   List<Map<String,Object>> updatedDocuments)
```
    Specified by:
    
    updateDocumentFieldValuesForGroupValue in class AbstractResponse
  - updateDocumentFieldValuesForCollapseExpandGroupValue
```
public void updateDocumentFieldValuesForCollapseExpandGroupValue(String groupField,
                                                                 String groupValue,
                                                                 List<Map<String,Object>> updatedDocuments)
```
    Description copied from class: AbstractResponse
    
    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
    
    Specified by:
    
    updateDocumentFieldValuesForCollapseExpandGroupValue in class AbstractResponse
  - getExpandedResults
```
public Map<String,Map<String,Object>> getExpandedResults()
```
    Description copied from class: AbstractResponse
    
    Returns all collapse expanded results as a map of collapse field name to grouping data that includes list of docs
    
    Specified by:
    
    getExpandedResults in class AbstractResponse
  - getGroupedResults
```
public Map<String,Map<String,Object>> getGroupedResults()
```
    Description copied from class: AbstractResponse
    
    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
    
    Specified by:
    
    getGroupedResults in class AbstractResponse
  - getGroups
```
public List<Map<String,Object>> getGroups(String groupField)
```
    Description copied from class: AbstractResponse
    
    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).
    
    Specified by:
    
    getGroups in class AbstractResponse
  - reorderGroupValues
```
public void reorderGroupValues(String groupField,
                               List<String> groupValues)
```
    Description copied from class: AbstractResponse
    
    Reorder group values in the response.
    
    Specified by:
    
    reorderGroupValues in class AbstractResponse
    
    Parameters:
    
    groupField - group field
    
    groupValues - a list of all group values in the desired order
  - getHighlighting
```
public Map<String,Map<String,Object>> getHighlighting()
```
    Description copied from class: AbstractResponse
    
    Return highlighting info as nested objects: {Doc ID -> Field name -> Snippets} Makes defensive copies, detached from underlying response object. Call AbstractResponse.updateHighlighting(Map) to commit the changes to the actual underlying response object.
    
    Specified by:
    
    getHighlighting in class AbstractResponse
    
    Returns:
  - updateHighlighting
```
public void updateHighlighting(Map<String,Map<String,Object>> highlighting)
```
    Description copied from class: AbstractResponse
    
    Update highlighting in underlying response object
    
    Specified by:
    
    updateHighlighting in class AbstractResponse
  - getFacets
```
public Map<String,Map<String,Object>> getFacets()
```
    Description copied from class: AbstractResponse
    
    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 AbstractResponse.updateFacets(Map) to commit the changes to the actual underlying response object.
    
    Specified by:
    
    getFacets in class AbstractResponse
    
    Returns:
  - getJsonFacets
```
public Map<String,Object> getJsonFacets()
```
    Specified by:
    
    getJsonFacets in class AbstractResponse
  - updateFacets
```
public void updateFacets(Map<String,Map<String,Object>> facets)
```
    Description copied from class: AbstractResponse
    
    Update facets in underlying response object
    
    Specified by:
    
    updateFacets in class AbstractResponse
  - getSpellcheck
```
public Map<String,Object> getSpellcheck()
```
    Description copied from class: AbstractResponse
    
    Returns response of Solr spellcheck handler
    
    Specified by:
    
    getSpellcheck in class AbstractResponse
    
    Returns:
    
    spellcheck results or empty map
  - getDocIds
```
public List<String> getDocIds(String docIdField)
```
    Specified by:
    
    getDocIds in class AbstractResponse

Class XMLResponse

Field Summary

Fields inherited from class com.lucidworks.apollo.solr.response.AbstractResponse

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

Constructor Summary

Method Summary

Methods inherited from class com.lucidworks.apollo.solr.response.QueryableResponse

Methods inherited from class com.lucidworks.apollo.solr.response.AbstractResponse

Methods inherited from class java.lang.Object

Constructor Detail

XMLResponse

XMLResponse

Method Detail

create

create

create

appendString

appendStringList

appendMultiMap

write

getUnderlyingObject

getContentType

getContentCharset

getMediaType

getQTime

getTotalTime

setTotalTime

getNumFound

setNumFound

getMaxScore

getStart

getCursorMark

setStart

getResponseHeaderParams

updateResponseHeaderParams

isGrouped

getGroupValues

getGroupValues

getDocumentFieldValuesForGroupValue

getDocumentFieldValuesForCollapseExpandGroupValue

updateDocumentFieldValuesForGroupValue

updateDocumentFieldValuesForCollapseExpandGroupValue

getExpandedResults

getGroupedResults

getGroups

reorderGroupValues

getHighlighting

updateHighlighting

getFacets

getJsonFacets

updateFacets

getSpellcheck

getDocIds