net.sourceforge.htmlunit.cyberneko.filters

Class NamespaceBinder

java.lang.Object

net.sourceforge.htmlunit.cyberneko.filters.DefaultFilter

net.sourceforge.htmlunit.cyberneko.filters.NamespaceBinder

All Implemented Interfaces:

HTMLComponent, XMLComponent, XMLDocumentFilter, XMLDocumentSource, XMLDocumentHandler

public class NamespaceBinder
extends DefaultFilter

This filter binds namespaces if namespace processing is turned on by setting the feature "http://xml.org/sax/features/namespaces" is set to true.

This configuration recognizes the following features:

• http://xml.org/sax/features/namespaces

Author:

Andy Clark

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	NamespaceBinder.NamespaceSupport This namespace context object implements the old and new XNI NamespaceContext interface methods so that it can be used across all versions of Xerces2.

Field Summary

Fields

Modifier and Type	Field and Description
protected boolean	fInsertNamespaces Insert namespaces.
protected short	fNamesAttrs Modify HTML attribute names.
protected short	fNamesElems Modify HTML element names.
protected NamespaceBinder.NamespaceSupport	fNamespaceContext Namespace context.
protected boolean	fNamespacePrefixes Namespace prefixes.
protected boolean	fNamespaces Namespaces.
protected String	fNamespacesURI Namespaces URI.
protected boolean	fOverrideNamespaces Override namespaces.
protected static String	INSERT_NAMESPACES Insert namespace binding URIs.
protected static String	NAMES_ATTRS Modify HTML attribute names: { "upper", "lower", "default" }.
protected static String	NAMES_ELEMS Modify HTML element names: { "upper", "lower", "default" }.
protected static short	NAMES_LOWERCASE Lowercase HTML names.
protected static short	NAMES_NO_CHANGE Don't modify HTML names.
protected static short	NAMES_UPPERCASE Uppercase HTML names.
protected static String	NAMESPACES Namespaces.
protected static String	NAMESPACES_URI Namespaces URI.
protected static String	OVERRIDE_NAMESPACES Override namespace binding URI.
static String	XHTML_1_0_URI XHTML 1.0 namespace URI (http://www.w3.org/1999/xhtml).
static String	XML_URI XML namespace URI (http://www.w3.org/XML/1998/namespace).
static String	XMLNS_URI XMLNS namespace URI (http://www.w3.org/2000/xmlns/).

Fields inherited from class net.sourceforge.htmlunit.cyberneko.filters.DefaultFilter

fDocumentHandler, fDocumentSource

Constructor Summary

Constructors

Constructor and Description
NamespaceBinder(HTMLConfiguration htmlConfiguration)

Method Summary

Modifier and Type	Method and Description
protected void	bindNamespaces(QName element, XMLAttributes attrs)
void	emptyElement(QName element, XMLAttributes attrs, Augmentations augs) Empty element.
void	endElement(QName element, Augmentations augs) End element.
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.
protected static short	getNamesValue(String value)
Object	getPropertyDefault(String propertyId) Returns the default value 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 static String	modifyName(String name, short mode)
void	reset(XMLComponentManager manager) Resets the component.
protected static void	splitQName(QName qname)
void	startDocument(XMLLocator locator, String encoding, NamespaceContext nscontext, Augmentations augs) Start document.
void	startElement(QName element, XMLAttributes attrs, Augmentations augs) Start element.

Methods inherited from class net.sourceforge.htmlunit.cyberneko.filters.DefaultFilter

characters, comment, doctypeDecl, endCDATA, endDocument, endGeneralEntity, getDocumentHandler, getDocumentSource, ignorableWhitespace, merge, processingInstruction, setDocumentHandler, setDocumentSource, setFeature, setProperty, startCDATA, startGeneralEntity, textDecl, xmlDecl

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

XHTML_1_0_URI

public static final String XHTML_1_0_URI

XHTML 1.0 namespace URI (http://www.w3.org/1999/xhtml).

See Also:

Constant Field Values

XML_URI

public static final String XML_URI

XML namespace URI (http://www.w3.org/XML/1998/namespace).

See Also:

Constant Field Values

XMLNS_URI

public static final String XMLNS_URI

XMLNS namespace URI (http://www.w3.org/2000/xmlns/).

See Also:

Constant Field Values

NAMESPACES

protected static final String NAMESPACES

Namespaces.

See Also:

Constant Field Values

OVERRIDE_NAMESPACES

protected static final String OVERRIDE_NAMESPACES

Override namespace binding URI.

See Also:

Constant Field Values

INSERT_NAMESPACES

protected static final String INSERT_NAMESPACES

Insert namespace binding URIs.

See Also:

Constant Field Values

NAMES_ELEMS

protected static final String NAMES_ELEMS

Modify HTML element names: { "upper", "lower", "default" }.

See Also:

Constant Field Values

NAMES_ATTRS

protected static final String NAMES_ATTRS

Modify HTML attribute names: { "upper", "lower", "default" }.

See Also:

Constant Field Values

NAMESPACES_URI

protected static final String NAMESPACES_URI

Namespaces URI.

See Also:

Constant Field Values

NAMES_NO_CHANGE

protected static final short NAMES_NO_CHANGE

Don't modify HTML names.

See Also:

Constant Field Values

NAMES_UPPERCASE

protected static final short NAMES_UPPERCASE

Uppercase HTML names.

See Also:

Constant Field Values

NAMES_LOWERCASE

protected static final short NAMES_LOWERCASE

Lowercase HTML names.

See Also:

Constant Field Values

fNamespaces

protected boolean fNamespaces

Namespaces.

fNamespacePrefixes

protected boolean fNamespacePrefixes

Namespace prefixes.

fOverrideNamespaces

protected boolean fOverrideNamespaces

Override namespaces.

fInsertNamespaces

protected boolean fInsertNamespaces

Insert namespaces.

fNamesElems

protected short fNamesElems

Modify HTML element names.

fNamesAttrs

protected short fNamesAttrs

Modify HTML attribute names.

fNamespacesURI

protected String fNamespacesURI

Namespaces URI.

fNamespaceContext

protected final NamespaceBinder.NamespaceSupport fNamespaceContext

Namespace context.

Constructor Detail

NamespaceBinder

public NamespaceBinder(HTMLConfiguration htmlConfiguration)

Method Detail

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.

Specified by:

getRecognizedFeatures in interface XMLComponent

Overrides:

getRecognizedFeatures in class DefaultFilter

Returns:

an array of feature identifiers that are recognized by this component. This method may return null if no features are recognized by this component.

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.

Specified by:

getFeatureDefault in interface HTMLComponent

Specified by:

getFeatureDefault in interface XMLComponent

Overrides:

getFeatureDefault in class DefaultFilter

Parameters:

featureId - The feature identifier.

Returns:

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

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.

Specified by:

getRecognizedProperties in interface XMLComponent

Overrides:

getRecognizedProperties in class DefaultFilter

Returns:

an array of property identifiers that are recognized by this component. This method may return null if no properties are recognized by this component.

getPropertyDefault

public Object getPropertyDefault(String propertyId)

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

Specified by:

getPropertyDefault in interface HTMLComponent

Specified by:

getPropertyDefault in interface XMLComponent

Overrides:

getPropertyDefault in class DefaultFilter

Parameters:

propertyId - The property identifier.

Returns:

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

reset

public void reset(XMLComponentManager manager)
           throws XMLConfigurationException

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 XMLComponent

Overrides:

reset in class DefaultFilter

Parameters:

manager - The component manager.

Throws:

XNIException - Thrown by component on initialization error.

XMLConfigurationException

startDocument

public void startDocument(XMLLocator locator,
                          String encoding,
                          NamespaceContext nscontext,
                          Augmentations augs)
                   throws XNIException

Start document.

Specified by:

startDocument in interface XMLDocumentHandler

Overrides:

startDocument in class DefaultFilter

Parameters:

locator - The document locator, or null if the document location cannot be reported during the parsing of this document. However, it is strongly recommended that a locator be supplied that can at least report the system identifier of the document.

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

nscontext - 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 attrs,
                         Augmentations augs)
                  throws XNIException

Start element.

Specified by:

startElement in interface XMLDocumentHandler

Overrides:

startElement in class DefaultFilter

Parameters:

element - The name of the element.

attrs - 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 attrs,
                         Augmentations augs)
                  throws XNIException

Empty element.

Specified by:

emptyElement in interface XMLDocumentHandler

Overrides:

emptyElement in class DefaultFilter

Parameters:

element - The name of the element.

attrs - The element attributes.

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

End element.

Specified by:

endElement in interface XMLDocumentHandler

Overrides:

endElement in class DefaultFilter

Parameters:

element - The name of the element.

augs - Additional information that may include infoset augmentations

Throws:

XNIException - Thrown by handler to signal an error.

splitQName

protected static void splitQName(QName qname)

getNamesValue

protected static short getNamesValue(String value)

modifyName

protected static String modifyName(String name,
                                   short mode)

bindNamespaces

protected void bindNamespaces(QName element,
                              XMLAttributes attrs)