ddf.services.schematron

Class SchematronValidationService

java.lang.Object

ddf.services.schematron.SchematronValidationService

All Implemented Interfaces:

MetacardValidator, ReportingMetacardValidator, Describable

public class SchematronValidationService
extends Object
implements MetacardValidator, Describable, ReportingMetacardValidator

This pre-ingest service provides validation of an ingested XML document against a Schematron schema file.

When this service is instantiated at deployment time to the OSGi container it goes through 3 different preprocessing stages on the Schematron schema file. (These steps are required by the ISO Schematron implementation)

1. 1. Preprocess the Schematron schema with iso_dsdl_include.xsl. This is a macro processor to assemble the schema from various parts.
2. 2. Preprocess the output from stage 1 with iso_abstract_expand.xsl. This is a macro processor to convert abstract patterns to real patterns.
3. 3. Compile the Schematron schema into an XSLT script. This will use iso_svrl_for_xslt2.xsl (which in turn invokes iso_schematron_skeleton_for_saxon.xsl)

When XML documents are ingested, this service will run the XSLT generated by stage 3 against the XML document, validating it against the "compiled" Schematron schema file.

This service is using the SVRL script, hence the output of the validation will be an SVRL-formatted XML document.

Author:

rodgersh

See Also:

Schematron

Field Summary

Fields

Modifier and Type	Field and Description
static String	DEFAULT_THREAD_POOL_SIZE

Constructor Summary

Constructors

Constructor and Description
SchematronValidationService()

Method Summary

Modifier and Type	Method and Description
String	getDescription() Returns a description of the describable item.
String	getId() Returns the name, aka ID, of the describable item.
String	getOrganization() Returns the organization associated with the describable item.
String	getTitle() Returns the title of the describable item.
String	getVersion() Retrieve the version.
void	init()
void	setId(String id)
void	setNamespace(String namespace)
void	setPriority(int priority)
void	setSchematronFileNames(List<String> schematronFileNames)
void	setSuppressWarnings(boolean suppressWarnings)
void	validate(Metacard metacard) Validates a Metacard
Optional<MetacardValidationReport>	validateMetacard(Metacard metacard) Validates a Metacard.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

DEFAULT_THREAD_POOL_SIZE

public static final String DEFAULT_THREAD_POOL_SIZE

See Also:

Constant Field Values

Constructor Detail

SchematronValidationService

public SchematronValidationService()

Method Detail

init

public void init()
          throws SchematronInitializationException

Throws:

SchematronInitializationException

setSuppressWarnings

public void setSuppressWarnings(boolean suppressWarnings)

setSchematronFileNames

public void setSchematronFileNames(List<String> schematronFileNames)
                            throws SchematronInitializationException

Throws:

SchematronInitializationException

setNamespace

public void setNamespace(String namespace)

setPriority

public void setPriority(int priority)

validate

public void validate(Metacard metacard)
              throws ValidationException

Description copied from interface: MetacardValidator

Validates a Metacard

Specified by:

validate in interface MetacardValidator

Parameters:

metacard - Metacard to validate

Throws:

ValidationException - if any validation error occurs

getVersion

public String getVersion()

Description copied from interface: Describable

Retrieve the version.

Specified by:

getVersion in interface Describable

Returns:

the version of the item being described (example: 1.0)

getId

public String getId()

Description copied from interface: Describable

Returns the name, aka ID, of the describable item. The name should be unique for each instance.
Example: html for a MetacardTransformer that transforms Metacards to HTML

Specified by:

getId in interface Describable

Returns:

ID of the item

setId

public void setId(String id)

getTitle

public String getTitle()

Description copied from interface: Describable

Returns the title of the describable item. It is generally more verbose than the name (aka ID).

Specified by:

getTitle in interface Describable

Returns:

title of the item (example: Dummy Catalog Provider)

getDescription

public String getDescription()

Description copied from interface: Describable

Returns a description of the describable item.

Specified by:

getDescription in interface Describable

Returns:

description of the item (example: Provider that returns back static results)

getOrganization

public String getOrganization()

Description copied from interface: Describable

Returns the organization associated with the describable item.

Specified by:

getOrganization in interface Describable

Returns:

organizational name or acronym (example: USAF)

validateMetacard

public Optional<MetacardValidationReport> validateMetacard(Metacard metacard)

Description copied from interface: ReportingMetacardValidator

Validates a Metacard.

Specified by:

validateMetacard in interface ReportingMetacardValidator

Parameters:

metacard - the Metacard to validate, cannot be null

Returns:

an Optional containing a MetacardValidationReport if there are violations, or an empty Optional if there are no violations