org.exist.validation.ValidationReport.java Source code

Introduction

Here is the source code for org.exist.validation.ValidationReport.java

Source

/*
 *  eXist Open Source Native XML Database
 *  Copyright (C) 2001-2010 The eXist Project
 *  http://exist-db.org
 *
 *  This program 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 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 Lesser General Public License for more details.
 *
 *  You should have received a copy of the GNU Lesser General Public
 *  License along with this library; if not, write to the Free Software
 *  Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA  02110-1301  USA
 *
 *  $Id$
 */
package org.exist.validation;

import java.io.PrintStream;
import org.xml.sax.ErrorHandler;
import org.xml.sax.SAXException;
import org.xml.sax.SAXParseException;

import java.util.ArrayList;
import java.util.List;
import org.apache.commons.io.output.ByteArrayOutputStream;

/**
 * Report containing all validation info (errors, warnings).
 *
 * @author Dannes Wessels (dizzzz@exist-db.org)
 *
 * @see org.xml.sax.ErrorHandler
 */
public class ValidationReport implements ErrorHandler {

    private List<ValidationReportItem> validationReport = new ArrayList<ValidationReportItem>();

    private ValidationReportItem lastItem;

    private long duration = -1L;
    private long start = -1L;
    private long stop = -1L;

    private Throwable throwed = null;
    private String namespaceUri = null;

    private ValidationReportItem createValidationReportItem(int type, SAXParseException exception) {

        final ValidationReportItem vri = new ValidationReportItem();
        vri.setType(type);
        vri.setLineNumber(exception.getLineNumber());
        vri.setColumnNumber(exception.getColumnNumber());
        vri.setMessage(exception.getMessage());
        vri.setPublicId(exception.getPublicId());
        vri.setSystemId(exception.getSystemId());
        return vri;
    }

    private void addItem(ValidationReportItem newItem) {
        if (lastItem == null) {
            // First reported item
            validationReport.add(newItem);
            lastItem = newItem;

        } else if (lastItem.getMessage().equals(newItem.getMessage())) {
            // Message is repeated
            lastItem.increaseRepeat();

        } else {
            // Received new message
            validationReport.add(newItem);

            // Swap reported item
            lastItem = newItem;
        }
    }

    /**
     *  Receive notification of a recoverable error.
     * @param exception The warning information encapsulated in a
     *                      SAX parse exception.
     * @throws SAXException Any SAX exception, possibly wrapping another
     *                      exception.
     */
    public void error(SAXParseException exception) throws SAXException {
        addItem(createValidationReportItem(ValidationReportItem.ERROR, exception));
    }

    /**
     *  Receive notification of a non-recoverable error.
     *
     * @param exception     The warning information encapsulated in a
     *                      SAX parse exception.
     * @throws SAXException Any SAX exception, possibly wrapping another
     *                      exception.
     */
    public void fatalError(SAXParseException exception) throws SAXException {
        addItem(createValidationReportItem(ValidationReportItem.FATAL, exception));
    }

    /**
     * Receive notification of a warning.
     *
     * @param exception     The warning information encapsulated in a
     *                      SAX parse exception.
     * @throws SAXException Any SAX exception, possibly wrapping another
     *                      exception.
     */
    public void warning(SAXParseException exception) throws SAXException {
        addItem(createValidationReportItem(ValidationReportItem.WARNING, exception));
    }

    public void setException(Throwable ex) {
        this.throwed = ex;
    }

    /**
     *  Give validation information of the XML document.
     *
     * @return FALSE if no errors and warnings occurred.
     */
    public boolean isValid() {
        return ((validationReport.size() == 0) && (throwed == null));
    }

    public List<ValidationReportItem> getValidationReportItemList() {
        return validationReport;
    }

    public List<String> getTextValidationReport() {

        final List<String> textReport = new ArrayList<String>();

        if (isValid()) {
            textReport.add("Document is valid.");
        } else {
            textReport.add("Document is not valid.");
        }

        if (throwed != null) {
            textReport.add("Exception: " + throwed.getMessage());
        }

        for (final ValidationReportItem item : validationReport) {
            textReport.add(item.toString());
        }

        textReport.add("Validated in " + duration + " millisec.");
        return textReport;
    }

    public String[] getValidationReportArray() {

        final List<String> vr = getTextValidationReport();
        final String report[] = new String[vr.size()];

        return vr.toArray(report);
    }

    public void setValidationDuration(long time) {
        duration = time;
    }

    public long getValidationDuration() {
        return duration;
    }

    @Override
    public String toString() {

        final StringBuilder sb = new StringBuilder();

        for (final String line : getTextValidationReport()) {
            sb.append(line);
            sb.append("\n");
        }

        return sb.toString();
    }

    public void start() {
        start = System.currentTimeMillis();
    }

    public void stop() {
        if (getValidationDuration() == -1L) { // not already stopped
            stop = System.currentTimeMillis();
            setValidationDuration(stop - start);
        }
    }

    public void setThrowable(Throwable throwable) {
        throwed = throwable;
    }

    public Throwable getThrowable() {
        return throwed;
    }

    public void setNamespaceUri(String namespace) {
        namespaceUri = namespace;
    }

    public String getNamespaceUri() {
        return namespaceUri;
    }

    public String getStackTrace() {

        if (throwed == null) {
            return null;
        }

        final ByteArrayOutputStream baos = new ByteArrayOutputStream();
        final PrintStream ps = new PrintStream(baos);
        throwed.printStackTrace(ps);

        return baos.toString();
    }
}