org.apache.xerces.impl

## Class XMLNamespaceBinder

- java.lang.Object
- - org.apache.xerces.impl.XMLNamespaceBinder

All Implemented Interfaces:
  org.apache.xerces.xni.parser.XMLComponent, org.apache.xerces.xni.parser.XMLDocumentFilter, org.apache.xerces.xni.parser.XMLDocumentSource, org.apache.xerces.xni.XMLDocumentHandler

Direct Known Subclasses:
  XML11NamespaceBinder

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

This class performs namespace binding on the startElement and endElement method calls and passes all other methods through to the registered document handler. This class can be configured to only pass the start and end prefix mappings (start/endPrefixMapping).

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

- http://xml.org/sax/features/namespaces
- http://apache.org/xml/properties/internal/symbol-table
- http://apache.org/xml/properties/internal/error-reporter

Version:
  $Id: XMLNamespaceBinder.java 572055 2007-09-02 17:55:43Z mrglavas $
Author:
  Andy Clark, IBM

# INTERNAL:

  Usage of this class is not supported. It may be altered or removed at any time.

### Field Summary

Fields
`protected static java.lang.String` `ERROR_REPORTER` Property identifier: error reporter.
`protected org.apache.xerces.xni.XMLDocumentHandler` `fDocumentHandler` Document handler.
`protected org.apache.xerces.xni.parser.XMLDocumentSource` `fDocumentSource`
`protected XMLErrorReporter` `fErrorReporter` Error reporter.
`protected boolean` `fNamespaces` Namespaces.
`protected boolean` `fOnlyPassPrefixMappingEvents` Only pass start and end prefix mapping events.
`protected SymbolTable` `fSymbolTable` Symbol table.
`protected static java.lang.String` `NAMESPACES` Feature identifier: namespaces.
`protected static java.lang.String` `SYMBOL_TABLE` Property identifier: symbol table.

### Constructor Summary

Constructors
Constructor and Description
`XMLNamespaceBinder()` Default constructor.

### Method Summary

All Methods Instance Methods Concrete Methods
`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` `endGeneralEntity(java.lang.String name, org.apache.xerces.xni.Augmentations augs)` This method notifies the end of a general entity.
`org.apache.xerces.xni.XMLDocumentHandler` `getDocumentHandler()` Returns the document handler
`org.apache.xerces.xni.parser.XMLDocumentSource` `getDocumentSource()` Returns the document source
`java.lang.Boolean` `getFeatureDefault(java.lang.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.
`boolean` `getOnlyPassPrefixMappingEvents()` Returns true if the namespace binder only passes the prefix mapping events to the registered document handler; false if the namespace binder passes all document events.
`java.lang.Object` `getPropertyDefault(java.lang.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.
`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(org.apache.xerces.xni.QName element, org.apache.xerces.xni.Augmentations augs, boolean isEmpty)` Handles end element.
`protected void` `handleStartElement(org.apache.xerces.xni.QName element, org.apache.xerces.xni.XMLAttributes attributes, org.apache.xerces.xni.Augmentations augs, boolean isEmpty)` Handles start element.
`void` `ignorableWhitespace(org.apache.xerces.xni.XMLString text, org.apache.xerces.xni.Augmentations augs)` Ignorable whitespace.
`protected boolean` `prefixBoundToNullURI(java.lang.String uri, java.lang.String localpart)`
`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` `setDocumentSource(org.apache.xerces.xni.parser.XMLDocumentSource source)` Sets the document source
`void` `setFeature(java.lang.String featureId, boolean state)` Sets the state of a feature.
`void` `setOnlyPassPrefixMappingEvents(boolean onlyPassPrefixMappingEvents)` Sets whether the namespace binder only passes the prefix mapping events to the registered document handler or passes all document events.
`void` `setProperty(java.lang.String propertyId, java.lang.Object value)` Sets the value of a property during parsing.
`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.NamespaceContext namespaceContext, 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)` Binds the namespaces.
`void` `startGeneralEntity(java.lang.String name, org.apache.xerces.xni.XMLResourceIdentifier identifier, java.lang.String encoding, org.apache.xerces.xni.Augmentations augs)` This method notifies the start of a general entity.
`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

Feature identifier: namespaces.

See Also:
  Constant Field Values

#### SYMBOL_TABLE

    protected static final java.lang.String SYMBOL_TABLE

Property identifier: symbol table.

See Also:
  Constant Field Values

#### ERROR_REPORTER

    protected static final java.lang.String ERROR_REPORTER

Property identifier: error reporter.

See Also:
  Constant Field Values

#### fNamespaces

    protected boolean fNamespaces

Namespaces.

#### fSymbolTable

    protected SymbolTable fSymbolTable

Symbol table.

#### fErrorReporter

    protected XMLErrorReporter fErrorReporter

Error reporter.

#### fDocumentHandler

    protected org.apache.xerces.xni.XMLDocumentHandler fDocumentHandler

Document handler.

#### fDocumentSource

    protected org.apache.xerces.xni.parser.XMLDocumentSource fDocumentSource

#### fOnlyPassPrefixMappingEvents

    protected boolean fOnlyPassPrefixMappingEvents

Only pass start and end prefix mapping events.

### Constructor Detail

#### XMLNamespaceBinder

    public XMLNamespaceBinder()

Default constructor.

### Method Detail

#### setOnlyPassPrefixMappingEvents

    public void setOnlyPassPrefixMappingEvents(boolean onlyPassPrefixMappingEvents)

Sets whether the namespace binder only passes the prefix mapping events to the registered document handler or passes all document events.

Parameters:
  `onlyPassPrefixMappingEvents` - True to pass only the prefix mapping events; false to pass all events.

#### getOnlyPassPrefixMappingEvents

    public boolean getOnlyPassPrefixMappingEvents()

Returns true if the namespace binder only passes the prefix mapping events to the registered document handler; false if the namespace binder passes all document events.

#### reset

    public void reset(org.apache.xerces.xni.parser.XMLComponentManager componentManager)
               throws org.apache.xerces.xni.XNIException

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`
Parameters:
  `componentManager` - The component manager.
Throws:
  `SAXException` - Thrown by component on initialization error. For example, if a feature or property is required for the operation of the component, the component manager may throw a SAXNotRecognizedException or a SAXNotSupportedException.
  `org.apache.xerces.xni.XNIException` - Thrown by component on initialization error.

#### 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.
  `org.apache.xerces.xni.parser.XMLConfigurationException` - Thrown for configuration error. In general, components should only throw this exception if it is really a critical error.

#### 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 during parsing.

Specified by:
  `setProperty` in interface `org.apache.xerces.xni.parser.XMLComponent`
Parameters:
  `propertyId` -
  `value` -
Throws:
  `org.apache.xerces.xni.parser.XMLConfigurationException` - Thrown for configuration error. In general, components should only throw this exception if it is really a critical error.

#### getFeatureDefault

    public java.lang.Boolean getFeatureDefault(java.lang.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.

Specified by:
  `getFeatureDefault` in interface `org.apache.xerces.xni.parser.XMLComponent`
Parameters:
  `featureId` - The feature identifier.
Since:
  Xerces 2.2.0

#### getPropertyDefault

    public java.lang.Object getPropertyDefault(java.lang.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.

Specified by:
  `getPropertyDefault` in interface `org.apache.xerces.xni.parser.XMLComponent`
Parameters:
  `propertyId` - The property identifier.
Since:
  Xerces 2.2.0

#### setDocumentHandler

    public void setDocumentHandler(org.apache.xerces.xni.XMLDocumentHandler documentHandler)

Sets the document handler to receive information about the document.

Specified by:
  `setDocumentHandler` in interface `org.apache.xerces.xni.parser.XMLDocumentSource`

#### getDocumentHandler

    public org.apache.xerces.xni.XMLDocumentHandler getDocumentHandler()

Returns the document handler

Specified by:
  `getDocumentHandler` in interface `org.apache.xerces.xni.parser.XMLDocumentSource`

#### setDocumentSource

    public void setDocumentSource(org.apache.xerces.xni.parser.XMLDocumentSource source)

Sets the document source

Specified by:
  `setDocumentSource` in interface `org.apache.xerces.xni.XMLDocumentHandler`

#### getDocumentSource

    public org.apache.xerces.xni.parser.XMLDocumentSource getDocumentSource()

Returns the document source

Specified by:
  `getDocumentSource` in interface `org.apache.xerces.xni.XMLDocumentHandler`

#### startGeneralEntity

    public void startGeneralEntity(java.lang.String name,
                                   org.apache.xerces.xni.XMLResourceIdentifier identifier,
                                   java.lang.String encoding,
                                   org.apache.xerces.xni.Augmentations augs)
                            throws org.apache.xerces.xni.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.

Specified by:
  `startGeneralEntity` in interface `org.apache.xerces.xni.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:
  `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.

Specified by:
  `textDecl` in interface `org.apache.xerces.xni.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:
  `org.apache.xerces.xni.XNIException` - Thrown by handler to signal an error.

#### startDocument

    public void startDocument(org.apache.xerces.xni.XMLLocator locator,
                              java.lang.String encoding,
                              org.apache.xerces.xni.NamespaceContext namespaceContext,
                              org.apache.xerces.xni.Augmentations augs)
                       throws org.apache.xerces.xni.XNIException

The start of the document.

Specified by:
  `startDocument` in interface `org.apache.xerces.xni.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).
  `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:
  `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.

Specified by:
  `xmlDecl` in interface `org.apache.xerces.xni.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:
  `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.

Specified by:
  `doctypeDecl` in interface `org.apache.xerces.xni.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:
  `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.

Specified by:
  `comment` in interface `org.apache.xerces.xni.XMLDocumentHandler`
Parameters:
  `text` - The text in the comment.
  `augs` - Additional information that may include infoset augmentations
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.

Specified by:
  `processingInstruction` in interface `org.apache.xerces.xni.XMLDocumentHandler`
Parameters:
  `target` - The target.
  `data` - The data or null if none specified.
  `augs` - Additional information that may include infoset augmentations
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

Binds the namespaces. This method will handle calling the document handler to start the prefix mappings.

Note: This method makes use of the fAttributeQName variable. Any contents of the variable will be destroyed. Caller should copy the values out of this temporary variable before calling this method.

Specified by:
  `startElement` in interface `org.apache.xerces.xni.XMLDocumentHandler`
Parameters:
  `element` - The name of the element.
  `attributes` - The element attributes.
  `augs` - Additional information that may include infoset augmentations
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.

Specified by:
  `emptyElement` in interface `org.apache.xerces.xni.XMLDocumentHandler`
Parameters:
  `element` - The name of the element.
  `attributes` - The element attributes.
  `augs` - Additional information that may include infoset augmentations
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.

Specified by:
  `characters` in interface `org.apache.xerces.xni.XMLDocumentHandler`
Parameters:
  `text` - The content.
  `augs` - Additional information that may include infoset augmentations
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.

Specified by:
  `ignorableWhitespace` in interface `org.apache.xerces.xni.XMLDocumentHandler`
Parameters:
  `text` - The ignorable whitespace.
  `augs` - Additional information that may include infoset augmentations
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.

Specified by:
  `endElement` in interface `org.apache.xerces.xni.XMLDocumentHandler`
Parameters:
  `element` - The name of the element.
  `augs` - Additional information that may include infoset augmentations
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.

Specified by:
  `startCDATA` in interface `org.apache.xerces.xni.XMLDocumentHandler`
Parameters:
  `augs` - Additional information that may include infoset augmentations
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.

Specified by:
  `endCDATA` in interface `org.apache.xerces.xni.XMLDocumentHandler`
Parameters:
  `augs` - Additional information that may include infoset augmentations
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.

Specified by:
  `endDocument` in interface `org.apache.xerces.xni.XMLDocumentHandler`
Parameters:
  `augs` - Additional information that may include infoset augmentations
Throws:
  `org.apache.xerces.xni.XNIException` - Thrown by handler to signal an error.

#### endGeneralEntity

    public void endGeneralEntity(java.lang.String name,
                                 org.apache.xerces.xni.Augmentations augs)
                          throws org.apache.xerces.xni.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.

Specified by:
  `endGeneralEntity` in interface `org.apache.xerces.xni.XMLDocumentHandler`
Parameters:
  `name` - The name of the entity.
  `augs` - Additional information that may include infoset augmentations
Throws:
  `org.apache.xerces.xni.XNIException` - Thrown by handler to signal an error.

#### handleStartElement

    protected void handleStartElement(org.apache.xerces.xni.QName element,
                                      org.apache.xerces.xni.XMLAttributes attributes,
                                      org.apache.xerces.xni.Augmentations augs,
                                      boolean isEmpty)
                               throws org.apache.xerces.xni.XNIException

Handles start element.

Throws:
  `org.apache.xerces.xni.XNIException`

#### handleEndElement

    protected void handleEndElement(org.apache.xerces.xni.QName element,
                                    org.apache.xerces.xni.Augmentations augs,
                                    boolean isEmpty)
                             throws org.apache.xerces.xni.XNIException

Handles end element.

Throws:
  `org.apache.xerces.xni.XNIException`

#### prefixBoundToNullURI

    protected boolean prefixBoundToNullURI(java.lang.String uri,
                                           java.lang.String localpart)