/*
 * 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.
 */

package org.apache.xerces.xs;

/**
 * This interface represents a complex or simple type definition.
 */
public interface XSTypeDefinition extends XSObject {
    /**
     * The object describes a complex type.
     */
    public static final short COMPLEX_TYPE              = 15;
    /**
     * The object describes a simple type.
     */
    public static final short SIMPLE_TYPE               = 16;
    /**
     * Return whether this type definition is a simple type or complex type.
     */
    public short getTypeCategory();

    /**
     * {base type definition}: either a simple type definition or a complex 
     * type definition. 
     */
    public XSTypeDefinition getBaseType();

    /**
     * {final}. For a complex type definition it is a subset of {extension, 
     * restriction}. For a simple type definition it is a subset of 
     * {extension, list, restriction, union}. 
     * @param restriction  Extension, restriction, list, union constants 
     *   (defined in <code>XSConstants</code>). 
     * @return True if <code>restriction</code> is in the final set, 
     *   otherwise false.
     */
    public boolean isFinal(short restriction);

    /**
     * For complex types the returned value is a bit combination of the subset 
     * of {<code>DERIVATION_EXTENSION, DERIVATION_RESTRICTION</code>} 
     * corresponding to <code>final</code> set of this type or 
     * <code>DERIVATION_NONE</code>. For simple types the returned value is 
     * a bit combination of the subset of { 
     * <code>DERIVATION_RESTRICTION, DERIVATION_EXTENSION, DERIVATION_UNION, DERIVATION_LIST</code>
     * } corresponding to <code>final</code> set of this type or 
     * <code>DERIVATION_NONE</code>. 
     */
    public short getFinal();

    /**
     *  Convenience attribute. A boolean that specifies if the type definition 
     * is anonymous. 
     */
    public boolean getAnonymous();

    /**
     * Convenience method which checks if this type is derived from the given 
     * <code>ancestorType</code>. 
     * @param ancestorType  An ancestor type definition. 
     * @param derivationMethod  A bit combination representing a subset of {
     *   <code>DERIVATION_RESTRICTION, DERIVATION_EXTENSION, DERIVATION_UNION, DERIVATION_LIST</code>
     *   }. 
     * @return  True if this type is derived from <code>ancestorType</code> 
     *   using only derivation methods from the <code>derivationMethod</code>
     *   . 
     */
    public boolean derivedFromType(XSTypeDefinition ancestorType, 
                                   short derivationMethod);

    /**
     * Convenience method which checks if this type is derived from the given 
     * ancestor type. 
     * @param namespace  An ancestor type namespace. 
     * @param name  An ancestor type name. 
     * @param derivationMethod  A bit combination representing a subset of {
     *   <code>DERIVATION_RESTRICTION, DERIVATION_EXTENSION, DERIVATION_UNION, DERIVATION_LIST</code>
     *   }. 
     * @return  True if this type is derived from <code>ancestorType</code> 
     *   using only derivation methods from the <code>derivationMethod</code>
     *   . 
     */
    public boolean derivedFrom(String namespace, 
                               String name, 
                               short derivationMethod);
    
    /**
     * A property that simplifies testing for the identity of anonymous type
     * definitions.
     * 
     * For complex type definition:
     * 1. If the name [attribute] is present (with the exception of the type being
     *    redefined, number 2 below), then absent, otherwise the Element
     *    Declaration corresponding to that parent information item
     * 2. In the case of redefine, the context of the redefined complex type is the
     *    redefining complex type definition
     * 
     * For simple type definition,
     * 1. If the name [attribute] is present (with the exception of the type being
     *    redefined, number 3 below), then absent
     * 2. otherwise the appropriate case among the following:
     *    2.1 If the parent element information item is attribute, then the
     *        corresponding Attribute Declaration
     *    2.2 If the parent element information item is element, then the
     *        corresponding Element Declaration
     *    2.3 If the parent element information item is list or union, then
     *        the Simple Type Definition corresponding to the grandparent simpleType
     *        element information item
     *    2.4 otherwise (the parent element information item is restriction), the
     *        appropriate case among the following:
     *        2.4.1 If the grandparent element information item is simpleType, then
     *              the Simple Type Definition corresponding to the grandparent
     *        2.4.2 otherwise (the grandparent element information item is simpleContent),
     *              the Simple Type Definition which is the {content type} of the Complex
     *              Type Definition corresponding to the great-grandparent complexType
     *              element information item.
     * 3. In the case of redefine, the context of the redefined simple type is the
     *    redefining simple type definition
     */
    public XSObject getContext();
}
