lucene-java-3.5.0/lucene/contrib/highlighter/src/java/org/apache/lucene/search/vectorhighlight/FragListBuilder.java

   1 package org.apache.lucene.search.vectorhighlight;
   2
   3 /**
   4  * Licensed to the Apache Software Foundation (ASF) under one or more
   5  * contributor license agreements.  See the NOTICE file distributed with
   6  * this work for additional information regarding copyright ownership.
   7  * The ASF licenses this file to You under the Apache License, Version 2.0
   8  * (the "License"); you may not use this file except in compliance with
   9  * 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  * FragListBuilder is an interface for FieldFragList builder classes.
  22  * A FragListBuilder class can be plugged in to Highlighter.
  23  */
  24 public interface FragListBuilder {
  25
  26   /**
  27    * create a FieldFragList.
  28    *
  29    * @param fieldPhraseList FieldPhraseList object
  30    * @param fragCharSize the length (number of chars) of a fragment
  31    * @return the created FieldFragList object
  32    */
  33   public FieldFragList createFieldFragList( FieldPhraseList fieldPhraseList, int fragCharSize );
  34 }