All Downloads are FREE. Search and download functionalities are using the official Maven repository.

org.qedeq.kernel.xml.parser.SaxParser Maven / Gradle / Ivy

/* This file is part of the project "Hilbert II" - http://www.qedeq.org
 *
 * Copyright 2000-2013,  Michael Meyling .
 *
 * "Hilbert II" is free software; you can redistribute
 * it and/or modify it under the terms of the GNU General Public
 * License as published by the Free Software Foundation; either
 * version 2 of the License, or (at your option) any later version.
 *
 * 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 the
 * GNU General Public License for more details.
 */
package org.qedeq.kernel.xml.parser;

import java.io.File;
import java.io.FileInputStream;
import java.io.IOException;
import java.io.InputStream;
import java.util.MissingResourceException;

import javax.xml.parsers.ParserConfigurationException;
import javax.xml.parsers.SAXParser;
import javax.xml.parsers.SAXParserFactory;

import org.qedeq.base.trace.Trace;
import org.qedeq.kernel.se.common.Plugin;
import org.qedeq.kernel.se.common.SourceFileException;
import org.qedeq.kernel.se.common.SourceFileExceptionList;
import org.qedeq.kernel.xml.common.XmlSyntaxException;
import org.qedeq.kernel.xml.handler.common.SaxDefaultHandler;
import org.qedeq.kernel.xml.handler.common.SimpleHandler;
import org.xml.sax.InputSource;
import org.xml.sax.SAXException;
import org.xml.sax.SAXNotRecognizedException;
import org.xml.sax.XMLReader;


/**
 * Parser for XML files. This class uses features specific for Xerces.
 *
 * @author Michael Meyling
 */
public final class SaxParser {

    /** This class. */
    private static final Class CLASS = SaxParser.class;

    /** Namespaces feature id (http://xml.org/sax/features/namespaces). */
    private static final String NAMESPACES_FEATURE_ID = "http://xml.org/sax/features/namespaces";

    /** Validation feature id (http://xml.org/sax/features/validation). */
    private static final String VALIDATION_FEATURE_ID = "http://xml.org/sax/features/validation";

    /** Schema validation feature id (http://apache.org/xml/features/validation/schema). */
    private static final String SCHEMA_VALIDATION_FEATURE_ID
        = "http://apache.org/xml/features/validation/schema";

    /** Schema full checking feature id
     * (http://apache.org/xml/features/validation/schema-full-checking). */
    protected static final String SCHEMA_FULL_CHECKING_FEATURE_ID
        = "http://apache.org/xml/features/validation/schema-full-checking";

    /** Handler which deals with the XML contents. */
    private SaxDefaultHandler handler;

    /** SAX parser. */
    private XMLReader reader;

    /** Simple handler for validation purpose only. */
    private final SimpleHandler deflt;

    /** Saved errors of parsing. */
    private SourceFileExceptionList exceptionList;

    /** Plugin we work for. */
    private Plugin plugin;

    /**
     * Constructor.
     *
     * @param   plugin    We work for this plugin.
     * @param   handler   Default handler for this application.
     * @throws  ParserConfigurationException    Severe parser configuration problem.
     * @throws  SAXException                    Option not recognized or supported.
     */
    public SaxParser(final Plugin plugin, final SaxDefaultHandler handler)
            throws ParserConfigurationException, SAXException {
        super();

        this.handler = handler;
        this.deflt = new SimpleHandler();
        this.plugin = plugin;

        final String factoryImpl = System.getProperty("javax.xml.parsers.SAXParserFactory");
        if (factoryImpl == null) {
            System.setProperty("javax.xml.parsers.SAXParserFactory",
                "org.apache.xerces.jaxp.SAXParserFactoryImpl");
        }
        SAXParserFactory factory = SAXParserFactory.newInstance();
        factory.setNamespaceAware(true);
        factory.setValidating(true);

        factory.setFeature(NAMESPACES_FEATURE_ID, true);
        factory.setFeature(VALIDATION_FEATURE_ID, true);

        try {
            factory.setFeature(SCHEMA_VALIDATION_FEATURE_ID, true);
        } catch (SAXNotRecognizedException e) {
            Trace.trace(CLASS, this, "constructor", e);
            // ignore
        }
        try {
            factory.setFeature(SCHEMA_FULL_CHECKING_FEATURE_ID, true);
        } catch (SAXNotRecognizedException e) {
            Trace.trace(CLASS, this, "constructor", e);
            // ignore
        }

        final SAXParser parser = factory.newSAXParser();
        if (!parser.isNamespaceAware()) {
            throw new ParserConfigurationException(
                "Current XML parser doesn't support namespaces.");
        }
        if (!parser.isValidating()) {
            throw new ParserConfigurationException(
                "Current XML parser doesn't support schema validation.");
        }

        reader = parser.getXMLReader();
        reader.setEntityResolver(new SaxEntityResolver(handler));

        // set parser features
        reader.setFeature(NAMESPACES_FEATURE_ID, true);
        reader.setFeature(VALIDATION_FEATURE_ID, true);
        try {
            reader.setFeature(SCHEMA_VALIDATION_FEATURE_ID, true);
        } catch (SAXNotRecognizedException e) {
            Trace.trace(CLASS, this, "constructor", e);
            // ignore
        }
        try {
            reader.setFeature(SCHEMA_FULL_CHECKING_FEATURE_ID, true);
        } catch (SAXNotRecognizedException e) {
            Trace.trace(CLASS, this, "constructor", e);
            // ignore
        }

    }

    /**
     * Parse input source.
     * @param   in              Parse data from this file source.
     * @param   validateOnly    validate with {@link #deflt} or parse with {@link #handler}.
     * @param   original        Original URL for the file. If this is null same as
     *                          file name.
     *
     * @throws  SourceFileExceptionList    Loading failed.
     */
    private void parse(final File in, final boolean validateOnly, final String original)
            throws SourceFileExceptionList {
        final String method = "parse(URL, boolean, InputStream)";
        InputStream stream = null;
        exceptionList = new SourceFileExceptionList();
        try {
            stream = new FileInputStream(in);
            final InputSource input = new InputSource(stream);
            reader.setErrorHandler(new SaxErrorHandler(plugin, original, exceptionList));
            handler.setUrl(original);
            deflt.setUrl(original);
            if (validateOnly) {
                try {
                    reader.setContentHandler(deflt);
                    reader.parse(input);
                } catch (MissingResourceException ex) {
                    throw new SAXException("For " + ex.getClassName() + " we searched for value"
                        + " of " + ex.getKey(), ex);
                }
            } else {
                handler.setExceptionList(exceptionList);
                reader.setContentHandler(handler);
                reader.parse(input);
            }
        } catch (SAXException e) {
            if (exceptionList.size() <= 0) {    // do we have already exceptions?
                // no, we must add this one
                final XmlSyntaxException xml = XmlSyntaxException.createBySAXException(e);
                exceptionList.add(new SourceFileException(plugin, xml, handler.createSourceArea(), null));
            }
            throw exceptionList;
        } catch (IOException e) {
            final XmlSyntaxException xml = XmlSyntaxException.createByIOException(e);
            exceptionList.add(new SourceFileException(plugin, xml, handler.createSourceArea(), null));
            throw exceptionList;
        } finally {
            if (stream != null) {
                try {
                    stream.close();
                } catch (Exception e) {
                    Trace.trace(CLASS, this, method, e);
                }
            }
        }
        if (exceptionList.size() > 0) {
            throw exceptionList;
        }
    }

    /**
     * Parses XML file.
     *
     * @param   fileName        File name.
     * @param   original        Original URL for the file. If this is null same as
     *                          file name.
     * @throws  SourceFileExceptionList    Loading failed.
     */
    public final void parse(final String fileName, final String original)
            throws SourceFileExceptionList {
        final File file = new File(fileName);
        parse(file.getAbsoluteFile(), original);
    }

    /**
     * Parses the XML file.
     *
     * @param   file            File to parse.
     * @param   original        Original URL for the file. If this is null same as
     *                          file.
     * @throws  SourceFileExceptionList    Loading failed.
     */
    public final void parse(final File file, final String original) throws SourceFileExceptionList {
        String org = original;
        if (org == null) {
            org = "" + file;
        }
        parse(file, true, org);
        parse(file, false, org);
    }

    /**
     * Get errors that occurred during last parsing.
     *
     * @return  List with collected Exceptions.
     */
    public SourceFileExceptionList getExceptionList() {
        return exceptionList;
    }

    /**
     * Get encoding of XML document. This value is set during parsing the document.
     *
     * @return  Encoding. Maybe null.
     */
    public String getEncoding() {
        return deflt.getEncoding();
    }

}




© 2015 - 2024 Weber Informatics LLC | Privacy Policy