org.apache.xerces.dom3.as.ASElementDeclaration Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of xercesImpl Show documentation

Xerces2 is the next generation of high performance, fully compliant XML parsers in the Apache Xerces family. This new version of Xerces introduces the Xerces Native Interface (XNI), a complete framework for building parser components and configurations that is extremely modular and easy to program. The Apache Xerces2 parser is the reference implementation of XNI but other parser components, configurations, and parsers can be written using the Xerces Native Interface. For complete design and implementation documents, refer to the XNI Manual. Xerces2 is a fully conforming XML Schema 1.0 processor. A partial experimental implementation of the XML Schema 1.1 Structures and Datatypes Working Drafts (December 2009) and an experimental implementation of the XML Schema Definition Language (XSD): Component Designators (SCD) Candidate Recommendation (January 2010) are provided for evaluation. For more information, refer to the XML Schema page. Xerces2 also provides a complete implementation of the Document Object Model Level 3 Core and Load/Save W3C Recommendations and provides a complete implementation of the XML Inclusions (XInclude) W3C Recommendation. It also provides support for OASIS XML Catalogs v1.1. Xerces2 is able to parse documents written according to the XML 1.1 Recommendation, except that it does not yet provide an option to enable normalization checking as described in section 2.13 of this specification. It also handles namespaces according to the XML Namespaces 1.1 Recommendation, and will correctly serialize XML 1.1 documents if the DOM level 3 load/save APIs are in use.

The newest version!

/*
 * Copyright (c) 2001 World Wide Web Consortium,
 * (Massachusetts Institute of Technology, Institut National de
 * Recherche en Informatique et en Automatique, Keio University). All
 * Rights Reserved. This program is distributed under the W3C's Software
 * Intellectual Property License. This program is distributed in the
 * hope that it will be useful, but WITHOUT ANY WARRANTY; without even
 * the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR
 * PURPOSE.
 * See W3C License http://www.w3.org/Consortium/Legal/ for more details.
 */

package org.apache.xerces.dom3.as;

/**
 * @deprecated
 * The element name along with the content specification in the context of an 
 * ASObject.
 * See also the Document Object Model (DOM) Level 3 Abstract Schemas and Load
and Save Specification.
 */
public interface ASElementDeclaration extends ASObject {
    // CONTENT_MODEL_TYPES
    /**
     * Represents an EMPTY content type for an Element declaration.
     */
    public static final short EMPTY_CONTENTTYPE         = 1;
    /**
     * Represents an ANY content type for an Element declaration.
     */
    public static final short ANY_CONTENTTYPE           = 2;
    /**
     * Represents a MIXED content type for an Element declaration. Note that 
     * isPCDataOnly would also need to checked, in addition to 
     * this, if an element's content model was simply text, as an example. 
     */
    public static final short MIXED_CONTENTTYPE         = 3;
    /**
     * Represents an ELEMENTS only content type for an Element declaration.
     */
    public static final short ELEMENTS_CONTENTTYPE      = 4;

    /**
     * A boolean defining whether the element order and number of the child 
     * elements for mixed content type has to be respected or not. For 
     * example XML Schema defined mixed content types the order is important 
     * and needs to be respected whether for DTD based AS the order and 
     * number of child elements are not important.
     */
    public boolean getStrictMixedContent();
    /**
     * A boolean defining whether the element order and number of the child 
     * elements for mixed content type has to be respected or not. For 
     * example XML Schema defined mixed content types the order is important 
     * and needs to be respected whether for DTD based AS the order and 
     * number of child elements are not important.
     */
    public void setStrictMixedContent(boolean strictMixedContent);

    /**
     * Datatype of the element.
     */
    public ASDataType getElementType();
    /**
     * Datatype of the element.
     */
    public void setElementType(ASDataType elementType);

    /**
     * Boolean defining whether the element type contains child elements and 
     * PCDATA or PCDATA only for mixed element types. true if 
     * the element is of type PCDATA only. Relevant only for mixed content 
     * type elements. 
     */
    public boolean getIsPCDataOnly();
    /**
     * Boolean defining whether the element type contains child elements and 
     * PCDATA or PCDATA only for mixed element types. true if 
     * the element is of type PCDATA only. Relevant only for mixed content 
     * type elements. 
     */
    public void setIsPCDataOnly(boolean isPCDataOnly);

    /**
     * The content type of the element. One of EMPTY_CONTENTTYPE, 
     * ANY_CONTENTTYPE, MIXED_CONTENTTYPE, 
     * ELEMENTS_CONTENTTYPE.
     */
    public short getContentType();
    /**
     * The content type of the element. One of EMPTY_CONTENTTYPE, 
     * ANY_CONTENTTYPE, MIXED_CONTENTTYPE, 
     * ELEMENTS_CONTENTTYPE.
     */
    public void setContentType(short contentType);

    /**
     * the URI reference representing the system identifier for the notation 
     * declaration, if present, null otherwise.
     */
    public String getSystemId();
    /**
     * the URI reference representing the system identifier for the notation 
     * declaration, if present, null otherwise.
     */
    public void setSystemId(String systemId);

    /**
     * The content model of element.
     */
    public ASContentModel getAsCM();
    /**
     * The content model of element.
     */
    public void setAsCM(ASContentModel asCM);

    /**
     * TheASNamedObjectMap containing 
     * ASAttributeDeclarations for all the attributes that can 
     * appear on this type of element.
     */
    public ASNamedObjectMap getASAttributeDecls();
    /**
     * TheASNamedObjectMap containing 
     * ASAttributeDeclarations for all the attributes that can 
     * appear on this type of element.
     */
    public void setASAttributeDecls(ASNamedObjectMap ASAttributeDecls);

    /**
     * Adds an ASAttributeDeclaration for the element being 
     * declared.
     * @param attributeDecl The new attribute to add. If the attribute 
     *   declaration already exists for the element, the call does not have 
     *   any effect.
     */
    public void addASAttributeDecl(ASAttributeDeclaration attributeDecl);

    /**
     * Removes an ASAttributeDeclaration from the element being 
     * declared.
     * @param attributeDecl The attribute declaraition to be removed. If the 
     *   attribute declaration does not exist for the element, the call does 
     *   not have any effect.
     * @return null if the attribute does not exist. Otherwise 
     *   returns the attribute being removed.
     */
    public ASAttributeDeclaration removeASAttributeDecl(ASAttributeDeclaration attributeDecl);

}