org.apache.solr.response

Class BaseResponseWriter

java.lang.Object

org.apache.solr.response.BaseResponseWriter

Direct Known Subclasses:

GenericBinaryResponseWriter, GenericTextResponseWriter

Deprecated.

use TextResponseWriter or BinaryResponseWriter see SOLR-2485

public abstract class BaseResponseWriter
extends java.lang.Object

This class serves as a basis from which QueryResponseWriters can be developed. The class provides a single method write(SingleResponseWriter, SolrQueryRequest, SolrQueryResponse) that allows users to implement a BaseResponseWriter.SingleResponseWriter sub-class which defines how to output SolrInputDocuments or a SolrDocumentList.

Since:

1.5

Version:

$Id: BaseResponseWriter.java 1098906 2011-05-03 05:02:02Z ryan $

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	BaseResponseWriter.DocListInfo Deprecated.
private static class	BaseResponseWriter.IdxInfo Deprecated.
static class	BaseResponseWriter.SingleResponseWriter Deprecated. Users wanting to define custom QueryResponseWriters that deal with SolrInputDocuments and SolrDocumentList should override the methods for this class.

Field Summary

Fields

Modifier and Type	Field and Description
private static org.slf4j.Logger	LOG Deprecated.
private static java.lang.String	SCORE_FIELD Deprecated.

Constructor Summary

Constructors

Constructor and Description
BaseResponseWriter() Deprecated.

Method Summary

Modifier and Type	Method and Description
private static SolrDocument	getDoc(int id, BaseResponseWriter.IdxInfo info) Deprecated.
void	init(NamedList args) Deprecated. No ops implementation so that the implementing classes do not have to do it
void	write(BaseResponseWriter.SingleResponseWriter responseWriter, SolrQueryRequest request, SolrQueryResponse response) Deprecated. The main method that allows users to write BaseResponseWriter.SingleResponseWriters and provide them as the initial parameter responseWriter to this method which defines how output should be generated.

Methods inherited from class java.lang.Object

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

Field Detail

LOG

private static final org.slf4j.Logger LOG

Deprecated.

SCORE_FIELD

private static final java.lang.String SCORE_FIELD

Deprecated.

See Also:

Constant Field Values

Constructor Detail

BaseResponseWriter

public BaseResponseWriter()

Deprecated.

Method Detail

write

public void write(BaseResponseWriter.SingleResponseWriter responseWriter,
                  SolrQueryRequest request,
                  SolrQueryResponse response)
           throws java.io.IOException

Deprecated.

The main method that allows users to write BaseResponseWriter.SingleResponseWriters and provide them as the initial parameter responseWriter to this method which defines how output should be generated.

Parameters:

responseWriter - The user-provided BaseResponseWriter.SingleResponseWriter implementation.

request - The provided SolrQueryRequest.

response - The provided SolrQueryResponse.

Throws:

java.io.IOException - If any error occurs.

init

public void init(NamedList args)

Deprecated.

No ops implementation so that the implementing classes do not have to do it

getDoc

private static SolrDocument getDoc(int id,
                                   BaseResponseWriter.IdxInfo info)
                            throws java.io.IOException

Deprecated.

Throws:

java.io.IOException