eu.cessda.cmv.core

Class CessdaMetadataValidatorFactory

java.lang.Object

eu.cessda.cmv.core.CessdaMetadataValidatorFactory

All Implemented Interfaces:

ValidationService

public class CessdaMetadataValidatorFactory
extends Object
implements ValidationService

Constructor Summary

Constructors

Constructor and Description
CessdaMetadataValidatorFactory()

Method Summary

Modifier and Type	Method and Description
static Set<String>	getConstraints() Return a set of all known constraints.
static ValidationGate	getValidationGate(ValidationGateName name) Returns a validation gate with the given name.
Document	newDocument(Document document) Parse the XML contained in the request to a Document.
Document	newDocument(File file) Parse the XML at the given file into a Document.
Document	newDocument(InputSource inputSource) Parse the given XML into a Document.
Document	newDocument(InputStream inputStream) Parse the XML located at the given URL into a Document.
Document	newDocument(Path path) Parse the XML at the given path into a Document.
Document	newDocument(URI uri) Parse the XML located at the given URI into a Document.
Document	newDocument(URL url) Parse the XML located at the given URL into a Document.
Profile	newProfile(Document profile) Parse the XML represented by the given request into a Profile.
Profile	newProfile(File file) Parse the XML located at the given file into a Profile.
Profile	newProfile(InputSource inputSource) Parse the XML represented by the given input source into a Profile.
Profile	newProfile(InputStream inputStream) Parse the XML represented by the given input stream into a Profile.
Profile	newProfile(Path path) Parse the XML located at the given path into a Profile.
Profile	newProfile(URI uri) Parse the XML located at the given URI into a Profile.
Profile	newProfile(URL url) Parse the XML located at the given URL into a Profile.
static ValidationGate	newValidationGate(Collection<String> constraints) Returns a validation gate for the given constraints.
ValidationService	newValidationService() Returns this as a validation service for compatibility with previous versions of CMV
ValidationReport	validate(Document document, Profile profile, ValidationGate validationGate) Validates the document against the given profile using the specified validation gate.
ValidationReport	validate(URI documentUri, URI profileUri, ValidationGate validationGate) Validates the document against the given profile using the specified validation gate.

Methods inherited from class java.lang.Object

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

Methods inherited from interface eu.cessda.cmv.core.ValidationService

validate, validate

Constructor Detail

CessdaMetadataValidatorFactory

public CessdaMetadataValidatorFactory()

Method Detail

newDocument

public Document newDocument(File file)
                     throws IOException,
                            NotDocumentException

Parse the XML at the given file into a Document. The XML document must be either a DDI document or an OAI-PMH document with a valid DDI document in the <metadata> element.

Parameters:

file - the file where the XML to be parsed is located.

Throws:

NotDocumentException - if the XML is not well-formed.

IOException - if an IO error occurs.

newDocument

public Document newDocument(Path path)
                     throws IOException,
                            NotDocumentException

Parse the XML at the given path into a Document. The XML document must be either a DDI document or an OAI-PMH document with a valid DDI document in the <metadata> element.

Parameters:

path - the path where the XML to be parsed is located.

Throws:

NotDocumentException - if the XML is not well-formed.

IOException - if an IO error occurs.

newDocument

public Document newDocument(URI uri)
                     throws IOException,
                            NotDocumentException

Parse the XML located at the given URI into a Document. The XML document must be either a DDI document or an OAI-PMH document with a valid DDI document in the <metadata> element.

Parameters:

uri - the URI where the XML to be parsed is located.

Throws:

NotDocumentException - if the XML is not well-formed.

IOException - if an IO error occurs.

Implementation Note:

this calls newDocument(URL) using URI.toURL() to transform the URI to a URL.

newDocument

public Document newDocument(URL url)
                     throws IOException,
                            NotDocumentException

Parse the XML located at the given URL into a Document. The XML document must be either a DDI document or an OAI-PMH document with a valid DDI document in the <metadata> element.

Parameters:

url - the URL where the XML to be parsed is located.

Throws:

NotDocumentException - if the XML is not well-formed.

IOException - if an IO error occurs.

newDocument

public Document newDocument(InputStream inputStream)
                     throws IOException,
                            NotDocumentException

Parse the XML located at the given URL into a Document. The XML document must be either a DDI document or an OAI-PMH document with a valid DDI document in the <metadata> element.

Parameters:

inputStream - the input stream of the XML to be parsed.

Throws:

NotDocumentException - if the XML is not well-formed.

IOException - if an IO error occurs.

newDocument

public Document newDocument(Document document)
                     throws IOException,
                            NotDocumentException

Parse the XML contained in the request to a Document. The XML document must be either a DDI document or an OAI-PMH document with a valid DDI document in the <metadata> element.

Parameters:

document - the request document.

Throws:

NotDocumentException - if the XML is not well-formed.

IOException - if an IO error occurs.

getValidationGate

public static ValidationGate getValidationGate(ValidationGateName name)

Returns a validation gate with the given name.

newProfile

public Profile newProfile(URI uri)
                   throws NotDocumentException,
                          IOException

Parse the XML located at the given URI into a Profile. The XML document must be a valid DDI profile.

Parameters:

uri - the URI of the XML to parse.

Throws:

NotDocumentException - if the XML is not well-formed, or no valid constraints were found.

IOException

newProfile

public Profile newProfile(URL url)
                   throws NotDocumentException,
                          IOException

Parse the XML located at the given URL into a Profile. The XML document must be a valid DDI profile.

Parameters:

url - the URL of the XML to parse.

Throws:

NotDocumentException - if the XML is not well-formed, or no valid constraints were found.

IOException

newProfile

public Profile newProfile(File file)
                   throws NotDocumentException,
                          IOException

Parse the XML located at the given file into a Profile. The XML document must be a valid DDI profile.

Parameters:

file - the file where the XML to be parsed is located.

Throws:

NotDocumentException - if the XML is not well-formed, or no valid constraints were found.

IOException

newProfile

public Profile newProfile(Path path)
                   throws NotDocumentException,
                          IOException

Parse the XML located at the given path into a Profile. The XML document must be a valid DDI profile.

Parameters:

path - the path where the XML to be parsed is located.

Throws:

NotDocumentException - if the XML is not well-formed, or no valid constraints were found.

IOException

newProfile

public Profile newProfile(InputStream inputStream)
                   throws NotDocumentException,
                          IOException

Parse the XML represented by the given input stream into a Profile. The XML document must be a valid DDI profile.

Parameters:

inputStream - the input stream of the XML to be parsed.

Throws:

NotDocumentException - if the XML is not well-formed, or no valid constraints were found.

IOException

newProfile

public Profile newProfile(Document profile)
                   throws NotDocumentException,
                          IOException

Parse the XML represented by the given request into a Profile. The XML document must be a valid DDI profile.

Parameters:

profile - the request containing the XML to be parsed.

Throws:

NotDocumentException - if the XML is not well-formed, or no valid constraints were found.

IOException

newProfile

public Profile newProfile(InputSource inputSource)
                   throws NotDocumentException,
                          IOException

Parse the XML represented by the given input source into a Profile. The XML document must be a valid DDI profile.

Parameters:

inputSource - the input source of the XML to be parsed.

Throws:

NotDocumentException - if the XML is not well-formed, or no valid constraints were found.

IOException

newValidationGate

public static ValidationGate newValidationGate(Collection<String> constraints)
                                        throws InvalidGateException

Returns a validation gate for the given constraints. The constraints are passed as the short name of the class (i.e. FixedValueNodeConstraint).

Parameters:

constraints - the constraints to be added

Returns:

the validation gate

Throws:

InvalidGateException - if any of the given constraints are invalid

getConstraints

public static Set<String> getConstraints()

Return a set of all known constraints.

This should be used with newValidationGate(Collection) to ensure that a validation gate is not constructed with invalid constraints.

newDocument

public Document newDocument(InputSource inputSource)
                     throws IOException,
                            NotDocumentException

Parse the given XML into a Document. The XML document must be either a DDI document or an OAI-PMH document with a valid DDI document in the <metadata> element.

Parameters:

inputSource - the input source of the XML to be parsed.

Throws:

NotDocumentException - if the XML is not well-formed.

IOException - if an IO error occurs.

validate

public ValidationReport validate(URI documentUri,
                                 URI profileUri,
                                 ValidationGate validationGate)
                          throws IOException,
                                 NotDocumentException

Validates the document against the given profile using the specified validation gate.

Specified by:

validate in interface ValidationService

Parameters:

documentUri - the URI of the document to validate.

profileUri - the URI of the profile to validate the document against.

validationGate - the validation gate to use.

Returns:

the validation report.

Throws:

IOException

NotDocumentException

validate

public ValidationReport validate(Document document,
                                 Profile profile,
                                 ValidationGate validationGate)

Validates the document against the given profile using the specified validation gate.

Specified by:

validate in interface ValidationService

Parameters:

document - the document to validate.

profile - the profile to validate the document against.

validationGate - the validation gate to use.

Returns:

the validation report.

newValidationService

public ValidationService newValidationService()

Returns this as a validation service for compatibility with previous versions of CMV