com.runwaysdk.dataaccess.schemamanager.xml.XSDConstraintsManager.java Source code

Introduction

Here is the source code for com.runwaysdk.dataaccess.schemamanager.xml.XSDConstraintsManager.java

Source

/**
 * Copyright (c) 2015 TerraFrame, Inc. All rights reserved.
 *
 * This file is part of Runway SDK(tm).
 *
 * Runway SDK(tm) is free software: you can redistribute it and/or modify
 * it under the terms of the GNU Lesser General Public License as
 * published by the Free Software Foundation, either version 3 of the
 * License, or (at your option) any later version.
 *
 * Runway SDK(tm) 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 the
 * GNU Lesser General Public License for more details.
 *
 * You should have received a copy of the GNU Lesser General Public
 * License along with Runway SDK(tm).  If not, see <http://www.gnu.org/licenses/>.
 */
package com.runwaysdk.dataaccess.schemamanager.xml;

import java.io.File;
import java.io.IOException;
import java.net.URL;
import java.util.HashMap;
import java.util.Map;

import org.apache.commons.logging.Log;
import org.apache.commons.logging.LogFactory;
import org.xml.sax.ErrorHandler;
import org.xml.sax.SAXException;
import org.xml.sax.SAXParseException;

import com.runwaysdk.dataaccess.io.RunwayClasspathEntityResolver;
import com.runwaysdk.dataaccess.io.XMLParseException;
import com.runwaysdk.dataaccess.schemamanager.model.SchemaElementIF;
import com.sun.xml.xsom.XSSchemaSet;
import com.sun.xml.xsom.XSType;
import com.sun.xml.xsom.parser.XSOMParser;

/**
 * Manages the child sequencing constraints associated with different complex
 * types in the xml schemas Manages the child sequencing constraints associated
 * with different complex types in the xml schemas
 * 
 * @author Aritra
 * 
 */
public class XSDConstraintsManager {
    class ParseLogger implements ErrorHandler {
        private Log log = LogFactory.getLog(XSDConstraintsManager.class);

        @Override
        public void error(SAXParseException arg0) throws SAXException {
            log.error(arg0);
            throw new XMLParseException("An error occurred while parsing an XSD.", arg0);
        }

        @Override
        public void fatalError(SAXParseException arg0) throws SAXException {
            log.fatal(arg0);
            throw new XMLParseException("An error occurred while parsing an XSD.", arg0);
        }

        @Override
        public void warning(SAXParseException arg0) throws SAXException {
            log.warn(arg0);
        }

        /**
         * @param e
         */
        public void fatal(Exception e) {
            this.log.fatal(e);
        }
    }

    private ParseLogger logger;

    private Map<XSType, ContentPriorityIF> tagToConstraints;

    private XSSchemaSet schemaSet;

    public XSDConstraintsManager(String xsdLocation) {
        this.logger = new ParseLogger();
        this.tagToConstraints = new HashMap<XSType, ContentPriorityIF>();

        try {
            XSOMParser parser = new XSOMParser();
            parser.setEntityResolver(new RunwayClasspathEntityResolver());
            parser.setErrorHandler(logger);

            if (xsdLocation.startsWith("classpath:")) {
                // For some reason this parser isn't handling the entity resolver
                // properly. That's fine, we'll do it ourselves.
                parser.parse(new RunwayClasspathEntityResolver().resolveEntity("", xsdLocation));
            } else {
                boolean isURL = false;
                URL url = null;
                try {
                    url = new URL(xsdLocation);
                    url.toURI(); // Performs extra validation on the URL
                    isURL = true;
                } catch (Exception e) {
                }

                if (isURL && url != null) {
                    parser.parse(url);
                } else {
                    parser.parse(new File(xsdLocation));
                }
            }

            schemaSet = parser.getResult();

            if (schemaSet == null) {
                throw new XMLParseException(
                        "The parser returned a null result when parsing XSD [" + xsdLocation + "].");
            }
        } catch (SAXException e) {
            this.logger.fatal(e);
            throw new XMLParseException(e);
        } catch (IOException e) {
            this.logger.fatal(e);
            throw new XMLParseException(e);
        }
    }

    public ContentPriorityIF getConstraints(SchemaElementIF element) {
        XSType type = element.getXSType(schemaSet);

        if (tagToConstraints.containsKey(type)) {
            return tagToConstraints.get(type);
        } else {
            XSDConstraintsMiner constraintsMiner = new XSDConstraintsMiner();
            type.visit(constraintsMiner);
            ContentPriorityIF contentPriority = constraintsMiner.getContentPriority();
            return contentPriority;
        }

    }

    public XMLElementSorter<SchemaElementIF> childComparator(SchemaElementIF element) {
        return new XMLChildrenSorter(getConstraints(element));
    }

}