public class

XMLDTDValidator

extends Object
implements RevalidationHandler XMLDTDValidatorFilter XMLComponent XMLDocumentFilter
java.lang.Object
   ↳ org.apache.xerces.impl.dtd.XMLDTDValidator
Known Direct Subclasses
Known Indirect Subclasses

Class Overview

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.

Formerly, this component also handled DTD events and grammar construction. To facilitate the development of a meaningful DTD grammar caching/preparsing framework, this functionality has been moved into the XMLDTDLoader class. Therefore, this class no longer implements the DTDFilter or DTDContentModelFilter interfaces.

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

  • http://xml.org/sax/features/namespaces
  • http://xml.org/sax/features/validation
  • http://apache.org/xml/features/validation/dynamic
  • http://apache.org/xml/properties/internal/symbol-table
  • http://apache.org/xml/properties/internal/error-reporter
  • http://apache.org/xml/properties/internal/grammar-pool
  • http://apache.org/xml/properties/internal/datatype-validator-factory
@xerces.internal

Summary

Constants
String BALANCE_SYNTAX_TREES Feature identifier: balance syntax trees.
String DATATYPE_VALIDATOR_FACTORY Property identifier: datatype validator factory.
String DYNAMIC_VALIDATION Feature identifier: dynamic validation.
String ERROR_REPORTER Property identifier: error reporter.
String GRAMMAR_POOL Property identifier: grammar pool.
String NAMESPACES Feature identifier: namespaces.
String PARSER_SETTINGS
String SYMBOL_TABLE Property identifier: symbol table.
String VALIDATION Feature identifier: validation.
String VALIDATION_MANAGER
String WARN_ON_DUPLICATE_ATTDEF Feature identifier: warn on duplicate attdef
Fields
protected boolean fBalanceSyntaxTrees Controls whether the DTD grammar produces balanced syntax trees.
protected DTDGrammar fDTDGrammar DTD Grammar.
protected boolean fDTDValidation Validation against only DTD
protected DTDDVFactory fDatatypeValidatorFactory Datatype validator factory.
protected XMLLocator fDocLocation
protected XMLDocumentHandler fDocumentHandler Document handler.
protected XMLDocumentSource fDocumentSource
protected boolean fDynamicValidation Dynamic validation.
protected XMLErrorReporter fErrorReporter Error reporter.
protected DTDGrammarBucket fGrammarBucket Grammar bucket.
protected XMLGrammarPool fGrammarPool
protected NamespaceContext fNamespaceContext Namespace support.
protected boolean fNamespaces Namespaces.
protected boolean fSeenDoctypeDecl True if seen DOCTYPE declaration.
protected SymbolTable fSymbolTable Symbol table.
protected DatatypeValidator fValENTITIES Datatype validator: ENTITIES.
protected DatatypeValidator fValENTITY Datatype validator: ENTITY.
protected DatatypeValidator fValID Datatype validator: ID.
protected DatatypeValidator fValIDRef Datatype validator: IDREF.
protected DatatypeValidator fValIDRefs Datatype validator: IDREFS.
protected DatatypeValidator fValNMTOKEN Datatype validator: NMTOKEN.
protected DatatypeValidator fValNMTOKENS Datatype validator: NMTOKENS.
protected DatatypeValidator fValNOTATION Datatype validator: NOTATION.
protected boolean fValidation Validation.
protected ValidationManager fValidationManager
protected ValidationState fValidationState
protected boolean fWarnDuplicateAttdef warn on duplicate attribute definition, this feature works only when validation is true
Public Constructors
XMLDTDValidator()
Default constructor.
Public Methods
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 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.
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.
final boolean hasGrammar()
Returns true if the validator has a DTD grammar
void ignorableWhitespace(XMLString text, Augmentations augs)
Ignorable whitespace.
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 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 textDecl(String version, String encoding, Augmentations augs)
Notifies of the presence of a TextDecl line in an entity.
final boolean validate()
Return true if validator must validate the document
void xmlDecl(String version, String encoding, String standalone, Augmentations augs)
Notifies of the presence of an XMLDecl line in the document.
Protected Methods
void addDTDDefaultAttrsAndValidate(QName elementName, int elementIndex, XMLAttributes attributes)
Add default attributes and validate.
void endNamespaceScope(QName element, Augmentations augs, boolean isEmpty)
String getExternalEntityRefInAttrValue(String nonNormalizedValue)
Checks entities in attribute values for standalone VC.
void handleEndElement(QName element, Augmentations augs, boolean isEmpty)
Handle end element.
boolean handleStartElement(QName element, XMLAttributes attributes, Augmentations augs)
Handle element
void init()
initialization
boolean invalidStandaloneAttDef(QName element, QName attribute)
Returns true if invalid standalone attribute definition.
boolean isSpace(int c)
void startNamespaceScope(QName element, XMLAttributes attributes, Augmentations augs)
void validateDTDattribute(QName element, String attValue, XMLAttributeDecl attributeDecl)
Validate attributes in DTD fashion.
[Expand]
Inherited Methods
From class java.lang.Object
From interface org.apache.xerces.impl.RevalidationHandler
From interface org.apache.xerces.impl.dtd.XMLDTDValidatorFilter
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 BALANCE_SYNTAX_TREES

Feature identifier: balance syntax trees.

Constant Value: "http://apache.org/xml/features/validation/balance-syntax-trees"

protected static final String DATATYPE_VALIDATOR_FACTORY

Property identifier: datatype validator factory.

Constant Value: "http://apache.org/xml/properties/internal/datatype-validator-factory"

protected static final String DYNAMIC_VALIDATION

Feature identifier: dynamic validation.

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

protected static final String ERROR_REPORTER

Property identifier: error reporter.

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

protected static final String GRAMMAR_POOL

Property identifier: grammar pool.

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

protected static final String NAMESPACES

Feature identifier: namespaces.

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

protected static final String PARSER_SETTINGS

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

protected static final String SYMBOL_TABLE

Property identifier: symbol table.

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

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"

protected static final String WARN_ON_DUPLICATE_ATTDEF

Feature identifier: warn on duplicate attdef

Constant Value: "http://apache.org/xml/features/validation/warn-on-duplicate-attdef"

Fields

protected boolean fBalanceSyntaxTrees

Controls whether the DTD grammar produces balanced syntax trees.

protected DTDGrammar fDTDGrammar

DTD Grammar.

protected boolean fDTDValidation

Validation against only DTD

protected DTDDVFactory fDatatypeValidatorFactory

Datatype validator factory.

protected XMLLocator fDocLocation

protected XMLDocumentHandler fDocumentHandler

Document handler.

protected XMLDocumentSource fDocumentSource

protected boolean fDynamicValidation

Dynamic validation. This state of this feature is only useful when the validation feature is set to true.

protected XMLErrorReporter fErrorReporter

Error reporter.

protected DTDGrammarBucket fGrammarBucket

Grammar bucket.

protected XMLGrammarPool fGrammarPool

protected NamespaceContext fNamespaceContext

Namespace support.

protected boolean fNamespaces

Namespaces.

protected boolean fSeenDoctypeDecl

True if seen DOCTYPE declaration.

protected SymbolTable fSymbolTable

Symbol table.

protected DatatypeValidator fValENTITIES

Datatype validator: ENTITIES.

protected DatatypeValidator fValENTITY

Datatype validator: ENTITY.

protected DatatypeValidator fValID

Datatype validator: ID.

protected DatatypeValidator fValIDRef

Datatype validator: IDREF.

protected DatatypeValidator fValIDRefs

Datatype validator: IDREFS.

protected DatatypeValidator fValNMTOKEN

Datatype validator: NMTOKEN.

protected DatatypeValidator fValNMTOKENS

Datatype validator: NMTOKENS.

protected DatatypeValidator fValNOTATION

Datatype validator: NOTATION.

protected boolean fValidation

Validation.

protected ValidationManager fValidationManager

protected ValidationState fValidationState

protected boolean fWarnDuplicateAttdef

warn on duplicate attribute definition, this feature works only when validation is true

Public Constructors

public XMLDTDValidator ()

Default constructor.

Public Methods

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 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 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 final boolean hasGrammar ()

Returns true if the validator has a DTD grammar

Returns
  • true if the validator has a DTD grammar

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 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 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 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 startParameterEntity call.

Note: This method is only called for external parameter entities referenced in the DTD.

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 final boolean validate ()

Return true if validator must validate the document

Returns
  • true if validator must validate the document

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.

Protected Methods

protected void addDTDDefaultAttrsAndValidate (QName elementName, int elementIndex, XMLAttributes attributes)

Add default attributes and validate.

Throws
XNIException

protected void endNamespaceScope (QName element, Augmentations augs, boolean isEmpty)

protected String getExternalEntityRefInAttrValue (String nonNormalizedValue)

Checks entities in attribute values for standalone VC.

protected void handleEndElement (QName element, Augmentations augs, boolean isEmpty)

Handle end element.

Throws
XNIException

protected boolean handleStartElement (QName element, XMLAttributes attributes, Augmentations augs)

Handle element

Returns
  • true if validator is removed from the pipeline
Throws
XNIException

protected void init ()

initialization

protected boolean invalidStandaloneAttDef (QName element, QName attribute)

Returns true if invalid standalone attribute definition.

protected boolean isSpace (int c)

protected void startNamespaceScope (QName element, XMLAttributes attributes, Augmentations augs)

protected void validateDTDattribute (QName element, String attValue, XMLAttributeDecl attributeDecl)

Validate attributes in DTD fashion.

Throws
XNIException