Save This Page
Home » lucene-3.0.1-src » org.apache » lucene » search » highlight » [javadoc | source]
    1   package org.apache.lucene.search.highlight;
    2   /**
    3    * Licensed to the Apache Software Foundation (ASF) under one or more
    4    * contributor license agreements.  See the NOTICE file distributed with
    5    * this work for additional information regarding copyright ownership.
    6    * The ASF licenses this file to You under the Apache License, Version 2.0
    7    * (the "License"); you may not use this file except in compliance with
    8    * the License.  You may obtain a copy of the License at
    9    *
   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   /**
   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   	/**
   28   	 * @param originalText The section of text being considered for markup
   29   	 * @param tokenGroup contains one or several overlapping Tokens along with
   30   	 * their scores and positions.
   31   	 */
   32   	String highlightTerm(String originalText, TokenGroup tokenGroup);
   33   }

Save This Page
Home » lucene-3.0.1-src » org.apache » lucene » search » highlight » [javadoc | source]