org.apache.xerces.impl.xs
Class XMLSchemaValidator

java.lang.Object
  |
  +--org.apache.xerces.impl.xs.XMLSchemaValidator

public class XMLSchemaValidator
extends java.lang.Object
implements org.apache.xerces.xni.parser.XMLComponent, org.apache.xerces.xni.parser.XMLDocumentFilter, FieldActivator

The DTD 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:

Version:
$Id: XMLSchemaValidator.java,v 1.26 2001/12/17 22:11:24 lmartin Exp $
Author:
Sandy Gao IBM, Elena Litani IBM, Andy Clark IBM, Neeraj Bajaj, Sun Microsystems, inc.

Inner Class Summary
protected  class XMLSchemaValidator.KeyRefValueStore
          Key reference value store.
protected  class XMLSchemaValidator.KeyValueStore
          Key value store.
protected  class XMLSchemaValidator.UniqueValueStore
          Unique value store.
protected  class XMLSchemaValidator.ValueStoreBase
          Value store implementation base class.
protected  class XMLSchemaValidator.ValueStoreCache
          Value store cache.
protected static class XMLSchemaValidator.XPathMatcherStack
          Stack of XPath matchers for identity constraints.
 
Field Summary
protected static java.lang.String ATTR_PSVI
           
protected static java.lang.String DYNAMIC_VALIDATION
          Feature identifier: dynamic validation.
protected static java.lang.String ELEM_PSVI
           
protected static java.lang.String ENTITY_MANAGER
           
static java.lang.String ENTITY_RESOLVER
          Property identifier: entity resolver.
static java.lang.String ERROR_REPORTER
          Property identifier: error reporter.
protected  ElementPSVImpl fCurrentPSVI
          current PSVI element info
protected  org.apache.xerces.xni.XMLDocumentHandler fDocumentHandler
          Document handler.
protected  boolean fDoValidation
           
protected  boolean fDynamicValidation
           
protected  ElementPSVImpl fElemPSVI
          PSV infoset information for element
protected  org.apache.xerces.xni.parser.XMLEntityResolver fEntityResolver
          Entity resolver
protected  java.lang.String fExternalNoNamespaceSchema
           
protected  java.lang.String fExternalSchemas
           
protected  boolean fFullChecking
           
protected  GrammarPool fGrammarPool
           
protected  XMLSchemaValidator.XPathMatcherStack fMatcherStack
          Stack of active XPath matchers for identity constraints.
protected  boolean fNamespaces
           
protected  boolean fSeenRoot
           
protected  SymbolTable fSymbolTable
          Symbol table.
protected  boolean fValidation
          Validation.
protected  ValidationManager fValidationManager
           
protected  ValidationState fValidationState
           
protected  XMLSchemaValidator.ValueStoreCache fValueStoreCache
          Cache of value stores for identity constraint fields.
protected  org.apache.xerces.impl.xs.XMLSchemaValidator.XSIErrorReporter fXSIErrorReporter
          Error reporter.
static java.lang.String GRAMMAR_POOL
          Property identifier: grammar pool.
protected static java.lang.String NAMESPACES
           
protected static java.lang.String[] RECOGNIZED_FEATURES
          Recognized features.
protected static java.lang.String[] RECOGNIZED_PROPERTIES
          Recognized properties.
protected static java.lang.String SCHEMA_FULL_CHECKING
          Feature identifier: schema full checking
protected static java.lang.String SCHEMA_LOCATION
          Property identifier: schema location.
protected static java.lang.String SCHEMA_NONS_LOCATION
          Property identifier: no namespace schema location.
protected static java.lang.String SCHEMA_VALIDATION
          Feature identifier: validation.
static java.lang.String SYMBOL_TABLE
          Property identifier: symbol table.
protected static java.lang.String VALIDATION
          Feature identifier: validation.
protected static java.lang.String VALIDATION_MANAGER
           
 
Constructor Summary
XMLSchemaValidator()
          Default constructor.
 
Method Summary
 XPathMatcher activateField(Field field)
          Request to activate the specified field.
 void characters(org.apache.xerces.xni.XMLString text, org.apache.xerces.xni.Augmentations augs)
          Character content.
 void comment(org.apache.xerces.xni.XMLString text, org.apache.xerces.xni.Augmentations augs)
          A comment.
 void doctypeDecl(java.lang.String rootElement, java.lang.String publicId, java.lang.String systemId, org.apache.xerces.xni.Augmentations augs)
          Notifies of the presence of the DOCTYPE line in the document.
 void emptyElement(org.apache.xerces.xni.QName element, org.apache.xerces.xni.XMLAttributes attributes, org.apache.xerces.xni.Augmentations augs)
          An empty element.
 void endCDATA(org.apache.xerces.xni.Augmentations augs)
          The end of a CDATA section.
 void endDocument(org.apache.xerces.xni.Augmentations augs)
          The end of the document.
 void endElement(org.apache.xerces.xni.QName element, org.apache.xerces.xni.Augmentations augs)
          The end of an element.
 void endEntity(java.lang.String name, org.apache.xerces.xni.Augmentations augs)
          This method notifies the end of an entity.
 void endPrefixMapping(java.lang.String prefix, org.apache.xerces.xni.Augmentations augs)
          The end of a namespace prefix mapping.
 void endValueScopeFor(IdentityConstraint identityConstraint)
          Ends the value scope for the specified identity constraint.
 java.lang.String[] getRecognizedFeatures()
          Returns a list of feature identifiers that are recognized by this component.
 java.lang.String[] getRecognizedProperties()
          Returns a list of property identifiers that are recognized by this component.
 void ignorableWhitespace(org.apache.xerces.xni.XMLString text, org.apache.xerces.xni.Augmentations augs)
          Ignorable whitespace.
 void processingInstruction(java.lang.String target, org.apache.xerces.xni.XMLString data, org.apache.xerces.xni.Augmentations augs)
          A processing instruction.
 void reset(org.apache.xerces.xni.parser.XMLComponentManager componentManager)
          Resets the component.
 void setDocumentHandler(org.apache.xerces.xni.XMLDocumentHandler documentHandler)
          Sets the document handler to receive information about the document.
 void setFeature(java.lang.String featureId, boolean state)
          Sets the state of a feature.
 void setProperty(java.lang.String propertyId, java.lang.Object value)
          Sets the value of a property.
 void startCDATA(org.apache.xerces.xni.Augmentations augs)
          The start of a CDATA section.
 void startDocument(org.apache.xerces.xni.XMLLocator locator, java.lang.String encoding, org.apache.xerces.xni.Augmentations augs)
          The start of the document.
 void startElement(org.apache.xerces.xni.QName element, org.apache.xerces.xni.XMLAttributes attributes, org.apache.xerces.xni.Augmentations augs)
          The start of an element.
 void startEntity(java.lang.String name, java.lang.String publicId, java.lang.String systemId, java.lang.String baseSystemId, java.lang.String encoding, org.apache.xerces.xni.Augmentations augs)
          This method notifies of the start of an entity.
 void startPrefixMapping(java.lang.String prefix, java.lang.String uri, org.apache.xerces.xni.Augmentations augs)
          The start of a namespace prefix mapping.
 void startValueScopeFor(IdentityConstraint identityConstraint)
          Start the value scope for the specified identity constraint.
 void textDecl(java.lang.String version, java.lang.String encoding, org.apache.xerces.xni.Augmentations augs)
          Notifies of the presence of a TextDecl line in an entity.
 void xmlDecl(java.lang.String version, java.lang.String encoding, java.lang.String standalone, org.apache.xerces.xni.Augmentations augs)
          Notifies of the presence of an XMLDecl line in the document.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

NAMESPACES

protected static final java.lang.String NAMESPACES

VALIDATION

protected static final java.lang.String VALIDATION
Feature identifier: validation.

SCHEMA_VALIDATION

protected static final java.lang.String SCHEMA_VALIDATION
Feature identifier: validation.

SCHEMA_FULL_CHECKING

protected static final java.lang.String SCHEMA_FULL_CHECKING
Feature identifier: schema full checking

DYNAMIC_VALIDATION

protected static final java.lang.String DYNAMIC_VALIDATION
Feature identifier: dynamic validation.

SYMBOL_TABLE

public static final java.lang.String SYMBOL_TABLE
Property identifier: symbol table.

ERROR_REPORTER

public static final java.lang.String ERROR_REPORTER
Property identifier: error reporter.

ENTITY_RESOLVER

public static final java.lang.String ENTITY_RESOLVER
Property identifier: entity resolver.

GRAMMAR_POOL

public static final java.lang.String GRAMMAR_POOL
Property identifier: grammar pool.

VALIDATION_MANAGER

protected static final java.lang.String VALIDATION_MANAGER

ENTITY_MANAGER

protected static final java.lang.String ENTITY_MANAGER

SCHEMA_LOCATION

protected static final java.lang.String SCHEMA_LOCATION
Property identifier: schema location.

SCHEMA_NONS_LOCATION

protected static final java.lang.String SCHEMA_NONS_LOCATION
Property identifier: no namespace schema location.

RECOGNIZED_FEATURES

protected static final java.lang.String[] RECOGNIZED_FEATURES
Recognized features.

RECOGNIZED_PROPERTIES

protected static final java.lang.String[] RECOGNIZED_PROPERTIES
Recognized properties.

fSeenRoot

protected boolean fSeenRoot

fNamespaces

protected boolean fNamespaces

fElemPSVI

protected final ElementPSVImpl fElemPSVI
PSV infoset information for element

fCurrentPSVI

protected ElementPSVImpl fCurrentPSVI
current PSVI element info

ELEM_PSVI

protected static final java.lang.String ELEM_PSVI

ATTR_PSVI

protected static final java.lang.String ATTR_PSVI

fValidation

protected boolean fValidation
Validation.

fDynamicValidation

protected boolean fDynamicValidation

fDoValidation

protected boolean fDoValidation

fFullChecking

protected boolean fFullChecking

fSymbolTable

protected SymbolTable fSymbolTable
Symbol table.

fXSIErrorReporter

protected org.apache.xerces.impl.xs.XMLSchemaValidator.XSIErrorReporter fXSIErrorReporter
Error reporter.

fEntityResolver

protected org.apache.xerces.xni.parser.XMLEntityResolver fEntityResolver
Entity resolver

fValidationManager

protected ValidationManager fValidationManager

fValidationState

protected ValidationState fValidationState

fGrammarPool

protected GrammarPool fGrammarPool

fExternalSchemas

protected java.lang.String fExternalSchemas

fExternalNoNamespaceSchema

protected java.lang.String fExternalNoNamespaceSchema

fDocumentHandler

protected org.apache.xerces.xni.XMLDocumentHandler fDocumentHandler
Document handler.

fMatcherStack

protected XMLSchemaValidator.XPathMatcherStack fMatcherStack
Stack of active XPath matchers for identity constraints. All active XPath matchers are notified of startElement, characters 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.


fValueStoreCache

protected XMLSchemaValidator.ValueStoreCache fValueStoreCache
Cache of value stores for identity constraint fields.
Constructor Detail

XMLSchemaValidator

public XMLSchemaValidator()
Default constructor.
Method Detail

getRecognizedFeatures

public java.lang.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.
Specified by:
getRecognizedFeatures in interface org.apache.xerces.xni.parser.XMLComponent

setFeature

public void setFeature(java.lang.String featureId,
                       boolean state)
                throws org.apache.xerces.xni.parser.XMLConfigurationException
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.

Specified by:
setFeature in interface org.apache.xerces.xni.parser.XMLComponent
Parameters:
featureId - The feature identifier.
state - The state of the feature.
Throws:
SAXNotRecognizedException - The component should not throw this exception.
SAXNotSupportedException - The component should not throw this exception.

getRecognizedProperties

public java.lang.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.
Specified by:
getRecognizedProperties in interface org.apache.xerces.xni.parser.XMLComponent

setProperty

public void setProperty(java.lang.String propertyId,
                        java.lang.Object value)
                 throws org.apache.xerces.xni.parser.XMLConfigurationException
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.

Specified by:
setProperty in interface org.apache.xerces.xni.parser.XMLComponent
Parameters:
propertyId - The property identifier.
value - The value of the property.
Throws:
SAXNotRecognizedException - The component should not throw this exception.
SAXNotSupportedException - The component should not throw this exception.

setDocumentHandler

public void setDocumentHandler(org.apache.xerces.xni.XMLDocumentHandler documentHandler)
Sets the document handler to receive information about the document.
Parameters:
documentHandler - The document handler.

startDocument

public void startDocument(org.apache.xerces.xni.XMLLocator locator,
                          java.lang.String encoding,
                          org.apache.xerces.xni.Augmentations augs)
                   throws org.apache.xerces.xni.XNIException
The start of the document.
Parameters:
systemId - 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).
Throws:
org.apache.xerces.xni.XNIException - Thrown by handler to signal an error.

xmlDecl

public void xmlDecl(java.lang.String version,
                    java.lang.String encoding,
                    java.lang.String standalone,
                    org.apache.xerces.xni.Augmentations augs)
             throws org.apache.xerces.xni.XNIException
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.
Throws:
org.apache.xerces.xni.XNIException - Thrown by handler to signal an error.

doctypeDecl

public void doctypeDecl(java.lang.String rootElement,
                        java.lang.String publicId,
                        java.lang.String systemId,
                        org.apache.xerces.xni.Augmentations augs)
                 throws org.apache.xerces.xni.XNIException
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.
Throws:
org.apache.xerces.xni.XNIException - Thrown by handler to signal an error.

startPrefixMapping

public void startPrefixMapping(java.lang.String prefix,
                               java.lang.String uri,
                               org.apache.xerces.xni.Augmentations augs)
                        throws org.apache.xerces.xni.XNIException
The start of a namespace prefix mapping. This method will only be called when namespace processing is enabled.
Parameters:
prefix - The namespace prefix.
uri - The URI bound to the prefix.
Throws:
org.apache.xerces.xni.XNIException - Thrown by handler to signal an error.

startElement

public void startElement(org.apache.xerces.xni.QName element,
                         org.apache.xerces.xni.XMLAttributes attributes,
                         org.apache.xerces.xni.Augmentations augs)
                  throws org.apache.xerces.xni.XNIException
The start of an element.
Parameters:
element - The name of the element.
attributes - The element attributes.
Throws:
org.apache.xerces.xni.XNIException - Thrown by handler to signal an error.

emptyElement

public void emptyElement(org.apache.xerces.xni.QName element,
                         org.apache.xerces.xni.XMLAttributes attributes,
                         org.apache.xerces.xni.Augmentations augs)
                  throws org.apache.xerces.xni.XNIException
An empty element.
Parameters:
element - The name of the element.
attributes - The element attributes.
Throws:
org.apache.xerces.xni.XNIException - Thrown by handler to signal an error.

characters

public void characters(org.apache.xerces.xni.XMLString text,
                       org.apache.xerces.xni.Augmentations augs)
                throws org.apache.xerces.xni.XNIException
Character content.
Parameters:
text - The content.
Throws:
org.apache.xerces.xni.XNIException - Thrown by handler to signal an error.

ignorableWhitespace

public void ignorableWhitespace(org.apache.xerces.xni.XMLString text,
                                org.apache.xerces.xni.Augmentations augs)
                         throws org.apache.xerces.xni.XNIException
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.
Throws:
org.apache.xerces.xni.XNIException - Thrown by handler to signal an error.

endElement

public void endElement(org.apache.xerces.xni.QName element,
                       org.apache.xerces.xni.Augmentations augs)
                throws org.apache.xerces.xni.XNIException
The end of an element.
Parameters:
element - The name of the element.
Throws:
org.apache.xerces.xni.XNIException - Thrown by handler to signal an error.

endPrefixMapping

public void endPrefixMapping(java.lang.String prefix,
                             org.apache.xerces.xni.Augmentations augs)
                      throws org.apache.xerces.xni.XNIException
The end of a namespace prefix mapping. This method will only be called when namespace processing is enabled.
Parameters:
prefix - The namespace prefix.
Throws:
org.apache.xerces.xni.XNIException - Thrown by handler to signal an error.

startCDATA

public void startCDATA(org.apache.xerces.xni.Augmentations augs)
                throws org.apache.xerces.xni.XNIException
The start of a CDATA section.
Throws:
org.apache.xerces.xni.XNIException - Thrown by handler to signal an error.

endCDATA

public void endCDATA(org.apache.xerces.xni.Augmentations augs)
              throws org.apache.xerces.xni.XNIException
The end of a CDATA section.
Throws:
org.apache.xerces.xni.XNIException - Thrown by handler to signal an error.

endDocument

public void endDocument(org.apache.xerces.xni.Augmentations augs)
                 throws org.apache.xerces.xni.XNIException
The end of the document.
Throws:
org.apache.xerces.xni.XNIException - Thrown by handler to signal an error.

startEntity

public void startEntity(java.lang.String name,
                        java.lang.String publicId,
                        java.lang.String systemId,
                        java.lang.String baseSystemId,
                        java.lang.String encoding,
                        org.apache.xerces.xni.Augmentations augs)
                 throws org.apache.xerces.xni.XNIException
This method notifies of the start of an entity. The DTD has the pseudo-name of "[dtd]" parameter entity names start with '%'; and general entity names are just the entity name.

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

Parameters:
name - The name of the entity.
publicId - The public identifier of the entity if the entity is external, null otherwise.
systemId - The system identifier of the entity if the entity is external, null otherwise.
baseSystemId - The base 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 parameter entities).
Throws:
org.apache.xerces.xni.XNIException - Thrown by handler to signal an error.

textDecl

public void textDecl(java.lang.String version,
                     java.lang.String encoding,
                     org.apache.xerces.xni.Augmentations augs)
              throws org.apache.xerces.xni.XNIException
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.
Throws:
org.apache.xerces.xni.XNIException - Thrown by handler to signal an error.

comment

public void comment(org.apache.xerces.xni.XMLString text,
                    org.apache.xerces.xni.Augmentations augs)
             throws org.apache.xerces.xni.XNIException
A comment.
Parameters:
text - The text in the comment.
Throws:
org.apache.xerces.xni.XNIException - Thrown by application to signal an error.

processingInstruction

public void processingInstruction(java.lang.String target,
                                  org.apache.xerces.xni.XMLString data,
                                  org.apache.xerces.xni.Augmentations augs)
                           throws org.apache.xerces.xni.XNIException
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.
Throws:
org.apache.xerces.xni.XNIException - Thrown by handler to signal an error.

endEntity

public void endEntity(java.lang.String name,
                      org.apache.xerces.xni.Augmentations augs)
               throws org.apache.xerces.xni.XNIException
This method notifies the end of an entity. The DTD has the pseudo-name of "[dtd]" parameter entity names start with '%'; and general entity names are just the entity name.

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

Parameters:
name - The name of the entity.
Throws:
org.apache.xerces.xni.XNIException - Thrown by handler to signal an error.

reset

public void reset(org.apache.xerces.xni.parser.XMLComponentManager componentManager)
           throws org.apache.xerces.xni.parser.XMLConfigurationException
Description copied from interface: org.apache.xerces.xni.parser.XMLComponent
Resets the component. The component can query the component manager about any features and properties that affect the operation of the component.
Specified by:
reset in interface org.apache.xerces.xni.parser.XMLComponent
Tags copied from interface: org.apache.xerces.xni.parser.XMLComponent
Parameters:
componentManager - The component manager.
Throws:
XNIException - Thrown by component on initialization error.

startValueScopeFor

public void startValueScopeFor(IdentityConstraint identityConstraint)
                        throws org.apache.xerces.xni.XNIException
Start the value scope for the specified identity constraint. This method is called when the selector matches in order to initialize the value store.
Specified by:
startValueScopeFor in interface FieldActivator
Parameters:
identityConstraint - The identity constraint.

activateField

public XPathMatcher activateField(Field field)
                           throws org.apache.xerces.xni.XNIException
Request to activate the specified field. This method returns the matcher for the field.
Specified by:
activateField in interface FieldActivator
Parameters:
field - The field to activate.

endValueScopeFor

public void endValueScopeFor(IdentityConstraint identityConstraint)
                      throws org.apache.xerces.xni.XNIException
Ends the value scope for the specified identity constraint.
Specified by:
endValueScopeFor in interface FieldActivator
Parameters:
identityConstraint - The identity constraint.


Copyright © 1999-2001 Apache XML Project. All Rights Reserved.