01: package org.apache.lucene.search.highlight;
02:
03: /**
04: * Licensed to the Apache Software Foundation (ASF) under one or more
05: * contributor license agreements. See the NOTICE file distributed with
06: * this work for additional information regarding copyright ownership.
07: * The ASF licenses this file to You under the Apache License, Version 2.0
08: * (the "License"); you may not use this file except in compliance with
09: * the License. You may obtain a copy of the License at
10: *
11: * http://www.apache.org/licenses/LICENSE-2.0
12: *
13: * Unless required by applicable law or agreed to in writing, software
14: * distributed under the License is distributed on an "AS IS" BASIS,
15: * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
16: * See the License for the specific language governing permissions and
17: * limitations under the License.
18: */
19:
20: /**
21: * Processes terms found in the original text, typically by applying some form
22: * of mark-up to highlight terms in HTML search results pages.
23: *
24: */
25: public interface Formatter {
26: /**
27: * @param originalText The section of text being considered for markup
28: * @param tokenGroup contains one or several overlapping Tokens along with
29: * their scores and positions.
30: */
31: String highlightTerm(String originalText, TokenGroup tokenGroup);
32: }
|