jdk8u.jaxp.org.apache.xerces.external.xs.XSElementDeclaration Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of openjdk8-jaxp-external Show documentation
The newest version!
/*
 * reserved comment block
 * DO NOT REMOVE OR ALTER!
 */
/*
 * Copyright 2003,2004 The Apache Software Foundation.
 *
 * Licensed 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 jdk8u.jaxp.org.apache.xerces.external.xs;

/**
 * The interface represents the Element Declaration schema component.
 */
public interface XSElementDeclaration extends XSTerm {
    /**
     * [type definition]: either a simple type definition or a complex type
     * definition.
     */
    public XSTypeDefinition getTypeDefinition();

    /**
     * [scope]. One of SCOPE_GLOBAL, SCOPE_LOCAL, or
     * SCOPE_ABSENT. If the scope is local, then the
     * enclosingCTDefinition is present.
     */
    public short getScope();

    /**
     * The complex type definition for locally scoped declarations (see
     * scope), otherwise null if no such
     * definition exists.
     */
    public XSComplexTypeDefinition getEnclosingCTDefinition();

    /**
     * [Value constraint]: one of VC_NONE, VC_DEFAULT, VC_FIXED.
     */
    public short getConstraintType();

    /**
     * [Value constraint]: the constraint value with respect to the [type
     * definition], otherwise null.
     */
    public String getConstraintValue();

    /**
     * Value Constraint: Binding specific actual constraint value or
     * null if the value is in error or there is no value
     * constraint.
     * @exception XSException
     *   NOT_SUPPORTED_ERR: Raised if the implementation does not support this
     *   method.
     */
    public Object getActualVC()
                                            throws XSException;

    /**
     * The actual constraint value built-in datatype, e.g.
     * STRING_DT, SHORT_DT. If the type definition of this
     * value is a list type definition, this method returns
     * LIST_DT. If the type definition of this value is a list
     * type definition whose item type is a union type definition, this
     * method returns LISTOFUNION_DT. To query the actual
     * constraint value of the list or list of union type definitions use
     * itemValueTypes. If the actualNormalizedValue
     *  is null, this method returns UNAVAILABLE_DT
     * .
     * @exception XSException
     *   NOT_SUPPORTED_ERR: Raised if the implementation does not support this
     *   method.
     */
    public short getActualVCType()
                                            throws XSException;

    /**
     * In the case the actual constraint value represents a list, i.e. the
     * actualValueType is LIST_DT, the returned
     * array consists of one type kind which represents the itemType. If the
     * actual constraint value represents a list type definition whose item
     * type is a union type definition, i.e. LISTOFUNION_DT,
     * for each actual constraint value in the list the array contains the
     * corresponding memberType kind. For examples, see
     * ItemPSVI.itemValueTypes.
     * @exception XSException
     *   NOT_SUPPORTED_ERR: Raised if the implementation does not support this
     *   method.
     */
    public ShortList getItemValueTypes()
                                            throws XSException;

    /**
     *  If nillable is true, then an element may also be valid if it carries
     * the namespace qualified attribute with local name nil
     * from namespace http://www.w3.org/2001/XMLSchema-instance
     * and value true (xsi:nil) even if it has no text or
     * element content despite a content type which would
     * otherwise require content.
     */
    public boolean getNillable();

    /**
     * identity-constraint definitions: a set of constraint definitions if it
     * exists, otherwise an empty XSNamedMap.
     */
    public XSNamedMap getIdentityConstraints();

    /**
     * [substitution group affiliation]: a top-level element definition if it
     * exists, otherwise null.
     */
    public XSElementDeclaration getSubstitutionGroupAffiliation();

    /**
     * Convenience method that checks if exclusion is a
     * substitution group exclusion for this element declaration.
     * @param exclusion
     *   DERIVATION_EXTENSION, DERIVATION_RESTRICTION or
     *   DERIVATION_NONE. Represents final set for the element.
     * @return True if exclusion is a part of the substitution
     *   group exclusion subset.
     */
    public boolean isSubstitutionGroupExclusion(short exclusion);

    /**
     *  [substitution group exclusions]: the returned value is a bit
     * combination of the subset of {
     * DERIVATION_EXTENSION, DERIVATION_RESTRICTION} or
     * DERIVATION_NONE.
     */
    public short getSubstitutionGroupExclusions();

    /**
     * Convenience method that checks if disallowed is a
     * disallowed substitution for this element declaration.
     * @param disallowed {
     *   DERIVATION_SUBSTITUTION, DERIVATION_EXTENSION, DERIVATION_RESTRICTION
     *   } or DERIVATION_NONE. Represents a block set for the
     *   element.
     * @return True if disallowed is a part of the substitution
     *   group exclusion subset.
     */
    public boolean isDisallowedSubstitution(short disallowed);

    /**
     *  [disallowed substitutions]: the returned value is a bit combination of
     * the subset of {
     * DERIVATION_SUBSTITUTION, DERIVATION_EXTENSION, DERIVATION_RESTRICTION
     * } corresponding to substitutions disallowed by this
     * XSElementDeclaration or DERIVATION_NONE.
     */
    public short getDisallowedSubstitutions();

    /**
     * {abstract} A boolean.
     */
    public boolean getAbstract();

    /**
     * An annotation if it exists, otherwise null. If not null
     * then the first [annotation] from the sequence of annotations.
     */
    public XSAnnotation getAnnotation();

    /**
     * A sequence of [annotations] or an empty XSObjectList.
     */
    public XSObjectList getAnnotations();
}