org.apache.xerces.xinclude
Class XIncludeHandler

java.lang.Object
  org.apache.xerces.xinclude.XIncludeHandler

All Implemented Interfaces:

XMLComponent, XMLDocumentFilter, XMLDocumentSource, XMLDTDFilter, XMLDTDSource, XMLDocumentHandler, XMLDTDHandler

Direct Known Subclasses:

XPointerHandler

public class XIncludeHandler
extends java.lang.Object
implements XMLComponent, XMLDocumentFilter, XMLDTDFilter

This is a pipeline component which performs XInclude handling, according to the W3C specification for XML Inclusions.

This component analyzes each event in the pipeline, looking for <include> elements. An <include> element is one which has a namespace of http://www.w3.org/2001/XInclude and a localname of include. When it finds an <include> element, it attempts to include the file specified in the href attribute of the element. If inclusion succeeds, all children of the <include> element are ignored (with the exception of checking for invalid children as outlined in the specification). If the inclusion fails, the <fallback> child of the <include> element is processed.

See the XInclude specification for more information on how XInclude is to be used.

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

• http://xml.org/sax/features/allow-dtd-events-after-endDTD
• http://apache.org/xml/properties/internal/error-reporter
• http://apache.org/xml/properties/internal/entity-resolver

Optional property:

• http://apache.org/xml/properties/input-buffer-size

Furthermore, the NamespaceContext used in the pipeline is required to be an instance of XIncludeNamespaceSupport.

Currently, this implementation has only partial support for the XInclude specification. Specifically, it is missing support for XPointer document fragments. Thus, only whole documents can be included using this component in the pipeline.

Version:

$Id: XIncludeHandler.java 572045 2007-09-02 17:32:09Z mrglavas $

Author:

Peter McCracken, IBM, Michael Glavassevich, IBM

See Also:

XIncludeNamespaceSupport

Field Summary

static java.lang.String	CURRENT_BASE_URI The identifier for the Augmentation that contains the current base URI
static java.lang.String	HTTP_ACCEPT
static java.lang.String	HTTP_ACCEPT_LANGUAGE
static java.lang.String	XINCLUDE_ATTR_ACCEPT
static java.lang.String	XINCLUDE_ATTR_ACCEPT_LANGUAGE
static java.lang.String	XINCLUDE_ATTR_ENCODING
static java.lang.String	XINCLUDE_ATTR_HREF
static java.lang.String	XINCLUDE_ATTR_PARSE
static java.lang.String	XINCLUDE_DEFAULT_CONFIGURATION
static java.lang.String	XINCLUDE_FALLBACK
static java.lang.String	XINCLUDE_INCLUDE
static java.lang.String	XINCLUDE_INCLUDED
static java.lang.String	XINCLUDE_NS_URI
static java.lang.String	XINCLUDE_PARSE_TEXT
static java.lang.String	XINCLUDE_PARSE_XML
static java.lang.String	XPOINTER

Fields inherited from interface org.apache.xerces.xni.XMLDTDHandler

CONDITIONAL_IGNORE, CONDITIONAL_INCLUDE

Constructor Summary

XIncludeHandler()

Method Summary

void	attributeDecl(java.lang.String elementName, java.lang.String attributeName, java.lang.String type, java.lang.String[] enumeration, java.lang.String defaultType, XMLString defaultValue, XMLString nonNormalizedDefaultValue, Augmentations augmentations) An attribute declaration.
void	characters(XMLString text, Augmentations augs) Character content.
void	comment(XMLString text, Augmentations augs) A comment.
void	doctypeDecl(java.lang.String rootElement, java.lang.String publicId, java.lang.String systemId, Augmentations augs) Notifies of the presence of the DOCTYPE line in the document.
void	elementDecl(java.lang.String name, java.lang.String contentModel, Augmentations augmentations) An element declaration.
void	emptyElement(QName element, XMLAttributes attributes, Augmentations augs) An empty element.
void	endAttlist(Augmentations augmentations) The end of an attribute list.
void	endCDATA(Augmentations augs) The end of a CDATA section.
void	endConditional(Augmentations augmentations) The end of a conditional section.
void	endDocument(Augmentations augs) The end of the document.
void	endDTD(Augmentations augmentations) The end of the DTD.
void	endElement(QName element, Augmentations augs) The end of an element.
void	endExternalSubset(Augmentations augmentations) The end of the DTD external subset.
void	endGeneralEntity(java.lang.String name, Augmentations augs) This method notifies the end of a general entity.
void	endParameterEntity(java.lang.String name, Augmentations augmentations) This method notifies the end of a parameter entity.
void	externalEntityDecl(java.lang.String name, XMLResourceIdentifier identifier, Augmentations augmentations) An external entity declaration.
java.lang.String	getBaseURI(int depth) Gets the base URI that was in use at that depth
XMLDocumentHandler	getDocumentHandler() Returns the document handler
XMLDocumentSource	getDocumentSource() Returns the document source.
XMLDTDHandler	getDTDHandler() Returns the DTD handler.
XMLDTDSource	getDTDSource()
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.
java.lang.String	getLanguage(int depth) Gets the language that was in use at that depth.
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.
java.lang.String	getRelativeURI(int depth) Returns a relative URI, which when resolved against the base URI at the specified depth, will create the current base URI.
void	ignorableWhitespace(XMLString text, Augmentations augs) Ignorable whitespace.
void	ignoredCharacters(XMLString text, Augmentations augmentations) Characters within an IGNORE conditional section.
void	internalEntityDecl(java.lang.String name, XMLString text, XMLString nonNormalizedText, Augmentations augmentations) An internal entity declaration.
void	notationDecl(java.lang.String name, XMLResourceIdentifier identifier, Augmentations augmentations) A notation declaration
void	processingInstruction(java.lang.String target, XMLString data, Augmentations augs) A processing instruction.
void	reset(XMLComponentManager componentManager) Resets the component.
java.lang.String	restoreLanguage() Discards the language at the top of the stack, and returns the one beneath it.
void	setDocumentHandler(XMLDocumentHandler handler) Sets the document handler.
void	setDocumentSource(XMLDocumentSource source) Sets the document source.
void	setDTDHandler(XMLDTDHandler handler) Sets the DTD handler.
void	setDTDSource(XMLDTDSource source)
void	setFeature(java.lang.String featureId, boolean state) Sets the state of a feature.
void	setProperty(java.lang.String propertyId, java.lang.Object value) Sets the value of a property.
void	startAttlist(java.lang.String elementName, Augmentations augmentations) The start of an attribute list.
void	startCDATA(Augmentations augs) The start of a CDATA section.
void	startConditional(short type, Augmentations augmentations) The start of a conditional section.
void	startDocument(XMLLocator locator, java.lang.String encoding, NamespaceContext namespaceContext, Augmentations augs) Event sent at the start of the document.
void	startDTD(XMLLocator locator, Augmentations augmentations) The start of the DTD.
void	startElement(QName element, XMLAttributes attributes, Augmentations augs) The start of an element.
void	startExternalSubset(XMLResourceIdentifier identifier, Augmentations augmentations) The start of the DTD external subset.
void	startGeneralEntity(java.lang.String name, XMLResourceIdentifier resId, java.lang.String encoding, Augmentations augs) This method notifies the start of a general entity.
void	startParameterEntity(java.lang.String name, XMLResourceIdentifier identifier, java.lang.String encoding, Augmentations augmentations) This method notifies of the start of a parameter entity.
void	textDecl(java.lang.String version, java.lang.String encoding, Augmentations augs) Notifies of the presence of a TextDecl line in an entity.
void	unparsedEntityDecl(java.lang.String name, XMLResourceIdentifier identifier, java.lang.String notation, Augmentations augmentations) An unparsed entity declaration.
void	xmlDecl(java.lang.String version, java.lang.String encoding, java.lang.String standalone, Augmentations augs) Notifies of the presence of an XMLDecl line in the document.

Methods inherited from class java.lang.Object

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

Field Detail

XINCLUDE_DEFAULT_CONFIGURATION

public static final java.lang.String XINCLUDE_DEFAULT_CONFIGURATION

See Also:

Constant Field Values

HTTP_ACCEPT

public static final java.lang.String HTTP_ACCEPT

See Also:

Constant Field Values

HTTP_ACCEPT_LANGUAGE

public static final java.lang.String HTTP_ACCEPT_LANGUAGE

See Also:

Constant Field Values

XPOINTER

public static final java.lang.String XPOINTER

See Also:

Constant Field Values

XINCLUDE_NS_URI

public static final java.lang.String XINCLUDE_NS_URI

XINCLUDE_INCLUDE

public static final java.lang.String XINCLUDE_INCLUDE

XINCLUDE_FALLBACK

public static final java.lang.String XINCLUDE_FALLBACK

XINCLUDE_PARSE_XML

public static final java.lang.String XINCLUDE_PARSE_XML

XINCLUDE_PARSE_TEXT

public static final java.lang.String XINCLUDE_PARSE_TEXT

XINCLUDE_ATTR_HREF

public static final java.lang.String XINCLUDE_ATTR_HREF

XINCLUDE_ATTR_PARSE

public static final java.lang.String XINCLUDE_ATTR_PARSE

XINCLUDE_ATTR_ENCODING

public static final java.lang.String XINCLUDE_ATTR_ENCODING

XINCLUDE_ATTR_ACCEPT

public static final java.lang.String XINCLUDE_ATTR_ACCEPT

XINCLUDE_ATTR_ACCEPT_LANGUAGE

public static final java.lang.String XINCLUDE_ATTR_ACCEPT_LANGUAGE

XINCLUDE_INCLUDED

public static final java.lang.String XINCLUDE_INCLUDED

CURRENT_BASE_URI

public static final java.lang.String CURRENT_BASE_URI

The identifier for the Augmentation that contains the current base URI

See Also:

Constant Field Values

Constructor Detail

XIncludeHandler

public XIncludeHandler()

Method Detail

reset

public void reset(XMLComponentManager componentManager)
           throws XNIException

Description copied from interface: XMLComponent

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

Parameters:

componentManager - The component manager.

Throws:

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 XMLComponent

setFeature

public void setFeature(java.lang.String featureId,
                       boolean state)
                throws 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 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.

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 XMLComponent

setProperty

public void setProperty(java.lang.String propertyId,
                        java.lang.Object value)
                 throws XMLConfigurationException

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

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

Specified by:

setProperty in interface XMLComponent

Parameters:

propertyId - The property identifier.

value - The value of the property.

Throws:

SAXNotRecognizedException - The component should not throw this exception.

SAXNotSupportedException - The component should not throw this exception.

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 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 XMLComponent

Parameters:

propertyId - The property identifier.

Since:

Xerces 2.2.0

setDocumentHandler

public void setDocumentHandler(XMLDocumentHandler handler)

Description copied from interface: XMLDocumentSource

Sets the document handler.

Specified by:

setDocumentHandler in interface XMLDocumentSource

getDocumentHandler

public XMLDocumentHandler getDocumentHandler()

Description copied from interface: XMLDocumentSource

Returns the document handler

Specified by:

getDocumentHandler in interface XMLDocumentSource

startDocument

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

Event sent at the start of the document. A fatal error will occur here, if it is detected that this document has been processed before. This event is only passed on to the document handler if this is the root document.

Specified by:

startDocument in interface XMLDocumentHandler

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

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.

xmlDecl

public void xmlDecl(java.lang.String version,
                    java.lang.String encoding,
                    java.lang.String standalone,
                    Augmentations augs)
             throws XNIException

Description copied from interface: XMLDocumentHandler

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

XNIException - Thrown by handler to signal an error.

doctypeDecl

public void doctypeDecl(java.lang.String rootElement,
                        java.lang.String publicId,
                        java.lang.String systemId,
                        Augmentations augs)
                 throws XNIException

Description copied from interface: XMLDocumentHandler

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

Specified by:

doctypeDecl in interface 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:

XNIException - Thrown by handler to signal an error.

comment

public void comment(XMLString text,
                    Augmentations augs)
             throws XNIException

Description copied from interface: XMLDocumentHandler

A comment.

Specified by:

comment in interface XMLDocumentHandler

Specified by:

comment in interface XMLDTDHandler

Parameters:

text - The text in the comment.

augs - Additional information that may include infoset augmentations

Throws:

XNIException - Thrown by application to signal an error.

processingInstruction

public void processingInstruction(java.lang.String target,
                                  XMLString data,
                                  Augmentations augs)
                           throws XNIException

Description copied from interface: XMLDocumentHandler

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 XMLDocumentHandler

Specified by:

processingInstruction in interface XMLDTDHandler

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.

startElement

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

Description copied from interface: XMLDocumentHandler

The start of an element.

Specified by:

startElement in interface XMLDocumentHandler

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.

emptyElement

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

Description copied from interface: XMLDocumentHandler

An empty element.

Specified by:

emptyElement in interface XMLDocumentHandler

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.

endElement

public void endElement(QName element,
                       Augmentations augs)
                throws XNIException

Description copied from interface: XMLDocumentHandler

The end of an element.

Specified by:

endElement in interface XMLDocumentHandler

Parameters:

element - The name of the element.

augs - Additional information that may include infoset augmentations

Throws:

XNIException - Thrown by handler to signal an error.

startGeneralEntity

public void startGeneralEntity(java.lang.String name,
                               XMLResourceIdentifier resId,
                               java.lang.String encoding,
                               Augmentations augs)
                        throws XNIException

Description copied from interface: XMLDocumentHandler

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 XMLDocumentHandler

Parameters:

name - The name of the general entity.

resId - 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(java.lang.String version,
                     java.lang.String encoding,
                     Augmentations augs)
              throws XNIException

Description copied from interface: XMLDocumentHandler

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 XMLDocumentHandler

Specified by:

textDecl in interface XMLDTDHandler

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.

endGeneralEntity

public void endGeneralEntity(java.lang.String name,
                             Augmentations augs)
                      throws XNIException

Description copied from interface: XMLDocumentHandler

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 XMLDocumentHandler

Parameters:

name - The name of the entity.

augs - Additional information that may include infoset augmentations

Throws:

XNIException - Thrown by handler to signal an error.

characters

public void characters(XMLString text,
                       Augmentations augs)
                throws XNIException

Description copied from interface: XMLDocumentHandler

Character content.

Specified by:

characters in interface XMLDocumentHandler

Parameters:

text - The content.

augs - Additional information that may include infoset augmentations

Throws:

XNIException - Thrown by handler to signal an error.

ignorableWhitespace

public void ignorableWhitespace(XMLString text,
                                Augmentations augs)
                         throws XNIException

Description copied from interface: XMLDocumentHandler

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 XMLDocumentHandler

Parameters:

text - The ignorable whitespace.

augs - Additional information that may include infoset augmentations

Throws:

XNIException - Thrown by handler to signal an error.

startCDATA

public void startCDATA(Augmentations augs)
                throws XNIException

Description copied from interface: XMLDocumentHandler

The start of a CDATA section.

Specified by:

startCDATA in interface XMLDocumentHandler

Parameters:

augs - Additional information that may include infoset augmentations

Throws:

XNIException - Thrown by handler to signal an error.

endCDATA

public void endCDATA(Augmentations augs)
              throws XNIException

Description copied from interface: XMLDocumentHandler

The end of a CDATA section.

Specified by:

endCDATA in interface XMLDocumentHandler

Parameters:

augs - Additional information that may include infoset augmentations

Throws:

XNIException - Thrown by handler to signal an error.

endDocument

public void endDocument(Augmentations augs)
                 throws XNIException

Description copied from interface: XMLDocumentHandler

The end of the document.

Specified by:

endDocument in interface XMLDocumentHandler

Parameters:

augs - Additional information that may include infoset augmentations

Throws:

XNIException - Thrown by handler to signal an error.

setDocumentSource

public void setDocumentSource(XMLDocumentSource source)

Description copied from interface: XMLDocumentHandler

Sets the document source.

Specified by:

setDocumentSource in interface XMLDocumentHandler

getDocumentSource

public XMLDocumentSource getDocumentSource()

Description copied from interface: XMLDocumentHandler

Returns the document source.

Specified by:

getDocumentSource in interface XMLDocumentHandler

attributeDecl

public void attributeDecl(java.lang.String elementName,
                          java.lang.String attributeName,
                          java.lang.String type,
                          java.lang.String[] enumeration,
                          java.lang.String defaultType,
                          XMLString defaultValue,
                          XMLString nonNormalizedDefaultValue,
                          Augmentations augmentations)
                   throws XNIException

Description copied from interface: XMLDTDHandler

An attribute declaration.

Specified by:

attributeDecl in interface XMLDTDHandler

Parameters:

elementName - The name of the element that this attribute is associated with.

attributeName - The name of the attribute.

type - The attribute type. This value will be one of the following: "CDATA", "ENTITY", "ENTITIES", "ENUMERATION", "ID", "IDREF", "IDREFS", "NMTOKEN", "NMTOKENS", or "NOTATION".

enumeration - If the type has the value "ENUMERATION" or "NOTATION", this array holds the allowed attribute values; otherwise, this array is null.

defaultType - The attribute default type. This value will be one of the following: "#FIXED", "#IMPLIED", "#REQUIRED", or null.

defaultValue - The attribute default value, or null if no default value is specified.

nonNormalizedDefaultValue - The attribute default value with no normalization performed, or null if no default value is specified.

augmentations - Additional information that may include infoset augmentations.

Throws:

XNIException - Thrown by handler to signal an error.

elementDecl

public void elementDecl(java.lang.String name,
                        java.lang.String contentModel,
                        Augmentations augmentations)
                 throws XNIException

Description copied from interface: XMLDTDHandler

An element declaration.

Specified by:

elementDecl in interface XMLDTDHandler

Parameters:

name - The name of the element.

contentModel - The element content model.

augmentations - Additional information that may include infoset augmentations.

Throws:

XNIException - Thrown by handler to signal an error.

endAttlist

public void endAttlist(Augmentations augmentations)
                throws XNIException

Description copied from interface: XMLDTDHandler

The end of an attribute list.

Specified by:

endAttlist in interface XMLDTDHandler

Parameters:

augmentations - Additional information that may include infoset augmentations.

Throws:

XNIException - Thrown by handler to signal an error.

endConditional

public void endConditional(Augmentations augmentations)
                    throws XNIException

Description copied from interface: XMLDTDHandler

The end of a conditional section.

Specified by:

endConditional in interface XMLDTDHandler

Parameters:

augmentations - Additional information that may include infoset augmentations.

Throws:

XNIException - Thrown by handler to signal an error.

endDTD

public void endDTD(Augmentations augmentations)
            throws XNIException

Description copied from interface: XMLDTDHandler

The end of the DTD.

Specified by:

endDTD in interface XMLDTDHandler

Parameters:

augmentations - Additional information that may include infoset augmentations.

Throws:

XNIException - Thrown by handler to signal an error.

endExternalSubset

public void endExternalSubset(Augmentations augmentations)
                       throws XNIException

Description copied from interface: XMLDTDHandler

The end of the DTD external subset.

Specified by:

endExternalSubset in interface XMLDTDHandler

Parameters:

augmentations - Additional information that may include infoset augmentations.

Throws:

XNIException - Thrown by handler to signal an error.

endParameterEntity

public void endParameterEntity(java.lang.String name,
                               Augmentations augmentations)
                        throws XNIException

Description copied from interface: XMLDTDHandler

This method notifies the end of a parameter entity. Parameter entity names begin with a '%' character.

Specified by:

endParameterEntity in interface XMLDTDHandler

Parameters:

name - The name of the parameter entity.

augmentations - Additional information that may include infoset augmentations.

Throws:

XNIException - Thrown by handler to signal an error.

externalEntityDecl

public void externalEntityDecl(java.lang.String name,
                               XMLResourceIdentifier identifier,
                               Augmentations augmentations)
                        throws XNIException

Description copied from interface: XMLDTDHandler

An external entity declaration.

Specified by:

externalEntityDecl in interface XMLDTDHandler

Parameters:

name - The name of the entity. Parameter entity names start with '%', whereas the name of a general entity is just the entity name.

identifier - An object containing all location information pertinent to this external entity.

augmentations - Additional information that may include infoset augmentations.

Throws:

XNIException - Thrown by handler to signal an error.

getDTDSource

public XMLDTDSource getDTDSource()

Specified by:

getDTDSource in interface XMLDTDHandler

ignoredCharacters

public void ignoredCharacters(XMLString text,
                              Augmentations augmentations)
                       throws XNIException

Description copied from interface: XMLDTDHandler

Characters within an IGNORE conditional section.

Specified by:

ignoredCharacters in interface XMLDTDHandler

Parameters:

text - The ignored text.

augmentations - Additional information that may include infoset augmentations.

Throws:

XNIException - Thrown by handler to signal an error.

internalEntityDecl

public void internalEntityDecl(java.lang.String name,
                               XMLString text,
                               XMLString nonNormalizedText,
                               Augmentations augmentations)
                        throws XNIException

Description copied from interface: XMLDTDHandler

An internal entity declaration.

Specified by:

internalEntityDecl in interface XMLDTDHandler

Parameters:

name - The name of the entity. Parameter entity names start with '%', whereas the name of a general entity is just the entity name.

text - The value of the entity.

nonNormalizedText - The non-normalized value of the entity. This value contains the same sequence of characters that was in the internal entity declaration, without any entity references expanded.

augmentations - Additional information that may include infoset augmentations.

Throws:

XNIException - Thrown by handler to signal an error.

notationDecl

public void notationDecl(java.lang.String name,
                         XMLResourceIdentifier identifier,
                         Augmentations augmentations)
                  throws XNIException

Description copied from interface: XMLDTDHandler

A notation declaration

Specified by:

notationDecl in interface XMLDTDHandler

Parameters:

name - The name of the notation.

identifier - An object containing all location information pertinent to this notation.

augmentations - Additional information that may include infoset augmentations.

Throws:

XNIException - Thrown by handler to signal an error.

setDTDSource

public void setDTDSource(XMLDTDSource source)

Specified by:

setDTDSource in interface XMLDTDHandler

startAttlist

public void startAttlist(java.lang.String elementName,
                         Augmentations augmentations)
                  throws XNIException

Description copied from interface: XMLDTDHandler

The start of an attribute list.

Specified by:

startAttlist in interface XMLDTDHandler

Parameters:

elementName - The name of the element that this attribute list is associated with.

augmentations - Additional information that may include infoset augmentations.

Throws:

XNIException - Thrown by handler to signal an error.

startConditional

public void startConditional(short type,
                             Augmentations augmentations)
                      throws XNIException

Description copied from interface: XMLDTDHandler

The start of a conditional section.

Specified by:

startConditional in interface XMLDTDHandler

Parameters:

type - The type of the conditional section. This value will either be CONDITIONAL_INCLUDE or CONDITIONAL_IGNORE.

augmentations - Additional information that may include infoset augmentations.

Throws:

XNIException - Thrown by handler to signal an error.

See Also:

XMLDTDHandler.CONDITIONAL_INCLUDE, XMLDTDHandler.CONDITIONAL_IGNORE

startDTD

public void startDTD(XMLLocator locator,
                     Augmentations augmentations)
              throws XNIException

Description copied from interface: XMLDTDHandler

The start of the DTD.

Specified by:

startDTD in interface XMLDTDHandler

Parameters:

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

augmentations - Additional information that may include infoset augmentations.

Throws:

XNIException - Thrown by handler to signal an error.

startExternalSubset

public void startExternalSubset(XMLResourceIdentifier identifier,
                                Augmentations augmentations)
                         throws XNIException

Description copied from interface: XMLDTDHandler

The start of the DTD external subset.

Specified by:

startExternalSubset in interface XMLDTDHandler

Parameters:

identifier - The resource identifier.

augmentations - Additional information that may include infoset augmentations.

Throws:

XNIException - Thrown by handler to signal an error.

startParameterEntity

public void startParameterEntity(java.lang.String name,
                                 XMLResourceIdentifier identifier,
                                 java.lang.String encoding,
                                 Augmentations augmentations)
                          throws XNIException

Description copied from interface: XMLDTDHandler

This method notifies of the start of a parameter entity. The parameter entity name start with a '%' character.

Specified by:

startParameterEntity in interface XMLDTDHandler

Parameters:

name - The name of the parameter 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 parameter entities).

augmentations - Additional information that may include infoset augmentations.

Throws:

XNIException - Thrown by handler to signal an error.

unparsedEntityDecl

public void unparsedEntityDecl(java.lang.String name,
                               XMLResourceIdentifier identifier,
                               java.lang.String notation,
                               Augmentations augmentations)
                        throws XNIException

Description copied from interface: XMLDTDHandler

An unparsed entity declaration.

Specified by:

unparsedEntityDecl in interface XMLDTDHandler

Parameters:

name - The name of the entity.

identifier - An object containing all location information pertinent to this unparsed entity declaration.

notation - The name of the notation.

augmentations - Additional information that may include infoset augmentations.

Throws:

XNIException - Thrown by handler to signal an error.

getDTDHandler

public XMLDTDHandler getDTDHandler()

Description copied from interface: XMLDTDSource

Returns the DTD handler.

Specified by:

getDTDHandler in interface XMLDTDSource

setDTDHandler

public void setDTDHandler(XMLDTDHandler handler)

Description copied from interface: XMLDTDSource

Sets the DTD handler.

Specified by:

setDTDHandler in interface XMLDTDSource

restoreLanguage

public java.lang.String restoreLanguage()

Discards the language at the top of the stack, and returns the one beneath it.

getBaseURI

public java.lang.String getBaseURI(int depth)

Gets the base URI that was in use at that depth

Parameters:

depth -

Returns:

the base URI

getLanguage

public java.lang.String getLanguage(int depth)

Gets the language that was in use at that depth.

Parameters:

depth -

Returns:

the language

getRelativeURI

public java.lang.String getRelativeURI(int depth)
                                throws URI.MalformedURIException

Returns a relative URI, which when resolved against the base URI at the specified depth, will create the current base URI. This is accomplished by merged the literal system IDs.

Parameters:

depth - the depth at which to start creating the relative URI

Returns:

a relative URI to convert the base URI at the given depth to the current base URI

Throws:

URI.MalformedURIException