org.opengis.cite.iso19142.util.ValidationUtils Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of ets-wfs20 Show documentation
Show all versions of ets-wfs20 Show documentation
Checks WFS 2.0 implementations for conformance to ISO 19142:2010.
package org.opengis.cite.iso19142.util;
import java.io.File;
import java.io.IOException;
import java.net.URI;
import java.net.URL;
import java.util.logging.Level;
import javax.xml.XMLConstants;
import javax.xml.namespace.QName;
import javax.xml.stream.XMLEventReader;
import javax.xml.stream.XMLInputFactory;
import javax.xml.stream.XMLStreamException;
import javax.xml.stream.events.Attribute;
import javax.xml.stream.events.StartElement;
import javax.xml.transform.Source;
import javax.xml.transform.stream.StreamSource;
import javax.xml.validation.Schema;
import org.apache.xerces.util.XMLCatalogResolver;
import org.opengis.cite.iso19142.Namespaces;
import org.opengis.cite.validation.SchematronValidator;
import org.opengis.cite.validation.XmlSchemaCompiler;
import org.w3c.dom.ls.LSResourceResolver;
import org.xml.sax.SAXException;
/**
* A utility class that provides convenience methods to support schema
* validation.
*/
public class ValidationUtils {
private static final XMLCatalogResolver SCH_RESOLVER = initCatalogResolver();
static final String ROOT_PKG = "/org/opengis/cite/iso19142/";
private static XMLCatalogResolver initCatalogResolver() {
return (XMLCatalogResolver) createSchemaResolver(Namespaces.SCH);
}
/**
* Creates a resource resolver suitable for locating schemas using an entity
* catalog. In effect, local copies of standard schemas are returned instead
* of retrieving them from external repositories.
*
* @param schemaLanguage
* A URI that identifies a schema language by namespace name.
* @return A {@code LSResourceResolver} object that is configured to use an
* OASIS entity catalog.
*/
public static LSResourceResolver createSchemaResolver(URI schemaLanguage) {
String catalogFileName;
if (schemaLanguage.equals(Namespaces.XSD)) {
catalogFileName = "schema-catalog.xml";
} else {
catalogFileName = "schematron-catalog.xml";
}
URL catalogURL = ValidationUtils.class.getResource(ROOT_PKG
+ catalogFileName);
XMLCatalogResolver resolver = new XMLCatalogResolver();
resolver.setCatalogList(new String[] { catalogURL.toString() });
return resolver;
}
/**
* Constructs a SchematronValidator that will check an XML resource against
* the rules defined in a Schematron schema. An attempt is made to resolve
* the schema reference using an entity catalog; if this fails the reference
* is used as given.
*
* @param schemaRef
* A reference to a Schematron schema; this is expected to be a
* relative or absolute URI value, possibly matching the system
* identifier for some entry in an entity catalog.
* @param phase
* The name of the phase to invoke.
* @return A SchematronValidator instance, or {@code null} if the validator
* cannot be constructed (e.g. invalid schema reference or phase
* name).
*/
public static SchematronValidator buildSchematronValidator(
String schemaRef, String phase) {
Source source = null;
try {
String catalogRef = SCH_RESOLVER
.resolveSystem(schemaRef.toString());
if (null != catalogRef) {
source = new StreamSource(URI.create(catalogRef).toString());
} else {
source = new StreamSource(schemaRef);
}
} catch (IOException x) {
TestSuiteLogger.log(Level.WARNING,
"Error reading Schematron schema catalog.", x);
}
SchematronValidator validator = null;
try {
validator = new SchematronValidator(source, phase);
} catch (Exception e) {
TestSuiteLogger.log(Level.WARNING,
"Error creating Schematron validator.", e);
}
return validator;
}
/**
* Extracts an XML Schema reference from a source XML document. The
* resulting URI value refers to the schema whose target namespace matches
* the namespace of the document element.
*
* @param source
* The source instance to read from; its base URI (systemId)
* should be set. The document element is expected to include the
* standard xsi:schemaLocation attribute.
* @param baseURI
* An alternative base URI to use if the source does not have a
* system identifier set or if its system id is a {@code file}
* URI. This will usually be the URI used to retrieve the
* resource; it may be null.
* @return An absolute URI reference specifying the location of an XML
* Schema resource, or {@code null} if no reference is found.
* @throws XMLStreamException
* If an error occurs while reading the source instance.
*/
public static URI extractSchemaReference(Source source, String baseURI)
throws XMLStreamException {
XMLInputFactory factory = XMLInputFactory.newInstance();
XMLEventReader reader = factory.createXMLEventReader(source);
// advance to document element
StartElement docElem = reader.nextTag().asStartElement();
QName qName = docElem.getName();
String namespace = qName.getNamespaceURI();
Attribute schemaLoc = docElem.getAttributeByName(new QName(
XMLConstants.W3C_XML_SCHEMA_INSTANCE_NS_URI, "schemaLocation"));
String[] uriValues = new String[] {};
if (null != schemaLoc) {
uriValues = schemaLoc.getValue().split("\\s");
}
URI schemaURI = null;
// one or more pairs of [namespace name] [schema location]
for (int i = 0; i < uriValues.length; i += 2) {
if (uriValues[i].equals(namespace)) {
if (!URI.create(uriValues[i + 1]).isAbsolute()
&& (null != source.getSystemId())) {
String schemaRef = URIUtils.resolveRelativeURI(
source.getSystemId(), uriValues[i + 1]);
if (schemaRef.startsWith("file")
&& !new File(schemaRef).exists()
&& (null != baseURI)) {
schemaRef = URIUtils.resolveRelativeURI(baseURI,
uriValues[i + 1]);
}
schemaURI = URI.create(schemaRef);
} else {
schemaURI = URI.create(uriValues[i + 1]);
}
break;
}
}
return schemaURI;
}
/**
* Creates a single Schema object representing the complete set of XML
* Schema constraints that apply to WFS 2.0 message entities.
*
* @return An immutable Schema object, or null if one cannot be
* constructed.
*
* @see XML Schema for WFS 2.0
*/
public static Schema createWFSSchema() {
URL entityCatalog = ValidationUtils.class.getResource(ROOT_PKG
+ "schema-catalog.xml");
XmlSchemaCompiler xsdCompiler = new XmlSchemaCompiler(entityCatalog);
Schema wfsSchema = null;
try {
URL schemaURL = ValidationUtils.class.getResource(ROOT_PKG
+ "xsd/opengis/wfs/2.0/wfs.xsd");
Source xsdSource = new StreamSource(schemaURL.toString());
wfsSchema = xsdCompiler
.compileXmlSchema(new Source[] { xsdSource });
} catch (SAXException e) {
TestSuiteLogger.log(Level.WARNING,
"Failed to create WFS Schema object.", e);
}
return wfsSchema;
}
}
© 2015 - 2025 Weber Informatics LLC | Privacy Policy