SchemaValidator

java.lang.Object
- net.sf.saxon.s9api.SchemaValidator

All Implemented Interfaces:

Destination

Direct Known Subclasses:

SchemaValidatorImpl
```
public abstract class SchemaValidator
extends Object
implements Destination
```
A SchemaValidator is an object that is used for validating instance documents against a schema. The schema consists of the collection of schema components that are available within the schema cache maintained by the SchemaManager, together with any additional schema components located during the course of validation by means of an xsl:schemaLocation or xsi:noNamespaceSchemaLocation attribute within the instance document.

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 Summary

Constructors
Constructor and Description

SchemaValidator()

Constructors
Constructor and Description
`SchemaValidator()`

Method Summary

Methods
Modifier and Type	Method and Description
`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 ErrorListener`	`getErrorListener()` Get the ErrorListener being used while 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(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`	`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`	`validate(Source source)` Validate an instance document supplied as a Source object

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - SchemaValidator
```
public SchemaValidator()
```
- Method Detail
  - setLax
```
public abstract void setLax(boolean lax)
```
    The validation mode may be either strict or lax. The default is strict; this method may be called to indicate that lax validation is required. With strict validation, validation fails if no element declaration can be located for the outermost element. With lax validation, the absence of an element declaration results in the content being considered valid.
    
    Parameters:
    lax - true if validation is to be lax, false if it is to be strict
  - isLax
```
public abstract boolean isLax()
```
    Ask whether validation is to be in lax mode.
    
    Returns:
    true if validation is to be in lax mode, false if it is to be in strict mode.
  - setErrorListener
```
public abstract void setErrorListener(ErrorListener listener)
```
    Set the ErrorListener to be used while validating instance documents.
    
    Parameters:
    listener - The error listener to be used. This is notified of all errors detected during the validation episode.
  - getErrorListener
```
public abstract ErrorListener getErrorListener()
```
    Get the ErrorListener being used while validating instance documents
    
    Returns:
    listener The error listener in use. This is notified of all errors detected during the validation episode. Returns null if no user-supplied ErrorListener has been set.
  - setCollectStatistics
```
public abstract void setCollectStatistics(boolean collect)
```
    Say whether validation statistics are to be collected. Calling this method has the side-effect of deleting any statistics previously collected.
    
    Parameters:
    collect - true if validation statistics are to be collected (default is false)
    Since:
    
    9.6
  - isCollectStatistics
```
public abstract boolean isCollectStatistics()
```
    Ask whether validation statistics are to be collected
    
    Returns:
    true if validation statistics are to be collected (default is false)
    Since:
    
    9.6
  - reportValidationStatistics
```
public abstract void reportValidationStatistics(Destination destination)
                                         throws SaxonApiException
```
    Report the validation statistics from the most recent validation episode Does nothing if no validation statistics have been collected.
    
    Parameters:
    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.
    
    Throws:
    
    SaxonApiException - if any error occurs writing the statistics
    Since:
    
    Saxon 9.6
  - setUseXsiSchemaLocation
```
public 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
    
    Parameters:
    recognize - true if these two attributes are to be recognized; false if they are to be ignored. Default is true.
  - isUseXsiSchemaLocation
```
public 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
    
    Returns:
    true if these two attributes are to be recognized; false if they are to be ignored. Default is true.
  - setDestination
```
public abstract void setDestination(Destination destination)
```
    Set the Destination to receive the validated document. If no destination is supplied, the validated document is discarded.
    
    Parameters:
    destination - the destination to receive the validated document
  - getDestination
```
public abstract Destination getDestination()
```
    Get the Destination that will receive the validated document. Return null if no destination has been set.
    
    Returns:
    the destination to receive the validated document, or null if none has been supplied
  - setDocumentElementName
```
public 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). If no value is supplied, there is no constraint on the required element name
    
    Parameters:
    name - the name of the document element, as a QName; or null to remove a previously-specified value.
  - getDocumentElementName
```
public abstract QName getDocumentElementName()
```
    Get the name of the required top-level element of the document to be validated.
    
    Returns:
    the name of the required document element, or null if no value has been set.
  - setDocumentElementTypeName
```
public abstract void setDocumentElementTypeName(QName name)
                                         throws SaxonApiException
```
    Set the name of the required type of the top-level element of the document to be validated. If no value is supplied, there is no constraint on the required type
    
    Parameters:
    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).
    
    Throws:
    
    SaxonApiException - if there is no known type with this name
  - getDocumentElementTypeName
```
public abstract QName getDocumentElementTypeName()
```
    Get the name of the required type of the top-level element of the document to be validated.
    
    Returns:
    the name of the required type of the document element, or null if no value has been set.
  - getDocumentElementType
```
protected abstract SchemaType getDocumentElementType()
```
    Get the schema type against which the document element is to be validated
    
    Returns:
    the schema type
  - setExpandAttributeDefaults
```
public 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)
    
    Parameters:
    expand - true if defaults are to be expanded, false if not
  - isExpandAttributeDefaults
```
public 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)
    
    Returns:
    true if defaults are to be expanded, false if not
  - setParameter
```
public 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)
    
    Parameters:
    name - the name of the schema parameter, as a QName
    value - the value of the schema parameter, or null to clear a previously set value
    Since:
    
    9.5
  - getParameter
```
public 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)
    
    Parameters:
    name - the parameter whose name is required
    
    Returns:
    the value that has been set for the parameter, or null if no value has been set
    Since:
    
    9.5
  - validate
```
public abstract void validate(Source source)
                       throws SaxonApiException
```
    Validate an instance document supplied as a Source object
    
    Parameters:
    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 attributes
    
    Throws:
    
    SaxonApiException - 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.
  - getReceiver
```
public abstract Receiver getReceiver(Configuration config)
                              throws SaxonApiException
```
    Description copied from interface: Destination
    
    Return a Receiver. Saxon calls this method to obtain a Receiver, to which it then sends a sequence of events representing the content of an XML document. The method is intended primarily for internal use, and may give poor diagnostics if used incorrectly.
    
    Specified by:
    
    getReceiver in interface Destination
    
    Parameters:
    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.
    
    Returns:
    the Receiver to which events are to be sent. It is the caller's responsibility to initialize this Receiver with a 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.
    
    Throws:
    
    SaxonApiException - if the Receiver cannot be created
  - close
```
public abstract void close()
                    throws SaxonApiException
```
    Close the destination, allowing resources to be released. Saxon calls this method when it has finished writing to the destination.
    
    Specified by:
    
    close in interface Destination
    
    Throws:
    
    SaxonApiException - if any failure occurs

Class SchemaValidator

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

SchemaValidator

Method Detail

setLax

isLax

setErrorListener

getErrorListener

setCollectStatistics

isCollectStatistics

reportValidationStatistics

setUseXsiSchemaLocation

isUseXsiSchemaLocation

setDestination

getDestination

setDocumentElementName

getDocumentElementName

setDocumentElementTypeName

getDocumentElementTypeName

getDocumentElementType

setExpandAttributeDefaults

isExpandAttributeDefaults

setParameter

getParameter

validate

getReceiver

close