PatternConsumer


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  /* $Id: PatternConsumer.java 426576 2006-07-28 15:44:37Z jeremias $ */
19   
20  package org.apache.fop.hyphenation;
21  
22  import java.util.ArrayList  ;
23  
24  /**
25   * This interface is used to connect the XML pattern file parser to
26   * the hyphenation tree.
27   *
28   * @author Carlos Villegas <cav@uniscope.co.jp>
29   */
30  public interface PatternConsumer {
31  
32      /**
33       * Add a character class.
34       * A character class defines characters that are considered
35       * equivalent for the purpose of hyphenation (e.g. "aA"). It
36       * usually means to ignore case.
37       * @param chargroup character group
38       */
39      void addClass(String   chargroup);
40  
41      /**
42       * Add a hyphenation exception. An exception replaces the
43       * result obtained by the algorithm for cases for which this
44       * fails or the user wants to provide his own hyphenation.
45       * A hyphenatedword is a vector of alternating String's and
46       * {@link Hyphen Hyphen} instances
47       */
48      void addException(String   word, ArrayList   hyphenatedword);
49  
50      /**
51       * Add hyphenation patterns.
52       * @param pattern the pattern
53       * @param values interletter values expressed as a string of
54       * digit characters.
55       */
56      void addPattern(String   pattern, String   values);
57  
58  }
59
A to Z: JavaDoc & Examples Daily Java News & Articles Open Source Projects Open Source Codes Free Computer Books Remove Frame
Popular Tags