org.apache.xerces.impl.dtd

Class XMLDTDValidator

public class XMLDTDValidator extends Object implements XMLComponent, XMLDocumentFilter, XMLDTDValidatorFilter, RevalidationHandler

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:

Version: $Id: XMLDTDValidator.java,v 1.62 2005/05/10 15:36:42 ankitp Exp $

Author: Eric Ye, IBM Andy Clark, IBM Jeffrey Rodriguez IBM Neil Graham, IBM

UNKNOWN:

Field Summary
protected static StringDATATYPE_VALIDATOR_FACTORY
Property identifier: datatype validator factory.
protected static StringDYNAMIC_VALIDATION
Feature identifier: dynamic validation.
protected static StringERROR_REPORTER
Property identifier: error reporter.
protected DTDDVFactoryfDatatypeValidatorFactory
Datatype validator factory.
protected XMLLocatorfDocLocation
protected XMLDocumentHandlerfDocumentHandler
Document handler.
protected XMLDocumentSourcefDocumentSource
protected DTDGrammarfDTDGrammar
DTD Grammar.
protected booleanfDTDValidation
Validation against only DTD
protected booleanfDynamicValidation
Dynamic validation.
protected XMLErrorReporterfErrorReporter
Error reporter.
protected DTDGrammarBucketfGrammarBucket
Grammar bucket.
protected XMLGrammarPoolfGrammarPool
protected NamespaceContextfNamespaceContext
Namespace support.
protected booleanfNamespaces
Namespaces.
protected booleanfSeenDoctypeDecl
True if seen DOCTYPE declaration.
protected SymbolTablefSymbolTable
Symbol table.
protected DatatypeValidatorfValENTITIES
Datatype validator: ENTITIES.
protected DatatypeValidatorfValENTITY
Datatype validator: ENTITY.
protected booleanfValidation
Validation.
protected ValidationManagerfValidationManager
protected ValidationStatefValidationState
protected DatatypeValidatorfValID
Datatype validator: ID.
protected DatatypeValidatorfValIDRef
Datatype validator: IDREF.
protected DatatypeValidatorfValIDRefs
Datatype validator: IDREFS.
protected DatatypeValidatorfValNMTOKEN
Datatype validator: NMTOKEN.
protected DatatypeValidatorfValNMTOKENS
Datatype validator: NMTOKENS.
protected DatatypeValidatorfValNOTATION
Datatype validator: NOTATION.
protected booleanfWarnDuplicateAttdef
warn on duplicate attribute definition, this feature works only when validation is true
protected static StringGRAMMAR_POOL
Property identifier: grammar pool.
protected static StringNAMESPACES
Feature identifier: namespaces.
protected static StringPARSER_SETTINGS
protected static StringSYMBOL_TABLE
Property identifier: symbol table.
protected static StringVALIDATION
Feature identifier: validation.
protected static StringVALIDATION_MANAGER
protected static StringWARN_ON_DUPLICATE_ATTDEF
Feature identifier: warn on duplicate attdef
Constructor Summary
XMLDTDValidator()
Default constructor.
Method Summary
protected voidaddDTDDefaultAttrsAndValidate(QName elementName, int elementIndex, XMLAttributes attributes)
Add default attributes and validate.
booleancharacterData(String data, Augmentations augs)
voidcharacters(XMLString text, Augmentations augs)
Character content.
voidcomment(XMLString text, Augmentations augs)
A comment.
voiddoctypeDecl(String rootElement, String publicId, String systemId, Augmentations augs)
Notifies of the presence of the DOCTYPE line in the document.
voidemptyElement(QName element, XMLAttributes attributes, Augmentations augs)
An empty element.
voidendCDATA(Augmentations augs)
The end of a CDATA section.
voidendDocument(Augmentations augs)
The end of the document.
voidendElement(QName element, Augmentations augs)
The end of an element.
voidendGeneralEntity(String name, Augmentations augs)
This method notifies the end of a general entity.
protected voidendNamespaceScope(QName element, Augmentations augs, boolean isEmpty)
XMLDocumentHandlergetDocumentHandler()
Returns the document handler
XMLDocumentSourcegetDocumentSource()
Returns the document source
protected StringgetExternalEntityRefInAttrValue(String nonNormalizedValue)
Checks entities in attribute values for standalone VC.
BooleangetFeatureDefault(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.
ObjectgetPropertyDefault(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.
protected voidhandleEndElement(QName element, Augmentations augs, boolean isEmpty)
Handle end element.
protected booleanhandleStartElement(QName element, XMLAttributes attributes, Augmentations augs)
Handle element
booleanhasGrammar()
voidignorableWhitespace(XMLString text, Augmentations augs)
Ignorable whitespace.
protected voidinit()
initialization
protected booleaninvalidStandaloneAttDef(QName element, QName attribute)
Returns true if invalid standalone attribute definition.
protected booleanisSpace(int c)
voidprocessingInstruction(String target, XMLString data, Augmentations augs)
A processing instruction.
voidreset(XMLComponentManager componentManager)
voidsetDocumentHandler(XMLDocumentHandler documentHandler)
Sets the document handler to receive information about the document.
voidsetDocumentSource(XMLDocumentSource source)
Sets the document source
voidsetFeature(String featureId, boolean state)
Sets the state of a feature.
voidsetProperty(String propertyId, Object value)
Sets the value of a property.
voidstartCDATA(Augmentations augs)
The start of a CDATA section.
voidstartDocument(XMLLocator locator, String encoding, NamespaceContext namespaceContext, Augmentations augs)
The start of the document.
voidstartElement(QName element, XMLAttributes attributes, Augmentations augs)
The start of an element.
voidstartGeneralEntity(String name, XMLResourceIdentifier identifier, String encoding, Augmentations augs)
This method notifies the start of a general entity.
protected voidstartNamespaceScope(QName element, XMLAttributes attributes, Augmentations augs)
voidtextDecl(String version, String encoding, Augmentations augs)
Notifies of the presence of a TextDecl line in an entity.
booleanvalidate()
protected voidvalidateDTDattribute(QName element, String attValue, XMLAttributeDecl attributeDecl)
Validate attributes in DTD fashion.
voidxmlDecl(String version, String encoding, String standalone, Augmentations augs)
Notifies of the presence of an XMLDecl line in the document.

Field Detail

DATATYPE_VALIDATOR_FACTORY

protected static final String DATATYPE_VALIDATOR_FACTORY
Property identifier: datatype validator factory.

DYNAMIC_VALIDATION

protected static final String DYNAMIC_VALIDATION
Feature identifier: dynamic validation.

ERROR_REPORTER

protected static final String ERROR_REPORTER
Property identifier: error reporter.

fDatatypeValidatorFactory

protected DTDDVFactory fDatatypeValidatorFactory
Datatype validator factory.

fDocLocation

protected XMLLocator fDocLocation

fDocumentHandler

protected XMLDocumentHandler fDocumentHandler
Document handler.

fDocumentSource

protected XMLDocumentSource fDocumentSource

fDTDGrammar

protected DTDGrammar fDTDGrammar
DTD Grammar.

fDTDValidation

protected boolean fDTDValidation
Validation against only DTD

fDynamicValidation

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

fErrorReporter

protected XMLErrorReporter fErrorReporter
Error reporter.

fGrammarBucket

protected DTDGrammarBucket fGrammarBucket
Grammar bucket.

fGrammarPool

protected XMLGrammarPool fGrammarPool

fNamespaceContext

protected NamespaceContext fNamespaceContext
Namespace support.

fNamespaces

protected boolean fNamespaces
Namespaces.

fSeenDoctypeDecl

protected boolean fSeenDoctypeDecl
True if seen DOCTYPE declaration.

fSymbolTable

protected SymbolTable fSymbolTable
Symbol table.

fValENTITIES

protected DatatypeValidator fValENTITIES
Datatype validator: ENTITIES.

fValENTITY

protected DatatypeValidator fValENTITY
Datatype validator: ENTITY.

fValidation

protected boolean fValidation
Validation.

fValidationManager

protected ValidationManager fValidationManager

fValidationState

protected ValidationState fValidationState

fValID

protected DatatypeValidator fValID
Datatype validator: ID.

fValIDRef

protected DatatypeValidator fValIDRef
Datatype validator: IDREF.

fValIDRefs

protected DatatypeValidator fValIDRefs
Datatype validator: IDREFS.

fValNMTOKEN

protected DatatypeValidator fValNMTOKEN
Datatype validator: NMTOKEN.

fValNMTOKENS

protected DatatypeValidator fValNMTOKENS
Datatype validator: NMTOKENS.

fValNOTATION

protected DatatypeValidator fValNOTATION
Datatype validator: NOTATION.

fWarnDuplicateAttdef

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

GRAMMAR_POOL

protected static final String GRAMMAR_POOL
Property identifier: grammar pool.

NAMESPACES

protected static final String NAMESPACES
Feature identifier: namespaces.

PARSER_SETTINGS

protected static final String PARSER_SETTINGS

SYMBOL_TABLE

protected static final String SYMBOL_TABLE
Property identifier: symbol table.

VALIDATION

protected static final String VALIDATION
Feature identifier: validation.

VALIDATION_MANAGER

protected static final String VALIDATION_MANAGER

WARN_ON_DUPLICATE_ATTDEF

protected static final String WARN_ON_DUPLICATE_ATTDEF
Feature identifier: warn on duplicate attdef

Constructor Detail

XMLDTDValidator

public XMLDTDValidator()
Default constructor.

Method Detail

addDTDDefaultAttrsAndValidate

protected void addDTDDefaultAttrsAndValidate(QName elementName, int elementIndex, XMLAttributes attributes)
Add default attributes and validate.

characterData

public boolean characterData(String data, Augmentations augs)

characters

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.

comment

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.

doctypeDecl

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.

emptyElement

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.

endCDATA

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.

endDocument

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.

endElement

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.

endGeneralEntity

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.

endNamespaceScope

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

getDocumentHandler

public XMLDocumentHandler getDocumentHandler()
Returns the document handler

getDocumentSource

public XMLDocumentSource getDocumentSource()
Returns the document source

getExternalEntityRefInAttrValue

protected String getExternalEntityRefInAttrValue(String nonNormalizedValue)
Checks entities in attribute values for standalone VC.

getFeatureDefault

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.

Since: Xerces 2.2.0

getPropertyDefault

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.

Since: Xerces 2.2.0

getRecognizedFeatures

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.

getRecognizedProperties

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.

handleEndElement

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

handleStartElement

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

Returns: true if validator is removed from the pipeline

hasGrammar

public final boolean hasGrammar()

ignorableWhitespace

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.

init

protected void init()
initialization

invalidStandaloneAttDef

protected boolean invalidStandaloneAttDef(QName element, QName attribute)
Returns true if invalid standalone attribute definition.

isSpace

protected boolean isSpace(int c)

processingInstruction

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.

reset

public void reset(XMLComponentManager componentManager)

setDocumentHandler

public void setDocumentHandler(XMLDocumentHandler documentHandler)
Sets the document handler to receive information about the document.

setDocumentSource

public void setDocumentSource(XMLDocumentSource source)
Sets the document source

setFeature

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: SAXNotRecognizedException The component should not throw this exception. SAXNotSupportedException The component should not throw this exception.

setProperty

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: SAXNotRecognizedException The component should not throw this exception. SAXNotSupportedException The component should not throw this exception.

startCDATA

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.

startDocument

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.

startElement

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.

startGeneralEntity

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.

startNamespaceScope

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

textDecl

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.

validate

public final boolean validate()

validateDTDattribute

protected void validateDTDattribute(QName element, String attValue, XMLAttributeDecl attributeDecl)
Validate attributes in DTD fashion.

xmlDecl

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.

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