Package org.apache.solr.response

Interface TextQueryResponseWriter

All Superinterfaces:

NamedListInitializedPlugin, QueryResponseWriter

All Known Implementing Classes:

CSVResponseWriter, GeoJSONResponseWriter, GraphMLResponseWriter, JacksonJsonWriter, JSONResponseWriter, SchemaXmlResponseWriter, XMLResponseWriter

public interface TextQueryResponseWriter
extends QueryResponseWriter

A writer supporting character streams (Writer based).

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static class	TextQueryResponseWriter.NonFlushingStream	Delegates write methods to an underlying OutputStream, but does not delegate OutputStream.flush(), (nor OutputStream.close()).

Field Summary

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

CONTENT_TYPE_TEXT_UTF8, CONTENT_TYPE_XML_UTF8

Method Summary

Modifier and Type	Method	Description
default void	write(OutputStream outputStream, SolrQueryRequest request, SolrQueryResponse response, String contentType)	Writes the response to the OutputStream.
void	write(Writer writer, SolrQueryRequest request, SolrQueryResponse response)	Write a SolrQueryResponse in a textual manner.
default String	writeToString(SolrQueryRequest request, SolrQueryResponse response)	Writes a String for debugging / testing purposes.

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

init

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

getContentType, write

Method Details

write

void write(Writer writer,
 SolrQueryRequest request,
 SolrQueryResponse response)
    throws IOException

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.

Throws:

IOException

writeToString

default String writeToString(SolrQueryRequest request,
 SolrQueryResponse response)
                      throws IOException

Description copied from interface: QueryResponseWriter

Writes a String for debugging / testing purposes.

Specified by:

writeToString in interface QueryResponseWriter

Throws:

IOException

write

default void write(OutputStream outputStream,
 SolrQueryRequest request,
 SolrQueryResponse response,
 String contentType)
            throws IOException

Description copied from interface: QueryResponseWriter

Writes the response to the OutputStream. contentType is from QueryResponseWriter.getContentType(SolrQueryRequest, SolrQueryResponse), and it's often ignored.

Specified by:

write in interface QueryResponseWriter

Throws:

IOException