public class

XMLSchemaValidator

extends Object
implements RevalidationHandler FieldActivator XMLComponent XMLDocumentFilter
java.lang.Object
   ↳ org.apache.xerces.impl.xs.XMLSchemaValidator

Class Overview

The XML Schema validator. The validator implements a document filter: receiving document events from the scanner; validating the content and structure; augmenting the InfoSet, if applicable; and notifying the parser of the information resulting from the validation process.

This component requires the following features and properties from the component manager that uses it:

  • http://xml.org/sax/features/validation
  • http://apache.org/xml/properties/internal/symbol-table
  • http://apache.org/xml/properties/internal/error-reporter
  • http://apache.org/xml/properties/internal/entity-resolver

Summary

Nested Classes
class XMLSchemaValidator.KeyRefValueStore Key reference value store. 
class XMLSchemaValidator.KeyValueStore Key value store. 
class XMLSchemaValidator.LocalIDKey  
class XMLSchemaValidator.ShortVector A simple vector for shorts. 
class XMLSchemaValidator.UniqueValueStore Unique value store. 
class XMLSchemaValidator.ValueStoreBase Value store implementation base class. 
class XMLSchemaValidator.ValueStoreCache Value store cache. 
class XMLSchemaValidator.XPathMatcherStack Stack of XPath matchers for identity constraints. 
class XMLSchemaValidator.XSIErrorReporter A wrapper of the standard error reporter. 
Constants
String ALLOW_JAVA_ENCODINGS Feature identifier: whether to recognize java encoding names
String CONTINUE_AFTER_FATAL_ERROR Feature identifier: whether to continue parsing a schema after a fatal error is encountered
String DYNAMIC_VALIDATION Feature identifier: dynamic validation.
String ENTITY_MANAGER
String ENTITY_RESOLVER Property identifier: entity resolver.
String ERROR_REPORTER Property identifier: error reporter.
String GENERATE_SYNTHETIC_ANNOTATIONS Feature: generate synthetic annotations
String HONOUR_ALL_SCHEMALOCATIONS Feature identifier: honour all schemaLocations
String IDENTITY_CONSTRAINT_CHECKING Feature identifier: whether to ignore identity constraint errors
int ID_CONSTRAINT_NUM
String ID_IDREF_CHECKING Feature identifier: whether to ignore ID/IDREF errors
String IGNORE_XSI_TYPE Feature identifier: whether to ignore xsi:type attributes until a global element declaration is encountered
String JAXP_SCHEMA_LANGUAGE Property identifier: JAXP schema language.
String JAXP_SCHEMA_SOURCE Property identifier: JAXP schema source.
String NORMALIZE_DATA Feature identifier: expose schema normalized value
String PARSER_SETTINGS
String ROOT_TYPE_DEF Property identifier: root type definition.
String SCHEMA_AUGMENT_PSVI Feature identifier: augment PSVI
String SCHEMA_ELEMENT_DEFAULT Feature identifier: send element default value via characters()
String SCHEMA_FULL_CHECKING Feature identifier: schema full checking
String SCHEMA_LOCATION Property identifier: schema location.
String SCHEMA_NONS_LOCATION Property identifier: no namespace schema location.
String SCHEMA_VALIDATION Feature identifier: validation.
String STANDARD_URI_CONFORMANT_FEATURE Feature identifier: standard uri conformant feature.
String SYMBOL_TABLE Property identifier: symbol table.
String UNPARSED_ENTITY_CHECKING Feature identifier: whether to ignore unparsed entity errors
String USE_GRAMMAR_POOL_ONLY Feature identifier: use grammar pool only
String VALIDATE_ANNOTATIONS Feature identifier: validate annotations.
String VALIDATION Feature identifier: validation.
String VALIDATION_MANAGER
String XMLGRAMMAR_POOL Property identifier: grammar pool.
Fields
protected boolean fAugPSVI
protected final AugmentationsImpl fAugmentations
protected ElementPSVImpl fCurrentPSVI current PSVI element info
protected XMLString fDefaultValue
protected boolean fDoValidation
protected XMLDocumentHandler fDocumentHandler Document handler.
protected XMLDocumentSource fDocumentSource
protected boolean fDynamicValidation
protected boolean fEntityRef
protected XMLEntityResolver fEntityResolver Entity resolver
protected String fExternalNoNamespaceSchema
protected String fExternalSchemas
protected boolean fFullChecking
protected XMLGrammarPool fGrammarPool
protected boolean fIdConstraint
protected boolean fInCDATA
protected Object fJaxpSchemaSource
protected final Hashtable fLocationPairs
protected XMLSchemaValidator.XPathMatcherStack fMatcherStack Stack of active XPath matchers for identity constraints.
protected final HashMap fMayMatchFieldMap Map which is used to catch instance documents that try and match a field several times in the same scope.
protected boolean fNormalizeData
protected boolean fSchemaDynamicValidation
protected boolean fSchemaElementDefault
protected SymbolTable fSymbolTable Symbol table.
protected boolean fUseGrammarPoolOnly
protected ValidationManager fValidationManager
protected ConfigurableValidationState fValidationState
protected XMLSchemaValidator.ValueStoreCache fValueStoreCache Cache of value stores for identity constraint fields.
protected final XSDDescription fXSDDescription Schema Grammar Description passed, to give a chance to application to supply the Grammar
protected final XMLSchemaValidator.XSIErrorReporter fXSIErrorReporter Error reporter.
Public Constructors
XMLSchemaValidator()
Default constructor.
Public Methods
XPathMatcher activateField(Field field, int initialDepth)
Request to activate the specified field.
boolean characterData(String data, Augmentations augs)
Character content.
void characters(XMLString text, Augmentations augs)
Character content.
void comment(XMLString text, Augmentations augs)
A comment.
void doctypeDecl(String rootElement, String publicId, String systemId, Augmentations augs)
Notifies of the presence of the DOCTYPE line in the document.
void elementDefault(String data)
void emptyElement(QName element, XMLAttributes attributes, Augmentations augs)
An empty element.
void endCDATA(Augmentations augs)
The end of a CDATA section.
void endDocument(Augmentations augs)
The end of the document.
void endElement(QName element, Augmentations augs)
The end of an element.
void endGeneralEntity(String name, Augmentations augs)
This method notifies the end of a general entity.
void endValueScopeFor(IdentityConstraint identityConstraint, int initialDepth)
Ends the value scope for the specified identity constraint.
XMLDocumentHandler getDocumentHandler()
Returns the document handler
XMLDocumentSource getDocumentSource()
Returns the document source
Boolean getFeatureDefault(String featureId)
Returns the default state for a feature, or null if this component does not want to report a default value for this feature.
Object getPropertyDefault(String propertyId)
Returns the default state for a property, or null if this component does not want to report a default value for this property.
String[] getRecognizedFeatures()
Returns a list of feature identifiers that are recognized by this component.
String[] getRecognizedProperties()
Returns a list of property identifiers that are recognized by this component.
void ignorableWhitespace(XMLString text, Augmentations augs)
Ignorable whitespace.
Boolean mayMatch(Field field)
Returns whether the given field is permitted to match a value.
void processingInstruction(String target, XMLString data, Augmentations augs)
A processing instruction.
void reset(XMLComponentManager componentManager)
Resets the component.
void setDocumentHandler(XMLDocumentHandler documentHandler)
Sets the document handler to receive information about the document.
void setDocumentSource(XMLDocumentSource source)
Sets the document source
void setFeature(String featureId, boolean state)
Sets the state of a feature.
void setMayMatch(Field field, Boolean state)
Sets whether the given field is permitted to match a value.
void setProperty(String propertyId, Object value)
Sets the value of a property.
void startCDATA(Augmentations augs)
The start of a CDATA section.
void startDocument(XMLLocator locator, String encoding, NamespaceContext namespaceContext, Augmentations augs)
The start of the document.
void startElement(QName element, XMLAttributes attributes, Augmentations augs)
The start of an element.
void startGeneralEntity(String name, XMLResourceIdentifier identifier, String encoding, Augmentations augs)
This method notifies the start of a general entity.
void startValueScopeFor(IdentityConstraint identityConstraint, int initialDepth)
Start the value scope for the specified identity constraint.
void textDecl(String version, String encoding, Augmentations augs)
Notifies of the presence of a TextDecl line in an entity.
void xmlDecl(String version, String encoding, String standalone, Augmentations augs)
Notifies of the presence of an XMLDecl line in the document.
[Expand]
Inherited Methods
From class java.lang.Object
From interface org.apache.xerces.impl.RevalidationHandler
From interface org.apache.xerces.impl.xs.identity.FieldActivator
From interface org.apache.xerces.xni.XMLDocumentHandler
From interface org.apache.xerces.xni.parser.XMLComponent
From interface org.apache.xerces.xni.parser.XMLDocumentSource

Constants

protected static final String ALLOW_JAVA_ENCODINGS

Feature identifier: whether to recognize java encoding names

Constant Value: "http://apache.org/xml/features/allow-java-encodings"

protected static final String CONTINUE_AFTER_FATAL_ERROR

Feature identifier: whether to continue parsing a schema after a fatal error is encountered

Constant Value: "http://apache.org/xml/features/continue-after-fatal-error"

protected static final String DYNAMIC_VALIDATION

Feature identifier: dynamic validation.

Constant Value: "http://apache.org/xml/features/validation/dynamic"

protected static final String ENTITY_MANAGER

Constant Value: "http://apache.org/xml/properties/internal/entity-manager"

public static final String ENTITY_RESOLVER

Property identifier: entity resolver.

Constant Value: "http://apache.org/xml/properties/internal/entity-resolver"

public static final String ERROR_REPORTER

Property identifier: error reporter.

Constant Value: "http://apache.org/xml/properties/internal/error-reporter"

protected static final String GENERATE_SYNTHETIC_ANNOTATIONS

Feature: generate synthetic annotations

Constant Value: "http://apache.org/xml/features/generate-synthetic-annotations"

protected static final String HONOUR_ALL_SCHEMALOCATIONS

Feature identifier: honour all schemaLocations

Constant Value: "http://apache.org/xml/features/honour-all-schemaLocations"

protected static final String IDENTITY_CONSTRAINT_CHECKING

Feature identifier: whether to ignore identity constraint errors

Constant Value: "http://apache.org/xml/features/validation/identity-constraint-checking"

protected static final int ID_CONSTRAINT_NUM

Constant Value: 1 (0x00000001)

protected static final String ID_IDREF_CHECKING

Feature identifier: whether to ignore ID/IDREF errors

Constant Value: "http://apache.org/xml/features/validation/id-idref-checking"

protected static final String IGNORE_XSI_TYPE

Feature identifier: whether to ignore xsi:type attributes until a global element declaration is encountered

Constant Value: "http://apache.org/xml/features/validation/schema/ignore-xsi-type-until-elemdecl"

protected static final String JAXP_SCHEMA_LANGUAGE

Property identifier: JAXP schema language.

Constant Value: "http://java.sun.com/xml/jaxp/properties/schemaLanguage"

protected static final String JAXP_SCHEMA_SOURCE

Property identifier: JAXP schema source.

Constant Value: "http://java.sun.com/xml/jaxp/properties/schemaSource"

protected static final String NORMALIZE_DATA

Feature identifier: expose schema normalized value

Constant Value: "http://apache.org/xml/features/validation/schema/normalized-value"

protected static final String PARSER_SETTINGS

Constant Value: "http://apache.org/xml/features/internal/parser-settings"

protected static final String ROOT_TYPE_DEF

Property identifier: root type definition.

Constant Value: "http://apache.org/xml/properties/validation/schema/root-type-definition"

protected static final String SCHEMA_AUGMENT_PSVI

Feature identifier: augment PSVI

Constant Value: "http://apache.org/xml/features/validation/schema/augment-psvi"

protected static final String SCHEMA_ELEMENT_DEFAULT

Feature identifier: send element default value via characters()

Constant Value: "http://apache.org/xml/features/validation/schema/element-default"

protected static final String SCHEMA_FULL_CHECKING

Feature identifier: schema full checking

Constant Value: "http://apache.org/xml/features/validation/schema-full-checking"

protected static final String SCHEMA_LOCATION

Property identifier: schema location.

Constant Value: "http://apache.org/xml/properties/schema/external-schemaLocation"

protected static final String SCHEMA_NONS_LOCATION

Property identifier: no namespace schema location.

Constant Value: "http://apache.org/xml/properties/schema/external-noNamespaceSchemaLocation"

protected static final String SCHEMA_VALIDATION

Feature identifier: validation.

Constant Value: "http://apache.org/xml/features/validation/schema"

protected static final String STANDARD_URI_CONFORMANT_FEATURE

Feature identifier: standard uri conformant feature.

Constant Value: "http://apache.org/xml/features/standard-uri-conformant"

public static final String SYMBOL_TABLE

Property identifier: symbol table.

Constant Value: "http://apache.org/xml/properties/internal/symbol-table"

protected static final String UNPARSED_ENTITY_CHECKING

Feature identifier: whether to ignore unparsed entity errors

Constant Value: "http://apache.org/xml/features/validation/unparsed-entity-checking"

protected static final String USE_GRAMMAR_POOL_ONLY

Feature identifier: use grammar pool only

Constant Value: "http://apache.org/xml/features/internal/validation/schema/use-grammar-pool-only"

protected static final String VALIDATE_ANNOTATIONS

Feature identifier: validate annotations.

Constant Value: "http://apache.org/xml/features/validate-annotations"

protected static final String VALIDATION

Feature identifier: validation.

Constant Value: "http://xml.org/sax/features/validation"

protected static final String VALIDATION_MANAGER

Constant Value: "http://apache.org/xml/properties/internal/validation-manager"

public static final String XMLGRAMMAR_POOL

Property identifier: grammar pool.

Constant Value: "http://apache.org/xml/properties/internal/grammar-pool"

Fields

protected boolean fAugPSVI

protected final AugmentationsImpl fAugmentations

protected ElementPSVImpl fCurrentPSVI

current PSVI element info

protected XMLString fDefaultValue

protected boolean fDoValidation

protected XMLDocumentHandler fDocumentHandler

Document handler.

protected XMLDocumentSource fDocumentSource

protected boolean fDynamicValidation

protected boolean fEntityRef

protected XMLEntityResolver fEntityResolver

Entity resolver

protected String fExternalNoNamespaceSchema

protected String fExternalSchemas

protected boolean fFullChecking

protected XMLGrammarPool fGrammarPool

protected boolean fIdConstraint

protected boolean fInCDATA

protected Object fJaxpSchemaSource

protected final Hashtable fLocationPairs

protected XMLSchemaValidator.XPathMatcherStack fMatcherStack

Stack of active XPath matchers for identity constraints. All active XPath matchers are notified of startElement and endElement callbacks in order to perform their matches.

For each element with identity constraints, the selector of each identity constraint is activated. When the selector matches its XPath, then all the fields of the identity constraint are activated.

Note: Once the activation scope is left, the XPath matchers are automatically removed from the stack of active matchers and no longer receive callbacks.

protected final HashMap fMayMatchFieldMap

Map which is used to catch instance documents that try and match a field several times in the same scope.

protected boolean fNormalizeData

protected boolean fSchemaDynamicValidation

protected boolean fSchemaElementDefault

protected SymbolTable fSymbolTable

Symbol table.

protected boolean fUseGrammarPoolOnly

protected ValidationManager fValidationManager

protected ConfigurableValidationState fValidationState

protected XMLSchemaValidator.ValueStoreCache fValueStoreCache

Cache of value stores for identity constraint fields.

protected final XSDDescription fXSDDescription

Schema Grammar Description passed, to give a chance to application to supply the Grammar

protected final XMLSchemaValidator.XSIErrorReporter fXSIErrorReporter

Error reporter.

Public Constructors

public XMLSchemaValidator ()

Default constructor.

Public Methods

public XPathMatcher activateField (Field field, int initialDepth)

Request to activate the specified field. This method returns the matcher for the field.

Parameters
field The field to activate.
initialDepth the 0-indexed depth in the instance document at which the Selector began to match.

public boolean characterData (String data, Augmentations augs)

Character content.

Parameters
data The character data.
augs Augmentations
Returns
  • True if data is whitespace only

public void characters (XMLString text, Augmentations augs)

Character content.

Parameters
text The content.
augs Additional information that may include infoset augmentations
Throws
XNIException Thrown by handler to signal an error.

public void comment (XMLString text, Augmentations augs)

A comment.

Parameters
text The text in the comment.
augs Additional information that may include infoset augmentations
Throws
XNIException Thrown by application to signal an error.

public void doctypeDecl (String rootElement, String publicId, String systemId, Augmentations augs)

Notifies of the presence of the DOCTYPE line in the document.

Parameters
rootElement The name of the root element.
publicId The public identifier if an external DTD or null if the external DTD is specified using SYSTEM.
systemId The system identifier if an external DTD, null otherwise.
augs Additional information that may include infoset augmentations
Throws
XNIException Thrown by handler to signal an error.

public void elementDefault (String data)

public void emptyElement (QName element, XMLAttributes attributes, Augmentations augs)

An empty element.

Parameters
element The name of the element.
attributes The element attributes.
augs Additional information that may include infoset augmentations
Throws
XNIException Thrown by handler to signal an error.

public void endCDATA (Augmentations augs)

The end of a CDATA section.

Parameters
augs Additional information that may include infoset augmentations
Throws
XNIException Thrown by handler to signal an error.

public void endDocument (Augmentations augs)

The end of the document.

Parameters
augs Additional information that may include infoset augmentations
Throws
XNIException Thrown by handler to signal an error.

public void endElement (QName element, Augmentations augs)

The end of an element.

Parameters
element The name of the element.
augs Additional information that may include infoset augmentations
Throws
XNIException Thrown by handler to signal an error.

public void endGeneralEntity (String name, Augmentations augs)

This method notifies the end of a general entity.

Note: This method is not called for entity references appearing as part of attribute values.

Parameters
name The name of the entity.
augs Additional information that may include infoset augmentations
Throws
XNIException Thrown by handler to signal an error.

public void endValueScopeFor (IdentityConstraint identityConstraint, int initialDepth)

Ends the value scope for the specified identity constraint.

Parameters
identityConstraint The identity constraint.
initialDepth the 0-indexed depth where the Selector began to match.

public XMLDocumentHandler getDocumentHandler ()

Returns the document handler

public XMLDocumentSource getDocumentSource ()

Returns the document source

public Boolean getFeatureDefault (String featureId)

Returns the default state for a feature, or null if this component does not want to report a default value for this feature.

Parameters
featureId The feature identifier.

public Object getPropertyDefault (String propertyId)

Returns the default state for a property, or null if this component does not want to report a default value for this property.

Parameters
propertyId The property identifier.

public String[] getRecognizedFeatures ()

Returns a list of feature identifiers that are recognized by this component. This method may return null if no features are recognized by this component.

public String[] getRecognizedProperties ()

Returns a list of property identifiers that are recognized by this component. This method may return null if no properties are recognized by this component.

public void ignorableWhitespace (XMLString text, Augmentations augs)

Ignorable whitespace. For this method to be called, the document source must have some way of determining that the text containing only whitespace characters should be considered ignorable. For example, the validator can determine if a length of whitespace characters in the document are ignorable based on the element content model.

Parameters
text The ignorable whitespace.
augs Additional information that may include infoset augmentations
Throws
XNIException Thrown by handler to signal an error.

public Boolean mayMatch (Field field)

Returns whether the given field is permitted to match a value.

Parameters
field The field that may be permitted to be matched.
Returns
  • Boolean indicating whether the field may be matched.

public void processingInstruction (String target, XMLString data, Augmentations augs)

A processing instruction. Processing instructions consist of a target name and, optionally, text data. The data is only meaningful to the application.

Typically, a processing instruction's data will contain a series of pseudo-attributes. These pseudo-attributes follow the form of element attributes but are not parsed or presented to the application as anything other than text. The application is responsible for parsing the data.

Parameters
target The target.
data The data or null if none specified.
augs Additional information that may include infoset augmentations
Throws
XNIException Thrown by handler to signal an error.

public void reset (XMLComponentManager componentManager)

Resets the component. The component can query the component manager about any features and properties that affect the operation of the component.

Parameters
componentManager The component manager.
Throws
XMLConfigurationException

public void setDocumentHandler (XMLDocumentHandler documentHandler)

Sets the document handler to receive information about the document.

public void setDocumentSource (XMLDocumentSource source)

Sets the document source

public void setFeature (String featureId, boolean state)

Sets the state of a feature. This method is called by the component manager any time after reset when a feature changes state.

Note: Components should silently ignore features that do not affect the operation of the component.

Parameters
featureId The feature identifier.
state The state of the feature.
Throws
The component should not throw this exception.
The component should not throw this exception.
XMLConfigurationException

public void setMayMatch (Field field, Boolean state)

Sets whether the given field is permitted to match a value. This should be used to catch instance documents that try and match a field several times in the same scope.

Parameters
field The field that may be permitted to be matched.
state Boolean indiciating whether the field may be matched.

public void setProperty (String propertyId, Object value)

Sets the value of a property. This method is called by the component manager any time after reset when a property changes value.

Note: Components should silently ignore properties that do not affect the operation of the component.

Parameters
propertyId The property identifier.
value The value of the property.
Throws
The component should not throw this exception.
The component should not throw this exception.
XMLConfigurationException

public void startCDATA (Augmentations augs)

The start of a CDATA section.

Parameters
augs Additional information that may include infoset augmentations
Throws
XNIException Thrown by handler to signal an error.

public void startDocument (XMLLocator locator, String encoding, NamespaceContext namespaceContext, Augmentations augs)

The start of the document.

Parameters
locator The system identifier of the entity if the entity is external, null otherwise.
encoding The auto-detected IANA encoding name of the entity stream. This value will be null in those situations where the entity encoding is not auto-detected (e.g. internal entities or a document entity that is parsed from a java.io.Reader).
namespaceContext The namespace context in effect at the start of this document. This object represents the current context. Implementors of this class are responsible for copying the namespace bindings from the the current context (and its parent contexts) if that information is important.
augs Additional information that may include infoset augmentations
Throws
XNIException Thrown by handler to signal an error.

public void startElement (QName element, XMLAttributes attributes, Augmentations augs)

The start of an element.

Parameters
element The name of the element.
attributes The element attributes.
augs Additional information that may include infoset augmentations
Throws
XNIException Thrown by handler to signal an error.

public void startGeneralEntity (String name, XMLResourceIdentifier identifier, String encoding, Augmentations augs)

This method notifies the start of a general entity.

Note: This method is not called for entity references appearing as part of attribute values.

Parameters
name The name of the general entity.
identifier The resource identifier.
encoding The auto-detected IANA encoding name of the entity stream. This value will be null in those situations where the entity encoding is not auto-detected (e.g. internal entities or a document entity that is parsed from a java.io.Reader).
augs Additional information that may include infoset augmentations
Throws
XNIException Thrown by handler to signal an error.

public void startValueScopeFor (IdentityConstraint identityConstraint, int initialDepth)

Start the value scope for the specified identity constraint. This method is called when the selector matches in order to initialize the value store.

Parameters
identityConstraint The identity constraint.
initialDepth the depth at which the selector began matching

public void textDecl (String version, String encoding, Augmentations augs)

Notifies of the presence of a TextDecl line in an entity. If present, this method will be called immediately following the startEntity call.

Note: This method will never be called for the document entity; it is only called for external general entities referenced in document content.

Note: This method is not called for entity references appearing as part of attribute values.

Parameters
version The XML version, or null if not specified.
encoding The IANA encoding name of the entity.
augs Additional information that may include infoset augmentations
Throws
XNIException Thrown by handler to signal an error.

public void xmlDecl (String version, String encoding, String standalone, Augmentations augs)

Notifies of the presence of an XMLDecl line in the document. If present, this method will be called immediately following the startDocument call.

Parameters
version The XML version.
encoding The IANA encoding name of the document, or null if not specified.
standalone The standalone value, or null if not specified.
augs Additional information that may include infoset augmentations
Throws
XNIException Thrown by handler to signal an error.