org.mustangproject.validator.Validator Maven / Gradle / Ivy

package org.mustangproject.validator;

import java.io.ByteArrayInputStream;
import java.io.IOException;
import java.net.URL;

import javax.xml.XMLConstants;
import javax.xml.transform.Source;
import javax.xml.transform.stream.StreamSource;
import javax.xml.validation.Schema;
import javax.xml.validation.SchemaFactory;

import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import org.xml.sax.SAXException;

//abstract class
public abstract class Validator {
	private static final Logger LOGGER = LoggerFactory.getLogger(Validator.class.getCanonicalName()); // log output
	
	protected ValidationContext context;
	
	public Validator(ValidationContext ctx){
		this.context=ctx;
	}
	
	//abstract method

	/***
	 * prepare validation
	 * @param filename the filename of the xml file to be examined
	 * @throws IrrecoverableValidationError when any fatal errors arise, e.g. when the source file can not be found
	 */
	public abstract void setFilename(String filename) throws IrrecoverableValidationError;

	/***
	 * perform the validation
	 * @throws IrrecoverableValidationError any fatal errors, e.g. when the source file can not be found
	 */
	public abstract void validate() throws IrrecoverableValidationError;

	/**
	 * get validation result
	 * @return validation result as xml string
	 */
	public String getXMLResult() {
		return context.getXMLResult();
	}
	
	/***
	 * validates a schema, which can only be needed in XML validation - and in pdf validation for additional data
	 * @param xmlRawData the XML to be validated
	 * @param schemaPath the filename of the schema file
	 * @param section the error message type code
	 * @param part whether the error message occurs in the pdf or xml part
	 * @throws IrrecoverableValidationError when any fatal errors arise, e.g. when the source file can not be found
	 */
	protected void validateSchema(byte[] xmlRawData, String schemaPath, int section, EPart part) throws IrrecoverableValidationError {
		URL schemaFile = Thread.currentThread().getContextClassLoader().getResource("schema/" + schemaPath);
		Source xmlData = new StreamSource(new ByteArrayInputStream(xmlRawData));
		SchemaFactory schemaFactory = SchemaFactory.newInstance(XMLConstants.W3C_XML_SCHEMA_NS_URI);
		try {
			Schema schema = schemaFactory.newSchema(schemaFile);
			javax.xml.validation.Validator validator = schema.newValidator();
			validator.validate(xmlData);
		} catch (SAXException e) {
			context.addResultItem(new ValidationResultItem(ESeverity.error, "schema validation fails:" + e)
					.setSection(section).setPart(part));
		} catch (IOException e) {
			LOGGER.error(e.getMessage(), e);
		}

	}



}