org.mycore.common.xml.MCRXMLParserErrorHandler Maven / Gradle / Ivy

Show more of this group Show more artifacts with this name
Show all versions of mycore-base Show documentation
There is a newer version: 2024.05
/*
 * This file is part of ***  M y C o R e  ***
 * See http://www.mycore.de/ for details.
 *
 * MyCoRe 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 3 of the License, or
 * (at your option) any later version.
 *
 * MyCoRe 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.
 *
 * You should have received a copy of the GNU General Public License
 * along with MyCoRe.  If not, see .
 */

package org.mycore.common.xml;

import org.apache.logging.log4j.LogManager;
import org.apache.logging.log4j.Logger;
import org.xml.sax.ErrorHandler;
import org.xml.sax.SAXParseException;

/**
 * Handles errors during XML parsing.
 * 
 * @author Frank L\u00FCtzenkirchen
 */
public class MCRXMLParserErrorHandler implements ErrorHandler {

    private static final Logger LOGGER = LogManager.getLogger(MCRXMLParserErrorHandler.class);

    protected boolean silent;

    public MCRXMLParserErrorHandler() {
        this(false);
    }

    public MCRXMLParserErrorHandler(boolean silent) {
        this.silent = silent;
    }

    /**
     * Handles parser warnings
     */
    public void warning(SAXParseException ex) {
        if (!silent) {
            LOGGER.warn(getSAXErrorMessage(ex), ex);
        }
    }

    /**
     * Handles parse errors
     */
    public void error(SAXParseException ex) {
        if (!silent) {
            LOGGER.error(getSAXErrorMessage(ex), ex);
        }
        throw new RuntimeException(ex);
    }

    /**
     * Handles fatal parse errors
     */
    public void fatalError(SAXParseException ex) {
        if (!silent) {
            LOGGER.fatal(getSAXErrorMessage(ex));
        }
        throw new RuntimeException(ex);
    }

    /**
     * Returns a text indicating at which line and column the error occured.
     * 
     * @param ex the SAXParseException exception
     * @return the location string
     */
    public static String getSAXErrorMessage(SAXParseException ex) {
        StringBuilder str = new StringBuilder();

        String systemId = ex.getSystemId();
        if (systemId != null) {
            int index = systemId.lastIndexOf('/');

            if (index != -1) {
                systemId = systemId.substring(index + 1);
            }

            str.append(systemId).append(": ");
        }

        str.append("line ").append(ex.getLineNumber());
        str.append(", column ").append(ex.getColumnNumber());
        str.append(", ");
        str.append(ex.getLocalizedMessage());

        return str.toString();
    }
}