org.apache.xerces.impl
Class XMLNamespaceBinder

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

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:

Version:
$Id: XMLNamespaceBinder.java,v 1.10 2001/10/26 05:21:27 andyc Exp $
Author:
Andy Clark, IBM

Field Summary
protected static java.lang.String ERROR_REPORTER
          Property identifier: error reporter.
protected  org.apache.xerces.xni.XMLDocumentHandler fDocumentHandler
          Document handler.
protected  XMLErrorReporter fErrorReporter
          Error reporter.
protected  boolean fNamespaces
          Namespaces.
protected  NamespaceSupport fNamespaceSupport
          Namespace support.
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[] RECOGNIZED_FEATURES
          Recognized features.
protected static java.lang.String[] RECOGNIZED_PROPERTIES
          Recognized properties.
protected static java.lang.String SYMBOL_TABLE
          Property identifier: symbol table.
 
Constructor Summary
XMLNamespaceBinder()
          Default constructor.
XMLNamespaceBinder(org.apache.xerces.xni.NamespaceContext namespaceContext)
          Constructs a namespace binder that shares the specified namespace context during each parse.
 
Method Summary
 void characters(org.apache.xerces.xni.XMLString text)
          Character content.
 void comment(org.apache.xerces.xni.XMLString text)
          A comment.
 void doctypeDecl(java.lang.String rootElement, java.lang.String publicId, java.lang.String systemId)
          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)
          An empty element.
 void endCDATA()
          The end of a CDATA section.
 void endDocument()
          The end of the document.
 void endElement(org.apache.xerces.xni.QName element)
          The end of an element.
 void endEntity(java.lang.String name)
          This method notifies the end of an entity.
 void endPrefixMapping(java.lang.String prefix)
          The end of a namespace prefix mapping.
 org.apache.xerces.xni.NamespaceContext getNamespaceContext()
          Returns the current namespace context.
 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.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, boolean isEmpty)
          Handles end element.
protected  void handleStartElement(org.apache.xerces.xni.QName element, org.apache.xerces.xni.XMLAttributes attributes, boolean isEmpty)
          Handles start element.
 void ignorableWhitespace(org.apache.xerces.xni.XMLString text)
          Ignorable whitespace.
 void processingInstruction(java.lang.String target, org.apache.xerces.xni.XMLString data)
          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 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()
          The start of a CDATA section.
 void startDocument(org.apache.xerces.xni.XMLLocator locator, java.lang.String encoding)
          The start of the document.
 void startElement(org.apache.xerces.xni.QName element, org.apache.xerces.xni.XMLAttributes attributes)
          Binds the namespaces.
 void startEntity(java.lang.String name, java.lang.String publicId, java.lang.String systemId, java.lang.String baseSystemId, java.lang.String encoding)
          This method notifies the start of an entity.
 void startPrefixMapping(java.lang.String prefix, java.lang.String uri)
          The start of a namespace prefix mapping.
 void textDecl(java.lang.String version, java.lang.String encoding)
          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)
          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.

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.

RECOGNIZED_FEATURES

protected static final java.lang.String[] RECOGNIZED_FEATURES
Recognized features.

RECOGNIZED_PROPERTIES

protected static final java.lang.String[] RECOGNIZED_PROPERTIES
Recognized properties.

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.

fNamespaceSupport

protected NamespaceSupport fNamespaceSupport
Namespace support.

fOnlyPassPrefixMappingEvents

protected boolean fOnlyPassPrefixMappingEvents
Only pass start and end prefix mapping events.
Constructor Detail

XMLNamespaceBinder

public XMLNamespaceBinder()
Default constructor.

XMLNamespaceBinder

public XMLNamespaceBinder(org.apache.xerces.xni.NamespaceContext namespaceContext)
Constructs a namespace binder that shares the specified namespace context during each parse.
Parameters:
namespaceContext - The shared context.
Method Detail

getNamespaceContext

public org.apache.xerces.xni.NamespaceContext getNamespaceContext()
Returns the current namespace context.

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.

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.

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 -  

setDocumentHandler

public void setDocumentHandler(org.apache.xerces.xni.XMLDocumentHandler documentHandler)
Sets the document handler to receive information about the document.
Parameters:
documentHandler - The document handler.

startEntity

public void startEntity(java.lang.String name,
                        java.lang.String publicId,
                        java.lang.String systemId,
                        java.lang.String baseSystemId,
                        java.lang.String encoding)
                 throws org.apache.xerces.xni.XNIException
This method notifies the start of an entity. General entities are just specified by their name.

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

Parameters:
name - The name of the entity.
publicId - The public identifier of the entity if the entity is external, null otherwise.
systemId - The system identifier of the entity if the entity is external, null otherwise.
baseSystemId - The base 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).
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)
              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.

Parameters:
version - The XML version, or null if not specified.
encoding - The IANA encoding name of the entity.
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)
                   throws org.apache.xerces.xni.XNIException
The start of the document.
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)
             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.
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.
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)
                 throws org.apache.xerces.xni.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.
Throws:
org.apache.xerces.xni.XNIException - Thrown by handler to signal an error.

comment

public void comment(org.apache.xerces.xni.XMLString text)
             throws org.apache.xerces.xni.XNIException
A comment.
Parameters:
text - The text in the comment.
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)
                           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.

Parameters:
target - The target.
data - The data or null if none specified.
Throws:
org.apache.xerces.xni.XNIException - Thrown by handler to signal an error.

startPrefixMapping

public void startPrefixMapping(java.lang.String prefix,
                               java.lang.String uri)
                        throws org.apache.xerces.xni.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.
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)
                  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.

Parameters:
element - The name of the element.
attributes - The element attributes.
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)
                  throws org.apache.xerces.xni.XNIException
An empty element.
Parameters:
element - The name of the element.
attributes - The element attributes.
Throws:
org.apache.xerces.xni.XNIException - Thrown by handler to signal an error.

characters

public void characters(org.apache.xerces.xni.XMLString text)
                throws org.apache.xerces.xni.XNIException
Character content.
Parameters:
text - The content.
Throws:
org.apache.xerces.xni.XNIException - Thrown by handler to signal an error.

ignorableWhitespace

public void ignorableWhitespace(org.apache.xerces.xni.XMLString text)
                         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.
Parameters:
text - The ignorable whitespace.
Throws:
org.apache.xerces.xni.XNIException - Thrown by handler to signal an error.

endElement

public void endElement(org.apache.xerces.xni.QName element)
                throws org.apache.xerces.xni.XNIException
The end of an element.
Parameters:
element - The name of the element.
Throws:
org.apache.xerces.xni.XNIException - Thrown by handler to signal an error.

endPrefixMapping

public void endPrefixMapping(java.lang.String prefix)
                      throws org.apache.xerces.xni.XNIException
The end of a namespace prefix mapping. This method will only be called when namespace processing is enabled.
Parameters:
prefix - The namespace prefix.
Throws:
org.apache.xerces.xni.XNIException - Thrown by handler to signal an error.

startCDATA

public void startCDATA()
                throws org.apache.xerces.xni.XNIException
The start of a CDATA section.
Throws:
org.apache.xerces.xni.XNIException - Thrown by handler to signal an error.

endCDATA

public void endCDATA()
              throws org.apache.xerces.xni.XNIException
The end of a CDATA section.
Throws:
org.apache.xerces.xni.XNIException - Thrown by handler to signal an error.

endDocument

public void endDocument()
                 throws org.apache.xerces.xni.XNIException
The end of the document.
Throws:
org.apache.xerces.xni.XNIException - Thrown by handler to signal an error.

endEntity

public void endEntity(java.lang.String name)
               throws org.apache.xerces.xni.XNIException
This method notifies the end of an entity. General entities are just specified by their name.

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

Parameters:
name - The name of the entity.
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,
                                  boolean isEmpty)
                           throws org.apache.xerces.xni.XNIException
Handles start element.

handleEndElement

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


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