← Back to branch summary

~slub.team/goobi-indexserver/3.x

« back to all changes in this revision

Viewing changes to solr/core/src/java/org/apache/solr/response/GenericBinaryResponseWriter.java

  • Committer: Sebastian Meyer
  • Date: 2012-08-03 09:12:40 UTC
  • Revision ID: sebastian.meyer@slub-dresden.de-20120803091240-x6861b0vabq1xror
https://launchpad.net/bugs/985487
Remove Lucene and Solr source code and add patches instead
Fix Bug #985487: Auto-suggestion for the search interface

Show diffs side-by-side

added added

removed removed

Lines of Context:
solr/core/src/java/org/apache/solr/response/GenericBinaryResponseWriter.java
1
 
/**
2
 
 * Licensed to the Apache Software Foundation (ASF) under one or more
3
 
 * contributor license agreements.  See the NOTICE file distributed with
4
 
 * this work for additional information regarding copyright ownership.
5
 
 * The ASF licenses this file to You under the Apache License, Version 2.0
6
 
 * (the "License"); you may not use this file except in compliance with
7
 
 * the License.  You may obtain a copy of the License at
8
 
 *
9
 
 *     http://www.apache.org/licenses/LICENSE-2.0
10
 
 *
11
 
 * Unless required by applicable law or agreed to in writing, software
12
 
 * distributed under the License is distributed on an "AS IS" BASIS,
13
 
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
14
 
 * See the License for the specific language governing permissions and
15
 
 * limitations under the License.
16
 
 */
17
 
 
18
 
package org.apache.solr.response;
19
 
 
20
 
import java.io.OutputStream;
21
 
import java.io.IOException;
22
 
import java.io.Writer;
23
 
 
24
 
import org.apache.solr.common.SolrDocumentList;
25
 
import org.apache.solr.common.SolrInputDocument;
26
 
import org.apache.solr.request.SolrQueryRequest;
27
 
 
28
 
import org.apache.solr.response.BaseResponseWriter.SingleResponseWriter; // javadocs
29
 
 
30
 
/**
31
 
 * 
32
 
 * 
33
 
 * A generic {@link QueryResponseWriter} implementation that requires a user to
34
 
 * implement the
35
 
 * {@link #getSingleResponseWriter(OutputStream, SolrQueryRequest, SolrQueryResponse)}
36
 
 * that defines a {@link SingleResponseWriter} to handle the binary output.
37
 
 * 
38
 
 * @since 1.5
39
 
 * @version $Id: GenericBinaryResponseWriter.java 1004075 2010-10-04 00:36:21Z rmuir $
40
 
 * 
41
 
 */
42
 
public abstract class GenericBinaryResponseWriter extends BaseResponseWriter
43
 
    implements BinaryQueryResponseWriter {
44
 
 
45
 
  /**
46
 
   * 
47
 
   * Writes the binary output data using the {@link SingleResponseWriter}
48
 
   * provided by a call to
49
 
   * {@link #getSingleResponseWriter(OutputStream, SolrQueryRequest, SolrQueryResponse)}
50
 
   * .
51
 
   * 
52
 
   * @param out
53
 
   *          The {@link OutputStream} to write the binary data to.
54
 
   * @param request
55
 
   *          The provided {@link SolrQueryRequest}.
56
 
   * @param response
57
 
   *          The provided {@link SolrQueryResponse}.
58
 
   */
59
 
  public void write(OutputStream out, SolrQueryRequest request,
60
 
      SolrQueryResponse response) throws IOException {
61
 
    super.write(getSingleResponseWriter(out, request, response), request,
62
 
        response);
63
 
  }
64
 
 
65
 
  /**
66
 
   * Users of this class should implement this method to define a
67
 
   * {@link SingleResponseWriter} responsible for writing the binary output
68
 
   * given a {@link SolrDocumentList} or doc-by-doc, given a
69
 
   * {@link SolrInputDocument}.
70
 
   * 
71
 
   * @param out
72
 
   *          The {@link OutputStream} to write the binary data response to.
73
 
   * @param request
74
 
   *          The provided {@link SolrQueryRequest}.
75
 
   * @param response
76
 
   *          The provided {@link SolrQueryResponse}.
77
 
   * @return A {@link SingleResponseWriter} that will be used to generate the
78
 
   *         response output from this {@link QueryResponseWriter}.
79
 
   */
80
 
  public abstract SingleResponseWriter getSingleResponseWriter(
81
 
      OutputStream out, SolrQueryRequest request, SolrQueryResponse response);
82
 
 
83
 
  /**Just to throw Exception So that the eimplementing classes do not have to do the  same
84
 
   */
85
 
  public void write(Writer writer, SolrQueryRequest request, SolrQueryResponse response) throws IOException {
86
 
    throw new RuntimeException("This is a binary writer , Cannot write to a characterstream");
87
 
  }
88
 
}