solr-4.5.1/docs/solr-core/org/apache/solr/response/PHPResponseWriter.html

   1 <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
   2 <!-- NewPage -->
   3 <html lang="en">
   4 <head>
   5 <!-- Generated by javadoc (version 1.6.0_27) on Thu Oct 17 21:44:56 EDT 2013 -->
   6 <meta http-equiv="Content-Type" content="text/html" charset="utf-8">
   7 <title>PHPResponseWriter (Solr 4.5.1 API)</title>
   8 <meta name="date" content="2013-10-17">
   9 <link rel="stylesheet" type="text/css" href="../../../../stylesheet.css" title="Style">
  10 </head>
  11 <body>
  12 <script type="text/javascript"><!--
  13     if (location.href.indexOf('is-external=true') == -1) {
  14         parent.document.title="PHPResponseWriter (Solr 4.5.1 API)";
  15     }
  16 //-->
  17 </script>
  18 <noscript>
  19 <div>JavaScript is disabled on your browser.</div>
  20 </noscript>
  21 <!-- ========= START OF TOP NAVBAR ======= -->
  22 <div class="topNav"><a name="navbar_top">
  23 <!--   -->
  24 </a><a href="#skip-navbar_top" title="Skip navigation links"></a><a name="navbar_top_firstrow">
  25 <!--   -->
  26 </a>
  27 <ul class="navList" title="Navigation">
  28 <li><a href="../../../../overview-summary.html">Overview</a></li>
  29 <li><a href="package-summary.html">Package</a></li>
  30 <li class="navBarCell1Rev">Class</li>
  31 <li><a href="class-use/PHPResponseWriter.html">Use</a></li>
  32 <li><a href="package-tree.html">Tree</a></li>
  33 <li><a href="../../../../deprecated-list.html">Deprecated</a></li>
  34 <li><a href="../../../../help-doc.html">Help</a></li>
  35 </ul>
  36 </div>
  37 <div class="subNav">
  38 <ul class="navList">
  39 <li><a href="../../../../org/apache/solr/response/JSONResponseWriter.html" title="class in org.apache.solr.response"><span class="strong">PREV CLASS</span></a></li>
  40 <li><a href="../../../../org/apache/solr/response/PHPSerializedResponseWriter.html" title="class in org.apache.solr.response"><span class="strong">NEXT CLASS</span></a></li>
  41 </ul>
  42 <ul class="navList">
  43 <li><a href="../../../../index.html?org/apache/solr/response/PHPResponseWriter.html" target="_top">FRAMES</a></li>
  44 <li><a href="PHPResponseWriter.html" target="_top">NO FRAMES</a></li>
  45 </ul>
  46 <ul class="navList" id="allclasses_navbar_top">
  47 <li><a href="../../../../allclasses-noframe.html">All Classes</a></li>
  48 </ul>
  49 <div>
  50 <script type="text/javascript"><!--
  51   allClassesLink = document.getElementById("allclasses_navbar_top");
  52   if(window==top) {
  53     allClassesLink.style.display = "block";
  54   }
  55   else {
  56     allClassesLink.style.display = "none";
  57   }
  58   //-->
  59 </script>
  60 </div>
  61 <div>
  62 <ul class="subNavList">
  63 <li>SUMMARY:&nbsp;</li>
  64 <li>NESTED&nbsp;|&nbsp;</li>
  65 <li>FIELD&nbsp;|&nbsp;</li>
  66 <li><a href="#constructor_summary">CONSTR</a>&nbsp;|&nbsp;</li>
  67 <li><a href="#method_summary">METHOD</a></li>
  68 </ul>
  69 <ul class="subNavList">
  70 <li>DETAIL:&nbsp;</li>
  71 <li>FIELD&nbsp;|&nbsp;</li>
  72 <li><a href="#constructor_detail">CONSTR</a>&nbsp;|&nbsp;</li>
  73 <li><a href="#method_detail">METHOD</a></li>
  74 </ul>
  75 </div>
  76 <a name="skip-navbar_top">
  77 <!--   -->
  78 </a></div>
  79 <!-- ========= END OF TOP NAVBAR ========= -->
  80 <!-- ======== START OF CLASS DATA ======== -->
  81 <div class="header">
  82 <p class="subTitle">org.apache.solr.response</p>
  83 <h2 title="Class PHPResponseWriter" class="title">Class PHPResponseWriter</h2>
  84 </div>
  85 <div class="contentContainer">
  86 <ul class="inheritance">
  87 <li><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></li>
  88 <li>
  89 <ul class="inheritance">
  90 <li>org.apache.solr.response.PHPResponseWriter</li>
  91 </ul>
  92 </li>
  93 </ul>
  94 <div class="description">
  95 <ul class="blockList">
  96 <li class="blockList">
  97 <dl>
  98 <dt>All Implemented Interfaces:</dt>
  99 <dd><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 <br>
 103 <pre>public class <strong>PHPResponseWriter</strong>
 104 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>
 105 implements <a href="../../../../org/apache/solr/response/QueryResponseWriter.html" title="interface in org.apache.solr.response">QueryResponseWriter</a></pre>
 106 </li>
 107 </ul>
 108 </div>
 109 <div class="summary">
 110 <ul class="blockList">
 111 <li class="blockList">
 112 <!-- =========== FIELD SUMMARY =========== -->
 113 <ul class="blockList">
 114 <li class="blockList"><a name="field_summary">
 115 <!--   -->
 116 </a>
 117 <h3>Field Summary</h3>
 118 <ul class="blockList">
 119 <li class="blockList"><a name="fields_inherited_from_class_org.apache.solr.response.QueryResponseWriter">
 120 <!--   -->
 121 </a>
 122 <h3>Fields inherited from interface&nbsp;org.apache.solr.response.<a href="../../../../org/apache/solr/response/QueryResponseWriter.html" title="interface in org.apache.solr.response">QueryResponseWriter</a></h3>
 123 <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></li>
 124 </ul>
 125 </li>
 126 </ul>
 127 <!-- ======== CONSTRUCTOR SUMMARY ======== -->
 128 <ul class="blockList">
 129 <li class="blockList"><a name="constructor_summary">
 130 <!--   -->
 131 </a>
 132 <h3>Constructor Summary</h3>
 133 <table class="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Constructor Summary table, listing constructors, and an explanation">
 134 <caption><span>Constructors</span><span class="tabEnd">&nbsp;</span></caption>
 135 <tr>
 136 <th class="colOne" scope="col">Constructor and Description</th>
 137 </tr>
 138 <tr class="altColor">
 139 <td class="colOne"><code><strong><a href="../../../../org/apache/solr/response/PHPResponseWriter.html#PHPResponseWriter()">PHPResponseWriter</a></strong>()</code>&nbsp;</td>
 140 </tr>
 141 </table>
 142 </li>
 143 </ul>
 144 <!-- ========== METHOD SUMMARY =========== -->
 145 <ul class="blockList">
 146 <li class="blockList"><a name="method_summary">
 147 <!--   -->
 148 </a>
 149 <h3>Method Summary</h3>
 150 <table class="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation">
 151 <caption><span>Methods</span><span class="tabEnd">&nbsp;</span></caption>
 152 <tr>
 153 <th class="colFirst" scope="col">Modifier and Type</th>
 154 <th class="colLast" scope="col">Method and Description</th>
 155 </tr>
 156 <tr class="altColor">
 157 <td class="colFirst"><code><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></td>
 158 <td class="colLast"><code><strong><a href="../../../../org/apache/solr/response/PHPResponseWriter.html#getContentType(org.apache.solr.request.SolrQueryRequest, org.apache.solr.response.SolrQueryResponse)">getContentType</a></strong>(<a href="../../../../org/apache/solr/request/SolrQueryRequest.html" title="interface in org.apache.solr.request">SolrQueryRequest</a>&nbsp;request,
 159               <a href="../../../../org/apache/solr/response/SolrQueryResponse.html" title="class in org.apache.solr.response">SolrQueryResponse</a>&nbsp;response)</code>
 160 <div class="block">Return the applicable Content Type for a request, this method
 161  must be thread safe.</div>
 162 </td>
 163 </tr>
 164 <tr class="rowColor">
 165 <td class="colFirst"><code>void</code></td>
 166 <td class="colLast"><code><strong><a href="../../../../org/apache/solr/response/PHPResponseWriter.html#init(org.apache.solr.common.util.NamedList)">init</a></strong>(<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;namedList)</code>
 167 <div class="block"><code>init</code> will be called just once, immediately after creation.</div>
 168 </td>
 169 </tr>
 170 <tr class="altColor">
 171 <td class="colFirst"><code>void</code></td>
 172 <td class="colLast"><code><strong><a href="../../../../org/apache/solr/response/PHPResponseWriter.html#write(java.io.Writer, org.apache.solr.request.SolrQueryRequest, org.apache.solr.response.SolrQueryResponse)">write</a></strong>(<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,
 173      <a href="../../../../org/apache/solr/request/SolrQueryRequest.html" title="interface in org.apache.solr.request">SolrQueryRequest</a>&nbsp;req,
 174      <a href="../../../../org/apache/solr/response/SolrQueryResponse.html" title="class in org.apache.solr.response">SolrQueryResponse</a>&nbsp;rsp)</code>
 175 <div class="block">Write a SolrQueryResponse, this method must be thread save.</div>
 176 </td>
 177 </tr>
 178 </table>
 179 <ul class="blockList">
 180 <li class="blockList"><a name="methods_inherited_from_class_java.lang.Object">
 181 <!--   -->
 182 </a>
 183 <h3>Methods inherited from class&nbsp;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></h3>
 184 <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></li>
 185 </ul>
 186 </li>
 187 </ul>
 188 </li>
 189 </ul>
 190 </div>
 191 <div class="details">
 192 <ul class="blockList">
 193 <li class="blockList">
 194 <!-- ========= CONSTRUCTOR DETAIL ======== -->
 195 <ul class="blockList">
 196 <li class="blockList"><a name="constructor_detail">
 197 <!--   -->
 198 </a>
 199 <h3>Constructor Detail</h3>
 200 <a name="PHPResponseWriter()">
 201 <!--   -->
 202 </a>
 203 <ul class="blockListLast">
 204 <li class="blockList">
 205 <h4>PHPResponseWriter</h4>
 206 <pre>public&nbsp;PHPResponseWriter()</pre>
 207 </li>
 208 </ul>
 209 </li>
 210 </ul>
 211 <!-- ============ METHOD DETAIL ========== -->
 212 <ul class="blockList">
 213 <li class="blockList"><a name="method_detail">
 214 <!--   -->
 215 </a>
 216 <h3>Method Detail</h3>
 217 <a name="init(org.apache.solr.common.util.NamedList)">
 218 <!--   -->
 219 </a>
 220 <ul class="blockList">
 221 <li class="blockList">
 222 <h4>init</h4>
 223 <pre>public&nbsp;void&nbsp;init(<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;namedList)</pre>
 224 <div class="block"><strong>Description copied from interface:&nbsp;<code><a href="../../../../org/apache/solr/response/QueryResponseWriter.html#init(org.apache.solr.common.util.NamedList)">QueryResponseWriter</a></code></strong></div>
 225 <div class="block"><code>init</code> will be called just once, immediately after creation.
 226  <p>The args are user-level initialization parameters that
 227  may be specified when declaring a response writer in
 228  solrconfig.xml</div>
 229 <dl>
 230 <dt><strong>Specified by:</strong></dt>
 231 <dd><code><a href="../../../../org/apache/solr/response/QueryResponseWriter.html#init(org.apache.solr.common.util.NamedList)">init</a></code>&nbsp;in interface&nbsp;<code><a href="../../../../org/apache/solr/response/QueryResponseWriter.html" title="interface in org.apache.solr.response">QueryResponseWriter</a></code></dd>
 232 <dt><strong>Specified by:</strong></dt>
 233 <dd><code><a href="../../../../org/apache/solr/util/plugin/NamedListInitializedPlugin.html#init(org.apache.solr.common.util.NamedList)">init</a></code>&nbsp;in interface&nbsp;<code><a href="../../../../org/apache/solr/util/plugin/NamedListInitializedPlugin.html" title="interface in org.apache.solr.util.plugin">NamedListInitializedPlugin</a></code></dd>
 234 </dl>
 235 </li>
 236 </ul>
 237 <a name="write(java.io.Writer, org.apache.solr.request.SolrQueryRequest, org.apache.solr.response.SolrQueryResponse)">
 238 <!--   -->
 239 </a>
 240 <ul class="blockList">
 241 <li class="blockList">
 242 <h4>write</h4>
 243 <pre>public&nbsp;void&nbsp;write(<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,
 244          <a href="../../../../org/apache/solr/request/SolrQueryRequest.html" title="interface in org.apache.solr.request">SolrQueryRequest</a>&nbsp;req,
 245          <a href="../../../../org/apache/solr/response/SolrQueryResponse.html" title="class in org.apache.solr.response">SolrQueryResponse</a>&nbsp;rsp)
 246            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>
 247 <div class="block"><strong>Description copied from interface:&nbsp;<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></strong></div>
 248 <div class="block">Write a SolrQueryResponse, this method must be thread save.
 249
 250  <p>
 251  Information about the request (in particular: formating options) may be
 252  obtained from <code>req</code> but the dominant source of information
 253  should be <code>rsp</code>.
 254  <p>
 255  There are no mandatory actions that write must perform.
 256  An empty write implementation would fulfill
 257  all interface obligations.
 258  </p></div>
 259 <dl>
 260 <dt><strong>Specified by:</strong></dt>
 261 <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>&nbsp;in interface&nbsp;<code><a href="../../../../org/apache/solr/response/QueryResponseWriter.html" title="interface in org.apache.solr.response">QueryResponseWriter</a></code></dd>
 262 <dt><span class="strong">Throws:</span></dt>
 263 <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></dd></dl>
 264 </li>
 265 </ul>
 266 <a name="getContentType(org.apache.solr.request.SolrQueryRequest, org.apache.solr.response.SolrQueryResponse)">
 267 <!--   -->
 268 </a>
 269 <ul class="blockListLast">
 270 <li class="blockList">
 271 <h4>getContentType</h4>
 272 <pre>public&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>&nbsp;getContentType(<a href="../../../../org/apache/solr/request/SolrQueryRequest.html" title="interface in org.apache.solr.request">SolrQueryRequest</a>&nbsp;request,
 273                     <a href="../../../../org/apache/solr/response/SolrQueryResponse.html" title="class in org.apache.solr.response">SolrQueryResponse</a>&nbsp;response)</pre>
 274 <div class="block"><strong>Description copied from interface:&nbsp;<code><a href="../../../../org/apache/solr/response/QueryResponseWriter.html#getContentType(org.apache.solr.request.SolrQueryRequest, org.apache.solr.response.SolrQueryResponse)">QueryResponseWriter</a></code></strong></div>
 275 <div class="block">Return the applicable Content Type for a request, this method
 276  must be thread safe.
 277
 278  <p>
 279  QueryResponseWriter's must implement this method to return a valid
 280  HTTP Content-Type header for the request, that will logically
 281  correspond with the output produced by the write method.
 282  </p></div>
 283 <dl>
 284 <dt><strong>Specified by:</strong></dt>
 285 <dd><code><a href="../../../../org/apache/solr/response/QueryResponseWriter.html#getContentType(org.apache.solr.request.SolrQueryRequest, org.apache.solr.response.SolrQueryResponse)">getContentType</a></code>&nbsp;in interface&nbsp;<code><a href="../../../../org/apache/solr/response/QueryResponseWriter.html" title="interface in org.apache.solr.response">QueryResponseWriter</a></code></dd>
 286 <dt><span class="strong">Returns:</span></dt><dd>a Content-Type string, which may not be null.</dd></dl>
 287 </li>
 288 </ul>
 289 </li>
 290 </ul>
 291 </li>
 292 </ul>
 293 </div>
 294 </div>
 295 <!-- ========= END OF CLASS DATA ========= -->
 296 <!-- ======= START OF BOTTOM NAVBAR ====== -->
 297 <div class="bottomNav"><a name="navbar_bottom">
 298 <!--   -->
 299 </a><a href="#skip-navbar_bottom" title="Skip navigation links"></a><a name="navbar_bottom_firstrow">
 300 <!--   -->
 301 </a>
 302 <ul class="navList" title="Navigation">
 303 <li><a href="../../../../overview-summary.html">Overview</a></li>
 304 <li><a href="package-summary.html">Package</a></li>
 305 <li class="navBarCell1Rev">Class</li>
 306 <li><a href="class-use/PHPResponseWriter.html">Use</a></li>
 307 <li><a href="package-tree.html">Tree</a></li>
 308 <li><a href="../../../../deprecated-list.html">Deprecated</a></li>
 309 <li><a href="../../../../help-doc.html">Help</a></li>
 310 </ul>
 311 </div>
 312 <div class="subNav">
 313 <ul class="navList">
 314 <li><a href="../../../../org/apache/solr/response/JSONResponseWriter.html" title="class in org.apache.solr.response"><span class="strong">PREV CLASS</span></a></li>
 315 <li><a href="../../../../org/apache/solr/response/PHPSerializedResponseWriter.html" title="class in org.apache.solr.response"><span class="strong">NEXT CLASS</span></a></li>
 316 </ul>
 317 <ul class="navList">
 318 <li><a href="../../../../index.html?org/apache/solr/response/PHPResponseWriter.html" target="_top">FRAMES</a></li>
 319 <li><a href="PHPResponseWriter.html" target="_top">NO FRAMES</a></li>
 320 </ul>
 321 <ul class="navList" id="allclasses_navbar_bottom">
 322 <li><a href="../../../../allclasses-noframe.html">All Classes</a></li>
 323 </ul>
 324 <div>
 325 <script type="text/javascript"><!--
 326   allClassesLink = document.getElementById("allclasses_navbar_bottom");
 327   if(window==top) {
 328     allClassesLink.style.display = "block";
 329   }
 330   else {
 331     allClassesLink.style.display = "none";
 332   }
 333   //-->
 334 </script>
 335 </div>
 336 <div>
 337 <ul class="subNavList">
 338 <li>SUMMARY:&nbsp;</li>
 339 <li>NESTED&nbsp;|&nbsp;</li>
 340 <li>FIELD&nbsp;|&nbsp;</li>
 341 <li><a href="#constructor_summary">CONSTR</a>&nbsp;|&nbsp;</li>
 342 <li><a href="#method_summary">METHOD</a></li>
 343 </ul>
 344 <ul class="subNavList">
 345 <li>DETAIL:&nbsp;</li>
 346 <li>FIELD&nbsp;|&nbsp;</li>
 347 <li><a href="#constructor_detail">CONSTR</a>&nbsp;|&nbsp;</li>
 348 <li><a href="#method_detail">METHOD</a></li>
 349 </ul>
 350 </div>
 351 <a name="skip-navbar_bottom">
 352 <!--   -->
 353 </a></div>
 354 <!-- ======== END OF BOTTOM NAVBAR ======= -->
 355 <p class="legalCopy"><small>
 356           <i>Copyright &copy; 2000-2013 Apache Software Foundation.  All Rights Reserved.</i>
 357           <script src='../../../../prettify.js' type='text/javascript'></script>
 358           <script type='text/javascript'>
 359             (function(){
 360               var oldonload = window.onload;
 361               if (typeof oldonload != 'function') {
 362                 window.onload = prettyPrint;
 363               } else {
 364                 window.onload = function() {
 365                   oldonload();
 366                   prettyPrint();
 367                 }
 368               }
 369             })();
 370           </script>
 371         </small></p>
 372 </body>
 373 </html>