Overview | Package | Class | Use | Tree | Deprecated | Index | Help
|  | BEA Systems, Inc.
PREV CLASS NEXT CLASS | FRAMES NO FRAMES
SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD

WebLogic Server 8.1 API Reference

## weblogic.apache.xerces.impl.dtd
Class XMLDTDValidator

    java.lang.Object
      |
      +--weblogic.apache.xerces.impl.dtd.XMLDTDValidator

public class XMLDTDValidator
extends java.lang.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 java.lang.String` | `DATATYPE_VALIDATOR_FACTORY` Property identifier: datatype validator factory.
`protected static java.lang.String` | `DYNAMIC_VALIDATION` Feature identifier: dynamic validation.
`protected static java.lang.String` | `ERROR_REPORTER` Property identifier: error reporter.
`protected DTDDVFactory` | `fDatatypeValidatorFactory` Datatype validator factory.
`protected XMLResourceIdentifier` | `fDocLocation`
`protected XMLDocumentHandler` | `fDocumentHandler` Document handler.
`protected XMLDocumentSource` | `fDocumentSource`
`protected DTDGrammar` | `fDTDGrammar` DTD Grammar.
`protected boolean` | `fDTDValidation` Validation against only DTD
`protected boolean` | `fDynamicValidation` Dynamic validation.
`protected XMLErrorReporter` | `fErrorReporter` Error reporter.
`protected DTDGrammarBucket` | `fGrammarBucket` Grammar bucket.
`protected XMLGrammarPool` | `fGrammarPool`
`protected boolean` | `fNamespaces` Namespaces.
`protected SymbolTable` | `fSymbolTable` Symbol table.
`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
`protected static java.lang.String` | `GRAMMAR_POOL` Property identifier: grammar pool.
`protected static java.lang.String` | `NAMESPACES` Feature identifier: namespaces.
`protected 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`
`protected static java.lang.String` | `WARN_ON_DUPLICATE_ATTDEF` Feature identifier: warn on duplicate attdef

Constructor Summary
`XMLDTDValidator()` Default constructor.

Method Summary
`void` | `characters(XMLString text, Augmentations augs)` Character content.
`void` | `comment(XMLString text, Augmentations augs)` A comment.
`void` | `doctypeDecl(java.lang.String rootElement, java.lang.String publicId, java.lang.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(java.lang.String name, Augmentations augs)` This method notifies the end of a general entity.
`void` | `endPrefixMapping(java.lang.String prefix, Augmentations augs)` The end of a namespace prefix mapping.
`XMLDocumentHandler` | `getDocumentHandler()` Returns the document handler
`XMLDocumentSource` | `getDocumentSource()` Returns the document source
`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.
`protected void` | `handleEndElement(QName element, Augmentations augs, boolean isEmpty)` Handle end element.
`protected boolean` | `handleStartElement(QName element, XMLAttributes attributes)` Handle element
`void` | `ignorableWhitespace(XMLString text, Augmentations augs)` Ignorable whitespace.
`void` | `processingInstruction(java.lang.String target, XMLString data, Augmentations augs)` A processing instruction.
`void` | `reset(XMLComponentManager componentManager)`
`void` | `setDocumentHandler(XMLDocumentHandler documentHandler)` Sets the document handler to receive information about the document.
`void` | `setDocumentSource(XMLDocumentSource source)` Sets the document source
`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(Augmentations augs)` The start of a CDATA section.
`void` | `startDocument(XMLLocator locator, java.lang.String encoding, Augmentations augs)` The start of the document.
`void` | `startElement(QName element, XMLAttributes attributes, Augmentations augs)` The start of an element.
`void` | `startGeneralEntity(java.lang.String name, XMLResourceIdentifier identifier, java.lang.String encoding, Augmentations augs)` This method notifies the start of a general entity.
`void` | `startPrefixMapping(java.lang.String prefix, java.lang.String uri, Augmentations augs)` The start of a namespace prefix mapping.
`void` | `textDecl(java.lang.String version, java.lang.String encoding, 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, 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

  Feature identifier: namespaces.

### VALIDATION

    protected static final java.lang.String VALIDATION

  Feature identifier: validation.

### DYNAMIC_VALIDATION

    protected static final java.lang.String DYNAMIC_VALIDATION

  Feature identifier: dynamic validation.

### WARN_ON_DUPLICATE_ATTDEF

    protected static final java.lang.String WARN_ON_DUPLICATE_ATTDEF

  Feature identifier: warn on duplicate attdef

### SYMBOL_TABLE

    protected static final java.lang.String SYMBOL_TABLE

  Property identifier: symbol table.

### ERROR_REPORTER

    protected static final java.lang.String ERROR_REPORTER

  Property identifier: error reporter.

### GRAMMAR_POOL

    protected static final java.lang.String GRAMMAR_POOL

  Property identifier: grammar pool.

### DATATYPE_VALIDATOR_FACTORY

    protected static final java.lang.String DATATYPE_VALIDATOR_FACTORY

  Property identifier: datatype validator factory.

### VALIDATION_MANAGER

    protected static final java.lang.String VALIDATION_MANAGER

### fValidationManager

    protected ValidationManager fValidationManager

### fValidationState

    protected ValidationState fValidationState

### fNamespaces

    protected boolean fNamespaces

  Namespaces.

### fValidation

    protected boolean fValidation

  Validation.

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

### fWarnDuplicateAttdef

    protected boolean fWarnDuplicateAttdef

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

### fSymbolTable

    protected SymbolTable fSymbolTable

  Symbol table.

### fErrorReporter

    protected XMLErrorReporter fErrorReporter

  Error reporter.

### fGrammarPool

    protected XMLGrammarPool fGrammarPool

### fGrammarBucket

    protected DTDGrammarBucket fGrammarBucket

  Grammar bucket.

### fDocLocation

    protected XMLResourceIdentifier fDocLocation

### fDatatypeValidatorFactory

    protected DTDDVFactory fDatatypeValidatorFactory

  Datatype validator factory.

### fDocumentHandler

    protected XMLDocumentHandler fDocumentHandler

  Document handler.

### fDocumentSource

    protected XMLDocumentSource fDocumentSource

### fDTDGrammar

    protected DTDGrammar fDTDGrammar

  DTD Grammar.

Constructor Detail

### XMLDTDValidator

    public XMLDTDValidator()

  Default constructor.

Method Detail

### reset

    public void reset(XMLComponentManager componentManager)
               throws XMLConfigurationException

  Specified by:
    reset in interface XMLComponent

### 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 XMLComponent

### setFeature

    public void setFeature(java.lang.String featureId,
                           boolean state)
                    throws 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 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 XMLComponent

### setProperty

    public void setProperty(java.lang.String propertyId,
                            java.lang.Object value)
                     throws 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 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(XMLDocumentHandler documentHandler)

  Sets the document handler to receive information about the document.

### getDocumentHandler

    public XMLDocumentHandler getDocumentHandler()

  Returns the document handler

### setDocumentSource

    public void setDocumentSource(XMLDocumentSource source)

  Sets the document source

### getDocumentSource

    public XMLDocumentSource getDocumentSource()

  Returns the document source

### startDocument

    public void startDocument(XMLLocator locator,
                              java.lang.String encoding,
                              Augmentations augs)
                       throws XNIException

  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).
    `augs` - Additional information that may include infoset augmentations
  Throws:
    XNIException - Thrown by handler to signal an error.

### xmlDecl

    public void xmlDecl(java.lang.String version,
                        java.lang.String encoding,
                        java.lang.String standalone,
                        Augmentations augs)
                 throws 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.
    `augs` - Additional information that may include infoset augmentations
  Throws:
    XNIException - Thrown by handler to signal an error.

### doctypeDecl

    public void doctypeDecl(java.lang.String rootElement,
                            java.lang.String publicId,
                            java.lang.String systemId,
                            Augmentations augs)
                     throws 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.
    `augs` - Additional information that may include infoset augmentations
  Throws:
    XNIException - Thrown by handler to signal an error.

### startPrefixMapping

    public void startPrefixMapping(java.lang.String prefix,
                                   java.lang.String uri,
                                   Augmentations augs)
                            throws 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.
    `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

  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.

### emptyElement

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

  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.

### characters

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

  Character content.

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

### ignorableWhitespace

    public void ignorableWhitespace(XMLString text,
                                    Augmentations augs)
                             throws 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.
    `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

  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.

### endPrefixMapping

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

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

  Parameters:
    `prefix` - The namespace prefix.
    `augs` - Additional information that may include infoset augmentations
  Throws:
    XNIException - Thrown by handler to signal an error.

### startCDATA

    public void startCDATA(Augmentations augs)
                    throws XNIException

  The start of a CDATA section.

  Parameters:
    `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

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

  The end of the document.

  Parameters:
    `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

  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.

### processingInstruction

    public void processingInstruction(java.lang.String target,
                                      XMLString data,
                                      Augmentations augs)
                               throws 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.
    `augs` - Additional information that may include infoset augmentations
  Throws:
    XNIException - Thrown by handler to signal an error.

### startGeneralEntity

    public void startGeneralEntity(java.lang.String name,
                                   XMLResourceIdentifier identifier,
                                   java.lang.String encoding,
                                   Augmentations augs)
                            throws XNIException

  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.

### endGeneralEntity

    public void endGeneralEntity(java.lang.String name,
                                 Augmentations augs)
                          throws XNIException

  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.

### textDecl

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

  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.

### handleStartElement

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

  Handle element

  Returns:
    true if validator is removed from the pipeline

### handleEndElement

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

  Handle end element.

Overview | Package | Class | Use | Tree | Deprecated | Index | Help
| Documentation is available at http://e-docs.bea.com/wls/docs81
PREV CLASS NEXT CLASS | FRAMES NO FRAMES
SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD