/*
* The Apache Software License, Version 1.1
*
*
* Copyright (c) 2000,2001 The Apache Software Foundation. All rights
* reserved.
*
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions
* are met:
*
* 1. Redistributions of source code must retain the above copyright
* notice, this list of conditions and the following disclaimer.
*
* 2. Redistributions in binary form must reproduce the above copyright
* notice, this list of conditions and the following disclaimer in
* the documentation and/or other materials provided with the
* distribution.
*
* 3. The end-user documentation included with the redistribution,
* if any, must include the following acknowledgment:
* "This product includes software developed by the
* Apache Software Foundation (http://www.apache.org/)."
* Alternately, this acknowledgment may appear in the software itself,
* if and wherever such third-party acknowledgments normally appear.
*
* 4. The names "Xerces" and "Apache Software Foundation" must
* not be used to endorse or promote products derived from this
* software without prior written permission. For written
* permission, please contact apache@apache.org.
*
* 5. Products derived from this software may not be called "Apache",
* nor may "Apache" appear in their name, without prior written
* permission of the Apache Software Foundation.
*
* THIS SOFTWARE IS PROVIDED ``AS IS'' AND ANY EXPRESSED OR IMPLIED
* WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
* OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
* DISCLAIMED. IN NO EVENT SHALL THE APACHE SOFTWARE FOUNDATION OR
* ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
* SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
* LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF
* USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
* ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
* OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT
* OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
* SUCH DAMAGE.
* ====================================================================
*
* This software consists of voluntary contributions made by many
* individuals on behalf of the Apache Software Foundation and was
* originally based on software copyright (c) 1999, International
* Business Machines, Inc., http://www.apache.org. For more
* information on the Apache Software Foundation, please see
* <http://www.apache.org/>.
*/
package org.apache.xerces.parsers;
import java.io.InputStream;
import java.io.IOException;
import java.io.Reader;
import java.util.Vector;
import org.w3c.dom.DOMException;
import org.w3c.dom.Document;
import org.w3c.dom.Node;
import org.apache.xerces.dom3.ls.DOMEntityResolver;
import org.apache.xerces.dom3.ls.DOMInputSource;
import org.apache.xerces.dom3.as.ASModel;
import org.apache.xerces.dom3.as.DOMASBuilder;
import org.apache.xerces.dom3.as.DOMASException;
import org.apache.xerces.dom.ASModelImpl;
import org.apache.xerces.util.DOMEntityResolverWrapper;
import org.apache.xerces.util.DOMErrorHandlerWrapper;
import org.apache.xerces.xni.XNIException;
import org.apache.xerces.xni.parser.XMLConfigurationException;
import org.apache.xerces.xni.parser.XMLInputSource;
import org.apache.xerces.xni.parser.XMLParserConfiguration;
import org.apache.xerces.impl.validation.GrammarPool;
import org.apache.xerces.impl.xs.traversers.XSDHandler;
import org.apache.xerces.impl.xs.XSGrammarResolver;
import org.apache.xerces.impl.xs.SubstitutionGroupHandler;
import org.apache.xerces.impl.xs.models.CMBuilder;
import org.apache.xerces.impl.xs.SchemaSymbols;
import org.apache.xerces.impl.xs.SchemaGrammar;
import org.apache.xerces.impl.xs.XSConstraints;
import org.apache.xerces.impl.xs.XSDeclarationPool;
import org.apache.xerces.impl.Constants;
import org.apache.xerces.impl.XMLErrorReporter;
import org.apache.xerces.xni.parser.XMLEntityResolver;
import org.apache.xerces.xni.parser.XMLInputSource;
import org.apache.xerces.util.SymbolTable;
import org.apache.xerces.util.SymbolHash;
import org.apache.xerces.util.DOMUtil;
/**
* This is Abstract Schema DOM Builder class. It extends the DOMBuilderImpl
* class. Provides support for preparsing schemas.
*
* @author Pavani Mukthipudi, Sun Microsystems Inc.
* @author Neil Graham, IBM
* @version $Id: DOMASBuilderImpl.java,v 1.2 2001/12/14 22:08:00 sandygao Exp $
*
*/
public class DOMASBuilderImpl
extends DOMBuilderImpl implements DOMASBuilder {
//
// Constants
//
// Feature ids
protected static final String SCHEMA_FULL_CHECKING =
Constants.XERCES_FEATURE_PREFIX + Constants.SCHEMA_FULL_CHECKING;
// Property ids
protected static final String ERROR_REPORTER =
Constants.XERCES_PROPERTY_PREFIX + Constants.ERROR_REPORTER_PROPERTY;
protected static final String SYMBOL_TABLE =
Constants.XERCES_PROPERTY_PREFIX + Constants.SYMBOL_TABLE_PROPERTY;
protected static final String ENTITY_MANAGER =
Constants.XERCES_PROPERTY_PREFIX + Constants.ENTITY_MANAGER_PROPERTY;
//
// Data
//
protected XSGrammarResolver fGrammarResolver;
protected SubstitutionGroupHandler fSubGroupHandler;
protected CMBuilder fCMBuilder;
protected XSDHandler fSchemaHandler;
protected XMLErrorReporter fErrorReporter;
protected XMLEntityResolver fEntityResolver;
protected SymbolTable fSymbolTable;
protected GrammarPool fGrammarPool = null;
protected ASModelImpl fAbstractSchema;
//
// Constructors
//
/**
* Constructs a DOM Builder using the dtd/xml schema parser configuration.
*/
public DOMASBuilderImpl() {
super(new DTDXSParserConfiguration());
} // <init>
/**
* Constructs a DOM Builder using the specified parser configuration.
*/
public DOMASBuilderImpl(XMLParserConfiguration config) {
super(config);
} // <init>(XMLParserConfiguration)
/**
* Constructs a DOM Builder using the specified symbol table.
*/
public DOMASBuilderImpl(SymbolTable symbolTable) {
super(new DTDXSParserConfiguration(symbolTable));
} // <init>(SymbolTable)
/**
* Constructs a DOM Builder using the specified symbol table and
* grammar pool.
*/
public DOMASBuilderImpl(SymbolTable symbolTable, GrammarPool grammarPool) {
super(new DTDXSParserConfiguration(symbolTable, grammarPool));
fGrammarPool = grammarPool;
}
//
// DOMASBuilder methods
//
/**
* Associate an <code>ASModel</code> with a document instance. 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() {
return fAbstractSchema;
}
/**
* Associate an <code>ASModel</code> with a document instance. 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) {
// since the ASModel associated with this object is an attribute
// according to the DOM IDL, we must obliterate anything
// that was set before, rather than adding to it.
fAbstractSchema = (ASModelImpl)abstractSchema;
// make sure the GrammarPool is properly initialized.
if (fGrammarPool == null) {
fGrammarPool = (GrammarPool)fConfiguration.getProperty(StandardParserConfiguration.GRAMMAR_POOL);
}
initGrammarPool(fAbstractSchema);
}
// some constants that'll be added into the symbol table
String XMLNS;
String URI_XSI;
String XSI_SCHEMALOCATION;
String XSI_NONAMESPACESCHEMALOCATION;
String XSI_TYPE;
String XSI_NIL;
String URI_SCHEMAFORSCHEMA;
/**
* Parse a Abstract Schema from a location identified by an URI.
*
* @param uri The location of the Abstract Schema to be read.
* @return The newly created <code>Abstract Schema</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> WRONG_MIME_TYPE_ERR: Raised 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 parseASURI(String uri)
throws DOMASException, Exception {
if (fSchemaHandler == null) {
fGrammarResolver = new XSGrammarResolver();
fSubGroupHandler = new SubstitutionGroupHandler(fGrammarResolver);
fSchemaHandler = new XSDHandler(fGrammarResolver);
fCMBuilder = new CMBuilder(new XSDeclarationPool());
}
fErrorReporter = (XMLErrorReporter)fConfiguration.getProperty(ERROR_REPORTER);
fEntityResolver = (XMLEntityResolver)fConfiguration.getProperty(ENTITY_RESOLVER);
if (fEntityResolver == null)
fEntityResolver = (XMLEntityResolver)fConfiguration.getProperty(ENTITY_MANAGER);
fSymbolTable = (SymbolTable)fConfiguration.getProperty(SYMBOL_TABLE);
String externalSchemas =
(String)(fConfiguration.getProperty(Constants.XERCES_PROPERTY_PREFIX+Constants.SCHEMA_LOCATION));
String noNamespaceExternalSchemas =
(String)(fConfiguration.getProperty(Constants.XERCES_PROPERTY_PREFIX+Constants.SCHEMA_NONS_LOCATION));
XMLNS = fSymbolTable.addSymbol(SchemaSymbols.O_XMLNS);
URI_XSI = fSymbolTable.addSymbol(SchemaSymbols.URI_XSI);
XSI_SCHEMALOCATION = fSymbolTable.addSymbol(SchemaSymbols.OXSI_SCHEMALOCATION);
XSI_NONAMESPACESCHEMALOCATION = fSymbolTable.addSymbol(SchemaSymbols.OXSI_NONAMESPACESCHEMALOCATION);
XSI_TYPE = fSymbolTable.addSymbol(SchemaSymbols.OXSI_TYPE);
XSI_NIL = fSymbolTable.addSymbol(SchemaSymbols.OXSI_NIL);
URI_SCHEMAFORSCHEMA = fSymbolTable.addSymbol(SchemaSymbols.OURI_SCHEMAFORSCHEMA);
initGrammarResolver();
fSubGroupHandler.reset();
fSchemaHandler.reset(fErrorReporter, fEntityResolver, fSymbolTable, externalSchemas, noNamespaceExternalSchemas);
SchemaGrammar grammar = fSchemaHandler.parseSchema(null,uri);
if (getFeature(SCHEMA_FULL_CHECKING)) {
XSConstraints.fullSchemaChecking(fGrammarResolver, fSubGroupHandler, fCMBuilder, fErrorReporter);
}
ASModelImpl newAsModel = new ASModelImpl();
addGrammars(newAsModel, fGrammarResolver);
return newAsModel;
}
/**
* Parse a Abstract Schema from a location identified by an
* <code>DOMInputSource</code>.
*
* @param is The <code>DOMInputSource</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> WRONG_MIME_TYPE_ERR: Raised when <code>mimeTypeCheck</code> is
* true 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(DOMInputSource is)
throws DOMASException, Exception {
if (fSchemaHandler == null) {
fGrammarResolver = new XSGrammarResolver();
fSubGroupHandler = new SubstitutionGroupHandler(fGrammarResolver);
fSchemaHandler = new XSDHandler(fGrammarResolver);
fCMBuilder = new CMBuilder(new XSDeclarationPool());
}
fErrorReporter = (XMLErrorReporter)fConfiguration.getProperty(ERROR_REPORTER);
fEntityResolver = (XMLEntityResolver)fConfiguration.getProperty(ENTITY_RESOLVER);
fSymbolTable = (SymbolTable)fConfiguration.getProperty(SYMBOL_TABLE);
String externalSchemas =
(String)(fConfiguration.getProperty(Constants.XERCES_PROPERTY_PREFIX+Constants.SCHEMA_LOCATION));
String noNamespaceExternalSchemas =
(String)(fConfiguration.getProperty(Constants.XERCES_PROPERTY_PREFIX+Constants.SCHEMA_NONS_LOCATION));
XMLNS = fSymbolTable.addSymbol(SchemaSymbols.O_XMLNS);
URI_XSI = fSymbolTable.addSymbol(SchemaSymbols.URI_XSI);
XSI_SCHEMALOCATION = fSymbolTable.addSymbol(SchemaSymbols.OXSI_SCHEMALOCATION);
XSI_NONAMESPACESCHEMALOCATION = fSymbolTable.addSymbol(SchemaSymbols.OXSI_NONAMESPACESCHEMALOCATION);
XSI_TYPE = fSymbolTable.addSymbol(SchemaSymbols.OXSI_TYPE);
XSI_NIL = fSymbolTable.addSymbol(SchemaSymbols.OXSI_NIL);
URI_SCHEMAFORSCHEMA = fSymbolTable.addSymbol(SchemaSymbols.OURI_SCHEMAFORSCHEMA);
initGrammarResolver();
fSubGroupHandler.reset();
fSchemaHandler.reset(fErrorReporter, fEntityResolver, fSymbolTable, externalSchemas, noNamespaceExternalSchemas);
SchemaGrammar grammar = fSchemaHandler.parseSchema(is.getBaseURI(),is.getSystemId());
if (getFeature(SCHEMA_FULL_CHECKING)) {
XSConstraints.fullSchemaChecking(fGrammarResolver, fSubGroupHandler, fCMBuilder, fErrorReporter);
}
ASModelImpl newAsModel = new ASModelImpl();
addGrammars(newAsModel, fGrammarResolver);
return newAsModel;
}
// put all the grammars we have access to in the GrammarResolver
private void initGrammarResolver() {
fGrammarResolver.reset();
fGrammarResolver.putGrammar(URI_SCHEMAFORSCHEMA, SchemaGrammar.SG_SchemaNS);
if (fAbstractSchema != null)
initGrammarResolverRecurse(fAbstractSchema);
}
private void initGrammarResolverRecurse(ASModelImpl currModel) {
if(currModel.getGrammar() != null) {
fGrammarResolver.putGrammar(currModel.getGrammar());
}
for(int i = 0; i < currModel.getInternalASModels().size(); i++) {
ASModelImpl nextModel = (ASModelImpl)(currModel.getInternalASModels().elementAt(i));
initGrammarResolverRecurse(nextModel);
}
}
private void addGrammars(ASModelImpl model, XSGrammarResolver grammarResolver) {
SchemaGrammar [] grammarList = grammarResolver.getGrammars();
for(int i=0; i<grammarList.length; i++) {
ASModelImpl newModel = new ASModelImpl();
newModel.setGrammar(grammarList[i]);
model.addASModel(newModel);
}
} // addGrammars
private void initGrammarPool(ASModelImpl currModel) {
// put all the grammars in fAbstractSchema into the grammar pool.
SchemaGrammar grammar = null;
if((grammar = currModel.getGrammar()) != null) {
String tns = grammar.getTargetNamespace();
fGrammarPool.putGrammarNS(tns, grammar);
}
Vector modelStore = currModel.getInternalASModels();
for (int i = 0; i < modelStore.size(); i++) {
initGrammarPool((ASModelImpl)modelStore.elementAt(i));
}
}
} // class DOMASBuilderImpl