public abstract class SchemaValidator extends java.lang.Object implements Destination
If validation fails, an exception is thrown. If validation succeeds, the validated document
can optionally be written to a specified destination. This will be a copy of the original document,
augmented with default values for absent elements and attributes, and carrying type annotations
derived from the schema processing. Expansion of defaults can be suppressed by means of the method
setExpandAttributeDefaults(boolean)
.
A SchemaValidator is serially resuable but not thread-safe. That is, it should normally be used in the thread where it is created, but it can be used more than once, to validate multiple input documents.
A SchemaValidator is a Destination, which allows it to receive the output of a query or transformation to be validated.
Saxon does not deliver the full PSVI as described in the XML schema specifications, only the subset of the PSVI properties featured in the XDM data model.
Constructor and Description |
---|
SchemaValidator() |
Modifier and Type | Method and Description |
---|---|
javax.xml.transform.Source |
asSource(javax.xml.transform.Source input)
Construct a Source object that applies validation to an underlying input Source.
|
abstract void |
close()
Close the destination, allowing resources to be released.
|
abstract Destination |
getDestination()
Get the Destination that will receive the validated document.
|
abstract QName |
getDocumentElementName()
Get the name of the required top-level element of the document to be validated.
|
protected abstract SchemaType |
getDocumentElementType()
Get the schema type against which the document element is to be validated
|
abstract QName |
getDocumentElementTypeName()
Get the name of the required type of the top-level element of the document to be validated.
|
abstract javax.xml.transform.ErrorListener |
getErrorListener()
Get the ErrorListener being used while validating instance documents
|
abstract InvalidityHandler |
getInvalidityHandler()
Get the InvalidityHandler used when validating instance documents
|
abstract XdmValue |
getParameter(QName name)
Get the value that has been set for a schema parameter (a parameter defined in the schema using
the
saxon:param extension) |
abstract Receiver |
getReceiver(Configuration config)
Return a Receiver.
|
abstract boolean |
isCollectStatistics()
Ask whether validation statistics are to be collected
|
abstract boolean |
isExpandAttributeDefaults()
Ask whether attribute defaults defined in a schema are to be expanded or not
(by default, fixed and default attribute values are expanded, that is, they are inserted
into the document during validation as if they were present in the instance being validated)
|
abstract boolean |
isLax()
Ask whether validation is to be in lax mode.
|
abstract boolean |
isUseXsiSchemaLocation()
Ask whether the schema processor is to take account of any xsi:schemaLocation and
xsi:noNamespaceSchemaLocation attributes encountered while validating an instance document
|
abstract void |
reportValidationStatistics(Destination destination)
Report the validation statistics from the most recent validation episode
Does nothing if no validation statistics have been collected.
|
abstract void |
setCollectStatistics(boolean collect)
Say whether validation statistics are to be collected.
|
abstract void |
setDestination(Destination destination)
Set the Destination to receive the validated document.
|
abstract void |
setDocumentElementName(QName name)
Set the name of the required top-level element of the document to be validated (that is, the
name of the outermost element of the document).
|
abstract void |
setDocumentElementTypeName(QName name)
Set the name of the required type of the top-level element of the document to be validated.
|
abstract void |
setErrorListener(javax.xml.transform.ErrorListener listener)
Set the ErrorListener to be used while validating instance documents.
|
abstract void |
setExpandAttributeDefaults(boolean expand)
Set whether attribute defaults defined in a schema are to be expanded or not
(by default, fixed and default attribute values are expanded, that is, they are inserted
into the document during validation as if they were present in the instance being validated)
|
abstract void |
setInvalidityHandler(InvalidityHandler handler)
Set the InvalidityHandler to be used when validating instance documents.
|
abstract void |
setLax(boolean lax)
The validation mode may be either strict or lax.
|
abstract void |
setParameter(QName name,
XdmValue value)
Set the value of a schema parameter (a parameter defined in the schema using
the
saxon:param extension) |
abstract void |
setUseXsiSchemaLocation(boolean recognize)
Say whether the schema processor is to take account of any xsi:schemaLocation and
xsi:noNamespaceSchemaLocation attributes encountered while validating an instance document
|
abstract void |
setValidityReporting(Destination destination)
This method can be called before running a validation to define a destination to which validation
reports should be written.
|
abstract void |
validate(javax.xml.transform.Source source)
Validate an instance document supplied as a Source object
|
abstract void |
validateMultiple(java.lang.Iterable<javax.xml.transform.Source> sources)
This method can be called to validate multiple source documents simultaneously (in parallel threads).
|
public abstract void setLax(boolean lax)
lax
- true if validation is to be lax, false if it is to be strictpublic abstract boolean isLax()
public abstract void setErrorListener(javax.xml.transform.ErrorListener listener)
listener
- The error listener to be used. This is notified of all errors detected during the
validation episode.public abstract javax.xml.transform.ErrorListener getErrorListener()
public abstract void setInvalidityHandler(InvalidityHandler handler)
handler
- the InvalidityHandler to be used.public abstract InvalidityHandler getInvalidityHandler()
public abstract void setCollectStatistics(boolean collect)
collect
- true if validation statistics are to be collected (default is false)public abstract boolean isCollectStatistics()
public abstract void reportValidationStatistics(Destination destination) throws SaxonApiException
destination
- the destination to which the statistics will be written.
The XML format of the destination is not guaranteed to be stable across
Saxon releases.SaxonApiException
- if any error occurs writing the statisticspublic abstract void setValidityReporting(Destination destination) throws SaxonApiException
destination
- where XML will be sentSaxonApiException
public abstract void setUseXsiSchemaLocation(boolean recognize)
recognize
- true if these two attributes are to be recognized; false if they are to
be ignored. Default is true.public abstract boolean isUseXsiSchemaLocation()
public abstract void setDestination(Destination destination)
destination
- the destination to receive the validated documentpublic abstract Destination getDestination()
public abstract void setDocumentElementName(QName name)
name
- the name of the document element, as a QName; or null to remove a previously-specified
value.public abstract QName getDocumentElementName()
public abstract void setDocumentElementTypeName(QName name) throws SaxonApiException
name
- the name of the type of the document element, as a QName;
or null to remove a previously-specified value. This must be the name of a type in the
schema (typically but not necessarily a complex type).SaxonApiException
- if there is no known type with this namepublic abstract QName getDocumentElementTypeName()
protected abstract SchemaType getDocumentElementType()
public abstract void setExpandAttributeDefaults(boolean expand)
expand
- true if defaults are to be expanded, false if notpublic abstract boolean isExpandAttributeDefaults()
public abstract void setParameter(QName name, XdmValue value)
saxon:param
extension)name
- the name of the schema parameter, as a QNamevalue
- the value of the schema parameter, or null to clear a previously set valuepublic abstract XdmValue getParameter(QName name)
saxon:param
extension)name
- the parameter whose name is requiredpublic abstract void validate(javax.xml.transform.Source source) throws SaxonApiException
source
- the instance document to be validated. The call getSystemId() applied to
this source object must return the base URI used for dereferencing any xsi:schemaLocation
or xsi:noNamespaceSchemaLocation attributesSaxonApiException
- if the source document is found to be invalid, or if error conditions
occur that prevented validation from taking place (such as failure to read or parse the input
document). The wrapped exception acting as the cause of the SaxonApiException can be used to
distinguish these failure conditions.public abstract void validateMultiple(java.lang.Iterable<javax.xml.transform.Source> sources) throws SaxonApiException
sources
- the Iterable of instance documents to be validated. The call getSystemId() applied to
the source objects must return the base URI used for dereferencing any xsi:schemaLocation
or xsi:noNamespaceSchemaLocation attributesSaxonApiException
- if the source document is found to be invalid, or if error conditions
occur that prevented validation from taking place (such as failure to read or parse the input
document). The wrapped exception acting as the cause of the SaxonApiException can be used to
distinguish these failure conditions.public abstract Receiver getReceiver(Configuration config) throws SaxonApiException
Destination
getReceiver
in interface Destination
config
- The Saxon configuration. This is supplied so that the destination can
use information from the configuration (for example, a reference to the name pool)
to construct or configure the returned Receiver.PipelineConfiguration
before calling
its open()
method. The caller is also responsible for ensuring that the sequence
of events sent to the Receiver represents a well-formed document: in particular the event
stream must include namespace events corresponding exactly to the namespace declarations
that are required. If the calling code cannot guarantee this, it should insert a
NamespaceReducer
into the pipeline in front of the returned
Receiver.SaxonApiException
- if the Receiver cannot be createdpublic javax.xml.transform.Source asSource(javax.xml.transform.Source input)
Source
is consumed. The Destination
associated with this SchemaValidator is ignored; indeed, it is overwritten. After
calling this method, the SchemaValidator
should not be used again for any
other purpose.input
- the input Source to be validatedSource
as input,
but not (in general) by other products.public abstract void close() throws SaxonApiException
close
in interface Destination
SaxonApiException
- if any failure occursCopyright (c) 2004-2018 Saxonica Limited. All rights reserved.