Formatter


1   package org.apache.lucene.search.highlight;
2   /**
3    * Copyright 2002-2004 The Apache Software Foundation
4    *
5    * Licensed under the Apache License, Version 2.0 (the "License");
6    * you may not use this file except in compliance with the License.
7    * 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  
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   */
24  public interface Formatter
25  {
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       * @return
31       */
32      String   highlightTerm(String   originalText, TokenGroup tokenGroup);
33  }
34

A to Z: JavaDoc & Examples Daily Java News & Articles Open Source Projects Open Source Codes Free Computer Books Remove Frame

Popular Tags