fop/src/java/org/apache/fop/complexscripts/fonts/GlyphClassMapping.java

/*
 * Licensed to the Apache Software Foundation (ASF) under one or more
 * contributor license agreements.  See the NOTICE file distributed with
 * this work for additional information regarding copyright ownership.
 * The ASF licenses this file to You under the Apache License, Version 2.0
 * (the "License"); you may not use this file except in compliance with
 * the License.  You may obtain a copy of the License at
 *
 *      http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

/* $Id$ */

package org.apache.fop.complexscripts.fonts;

// CSOFF: LineLengthCheck

/**
 * <p>The <code>GlyphClassMapping</code> interface provides glyph identifier to class
 * index mapping support.</p>
 *
 * <p>This work was originally authored by Glenn Adams (gadams@apache.org).</p>
 */
public interface GlyphClassMapping {

    /**
     * Obtain size of class table, i.e., ciMax + 1, where ciMax is the maximum
     * class index.
     * @param set for coverage set based class mappings, indicates set index, otherwise ignored
     * @return size of class table
     */
    int getClassSize ( int set );

    /**
     * Map glyph identifier (code) to coverge index. Returns -1 if glyph identifier is not in the domain of
     * the class table.
     * @param gid glyph identifier (code)
     * @param set for coverage set based class mappings, indicates set index, otherwise ignored
     * @return non-negative glyph class index or -1 if glyph identifiers is not mapped by table
     */
    int getClassIndex ( int gid, int set );

}