Package org.apache.solr.response

Class XMLResponseWriter

java.lang.Object

org.apache.solr.response.XMLResponseWriter

All Implemented Interfaces:

QueryResponseWriter, TextQueryResponseWriter, NamedListInitializedPlugin

public class XMLResponseWriter
extends Object
implements TextQueryResponseWriter

An XML QueryResponseWriter.

Nested Class Summary

Nested classes/interfaces inherited from interface org.apache.solr.response.TextQueryResponseWriter

TextQueryResponseWriter.NonFlushingStream

Field Summary

Fields inherited from interface org.apache.solr.response.QueryResponseWriter

CONTENT_TYPE_TEXT_UTF8, CONTENT_TYPE_XML_UTF8

Constructor Summary

Constructors

Constructor	Description
XMLResponseWriter()

Method Summary

Modifier and Type	Method	Description
String	getContentType(SolrQueryRequest request, SolrQueryResponse response)	Return the applicable Content Type for a request, this method must be thread safe.
void	write(Writer writer, SolrQueryRequest req, SolrQueryResponse rsp)	Write a SolrQueryResponse in a textual manner.

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.apache.solr.util.plugin.NamedListInitializedPlugin

init

Methods inherited from interface org.apache.solr.response.QueryResponseWriter

write

Methods inherited from interface org.apache.solr.response.TextQueryResponseWriter

write, writeToString

Constructor Details

XMLResponseWriter

public XMLResponseWriter()

Method Details

write

public void write(Writer writer,
 SolrQueryRequest req,
 SolrQueryResponse rsp)
           throws IOException

Description copied from interface: TextQueryResponseWriter

Write a SolrQueryResponse in a textual manner.

Information about the request (in particular: formatting options) may be obtained from req but the dominant source of information should be rsp.

There are no mandatory actions that write must perform. An empty write implementation would fulfill all interface obligations.

Specified by:

write in interface TextQueryResponseWriter

Throws:

IOException

getContentType

public String getContentType(SolrQueryRequest request,
 SolrQueryResponse response)

Description copied from interface: QueryResponseWriter

Return the applicable Content Type for a request, this method must be thread safe.

QueryResponseWriter's must implement this method to return a valid HTTP Content-Type header for the request, that will logically correspond with the output produced by the write method.

Specified by:

getContentType in interface QueryResponseWriter

Returns:

a Content-Type string, which may not be null.