lucene-java-3.4.0/lucene/contrib/analyzers/common/src/java/org/apache/lucene/analysis/compound/hyphenation/PatternConsumer.java

   1 /*
   2  * Licensed to the Apache Software Foundation (ASF) under one or more
   3  * contributor license agreements.  See the NOTICE file distributed with
   4  * this work for additional information regarding copyright ownership.
   5  * The ASF licenses this file to You under the Apache License, Version 2.0
   6  * (the "License"); you may not use this file except in compliance with
   7  * the License.  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 package org.apache.lucene.analysis.compound.hyphenation;
  19
  20 import java.util.ArrayList;
  21
  22 /**
  23  * This interface is used to connect the XML pattern file parser to the
  24  * hyphenation tree.
  25  *
  26  * This class has been taken from the Apache FOP project (http://xmlgraphics.apache.org/fop/). They have been slightly modified.
  27  */
  28 public interface PatternConsumer {
  29
  30   /**
  31    * Add a character class. A character class defines characters that are
  32    * considered equivalent for the purpose of hyphenation (e.g. "aA"). It
  33    * usually means to ignore case.
  34    *
  35    * @param chargroup character group
  36    */
  37   void addClass(String chargroup);
  38
  39   /**
  40    * Add a hyphenation exception. An exception replaces the result obtained by
  41    * the algorithm for cases for which this fails or the user wants to provide
  42    * his own hyphenation. A hyphenatedword is a vector of alternating String's
  43    * and {@link Hyphen Hyphen} instances
  44    */
  45   void addException(String word, ArrayList<Object> hyphenatedword);
  46
  47   /**
  48    * Add hyphenation patterns.
  49    *
  50    * @param pattern the pattern
  51    * @param values interletter values expressed as a string of digit characters.
  52    */
  53   void addPattern(String pattern, String values);
  54
  55 }