xerces-2_12_1-xml-schema-1.1.samples.xs.XSSerializer Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of ibis-xerces Show documentation
Show all versions of ibis-xerces 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.
/*
* Licensed to the Apache Software Foundation (ASF) under one or more
* contributor license agreements. See the NOTICE file distributed with
* this work for additional information regarding copyright ownership.
* The ASF licenses this file to You 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 xs;
import java.io.StringReader;
import javax.xml.XMLConstants;
import javax.xml.parsers.DocumentBuilder;
import javax.xml.parsers.DocumentBuilderFactory;
import org.apache.xerces.impl.Constants;
import org.apache.xerces.impl.dv.xs.XSSimpleTypeDecl;
import org.apache.xerces.impl.xs.SchemaSymbols;
import org.apache.xerces.impl.xs.XMLSchemaLoader;
import org.apache.xerces.impl.xs.XSAnnotationImpl;
import org.apache.xerces.impl.xs.XSAttributeDecl;
import org.apache.xerces.impl.xs.XSAttributeGroupDecl;
import org.apache.xerces.impl.xs.XSComplexTypeDecl;
import org.apache.xerces.impl.xs.XSElementDecl;
import org.apache.xerces.impl.xs.XSGroupDecl;
import org.apache.xerces.impl.xs.XSModelGroupImpl;
import org.apache.xerces.impl.xs.XSWildcardDecl;
import org.apache.xerces.impl.xs.identity.Field;
import org.apache.xerces.impl.xs.identity.IdentityConstraint;
import org.apache.xerces.impl.xs.identity.KeyRef;
import org.apache.xerces.impl.xs.identity.Selector;
import org.apache.xerces.impl.xs.util.XS11TypeHelper;
import org.apache.xerces.xs.StringList;
import org.apache.xerces.xs.XSAttributeUse;
import org.apache.xerces.xs.XSComplexTypeDefinition;
import org.apache.xerces.xs.XSConstants;
import org.apache.xerces.xs.XSElementDeclaration;
import org.apache.xerces.xs.XSFacet;
import org.apache.xerces.xs.XSIDCDefinition;
import org.apache.xerces.xs.XSModel;
import org.apache.xerces.xs.XSModelGroup;
import org.apache.xerces.xs.XSMultiValueFacet;
import org.apache.xerces.xs.XSNamedMap;
import org.apache.xerces.xs.XSObject;
import org.apache.xerces.xs.XSObjectList;
import org.apache.xerces.xs.XSParticle;
import org.apache.xerces.xs.XSSimpleTypeDefinition;
import org.apache.xerces.xs.XSTerm;
import org.apache.xerces.xs.XSTypeDefinition;
import org.apache.xerces.xs.XSValue;
import org.apache.xerces.xs.XSWildcard;
import org.w3c.dom.DOMException;
import org.w3c.dom.Document;
import org.w3c.dom.Element;
import org.w3c.dom.bootstrap.DOMImplementationRegistry;
import org.w3c.dom.ls.DOMImplementationLS;
import org.w3c.dom.ls.LSOutput;
import org.w3c.dom.ls.LSSerializer;
import org.xml.sax.InputSource;
/**
* XSModel serialization utility.
* This utility serializes the Xerces XSModel instance into lexical, XSD syntax.
*
* @author Mukul Gandhi, IBM
* @version $Id$
*/
public class XSSerializer {
private static final String XSD_LANGUAGE_URI = SchemaSymbols.URI_SCHEMAFORSCHEMA;
private static final String XML_SCHEMA_VERSION = Constants.XERCES_PROPERTY_PREFIX + Constants.XML_SCHEMA_VERSION_PROPERTY;
private static String XSD_LANGUAGE_PREFIX = "xs:";
/*
* "Main method"
*
* An entry point to test this utility.
*
* The XSModel could be synthesized by various means (for example, by direct
* API calls to Xerces Schema API, methods) -- in which case, the method
* "serialize" will be used directly, passing in the XSModel object.
*/
public static void main(String[] args) {
if (args.length == 0 || args.length > 5) {
printUsage();
System.exit(-1);
}
// the last command line argument must be a schema URI
String schemaUri = args[args.length - 1];
// iterate other command line arguments
String schemaVersion = null;
String schemaPrefix = null;
for (int argIndx = 0; argIndx < args.length - 1; argIndx += 2) {
if (args[argIndx].equals("-version")) {
schemaVersion = args[argIndx + 1];
}
else if (args[argIndx].equals("-prefix")) {
if (argIndx + 1 < args.length - 1) {
schemaPrefix = args[argIndx + 1];
}
}
}
XMLSchemaLoader xsLoader = new XMLSchemaLoader();
if ("1.1".equals(schemaVersion)) {
xsLoader.setProperty(XML_SCHEMA_VERSION, Constants.W3C_XML_SCHEMA11_NS_URI);
}
else if (schemaVersion != null && !"1.0".equals(schemaVersion)) {
printUsage();
System.exit(-1);
}
if (schemaPrefix != null) {
XSD_LANGUAGE_PREFIX = schemaPrefix + ":";
}
// construct the XSModel object from a schema document
XSModel xsModel = xsLoader.loadURI(schemaUri);
try {
// instantiate the serializer and invoke serialization method
XSSerializer xsSerializer = new XSSerializer();
xsSerializer.serialize(xsModel);
}
catch(Exception ex) {
ex.printStackTrace();
}
} // main
/*
* Print a diagnostic message, explaining how to invoke this sample.
*/
private static void printUsage() {
System.err.println("Usage:");
System.err.println("java xs.XSSerializer [options] schema.xsd");
System.err.println("\nOptions:");
System.err.println("-version [1.0|1.1] XSD language level (default level is 1.0)");
System.err.println("-prefix XSD language URI prefix (for e.g 'xs' or 'xsd'), for the serialized output");
} // printUsage
/*
* Serialize an XML Schema, XSModel object to the standard output.
*/
public void serialize(XSModel xsModel) throws Exception {
//get DOM after conversion, from XSModel
Document xsdDocument = transformXSModelToDOMTree(xsModel);
// serialize the DOM to XML Schema document
DOMImplementationRegistry registry = DOMImplementationRegistry.newInstance();
DOMImplementationLS impl = (DOMImplementationLS) registry.getDOMImplementation("LS");
LSSerializer writer = impl.createLSSerializer();
writer.getDomConfig().setParameter("format-pretty-print", Boolean.TRUE);
LSOutput output = impl.createLSOutput();
output.setEncoding("UTF-8");
output.setByteStream(System.out);
writer.write(xsdDocument, output);
} // serialize
/*
* Transform an XML Schema, XSModel object into DOM document.
*/
public Document transformXSModelToDOMTree(XSModel xsModel) throws Exception {
DocumentBuilderFactory dbf = DocumentBuilderFactory.newInstance();
DocumentBuilder dBuilder = dbf.newDocumentBuilder();
Document document = dBuilder.newDocument();
Element schemaDeclDomNode = document.createElementNS(XSD_LANGUAGE_URI, XSD_LANGUAGE_PREFIX + SchemaSymbols.ELT_SCHEMA);
document.appendChild(schemaDeclDomNode);
// process global element declarations
XSNamedMap globalElemDecls = xsModel.getComponents(XSConstants.ELEMENT_DECLARATION);
processGlobalElementDecl(globalElemDecls, document, schemaDeclDomNode);
// process global complex type declarations
XSNamedMap globalComplexTypeDecls = xsModel.getComponents(XSTypeDefinition.COMPLEX_TYPE);
processGlobalComplexTypeDecl(globalComplexTypeDecls, document, schemaDeclDomNode);
// process global simple type declarations
XSNamedMap globalSimpleTypeDecls = xsModel.getComponents(XSTypeDefinition.SIMPLE_TYPE);
processGlobalSimpleTypeDecl(globalSimpleTypeDecls, document, schemaDeclDomNode);
// process global attribute declarations
XSNamedMap globalAttrDecls = xsModel.getComponents(XSConstants.ATTRIBUTE_DECLARATION);
processGlobalAttrDecl(globalAttrDecls, document, schemaDeclDomNode);
// process global attribute group declarations
XSNamedMap globalAttrGroupDecls = xsModel.getComponents(XSConstants.ATTRIBUTE_GROUP);
processGlobalAttrGroupDecl(globalAttrGroupDecls, document, schemaDeclDomNode);
// process global model group declarations
XSNamedMap globalGroupDecls = xsModel.getComponents(XSConstants.MODEL_GROUP_DEFINITION);
processGlobalGroupDecl(globalGroupDecls, document, schemaDeclDomNode);
return document;
} // transformXSModelToDOMTree
/*
* Process global attribute group declarations.
*/
private void processGlobalAttrGroupDecl(XSNamedMap globalAttrGpDecls, Document document, Element schemaDeclDomNode) {
// iterating global attribute group declarations in the Schema
for (int attrGpIdx = 0; attrGpIdx < globalAttrGpDecls.size(); attrGpIdx++) {
XSAttributeGroupDecl attrGpDecl = (XSAttributeGroupDecl) globalAttrGpDecls.item(attrGpIdx);
String attrGpName = attrGpDecl.getName();
Element attrGpDomNode = document.createElementNS(XSD_LANGUAGE_URI, XSD_LANGUAGE_PREFIX + SchemaSymbols.ELT_ATTRIBUTEGROUP);
attrGpDomNode.setAttributeNS(null, SchemaSymbols.ATT_NAME, attrGpName);
// add annotation to attribute group
XSAnnotationImpl attrGpAnnotation = (XSAnnotationImpl) attrGpDecl.getAnnotation();
if (attrGpAnnotation != null) {
addAnnotationToSchemaComponent(document, attrGpDomNode, attrGpAnnotation);
}
XSObjectList attrUses = attrGpDecl.getAttributeUses();
for (int attrUsesIdx = 0; attrUsesIdx < attrUses.size(); attrUsesIdx++) {
XSAttributeUse attrUse = (XSAttributeUse) attrUses.item(attrUsesIdx);
XSAttributeDecl attrDecl = (XSAttributeDecl) attrUse.getAttrDeclaration();
String constraintName = null;
String constraintVal = null;
if (attrUse.getConstraintType() != XSConstants.VC_NONE) {
constraintName = (attrUse.getConstraintType() == XSConstants.VC_DEFAULT) ? SchemaSymbols.ATT_DEFAULT : SchemaSymbols.ATT_FIXED;
XSValue xsConstraintVal = attrUse.getValueConstraintValue();
constraintVal = xsConstraintVal.getNormalizedValue();
}
String requiredVal = (attrUse.getRequired() == true) ? SchemaSymbols.ATTVAL_REQUIRED : SchemaSymbols.ATTVAL_OPTIONAL;
addAttributeToSchemaComponent(document, attrGpDomNode, attrDecl, constraintName, constraintVal, requiredVal);
}
// possible serialization of