public class

XMLNamespaceBinder

extends Object
implements XMLComponent XMLDocumentFilter
java.lang.Object
   ↳ org.apache.xerces.impl.XMLNamespaceBinder
Known Direct Subclasses

Class Overview

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
@xerces.internal

Summary

Constants
String ERROR_REPORTER Property identifier: error reporter.
String NAMESPACES Feature identifier: namespaces.
String SYMBOL_TABLE Property identifier: symbol table.
Fields
protected XMLDocumentHandler fDocumentHandler Document handler.
protected 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.
Public Constructors
XMLNamespaceBinder()
Default constructor.
Public Methods
void characters(XMLString text, Augmentations augs)
Character content.
void comment(XMLString text, Augmentations augs)
A comment.
void doctypeDecl(String rootElement, String publicId, String systemId, Augmentations augs)
Notifies of the presence of the DOCTYPE line in the document.
void emptyElement(QName element, XMLAttributes attributes, Augmentations augs)
An empty element.
void endCDATA(Augmentations augs)
The end of a CDATA section.
void endDocument(Augmentations augs)
The end of the document.
void endElement(QName element, Augmentations augs)
The end of an element.
void endGeneralEntity(String name, Augmentations augs)
This method notifies the end of a general entity.
XMLDocumentHandler getDocumentHandler()
Returns the document handler
XMLDocumentSource getDocumentSource()
Returns the document source
Boolean getFeatureDefault(String featureId)
Returns the default state for a feature, or null if this component does not want to report a default value for this feature.
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.
Object getPropertyDefault(String propertyId)
Returns the default state for a property, or null if this component does not want to report a default value for this property.
String[] getRecognizedFeatures()
Returns a list of feature identifiers that are recognized by this component.
String[] getRecognizedProperties()
Returns a list of property identifiers that are recognized by this component.
void ignorableWhitespace(XMLString text, Augmentations augs)
Ignorable whitespace.
void processingInstruction(String target, XMLString data, Augmentations augs)
A processing instruction.
void reset(XMLComponentManager componentManager)
Resets the component.
void setDocumentHandler(XMLDocumentHandler documentHandler)
Sets the document handler to receive information about the document.
void setDocumentSource(XMLDocumentSource source)
Sets the document source
void setFeature(String featureId, boolean state)
Sets the state of a feature.
void 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(String propertyId, Object value)
Sets the value of a property during parsing.
void startCDATA(Augmentations augs)
The start of a CDATA section.
void startDocument(XMLLocator locator, String encoding, NamespaceContext namespaceContext, Augmentations augs)
The start of the document.
void startElement(QName element, XMLAttributes attributes, Augmentations augs)
Binds the namespaces.
void startGeneralEntity(String name, XMLResourceIdentifier identifier, String encoding, Augmentations augs)
This method notifies the start of a general entity.
void textDecl(String version, String encoding, Augmentations augs)
Notifies of the presence of a TextDecl line in an entity.
void xmlDecl(String version, String encoding, String standalone, Augmentations augs)
Notifies of the presence of an XMLDecl line in the document.
Protected Methods
void handleEndElement(QName element, Augmentations augs, boolean isEmpty)
Handles end element.
void handleStartElement(QName element, XMLAttributes attributes, Augmentations augs, boolean isEmpty)
Handles start element.
boolean prefixBoundToNullURI(String uri, String localpart)
[Expand]
Inherited Methods
From class java.lang.Object
From interface org.apache.xerces.xni.XMLDocumentHandler
From interface org.apache.xerces.xni.parser.XMLComponent
From interface org.apache.xerces.xni.parser.XMLDocumentSource

Constants

protected static final String ERROR_REPORTER

Property identifier: error reporter.

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

protected static final String NAMESPACES

Feature identifier: namespaces.

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

protected static final String SYMBOL_TABLE

Property identifier: symbol table.

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

Fields

protected XMLDocumentHandler fDocumentHandler

Document handler.

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

Public Constructors

public XMLNamespaceBinder ()

Default constructor.

Public Methods

public void characters (XMLString text, Augmentations augs)

Character content.

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

public void comment (XMLString text, Augmentations augs)

A comment.

Parameters
text The text in the comment.
augs Additional information that may include infoset augmentations
Throws
XNIException Thrown by application to signal an error.

public void doctypeDecl (String rootElement, String publicId, String systemId, Augmentations augs)

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

Parameters
rootElement The name of the root element.
publicId The public identifier if an external DTD or null if the external DTD is specified using SYSTEM.
systemId The system identifier if an external DTD, null otherwise.
augs Additional information that may include infoset augmentations
Throws
XNIException Thrown by handler to signal an error.

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

An empty element.

Parameters
element The name of the element.
attributes The element attributes.
augs Additional information that may include infoset augmentations
Throws
XNIException Thrown by handler to signal an error.

public void endCDATA (Augmentations augs)

The end of a CDATA section.

Parameters
augs Additional information that may include infoset augmentations
Throws
XNIException Thrown by handler to signal an error.

public void endDocument (Augmentations augs)

The end of the document.

Parameters
augs Additional information that may include infoset augmentations
Throws
XNIException Thrown by handler to signal an error.

public void endElement (QName element, Augmentations augs)

The end of an element.

Parameters
element The name of the element.
augs Additional information that may include infoset augmentations
Throws
XNIException Thrown by handler to signal an error.

public void endGeneralEntity (String name, Augmentations augs)

This method notifies the end of a general entity.

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

Parameters
name The name of the entity.
augs Additional information that may include infoset augmentations
Throws
XNIException Thrown by handler to signal an error.

public XMLDocumentHandler getDocumentHandler ()

Returns the document handler

public XMLDocumentSource getDocumentSource ()

Returns the document source

public Boolean getFeatureDefault (String featureId)

Returns the default state for a feature, or null if this component does not want to report a default value for this feature.

Parameters
featureId The feature identifier.

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

public Object getPropertyDefault (String propertyId)

Returns the default state for a property, or null if this component does not want to report a default value for this property.

Parameters
propertyId The property identifier.

public String[] getRecognizedFeatures ()

Returns a list of feature identifiers that are recognized by this component. This method may return null if no features are recognized by this component.

public String[] getRecognizedProperties ()

Returns a list of property identifiers that are recognized by this component. This method may return null if no properties are recognized by this component.

public void ignorableWhitespace (XMLString text, Augmentations augs)

Ignorable whitespace. For this method to be called, the document source must have some way of determining that the text containing only whitespace characters should be considered ignorable. For example, the validator can determine if a length of whitespace characters in the document are ignorable based on the element content model.

Parameters
text The ignorable whitespace.
augs Additional information that may include infoset augmentations
Throws
XNIException Thrown by handler to signal an error.

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

A processing instruction. Processing instructions consist of a target name and, optionally, text data. The data is only meaningful to the application.

Typically, a processing instruction's data will contain a series of pseudo-attributes. These pseudo-attributes follow the form of element attributes but are not parsed or presented to the application as anything other than text. The application is responsible for parsing the data.

Parameters
target The target.
data The data or null if none specified.
augs Additional information that may include infoset augmentations
Throws
XNIException Thrown by handler to signal an error.

public void reset (XMLComponentManager componentManager)

Resets the component. The component can query the component manager about any features and properties that affect the operation of the component.

Parameters
componentManager The component manager.
Throws
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.
XNIException

public void setDocumentHandler (XMLDocumentHandler documentHandler)

Sets the document handler to receive information about the document.

public void setDocumentSource (XMLDocumentSource source)

Sets the document source

public void setFeature (String featureId, boolean state)

Sets the state of a feature. This method is called by the component manager any time after reset when a feature changes state.

Note: Components should silently ignore features that do not affect the operation of the component.

Parameters
featureId The feature identifier.
state The state of the feature.
Throws
The component should not throw this exception.
The component should not throw this exception.
XMLConfigurationException

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

public void setProperty (String propertyId, Object value)

Sets the value of a property during parsing.

Parameters
propertyId The property identifier.
value The value of the property.
Throws
XMLConfigurationException

public void startCDATA (Augmentations augs)

The start of a CDATA section.

Parameters
augs Additional information that may include infoset augmentations
Throws
XNIException Thrown by handler to signal an error.

public void startDocument (XMLLocator locator, String encoding, NamespaceContext namespaceContext, Augmentations augs)

The start of the document.

Parameters
locator The system identifier of the entity if the entity is external, null otherwise.
encoding The auto-detected IANA encoding name of the entity stream. This value will be null in those situations where the entity encoding is not auto-detected (e.g. internal entities or a document entity that is parsed from a java.io.Reader).
namespaceContext The namespace context in effect at the start of this document. This object represents the current context. Implementors of this class are responsible for copying the namespace bindings from the the current context (and its parent contexts) if that information is important.
augs Additional information that may include infoset augmentations
Throws
XNIException Thrown by handler to signal an error.

public void startElement (QName element, XMLAttributes attributes, Augmentations augs)

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.

Parameters
element The name of the element.
attributes The element attributes.
augs Additional information that may include infoset augmentations
Throws
XNIException Thrown by handler to signal an error.

public void startGeneralEntity (String name, XMLResourceIdentifier identifier, String encoding, Augmentations augs)

This method notifies the start of a general entity.

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

Parameters
name The name of the general entity.
identifier The resource identifier.
encoding The auto-detected IANA encoding name of the entity stream. This value will be null in those situations where the entity encoding is not auto-detected (e.g. internal entities or a document entity that is parsed from a java.io.Reader).
augs Additional information that may include infoset augmentations
Throws
XNIException Thrown by handler to signal an error.

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

Notifies of the presence of a TextDecl line in an entity. If present, this method will be called immediately following the 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.

Parameters
version The XML version, or null if not specified.
encoding The IANA encoding name of the entity.
augs Additional information that may include infoset augmentations
Throws
XNIException Thrown by handler to signal an error.

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

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

Parameters
version The XML version.
encoding The IANA encoding name of the document, or null if not specified.
standalone The standalone value, or null if not specified.
augs Additional information that may include infoset augmentations
Throws
XNIException Thrown by handler to signal an error.

Protected Methods

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

Handles end element.

Throws
XNIException

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

Handles start element.

Throws
XNIException

protected boolean prefixBoundToNullURI (String uri, String localpart)