← 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/GenericTextResponseWriter.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/GenericTextResponseWriter.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.Writer;
21
 
import java.io.IOException;
22
 
 
23
 
import org.apache.solr.common.SolrDocumentList;
24
 
import org.apache.solr.common.SolrInputDocument;
25
 
import org.apache.solr.request.SolrQueryRequest;
26
 
 
27
 
import org.apache.solr.response.BaseResponseWriter.SingleResponseWriter; // javadocs
28
 
 
29
 
/**
30
 
 * 
31
 
 * 
32
 
 * A generic {@link QueryResponseWriter} implementation that requires a user to
33
 
 * implement the
34
 
 * {@link #getSingleResponseWriter(Writer, SolrQueryRequest, SolrQueryResponse)}
35
 
 * that defines a {@link SingleResponseWriter} to handle plain ol' text output.
36
 
 * 
37
 
 * @since 1.5
38
 
 * @version $Id: GenericTextResponseWriter.java 1098906 2011-05-03 05:02:02Z ryan $
39
 
 * 
40
 
 * @deprecated use {@link TextResponseWriter} see SOLR-2485
41
 
 */
42
 
public abstract class GenericTextResponseWriter extends BaseResponseWriter
43
 
    implements QueryResponseWriter {
44
 
 
45
 
  /**
46
 
   * 
47
 
   * Writes text output using the {@link SingleResponseWriter} provided by a
48
 
   * call to
49
 
   * {@link #getSingleResponseWriter(Writer, SolrQueryRequest, SolrQueryResponse)}
50
 
   * .
51
 
   * 
52
 
   * @param writer
53
 
   *          The {@link Writer} to write the text output to.
54
 
   * @param request
55
 
   *          The provided {@link SolrQueryRequest}.
56
 
   * @param response
57
 
   *          The provided {@link SolrQueryResponse}.
58
 
   */
59
 
  public void write(Writer writer, SolrQueryRequest request,
60
 
      SolrQueryResponse response) throws IOException {
61
 
    super.write(getSingleResponseWriter(writer, 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 text output given a
68
 
   * {@link SolrDocumentList} or doc-by-doc, given a {@link SolrInputDocument}.
69
 
   * 
70
 
   * @param writer
71
 
   *          The {@link Writer} to write the text data response to.
72
 
   * @param request
73
 
   *          The provided {@link SolrQueryRequest}.
74
 
   * @param response
75
 
   *          The provided {@link SolrQueryResponse}.
76
 
   * @return A {@link SingleResponseWriter} that will be used to generate the
77
 
   *         response output from this {@link QueryResponseWriter}.
78
 
   */
79
 
  protected abstract SingleResponseWriter getSingleResponseWriter(
80
 
      Writer writer, SolrQueryRequest request, SolrQueryResponse response);
81
 
}