org.apache.solr.response
Class BaseResponseWriter

java.lang.Object
  extended by org.apache.solr.response.BaseResponseWriter
Direct Known Subclasses:
GenericBinaryResponseWriter, GenericTextResponseWriter

Deprecated. use TextResponseWriter or BinaryResponseWriter see SOLR-2485

public abstract class BaseResponseWriter
extends 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
static class BaseResponseWriter.DocListInfo
          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.
 
Constructor Summary
BaseResponseWriter()
          Deprecated.  
 
Method Summary
 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
 

Constructor Detail

BaseResponseWriter

public BaseResponseWriter()
Deprecated. 
Method Detail

write

public void write(BaseResponseWriter.SingleResponseWriter responseWriter,
                  SolrQueryRequest request,
                  SolrQueryResponse response)
           throws 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:
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



Copyright © 2000-2011 Apache Software Foundation. All Rights Reserved.