BEA WebLogic Server 9.1 API Reference

weblogic.apache.xerces.impl.dtd
Class XMLDTDValidator

java.lang.Object
  weblogic.apache.xerces.impl.dtd.XMLDTDValidator

All Implemented Interfaces:

XMLComponent, XMLDocumentFilter, XMLDocumentHandler, XMLDocumentSource

Deprecated. please use JDK supplied XML parsers and transformers

public class XMLDTDValidator

extends Object

implements XMLComponent, XMLDocumentFilter

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

Field Summary

protected static String	DATATYPE_VALIDATOR_FACTORY Deprecated. Property identifier: datatype validator factory.
protected static String	DYNAMIC_VALIDATION Deprecated. Feature identifier: dynamic validation.
protected static String	ERROR_REPORTER Deprecated. Property identifier: error reporter.
protected DTDDVFactory	fDatatypeValidatorFactory Deprecated. Datatype validator factory.
protected XMLResourceIdentifier	fDocLocation Deprecated.
protected XMLDocumentHandler	fDocumentHandler Deprecated. Document handler.
protected XMLDocumentSource	fDocumentSource Deprecated.
protected DTDGrammar	fDTDGrammar Deprecated. DTD Grammar.
protected boolean	fDTDValidation Deprecated. Validation against only DTD
protected boolean	fDynamicValidation Deprecated. Dynamic validation.
protected XMLErrorReporter	fErrorReporter Deprecated. Error reporter.
protected DTDGrammarBucket	fGrammarBucket Deprecated. Grammar bucket.
protected XMLGrammarPool	fGrammarPool Deprecated.
protected boolean	fNamespaces Deprecated. Namespaces.
protected SymbolTable	fSymbolTable Deprecated. Symbol table.
protected boolean	fValidation Deprecated. Validation.
protected ValidationManager	fValidationManager Deprecated.
protected ValidationState	fValidationState Deprecated.
protected boolean	fWarnDuplicateAttdef Deprecated. warn on duplicate attribute definition, this feature works only when validation is true
protected static String	GRAMMAR_POOL Deprecated. Property identifier: grammar pool.
protected static String	NAMESPACES Deprecated. Feature identifier: namespaces.
protected static String	SYMBOL_TABLE Deprecated. Property identifier: symbol table.
protected static String	VALIDATION Deprecated. Feature identifier: validation.
protected static String	VALIDATION_MANAGER Deprecated.
protected static String	WARN_ON_DUPLICATE_ATTDEF Deprecated. Feature identifier: warn on duplicate attdef

Constructor Summary

XMLDTDValidator()
Deprecated. Default constructor.

Method Summary

void	characters(XMLString text, Augmentations augs) Deprecated. Character content.
void	comment(XMLString text, Augmentations augs) Deprecated. A comment.
void	doctypeDecl(String rootElement, String publicId, String systemId, Augmentations augs) Deprecated. Notifies of the presence of the DOCTYPE line in the document.
void	emptyElement(QName element, XMLAttributes attributes, Augmentations augs) Deprecated. An empty element.
void	endCDATA(Augmentations augs) Deprecated. The end of a CDATA section.
void	endDocument(Augmentations augs) Deprecated. The end of the document.
void	endElement(QName element, Augmentations augs) Deprecated. The end of an element.
void	endGeneralEntity(String name, Augmentations augs) Deprecated. This method notifies the end of a general entity.
void	endPrefixMapping(String prefix, Augmentations augs) Deprecated. The end of a namespace prefix mapping.
XMLDocumentHandler	getDocumentHandler() Deprecated. Returns the document handler
XMLDocumentSource	getDocumentSource() Deprecated. Returns the document source
String[]	getRecognizedFeatures() Deprecated. Returns a list of feature identifiers that are recognized by this component.
String[]	getRecognizedProperties() Deprecated. Returns a list of property identifiers that are recognized by this component.
protected void	handleEndElement(QName element, Augmentations augs, boolean isEmpty) Deprecated. Handle end element.
protected boolean	handleStartElement(QName element, XMLAttributes attributes) Deprecated. Handle element
void	ignorableWhitespace(XMLString text, Augmentations augs) Deprecated. Ignorable whitespace.
void	processingInstruction(String target, XMLString data, Augmentations augs) Deprecated. A processing instruction.
void	reset(XMLComponentManager componentManager) Deprecated.
void	setDocumentHandler(XMLDocumentHandler documentHandler) Deprecated. Sets the document handler to receive information about the document.
void	setDocumentSource(XMLDocumentSource source) Deprecated. Sets the document source
void	setFeature(String featureId, boolean state) Deprecated. Sets the state of a feature.
void	setProperty(String propertyId, Object value) Deprecated. Sets the value of a property.
void	startCDATA(Augmentations augs) Deprecated. The start of a CDATA section.
void	startDocument(XMLLocator locator, String encoding, Augmentations augs) Deprecated. The start of the document.
void	startElement(QName element, XMLAttributes attributes, Augmentations augs) Deprecated. The start of an element.
void	startGeneralEntity(String name, XMLResourceIdentifier identifier, String encoding, Augmentations augs) Deprecated. This method notifies the start of a general entity.
void	startPrefixMapping(String prefix, String uri, Augmentations augs) Deprecated. The start of a namespace prefix mapping.
void	textDecl(String version, String encoding, Augmentations augs) Deprecated. Notifies of the presence of a TextDecl line in an entity.
void	xmlDecl(String version, String encoding, String standalone, Augmentations augs) Deprecated. 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

DATATYPE_VALIDATOR_FACTORY

protected static final String DATATYPE_VALIDATOR_FACTORY

Deprecated.

Property identifier: datatype validator factory.

See Also:

Constant Field Values

DYNAMIC_VALIDATION

protected static final String DYNAMIC_VALIDATION

Deprecated.

Feature identifier: dynamic validation.

See Also:

Constant Field Values

ERROR_REPORTER

protected static final String ERROR_REPORTER

Deprecated.

Property identifier: error reporter.

See Also:

Constant Field Values

fDatatypeValidatorFactory

protected DTDDVFactory fDatatypeValidatorFactory

Deprecated.

Datatype validator factory.

fDocLocation

protected XMLResourceIdentifier fDocLocation

Deprecated.

fDocumentHandler

protected XMLDocumentHandler fDocumentHandler

Deprecated.

Document handler.

fDocumentSource

protected XMLDocumentSource fDocumentSource

Deprecated.

fDTDGrammar

protected DTDGrammar fDTDGrammar

Deprecated.

DTD Grammar.

fDTDValidation

protected boolean fDTDValidation

Deprecated.

Validation against only DTD

fDynamicValidation

protected boolean fDynamicValidation

Deprecated.

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

fErrorReporter

protected XMLErrorReporter fErrorReporter

Deprecated.

Error reporter.

fGrammarBucket

protected DTDGrammarBucket fGrammarBucket

Deprecated.

Grammar bucket.

fGrammarPool

protected XMLGrammarPool fGrammarPool

Deprecated.

fNamespaces

protected boolean fNamespaces

Deprecated.

Namespaces.

fSymbolTable

protected SymbolTable fSymbolTable

Deprecated.

Symbol table.

fValidation

protected boolean fValidation

Deprecated.

Validation.

fValidationManager

protected ValidationManager fValidationManager

Deprecated.

fValidationState

protected ValidationState fValidationState

Deprecated.

fWarnDuplicateAttdef

protected boolean fWarnDuplicateAttdef

Deprecated.

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

GRAMMAR_POOL

protected static final String GRAMMAR_POOL

Deprecated.

Property identifier: grammar pool.

See Also:

Constant Field Values

NAMESPACES

protected static final String NAMESPACES

Deprecated.

Feature identifier: namespaces.

See Also:

Constant Field Values

SYMBOL_TABLE

protected static final String SYMBOL_TABLE

Deprecated.

Property identifier: symbol table.

See Also:

Constant Field Values

VALIDATION

protected static final String VALIDATION

Deprecated.

Feature identifier: validation.

See Also:

Constant Field Values

VALIDATION_MANAGER

protected static final String VALIDATION_MANAGER

Deprecated.

See Also:

Constant Field Values

WARN_ON_DUPLICATE_ATTDEF

protected static final String WARN_ON_DUPLICATE_ATTDEF

Deprecated.

Feature identifier: warn on duplicate attdef

See Also:

Constant Field Values

Constructor Detail

XMLDTDValidator

public XMLDTDValidator()

Deprecated.

Default constructor.

Method Detail

characters

public void characters(XMLString text,
                       Augmentations augs)
                throws XNIException

Deprecated.

Character content.

Specified by:

characters in interface XMLDocumentHandler

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)
             throws XNIException

Deprecated.

A comment.

Specified by:

comment in interface XMLDocumentHandler

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)
                 throws XNIException

Deprecated.

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

Specified by:

doctypeDecl in interface XMLDocumentHandler

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)
                  throws XNIException

Deprecated.

An empty element.

Specified by:

emptyElement in interface XMLDocumentHandler

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)
              throws XNIException

Deprecated.

The end of a CDATA section.

Specified by:

endCDATA in interface XMLDocumentHandler

Parameters:

augs - Additional information that may include infoset augmentations

Throws:

XNIException - Thrown by handler to signal an error.

endDocument

public void endDocument(Augmentations augs)
                 throws XNIException

Deprecated.

The end of the document.

Specified by:

endDocument in interface XMLDocumentHandler

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)
                throws XNIException

Deprecated.

The end of an element.

Specified by:

endElement in interface XMLDocumentHandler

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)
                      throws XNIException

Deprecated.

This method notifies the end of a general entity.

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

Specified by:

endGeneralEntity in interface XMLDocumentHandler

Parameters:

name - The name of the entity.

augs - Additional information that may include infoset augmentations

Throws:

XNIException - Thrown by handler to signal an error.

endPrefixMapping

public void endPrefixMapping(String prefix,
                             Augmentations augs)
                      throws XNIException

Deprecated.

The end of a namespace prefix mapping. This method will only be called when namespace processing is enabled.

Specified by:

endPrefixMapping in interface XMLDocumentHandler

Parameters:

prefix - The namespace prefix.

augs - Additional information that may include infoset augmentations

Throws:

XNIException - Thrown by handler to signal an error.

getDocumentHandler

public XMLDocumentHandler getDocumentHandler()

Deprecated.

Returns the document handler

Specified by:

getDocumentHandler in interface XMLDocumentSource

getDocumentSource

public XMLDocumentSource getDocumentSource()

Deprecated.

Returns the document source

Specified by:

getDocumentSource in interface XMLDocumentHandler

getRecognizedFeatures

public String[] getRecognizedFeatures()

Deprecated.

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 XMLComponent

getRecognizedProperties

public String[] getRecognizedProperties()

Deprecated.

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 XMLComponent

handleEndElement

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

Deprecated.

Handle end element.

Throws:

XNIException

handleStartElement

protected boolean handleStartElement(QName element,
                                     XMLAttributes attributes)
                              throws XNIException

Deprecated.

Handle element

Returns:

true if validator is removed from the pipeline

Throws:

XNIException

ignorableWhitespace

public void ignorableWhitespace(XMLString text,
                                Augmentations augs)
                         throws XNIException

Deprecated.

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.

Specified by:

ignorableWhitespace in interface XMLDocumentHandler

Parameters:

text - The ignorable whitespace.

augs - Additional information that may include infoset augmentations

Throws:

XNIException - Thrown by handler to signal an error.

processingInstruction

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

Deprecated.

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.

Specified by:

processingInstruction in interface XMLDocumentHandler

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)
           throws XMLConfigurationException

Deprecated.

Description copied from interface: 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 XMLComponent

Parameters:

componentManager - The component manager.

Throws:

XMLConfigurationException

setDocumentHandler

public void setDocumentHandler(XMLDocumentHandler documentHandler)

Deprecated.

Sets the document handler to receive information about the document.

Specified by:

setDocumentHandler in interface XMLDocumentSource

setDocumentSource

public void setDocumentSource(XMLDocumentSource source)

Deprecated.

Sets the document source

Specified by:

setDocumentSource in interface XMLDocumentHandler

setFeature

public void setFeature(String featureId,
                       boolean state)
                throws XMLConfigurationException

Deprecated.

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

XMLConfigurationException - Thrown for configuration error. In general, components should only throw this exception if it is really a critical error.

setProperty

public void setProperty(String propertyId,
                        Object value)
                 throws XMLConfigurationException

Deprecated.

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

XMLConfigurationException - Thrown for configuration error. In general, components should only throw this exception if it is really a critical error.

startCDATA

public void startCDATA(Augmentations augs)
                throws XNIException

Deprecated.

The start of a CDATA section.

Specified by:

startCDATA in interface XMLDocumentHandler

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,
                          Augmentations augs)
                   throws XNIException

Deprecated.

The start of the document.

Specified by:

startDocument in interface XMLDocumentHandler

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).

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)
                  throws XNIException

Deprecated.

The start of an element.

Specified by:

startElement in interface XMLDocumentHandler

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)
                        throws XNIException

Deprecated.

This method notifies the start of a general entity.

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

Specified by:

startGeneralEntity in interface XMLDocumentHandler

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.

startPrefixMapping

public void startPrefixMapping(String prefix,
                               String uri,
                               Augmentations augs)
                        throws XNIException

Deprecated.

The start of a namespace prefix mapping. This method will only be called when namespace processing is enabled.

Specified by:

startPrefixMapping in interface XMLDocumentHandler

Parameters:

prefix - The namespace prefix.

uri - The URI bound to the prefix.

augs - Additional information that may include infoset augmentations

Throws:

XNIException - Thrown by handler to signal an error.

textDecl

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

Deprecated.

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.

Specified by:

textDecl in interface XMLDocumentHandler

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.

xmlDecl

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

Deprecated.

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

Specified by:

xmlDecl in interface XMLDocumentHandler

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.