← 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/highlight/SolrEncoder.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/highlight/SolrEncoder.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.highlight;
19
 
 
20
 
import org.apache.lucene.search.highlight.Encoder;
21
 
import org.apache.solr.common.params.SolrParams;
22
 
import org.apache.solr.common.util.NamedList;
23
 
import org.apache.solr.core.SolrInfoMBean;
24
 
import org.apache.solr.util.plugin.NamedListInitializedPlugin;
25
 
 
26
 
public interface SolrEncoder extends SolrInfoMBean, NamedListInitializedPlugin {
27
 
 
28
 
  /** <code>init</code> will be called just once, immediately after creation.
29
 
   * <p>The args are user-level initialization parameters that
30
 
   * may be specified when declaring a request handler in
31
 
   * solrconfig.xml
32
 
   */
33
 
  public void init(NamedList args);
34
 
 
35
 
  /**
36
 
   * Return an {@link org.apache.lucene.search.highlight.Encoder} appropriate for this field.
37
 
   * 
38
 
   * @param fieldName The name of the field
39
 
   * @param params The params controlling Highlighting
40
 
   * @return An appropriate {@link org.apache.lucene.search.highlight.Encoder}
41
 
   */
42
 
  public Encoder getEncoder(String fieldName, SolrParams params);
43
 
}