org.apache.xerces.dom3.as.DOMASBuilder 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;

import org.w3c.dom.ls.LSInput;
import org.w3c.dom.ls.LSParser;

/**
 * @deprecated
 * An Abstract Schema parser interface.
 * DOMASBuilder provides an API for parsing Abstract Schemas 
 * and building the corresponding ASModel tree. 
 * See also the Document Object Model (DOM) Level 3 Abstract Schemas and Load
and Save Specification.
 */
public interface DOMASBuilder extends LSParser {
    /**
     *  Associate an ASModel with a LSParser. This
     * ASModel will be used by the "
     * validate-if-schema" and "
     * datatype-normalization" options during the load of a new 
     * Document. 
     */
    public ASModel getAbstractSchema();
    /**
     *  Associate an ASModel with a LSParser. This
     * ASModel will be used by the "
     * validate-if-schema" and "
     * datatype-normalization" options during the load of a new 
     * Document. 
     */
    public void setAbstractSchema(ASModel abstractSchema);

    /**
     * Parse a Abstract Schema from a location identified by an URI reference.
     * @param uri The location of the Abstract Schema to be read. 
     * @return The newly created Abstract Schema.
     * @exception DOMASException
     *   Exceptions raised by parseASURI() originate with the 
     *   installed ErrorHandler, and thus depend on the implementation of 
     *   the DOMErrorHandler interfaces. The default error 
     *   handlers will raise a DOMASException if any form of 
     *   Abstract Schema inconsistencies or warning occurs during the parse, 
     *   but application defined errorHandlers are not required to do so. 
     *   
 WRONG_MIME_TYPE_ERR: Raised when mimeTypeCheck is 
     *   true and the input source has an incorrect MIME Type. 
     *   See the attribute mimeTypeCheck. 
     * @exception DOMSystemException
     *   Exceptions raised by parseURI() originate with the 
     *   installed ErrorHandler, and thus depend on the implementation of 
     *   the DOMErrorHandler interfaces. The default error 
     *   handlers will raise a DOMSystemException if any form I/O or other 
     *   system error occurs during the parse, but application defined error 
     *   handlers are not required to do so. 
     */
    public ASModel parseASURI(String uri)
                              throws DOMASException, Exception;

    /**
     * Parse a Abstract Schema from a location identified by an 
     * LSInput.
     * @param is The LSInput from which the source
     *   Abstract Schema is to be read. 
     * @return The newly created ASModel.
     * @exception DOMASException
     *   Exceptions raised by parseASURI() originate with the 
     *   installed ErrorHandler, and thus depend on the implementation of 
     *   the DOMErrorHandler interfaces. The default error 
     *   handlers will raise a DOMASException if any form of 
     *   Abstract Schema inconsistencies or warning occurs during the parse, 
     *   but application defined errorHandlers are not required to do so. 
     *   
 Raise a WRONG_MIME_TYPE_ERR when mimeTypeCheck is 
     *   true and the inputsource has an incorrect MIME Type. 
     *   See attribute mimeTypeCheck. 
     * @exception DOMSystemException
     *   Exceptions raised by parseURI() originate with the 
     *   installed ErrorHandler, and thus depend on the implementation of 
     *   the DOMErrorHandler interfaces. The default error 
     *   handlers will raise a DOMSystemException if any form I/O or other 
     *   system error occurs during the parse, but application defined error 
     *   handlers are not required to do so. 
     */
    public ASModel parseASInputSource(LSInput is)
                                      throws DOMASException, Exception;

}