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

/** * @deprecated * An Abstract Schema parser interface. * <p><code>DOMASBuilder</code> provides an API for parsing Abstract Schemas * and building the corresponding <code>ASModel</code> tree. * <p>See also the <a href='http://www.w3.org/TR/2001/WD-DOM-Level-3-ASLS-20011025'>Document Object Model (DOM) Level 3 Abstract Schemas and Load and Save Specification</a>. */
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.
/** * Associate an <code>ASModel</code> with a <code>LSParser</code>. This * <code>ASModel</code> will be used by the " * <code>validate-if-schema</code>" and " * <code>datatype-normalization</code>" options during the load of a new * <code>Document</code>. */
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.
/** * Associate an <code>ASModel</code> with a <code>LSParser</code>. This * <code>ASModel</code> will be used by the " * <code>validate-if-schema</code>" and " * <code>datatype-normalization</code>" options during the load of a new * <code>Document</code>. */
public void setAbstractSchema(ASModel abstractSchema);
Parse a Abstract Schema from a location identified by an URI reference.
Params:
  • uri – The location of the Abstract Schema to be read.
Throws:
  • 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.
  • 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.
Returns:The newly created Abstract Schema.
/** * 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 <code>parseASURI()</code> originate with the * installed ErrorHandler, and thus depend on the implementation of * the <code>DOMErrorHandler</code> interfaces. The default error * handlers will raise a <code>DOMASException</code> if any form of * Abstract Schema inconsistencies or warning occurs during the parse, * but application defined errorHandlers are not required to do so. * <br> WRONG_MIME_TYPE_ERR: Raised when <code>mimeTypeCheck</code> is * <code>true</code> and the input source has an incorrect MIME Type. * See the attribute <code>mimeTypeCheck</code>. * @exception DOMSystemException * Exceptions raised by <code>parseURI()</code> originate with the * installed ErrorHandler, and thus depend on the implementation of * the <code>DOMErrorHandler</code> 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.
Params:
  • is – The LSInput from which the source Abstract Schema is to be read.
Throws:
  • 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.
  • 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.
Returns:The newly created ASModel.
/** * Parse a Abstract Schema from a location identified by an * <code>LSInput</code>. * @param is The <code>LSInput</code> from which the source * Abstract Schema is to be read. * @return The newly created <code>ASModel</code>. * @exception DOMASException * Exceptions raised by <code>parseASURI()</code> originate with the * installed ErrorHandler, and thus depend on the implementation of * the <code>DOMErrorHandler</code> interfaces. The default error * handlers will raise a <code>DOMASException</code> if any form of * Abstract Schema inconsistencies or warning occurs during the parse, * but application defined errorHandlers are not required to do so. * <br> Raise a WRONG_MIME_TYPE_ERR when <code>mimeTypeCheck</code> is * <code>true</code> and the inputsource has an incorrect MIME Type. * See attribute <code>mimeTypeCheck</code>. * @exception DOMSystemException * Exceptions raised by <code>parseURI()</code> originate with the * installed ErrorHandler, and thus depend on the implementation of * the <code>DOMErrorHandler</code> 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; }