solr-4.6.0/docs/solr-core/org/apache/solr/response/BinaryResponseWriter.html

   1 <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
   2 <!--NewPage-->
   3 <HTML>
   4 <HEAD>
   5 <!-- Generated by javadoc (build 1.6.0_30) on Tue Nov 19 11:16:53 CET 2013 -->
   6 <META http-equiv="Content-Type" content="text/html; charset=utf-8">
   7 <TITLE>
   8 BinaryResponseWriter (Solr 4.6.0 API)
   9 </TITLE>
  10
  11 <META NAME="date" CONTENT="2013-11-19">
  12
  13 <LINK REL ="stylesheet" TYPE="text/css" HREF="../../../../stylesheet.css" TITLE="Style">
  14
  15 <SCRIPT type="text/javascript">
  16 function windowTitle()
  17 {
  18     if (location.href.indexOf('is-external=true') == -1) {
  19         parent.document.title="BinaryResponseWriter (Solr 4.6.0 API)";
  20     }
  21 }
  22 </SCRIPT>
  23 <NOSCRIPT>
  24 </NOSCRIPT>
  25
  26 </HEAD>
  27
  28 <BODY BGCOLOR="white" onload="windowTitle();">
  29 <HR>
  30
  31
  32 <!-- ========= START OF TOP NAVBAR ======= -->
  33 <A NAME="navbar_top"><!-- --></A>
  34 <A HREF="#skip-navbar_top" title="Skip navigation links"></A>
  35 <TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY="">
  36 <TR>
  37 <TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">
  38 <A NAME="navbar_top_firstrow"><!-- --></A>
  39 <TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY="">
  40   <TR ALIGN="center" VALIGN="top">
  41   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A>&nbsp;</TD>
  42   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A>&nbsp;</TD>
  43   <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> &nbsp;<FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT>&nbsp;</TD>
  44   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="class-use/BinaryResponseWriter.html"><FONT CLASS="NavBarFont1"><B>Use</B></FONT></A>&nbsp;</TD>
  45   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A>&nbsp;</TD>
  46   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A>&nbsp;</TD>
  47   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A>&nbsp;</TD>
  48   </TR>
  49 </TABLE>
  50 </TD>
  51 <TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
  52 </EM>
  53 </TD>
  54 </TR>
  55
  56 <TR>
  57 <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
  58 &nbsp;<A HREF="../../../../org/apache/solr/response/BinaryQueryResponseWriter.html" title="interface in org.apache.solr.response"><B>PREV CLASS</B></A>&nbsp;
  59 &nbsp;<A HREF="../../../../org/apache/solr/response/BinaryResponseWriter.Resolver.html" title="class in org.apache.solr.response"><B>NEXT CLASS</B></A></FONT></TD>
  60 <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
  61   <A HREF="../../../../index.html?org/apache/solr/response/BinaryResponseWriter.html" target="_top"><B>FRAMES</B></A>  &nbsp;
  62 &nbsp;<A HREF="BinaryResponseWriter.html" target="_top"><B>NO FRAMES</B></A>  &nbsp;
  63 &nbsp;<SCRIPT type="text/javascript">
  64   <!--
  65   if(window==top) {
  66     document.writeln('<A HREF="../../../../allclasses-noframe.html"><B>All Classes</B></A>');
  67   }
  68   //-->
  69 </SCRIPT>
  70 <NOSCRIPT>
  71   <A HREF="../../../../allclasses-noframe.html"><B>All Classes</B></A>
  72 </NOSCRIPT>
  73
  74
  75 </FONT></TD>
  76 </TR>
  77 <TR>
  78 <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
  79   SUMMARY:&nbsp;<A HREF="#nested_class_summary">NESTED</A>&nbsp;|&nbsp;<A HREF="#field_summary">FIELD</A>&nbsp;|&nbsp;<A HREF="#constructor_summary">CONSTR</A>&nbsp;|&nbsp;<A HREF="#method_summary">METHOD</A></FONT></TD>
  80 <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
  81 DETAIL:&nbsp;<A HREF="#field_detail">FIELD</A>&nbsp;|&nbsp;<A HREF="#constructor_detail">CONSTR</A>&nbsp;|&nbsp;<A HREF="#method_detail">METHOD</A></FONT></TD>
  82 </TR>
  83 </TABLE>
  84 <A NAME="skip-navbar_top"></A>
  85 <!-- ========= END OF TOP NAVBAR ========= -->
  86
  87 <HR>
  88 <!-- ======== START OF CLASS DATA ======== -->
  89 <H2>
  90 <FONT SIZE="-1">
  91 org.apache.solr.response</FONT>
  92 <BR>
  93 Class BinaryResponseWriter</H2>
  94 <PRE>
  95 <A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">java.lang.Object</A>
  96   <IMG SRC="../../../../resources/inherit.gif" ALT="extended by "><B>org.apache.solr.response.BinaryResponseWriter</B>
  97 </PRE>
  98 <DL>
  99 <DT><B>All Implemented Interfaces:</B> <DD><A HREF="../../../../org/apache/solr/response/BinaryQueryResponseWriter.html" title="interface in org.apache.solr.response">BinaryQueryResponseWriter</A>, <A HREF="../../../../org/apache/solr/response/QueryResponseWriter.html" title="interface in org.apache.solr.response">QueryResponseWriter</A>, <A HREF="../../../../org/apache/solr/util/plugin/NamedListInitializedPlugin.html" title="interface in org.apache.solr.util.plugin">NamedListInitializedPlugin</A></DD>
 100 </DL>
 101 <HR>
 102 <DL>
 103 <DT><PRE>public class <B>BinaryResponseWriter</B><DT>extends <A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</A><DT>implements <A HREF="../../../../org/apache/solr/response/BinaryQueryResponseWriter.html" title="interface in org.apache.solr.response">BinaryQueryResponseWriter</A></DL>
 104 </PRE>
 105
 106 <P>
 107 <HR>
 108
 109 <P>
 110 <!-- ======== NESTED CLASS SUMMARY ======== -->
 111
 112 <A NAME="nested_class_summary"><!-- --></A>
 113 <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
 114 <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
 115 <TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2">
 116 <B>Nested Class Summary</B></FONT></TH>
 117 </TR>
 118 <TR BGCOLOR="white" CLASS="TableRowColor">
 119 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
 120 <CODE>static&nbsp;class</CODE></FONT></TD>
 121 <TD><CODE><B><A HREF="../../../../org/apache/solr/response/BinaryResponseWriter.Resolver.html" title="class in org.apache.solr.response">BinaryResponseWriter.Resolver</A></B></CODE>
 122
 123 <BR>
 124 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</TD>
 125 </TR>
 126 </TABLE>
 127 &nbsp;<!-- =========== FIELD SUMMARY =========== -->
 128
 129 <A NAME="field_summary"><!-- --></A>
 130 <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
 131 <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
 132 <TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2">
 133 <B>Field Summary</B></FONT></TH>
 134 </TR>
 135 <TR BGCOLOR="white" CLASS="TableRowColor">
 136 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
 137 <CODE>static&nbsp;<A HREF="http://download.oracle.com/javase/6/docs/api/java/util/Set.html?is-external=true" title="class or interface in java.util">Set</A>&lt;<A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/Class.html?is-external=true" title="class or interface in java.lang">Class</A>&gt;</CODE></FONT></TD>
 138 <TD><CODE><B><A HREF="../../../../org/apache/solr/response/BinaryResponseWriter.html#KNOWN_TYPES">KNOWN_TYPES</A></B></CODE>
 139
 140 <BR>
 141 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</TD>
 142 </TR>
 143 </TABLE>
 144 &nbsp;<A NAME="fields_inherited_from_class_org.apache.solr.response.QueryResponseWriter"><!-- --></A>
 145 <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
 146 <TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
 147 <TH ALIGN="left"><B>Fields inherited from interface org.apache.solr.response.<A HREF="../../../../org/apache/solr/response/QueryResponseWriter.html" title="interface in org.apache.solr.response">QueryResponseWriter</A></B></TH>
 148 </TR>
 149 <TR BGCOLOR="white" CLASS="TableRowColor">
 150 <TD><CODE><A HREF="../../../../org/apache/solr/response/QueryResponseWriter.html#CONTENT_TYPE_TEXT_ASCII">CONTENT_TYPE_TEXT_ASCII</A>, <A HREF="../../../../org/apache/solr/response/QueryResponseWriter.html#CONTENT_TYPE_TEXT_UTF8">CONTENT_TYPE_TEXT_UTF8</A>, <A HREF="../../../../org/apache/solr/response/QueryResponseWriter.html#CONTENT_TYPE_XML_UTF8">CONTENT_TYPE_XML_UTF8</A></CODE></TD>
 151 </TR>
 152 </TABLE>
 153 &nbsp;
 154 <!-- ======== CONSTRUCTOR SUMMARY ======== -->
 155
 156 <A NAME="constructor_summary"><!-- --></A>
 157 <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
 158 <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
 159 <TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2">
 160 <B>Constructor Summary</B></FONT></TH>
 161 </TR>
 162 <TR BGCOLOR="white" CLASS="TableRowColor">
 163 <TD><CODE><B><A HREF="../../../../org/apache/solr/response/BinaryResponseWriter.html#BinaryResponseWriter()">BinaryResponseWriter</A></B>()</CODE>
 164
 165 <BR>
 166 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</TD>
 167 </TR>
 168 </TABLE>
 169 &nbsp;
 170 <!-- ========== METHOD SUMMARY =========== -->
 171
 172 <A NAME="method_summary"><!-- --></A>
 173 <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
 174 <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
 175 <TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2">
 176 <B>Method Summary</B></FONT></TH>
 177 </TR>
 178 <TR BGCOLOR="white" CLASS="TableRowColor">
 179 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
 180 <CODE>&nbsp;<A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A></CODE></FONT></TD>
 181 <TD><CODE><B><A HREF="../../../../org/apache/solr/response/BinaryResponseWriter.html#getContentType(org.apache.solr.request.SolrQueryRequest, org.apache.solr.response.SolrQueryResponse)">getContentType</A></B>(<A HREF="../../../../org/apache/solr/request/SolrQueryRequest.html" title="interface in org.apache.solr.request">SolrQueryRequest</A>&nbsp;request,
 182                <A HREF="../../../../org/apache/solr/response/SolrQueryResponse.html" title="class in org.apache.solr.response">SolrQueryResponse</A>&nbsp;response)</CODE>
 183
 184 <BR>
 185 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Return the applicable Content Type for a request, this method
 186  must be thread safe.</TD>
 187 </TR>
 188 <TR BGCOLOR="white" CLASS="TableRowColor">
 189 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
 190 <CODE>static&nbsp;<A HREF="../../../../../solr-solrj/org/apache/solr/common/util/NamedList.html?is-external=true" title="class or interface in org.apache.solr.common.util">NamedList</A>&lt;<A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</A>&gt;</CODE></FONT></TD>
 191 <TD><CODE><B><A HREF="../../../../org/apache/solr/response/BinaryResponseWriter.html#getParsedResponse(org.apache.solr.request.SolrQueryRequest, org.apache.solr.response.SolrQueryResponse)">getParsedResponse</A></B>(<A HREF="../../../../org/apache/solr/request/SolrQueryRequest.html" title="interface in org.apache.solr.request">SolrQueryRequest</A>&nbsp;req,
 192                   <A HREF="../../../../org/apache/solr/response/SolrQueryResponse.html" title="class in org.apache.solr.response">SolrQueryResponse</A>&nbsp;rsp)</CODE>
 193
 194 <BR>
 195 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;TODO -- there may be a way to do this without marshal at all...</TD>
 196 </TR>
 197 <TR BGCOLOR="white" CLASS="TableRowColor">
 198 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
 199 <CODE>&nbsp;void</CODE></FONT></TD>
 200 <TD><CODE><B><A HREF="../../../../org/apache/solr/response/BinaryResponseWriter.html#init(org.apache.solr.common.util.NamedList)">init</A></B>(<A HREF="../../../../../solr-solrj/org/apache/solr/common/util/NamedList.html?is-external=true" title="class or interface in org.apache.solr.common.util">NamedList</A>&nbsp;args)</CODE>
 201
 202 <BR>
 203 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<code>init</code> will be called just once, immediately after creation.</TD>
 204 </TR>
 205 <TR BGCOLOR="white" CLASS="TableRowColor">
 206 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
 207 <CODE>&nbsp;void</CODE></FONT></TD>
 208 <TD><CODE><B><A HREF="../../../../org/apache/solr/response/BinaryResponseWriter.html#write(java.io.OutputStream, org.apache.solr.request.SolrQueryRequest, org.apache.solr.response.SolrQueryResponse)">write</A></B>(<A HREF="http://download.oracle.com/javase/6/docs/api/java/io/OutputStream.html?is-external=true" title="class or interface in java.io">OutputStream</A>&nbsp;out,
 209       <A HREF="../../../../org/apache/solr/request/SolrQueryRequest.html" title="interface in org.apache.solr.request">SolrQueryRequest</A>&nbsp;req,
 210       <A HREF="../../../../org/apache/solr/response/SolrQueryResponse.html" title="class in org.apache.solr.response">SolrQueryResponse</A>&nbsp;response)</CODE>
 211
 212 <BR>
 213 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Use it to write the reponse in a binary format</TD>
 214 </TR>
 215 <TR BGCOLOR="white" CLASS="TableRowColor">
 216 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
 217 <CODE>&nbsp;void</CODE></FONT></TD>
 218 <TD><CODE><B><A HREF="../../../../org/apache/solr/response/BinaryResponseWriter.html#write(java.io.Writer, org.apache.solr.request.SolrQueryRequest, org.apache.solr.response.SolrQueryResponse)">write</A></B>(<A HREF="http://download.oracle.com/javase/6/docs/api/java/io/Writer.html?is-external=true" title="class or interface in java.io">Writer</A>&nbsp;writer,
 219       <A HREF="../../../../org/apache/solr/request/SolrQueryRequest.html" title="interface in org.apache.solr.request">SolrQueryRequest</A>&nbsp;request,
 220       <A HREF="../../../../org/apache/solr/response/SolrQueryResponse.html" title="class in org.apache.solr.response">SolrQueryResponse</A>&nbsp;response)</CODE>
 221
 222 <BR>
 223 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Write a SolrQueryResponse, this method must be thread save.</TD>
 224 </TR>
 225 </TABLE>
 226 &nbsp;<A NAME="methods_inherited_from_class_java.lang.Object"><!-- --></A>
 227 <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
 228 <TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
 229 <TH ALIGN="left"><B>Methods inherited from class java.lang.<A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</A></B></TH>
 230 </TR>
 231 <TR BGCOLOR="white" CLASS="TableRowColor">
 232 <TD><CODE><A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true#clone()" title="class or interface in java.lang">clone</A>, <A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true#equals(java.lang.Object)" title="class or interface in java.lang">equals</A>, <A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true#finalize()" title="class or interface in java.lang">finalize</A>, <A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true#getClass()" title="class or interface in java.lang">getClass</A>, <A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true#hashCode()" title="class or interface in java.lang">hashCode</A>, <A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true#notify()" title="class or interface in java.lang">notify</A>, <A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true#notifyAll()" title="class or interface in java.lang">notifyAll</A>, <A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true#toString()" title="class or interface in java.lang">toString</A>, <A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true#wait()" title="class or interface in java.lang">wait</A>, <A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true#wait(long)" title="class or interface in java.lang">wait</A>, <A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true#wait(long, int)" title="class or interface in java.lang">wait</A></CODE></TD>
 233 </TR>
 234 </TABLE>
 235 &nbsp;
 236 <P>
 237
 238 <!-- ============ FIELD DETAIL =========== -->
 239
 240 <A NAME="field_detail"><!-- --></A>
 241 <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
 242 <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
 243 <TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2">
 244 <B>Field Detail</B></FONT></TH>
 245 </TR>
 246 </TABLE>
 247
 248 <A NAME="KNOWN_TYPES"><!-- --></A><H3>
 249 KNOWN_TYPES</H3>
 250 <PRE>
 251 public static final <A HREF="http://download.oracle.com/javase/6/docs/api/java/util/Set.html?is-external=true" title="class or interface in java.util">Set</A>&lt;<A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/Class.html?is-external=true" title="class or interface in java.lang">Class</A>&gt; <B>KNOWN_TYPES</B></PRE>
 252 <DL>
 253 <DL>
 254 </DL>
 255 </DL>
 256
 257 <!-- ========= CONSTRUCTOR DETAIL ======== -->
 258
 259 <A NAME="constructor_detail"><!-- --></A>
 260 <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
 261 <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
 262 <TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2">
 263 <B>Constructor Detail</B></FONT></TH>
 264 </TR>
 265 </TABLE>
 266
 267 <A NAME="BinaryResponseWriter()"><!-- --></A><H3>
 268 BinaryResponseWriter</H3>
 269 <PRE>
 270 public <B>BinaryResponseWriter</B>()</PRE>
 271 <DL>
 272 </DL>
 273
 274 <!-- ============ METHOD DETAIL ========== -->
 275
 276 <A NAME="method_detail"><!-- --></A>
 277 <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
 278 <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
 279 <TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2">
 280 <B>Method Detail</B></FONT></TH>
 281 </TR>
 282 </TABLE>
 283
 284 <A NAME="write(java.io.OutputStream, org.apache.solr.request.SolrQueryRequest, org.apache.solr.response.SolrQueryResponse)"><!-- --></A><H3>
 285 write</H3>
 286 <PRE>
 287 public void <B>write</B>(<A HREF="http://download.oracle.com/javase/6/docs/api/java/io/OutputStream.html?is-external=true" title="class or interface in java.io">OutputStream</A>&nbsp;out,
 288                   <A HREF="../../../../org/apache/solr/request/SolrQueryRequest.html" title="interface in org.apache.solr.request">SolrQueryRequest</A>&nbsp;req,
 289                   <A HREF="../../../../org/apache/solr/response/SolrQueryResponse.html" title="class in org.apache.solr.response">SolrQueryResponse</A>&nbsp;response)
 290            throws <A HREF="http://download.oracle.com/javase/6/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</A></PRE>
 291 <DL>
 292 <DD><B>Description copied from interface: <CODE><A HREF="../../../../org/apache/solr/response/BinaryQueryResponseWriter.html#write(java.io.OutputStream, org.apache.solr.request.SolrQueryRequest, org.apache.solr.response.SolrQueryResponse)">BinaryQueryResponseWriter</A></CODE></B></DD>
 293 <DD>Use it to write the reponse in a binary format
 294 <P>
 295 <DD><DL>
 296 <DT><B>Specified by:</B><DD><CODE><A HREF="../../../../org/apache/solr/response/BinaryQueryResponseWriter.html#write(java.io.OutputStream, org.apache.solr.request.SolrQueryRequest, org.apache.solr.response.SolrQueryResponse)">write</A></CODE> in interface <CODE><A HREF="../../../../org/apache/solr/response/BinaryQueryResponseWriter.html" title="interface in org.apache.solr.response">BinaryQueryResponseWriter</A></CODE></DL>
 297 </DD>
 298 <DD><DL>
 299
 300 <DT><B>Throws:</B>
 301 <DD><CODE><A HREF="http://download.oracle.com/javase/6/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</A></CODE></DL>
 302 </DD>
 303 </DL>
 304 <HR>
 305
 306 <A NAME="write(java.io.Writer, org.apache.solr.request.SolrQueryRequest, org.apache.solr.response.SolrQueryResponse)"><!-- --></A><H3>
 307 write</H3>
 308 <PRE>
 309 public void <B>write</B>(<A HREF="http://download.oracle.com/javase/6/docs/api/java/io/Writer.html?is-external=true" title="class or interface in java.io">Writer</A>&nbsp;writer,
 310                   <A HREF="../../../../org/apache/solr/request/SolrQueryRequest.html" title="interface in org.apache.solr.request">SolrQueryRequest</A>&nbsp;request,
 311                   <A HREF="../../../../org/apache/solr/response/SolrQueryResponse.html" title="class in org.apache.solr.response">SolrQueryResponse</A>&nbsp;response)
 312            throws <A HREF="http://download.oracle.com/javase/6/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</A></PRE>
 313 <DL>
 314 <DD><B>Description copied from interface: <CODE><A HREF="../../../../org/apache/solr/response/QueryResponseWriter.html#write(java.io.Writer, org.apache.solr.request.SolrQueryRequest, org.apache.solr.response.SolrQueryResponse)">QueryResponseWriter</A></CODE></B></DD>
 315 <DD>Write a SolrQueryResponse, this method must be thread save.
 316
 317  <p>
 318  Information about the request (in particular: formating options) may be
 319  obtained from <code>req</code> but the dominant source of information
 320  should be <code>rsp</code>.
 321  <p>
 322  There are no mandatory actions that write must perform.
 323  An empty write implementation would fulfill
 324  all interface obligations.
 325  </p>
 326 <P>
 327 <DD><DL>
 328 <DT><B>Specified by:</B><DD><CODE><A HREF="../../../../org/apache/solr/response/QueryResponseWriter.html#write(java.io.Writer, org.apache.solr.request.SolrQueryRequest, org.apache.solr.response.SolrQueryResponse)">write</A></CODE> in interface <CODE><A HREF="../../../../org/apache/solr/response/QueryResponseWriter.html" title="interface in org.apache.solr.response">QueryResponseWriter</A></CODE></DL>
 329 </DD>
 330 <DD><DL>
 331
 332 <DT><B>Throws:</B>
 333 <DD><CODE><A HREF="http://download.oracle.com/javase/6/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</A></CODE></DL>
 334 </DD>
 335 </DL>
 336 <HR>
 337
 338 <A NAME="getContentType(org.apache.solr.request.SolrQueryRequest, org.apache.solr.response.SolrQueryResponse)"><!-- --></A><H3>
 339 getContentType</H3>
 340 <PRE>
 341 public <A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A> <B>getContentType</B>(<A HREF="../../../../org/apache/solr/request/SolrQueryRequest.html" title="interface in org.apache.solr.request">SolrQueryRequest</A>&nbsp;request,
 342                              <A HREF="../../../../org/apache/solr/response/SolrQueryResponse.html" title="class in org.apache.solr.response">SolrQueryResponse</A>&nbsp;response)</PRE>
 343 <DL>
 344 <DD><B>Description copied from interface: <CODE><A HREF="../../../../org/apache/solr/response/QueryResponseWriter.html#getContentType(org.apache.solr.request.SolrQueryRequest, org.apache.solr.response.SolrQueryResponse)">QueryResponseWriter</A></CODE></B></DD>
 345 <DD>Return the applicable Content Type for a request, this method
 346  must be thread safe.
 347
 348  <p>
 349  QueryResponseWriter's must implement this method to return a valid
 350  HTTP Content-Type header for the request, that will logically
 351  correspond with the output produced by the write method.
 352  </p>
 353 <P>
 354 <DD><DL>
 355 <DT><B>Specified by:</B><DD><CODE><A HREF="../../../../org/apache/solr/response/QueryResponseWriter.html#getContentType(org.apache.solr.request.SolrQueryRequest, org.apache.solr.response.SolrQueryResponse)">getContentType</A></CODE> in interface <CODE><A HREF="../../../../org/apache/solr/response/QueryResponseWriter.html" title="interface in org.apache.solr.response">QueryResponseWriter</A></CODE></DL>
 356 </DD>
 357 <DD><DL>
 358
 359 <DT><B>Returns:</B><DD>a Content-Type string, which may not be null.</DL>
 360 </DD>
 361 </DL>
 362 <HR>
 363
 364 <A NAME="init(org.apache.solr.common.util.NamedList)"><!-- --></A><H3>
 365 init</H3>
 366 <PRE>
 367 public void <B>init</B>(<A HREF="../../../../../solr-solrj/org/apache/solr/common/util/NamedList.html?is-external=true" title="class or interface in org.apache.solr.common.util">NamedList</A>&nbsp;args)</PRE>
 368 <DL>
 369 <DD><B>Description copied from interface: <CODE><A HREF="../../../../org/apache/solr/response/QueryResponseWriter.html#init(org.apache.solr.common.util.NamedList)">QueryResponseWriter</A></CODE></B></DD>
 370 <DD><code>init</code> will be called just once, immediately after creation.
 371  <p>The args are user-level initialization parameters that
 372  may be specified when declaring a response writer in
 373  solrconfig.xml
 374 <P>
 375 <DD><DL>
 376 <DT><B>Specified by:</B><DD><CODE><A HREF="../../../../org/apache/solr/response/QueryResponseWriter.html#init(org.apache.solr.common.util.NamedList)">init</A></CODE> in interface <CODE><A HREF="../../../../org/apache/solr/response/QueryResponseWriter.html" title="interface in org.apache.solr.response">QueryResponseWriter</A></CODE><DT><B>Specified by:</B><DD><CODE><A HREF="../../../../org/apache/solr/util/plugin/NamedListInitializedPlugin.html#init(org.apache.solr.common.util.NamedList)">init</A></CODE> in interface <CODE><A HREF="../../../../org/apache/solr/util/plugin/NamedListInitializedPlugin.html" title="interface in org.apache.solr.util.plugin">NamedListInitializedPlugin</A></CODE></DL>
 377 </DD>
 378 <DD><DL>
 379 </DL>
 380 </DD>
 381 </DL>
 382 <HR>
 383
 384 <A NAME="getParsedResponse(org.apache.solr.request.SolrQueryRequest, org.apache.solr.response.SolrQueryResponse)"><!-- --></A><H3>
 385 getParsedResponse</H3>
 386 <PRE>
 387 public static <A HREF="../../../../../solr-solrj/org/apache/solr/common/util/NamedList.html?is-external=true" title="class or interface in org.apache.solr.common.util">NamedList</A>&lt;<A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</A>&gt; <B>getParsedResponse</B>(<A HREF="../../../../org/apache/solr/request/SolrQueryRequest.html" title="interface in org.apache.solr.request">SolrQueryRequest</A>&nbsp;req,
 388                                                   <A HREF="../../../../org/apache/solr/response/SolrQueryResponse.html" title="class in org.apache.solr.response">SolrQueryResponse</A>&nbsp;rsp)</PRE>
 389 <DL>
 390 <DD>TODO -- there may be a way to do this without marshal at all...
 391 <P>
 392 <DD><DL>
 393 </DL>
 394 </DD>
 395 <DD><DL>
 396
 397 <DT><B>Returns:</B><DD>a response object equivalent to what you get from the XML/JSON/javabin parser. Documents become
 398          SolrDocuments, DocList becomes SolrDocumentList etc.<DT><B>Since:</B></DT>
 399   <DD>solr 1.4</DD>
 400 </DL>
 401 </DD>
 402 </DL>
 403 <!-- ========= END OF CLASS DATA ========= -->
 404 <HR>
 405
 406
 407 <!-- ======= START OF BOTTOM NAVBAR ====== -->
 408 <A NAME="navbar_bottom"><!-- --></A>
 409 <A HREF="#skip-navbar_bottom" title="Skip navigation links"></A>
 410 <TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY="">
 411 <TR>
 412 <TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">
 413 <A NAME="navbar_bottom_firstrow"><!-- --></A>
 414 <TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY="">
 415   <TR ALIGN="center" VALIGN="top">
 416   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A>&nbsp;</TD>
 417   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A>&nbsp;</TD>
 418   <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> &nbsp;<FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT>&nbsp;</TD>
 419   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="class-use/BinaryResponseWriter.html"><FONT CLASS="NavBarFont1"><B>Use</B></FONT></A>&nbsp;</TD>
 420   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A>&nbsp;</TD>
 421   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A>&nbsp;</TD>
 422   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A>&nbsp;</TD>
 423   </TR>
 424 </TABLE>
 425 </TD>
 426 <TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
 427 </EM>
 428 </TD>
 429 </TR>
 430
 431 <TR>
 432 <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
 433 &nbsp;<A HREF="../../../../org/apache/solr/response/BinaryQueryResponseWriter.html" title="interface in org.apache.solr.response"><B>PREV CLASS</B></A>&nbsp;
 434 &nbsp;<A HREF="../../../../org/apache/solr/response/BinaryResponseWriter.Resolver.html" title="class in org.apache.solr.response"><B>NEXT CLASS</B></A></FONT></TD>
 435 <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
 436   <A HREF="../../../../index.html?org/apache/solr/response/BinaryResponseWriter.html" target="_top"><B>FRAMES</B></A>  &nbsp;
 437 &nbsp;<A HREF="BinaryResponseWriter.html" target="_top"><B>NO FRAMES</B></A>  &nbsp;
 438 &nbsp;<SCRIPT type="text/javascript">
 439   <!--
 440   if(window==top) {
 441     document.writeln('<A HREF="../../../../allclasses-noframe.html"><B>All Classes</B></A>');
 442   }
 443   //-->
 444 </SCRIPT>
 445 <NOSCRIPT>
 446   <A HREF="../../../../allclasses-noframe.html"><B>All Classes</B></A>
 447 </NOSCRIPT>
 448
 449
 450 </FONT></TD>
 451 </TR>
 452 <TR>
 453 <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
 454   SUMMARY:&nbsp;<A HREF="#nested_class_summary">NESTED</A>&nbsp;|&nbsp;<A HREF="#field_summary">FIELD</A>&nbsp;|&nbsp;<A HREF="#constructor_summary">CONSTR</A>&nbsp;|&nbsp;<A HREF="#method_summary">METHOD</A></FONT></TD>
 455 <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
 456 DETAIL:&nbsp;<A HREF="#field_detail">FIELD</A>&nbsp;|&nbsp;<A HREF="#constructor_detail">CONSTR</A>&nbsp;|&nbsp;<A HREF="#method_detail">METHOD</A></FONT></TD>
 457 </TR>
 458 </TABLE>
 459 <A NAME="skip-navbar_bottom"></A>
 460 <!-- ======== END OF BOTTOM NAVBAR ======= -->
 461
 462 <HR>
 463
 464           <i>Copyright &copy; 2000-2013 Apache Software Foundation.  All Rights Reserved.</i>
 465           <script src='../../../../prettify.js' type='text/javascript'></script>
 466           <script type='text/javascript'>
 467             (function(){
 468               var oldonload = window.onload;
 469               if (typeof oldonload != 'function') {
 470                 window.onload = prettyPrint;
 471               } else {
 472                 window.onload = function() {
 473                   oldonload();
 474                   prettyPrint();
 475                 }
 476               }
 477             })();
 478           </script>
 479
 480 </BODY>
 481 </HTML>