org.apache.xerces.impl

Class XMLNamespaceBinder

public class XMLNamespaceBinder extends Object implements XMLComponent, 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.34 2004/10/04 21:45:48 mrglavas Exp $

Author: Andy Clark, IBM

UNKNOWN:

Field Summary
protected static StringERROR_REPORTER
Property identifier: error reporter.
protected XMLDocumentHandlerfDocumentHandler
Document handler.
protected XMLDocumentSourcefDocumentSource
protected XMLErrorReporterfErrorReporter
Error reporter.
protected booleanfNamespaces
Namespaces.
protected booleanfOnlyPassPrefixMappingEvents
Only pass start and end prefix mapping events.
protected SymbolTablefSymbolTable
Symbol table.
protected static StringNAMESPACES
Feature identifier: namespaces.
protected static StringSYMBOL_TABLE
Property identifier: symbol table.
Constructor Summary
XMLNamespaceBinder()
Default constructor.
Method Summary
voidcharacters(XMLString text, Augmentations augs)
Character content.
voidcomment(XMLString text, Augmentations augs)
A comment.
voiddoctypeDecl(String rootElement, String publicId, String systemId, Augmentations augs)
Notifies of the presence of the DOCTYPE line in the document.
voidemptyElement(QName element, XMLAttributes attributes, Augmentations augs)
An empty element.
voidendCDATA(Augmentations augs)
The end of a CDATA section.
voidendDocument(Augmentations augs)
The end of the document.
voidendElement(QName element, Augmentations augs)
The end of an element.
voidendGeneralEntity(String name, Augmentations augs)
This method notifies the end of a general entity.
XMLDocumentHandlergetDocumentHandler()
Returns the document handler
XMLDocumentSourcegetDocumentSource()
Returns the document source
BooleangetFeatureDefault(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.
booleangetOnlyPassPrefixMappingEvents()
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.
ObjectgetPropertyDefault(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.
protected voidhandleEndElement(QName element, Augmentations augs, boolean isEmpty)
Handles end element.
protected voidhandleStartElement(QName element, XMLAttributes attributes, Augmentations augs, boolean isEmpty)
Handles start element.
voidignorableWhitespace(XMLString text, Augmentations augs)
Ignorable whitespace.
protected booleanprefixBoundToNullURI(String uri, String localpart)
voidprocessingInstruction(String target, XMLString data, Augmentations augs)
A processing instruction.
voidreset(XMLComponentManager componentManager)
Resets the component.
voidsetDocumentHandler(XMLDocumentHandler documentHandler)
Sets the document handler to receive information about the document.
voidsetDocumentSource(XMLDocumentSource source)
Sets the document source
voidsetFeature(String featureId, boolean state)
Sets the state of a feature.
voidsetOnlyPassPrefixMappingEvents(boolean onlyPassPrefixMappingEvents)
Sets whether the namespace binder only passes the prefix mapping events to the registered document handler or passes all document events.
voidsetProperty(String propertyId, Object value)
Sets the value of a property during parsing.
voidstartCDATA(Augmentations augs)
The start of a CDATA section.
voidstartDocument(XMLLocator locator, String encoding, NamespaceContext namespaceContext, Augmentations augs)
The start of the document.
voidstartElement(QName element, XMLAttributes attributes, Augmentations augs)
Binds the namespaces.
voidstartGeneralEntity(String name, XMLResourceIdentifier identifier, String encoding, Augmentations augs)
This method notifies the start of a general entity.
voidtextDecl(String version, String encoding, Augmentations augs)
Notifies of the presence of a TextDecl line in an entity.
voidxmlDecl(String version, String encoding, String standalone, Augmentations augs)
Notifies of the presence of an XMLDecl line in the document.

Field Detail

ERROR_REPORTER

protected static final String ERROR_REPORTER
Property identifier: error reporter.

fDocumentHandler

protected XMLDocumentHandler fDocumentHandler
Document handler.

fDocumentSource

protected XMLDocumentSource fDocumentSource

fErrorReporter

protected XMLErrorReporter fErrorReporter
Error reporter.

fNamespaces

protected boolean fNamespaces
Namespaces.

fOnlyPassPrefixMappingEvents

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

fSymbolTable

protected SymbolTable fSymbolTable
Symbol table.

NAMESPACES

protected static final String NAMESPACES
Feature identifier: namespaces.

SYMBOL_TABLE

protected static final String SYMBOL_TABLE
Property identifier: symbol table.

Constructor Detail

XMLNamespaceBinder

public XMLNamespaceBinder()
Default constructor.

Method Detail

characters

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.

comment

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.

doctypeDecl

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.

emptyElement

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.

endCDATA

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.

endDocument

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.

endElement

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.

endGeneralEntity

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.

getDocumentHandler

public XMLDocumentHandler getDocumentHandler()
Returns the document handler

getDocumentSource

public XMLDocumentSource getDocumentSource()
Returns the document source

getFeatureDefault

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.

Since: Xerces 2.2.0

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.

getPropertyDefault

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.

Since: Xerces 2.2.0

getRecognizedFeatures

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.

getRecognizedProperties

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.

handleEndElement

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

handleStartElement

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

ignorableWhitespace

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.

prefixBoundToNullURI

protected boolean prefixBoundToNullURI(String uri, String localpart)

processingInstruction

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.

reset

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

setDocumentHandler

public void setDocumentHandler(XMLDocumentHandler documentHandler)
Sets the document handler to receive information about the document.

setDocumentSource

public void setDocumentSource(XMLDocumentSource source)
Sets the document source

setFeature

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: SAXNotRecognizedException The component should not throw this exception. SAXNotSupportedException The component should not throw this exception.

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.

setProperty

public void setProperty(String propertyId, Object value)
Sets the value of a property during parsing.

Parameters: propertyId value

startCDATA

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.

startDocument

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.

startElement

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.

startGeneralEntity

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.

textDecl

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.

xmlDecl

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.

Copyright B) 1999-2005 Apache XML Project. All Rights Reserved.