← 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/util/HighlightingUtils.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/util/HighlightingUtils.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
 
package org.apache.solr.util;
18
 
 
19
 
import java.io.IOException;
20
 
import java.util.HashMap;
21
 
import java.util.Map;
22
 
import org.apache.solr.common.params.DefaultSolrParams;
23
 
import org.apache.solr.common.params.HighlightParams;
24
 
import org.apache.solr.common.params.MapSolrParams;
25
 
import org.apache.solr.common.params.SolrParams;
26
 
import org.apache.solr.common.util.NamedList;
27
 
import org.apache.solr.request.*;
28
 
import org.apache.solr.search.DocList;
29
 
import org.apache.solr.highlight.DefaultSolrHighlighter;
30
 
 
31
 
import org.apache.lucene.search.Query;
32
 
import org.apache.lucene.search.highlight.*;
33
 
 
34
 
/**
35
 
 * DEPRECATED Collection of Utility and Factory methods for Highlighting.
36
 
 *
37
 
 * @deprecated use DefaultSolrHighlighter
38
 
 * @see DefaultSolrHighlighter
39
 
 */
40
 
@Deprecated
41
 
public class HighlightingUtils implements HighlightParams {
42
 
 
43
 
   static SolrParams DEFAULTS = null;
44
 
   static {
45
 
      Map<String,String> map = new HashMap<String,String>();
46
 
      map.put(SNIPPETS, "1");
47
 
      map.put(FRAGSIZE, "100");
48
 
      map.put(FORMATTER, SIMPLE);
49
 
      map.put(SIMPLE_PRE, "<em>");
50
 
      map.put(SIMPLE_POST, "</em>");
51
 
      
52
 
      DEFAULTS = new MapSolrParams(map);
53
 
   }
54
 
  
55
 
  private static SolrHighlighterX HIGHLIGHTER = new SolrHighlighterX();
56
 
  
57
 
   /** Combine request parameters with highlighting defaults. */
58
 
   static SolrParams getParams(SolrQueryRequest request) {
59
 
      return new DefaultSolrParams(request.getParams(), DEFAULTS);
60
 
   }
61
 
   
62
 
   /**
63
 
    * @deprecated use DefaultSolrHighlighter
64
 
    * @see DefaultSolrHighlighter#isHighlightingEnabled
65
 
    */
66
 
   @Deprecated
67
 
   public static boolean isHighlightingEnabled(SolrQueryRequest request) {
68
 
     return HIGHLIGHTER.isHighlightingEnabled(getParams(request));
69
 
   }
70
 
   
71
 
   /**
72
 
    * @deprecated use DefaultSolrHighlighter
73
 
    * @see DefaultSolrHighlighter
74
 
    */
75
 
   @Deprecated
76
 
   public static Highlighter getHighlighter(Query query, String fieldName, SolrQueryRequest request) {
77
 
     return HIGHLIGHTER.getHighlighterX(query, fieldName, request);
78
 
   }
79
 
   
80
 
   /**
81
 
    * @deprecated use DefaultSolrHighlighter
82
 
    * @see DefaultSolrHighlighter#getHighlightFields
83
 
    */
84
 
   @Deprecated
85
 
   public static String[] getHighlightFields(Query query, SolrQueryRequest request, String[] defaultFields) {
86
 
     return HIGHLIGHTER.getHighlightFields(query, request, defaultFields);
87
 
   }
88
 
   
89
 
   /**
90
 
    * @deprecated use DefaultSolrHighlighter
91
 
    * @see DefaultSolrHighlighter
92
 
    */
93
 
   @Deprecated
94
 
   public static int getMaxSnippets(String fieldName, SolrQueryRequest request) {
95
 
     return HIGHLIGHTER.getMaxSnippetsX(fieldName, request);
96
 
   }
97
 
   
98
 
   /**
99
 
    * @deprecated use DefaultSolrHighlighter
100
 
    * @see DefaultSolrHighlighter
101
 
    */
102
 
   @Deprecated
103
 
   public static Formatter getFormatter(String fieldName, SolrQueryRequest request) {
104
 
     return HIGHLIGHTER.getFormatterX(fieldName, request);
105
 
   }
106
 
   
107
 
   /**
108
 
    * @deprecated use DefaultSolrHighlighter
109
 
    * @see DefaultSolrHighlighter
110
 
    */
111
 
   @Deprecated
112
 
   public static Fragmenter getFragmenter(String fieldName, SolrQueryRequest request) {
113
 
     return HIGHLIGHTER.getFragmenterX(fieldName, request);
114
 
   }
115
 
   
116
 
   /**
117
 
    * @deprecated use DefaultSolrHighlighter
118
 
    * @see DefaultSolrHighlighter#doHighlighting
119
 
    */
120
 
   @Deprecated @SuppressWarnings("unchecked")
121
 
   public static NamedList doHighlighting(DocList docs, Query query, SolrQueryRequest req, String[] defaultFields) throws IOException {
122
 
     return HIGHLIGHTER.doHighlighting(docs, query, req, defaultFields);
123
 
   }
124
 
}
125
 
 
126
 
/**
127
 
 * subclass containing package protected versions of some protected methods, used for proxying calls to deprecated methods that have been moved and made protected.
128
 
 */
129
 
class SolrHighlighterX extends DefaultSolrHighlighter {
130
 
  Highlighter getHighlighterX(Query query, String fieldName, SolrQueryRequest request) {
131
 
    return getHighlighter(query, fieldName, request);
132
 
  }
133
 
  int getMaxSnippetsX(String fieldName, SolrQueryRequest request) {
134
 
    return getMaxSnippets(fieldName, HighlightingUtils.getParams(request));
135
 
  }
136
 
  Formatter getFormatterX(String fieldName, SolrQueryRequest request) {
137
 
        return getFormatter(fieldName, HighlightingUtils.getParams(request));
138
 
  }
139
 
  Fragmenter getFragmenterX(String fieldName, SolrQueryRequest request) {
140
 
    return getFragmenter(fieldName, HighlightingUtils.getParams(request));
141
 
  }
142
 
}
143