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