public class

XIncludeHandler

extends Object
implements XMLComponent XMLDTDFilter XMLDocumentFilter
java.lang.Object
   ↳ org.apache.xerces.xinclude.XIncludeHandler
Known Direct Subclasses

Class Overview

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.

Summary

Nested Classes
class XIncludeHandler.Notation  
class XIncludeHandler.UnparsedEntity  
Constants
String ALLOW_UE_AND_NOTATION_EVENTS Feature identifier: allow notation and unparsed entity events to be sent out of order.
String BUFFER_SIZE property identifier: buffer size.
String CURRENT_BASE_URI The identifier for the Augmentation that contains the current base URI
String DYNAMIC_VALIDATION Feature identifier: dynamic validation.
String ENTITY_RESOLVER Property identifier: entity resolver.
String ERROR_REPORTER Property identifier: error reporter.
String HTTP_ACCEPT
String HTTP_ACCEPT_LANGUAGE
String JAXP_SCHEMA_LANGUAGE Property identifier: JAXP schema language.
String PARSER_SETTINGS
String SCHEMA_VALIDATION Feature identifier: schema validation.
String SECURITY_MANAGER property identifier: security manager.
String SYMBOL_TABLE Property identifier: symbol table.
String VALIDATION Feature identifier: validation.
String XINCLUDE_DEFAULT_CONFIGURATION
String XINCLUDE_FIXUP_BASE_URIS Feature identifier: fixup base URIs.
String XINCLUDE_FIXUP_LANGUAGE Feature identifier: fixup language.
String XPOINTER
[Expand]
Inherited Constants
From interface org.apache.xerces.xni.XMLDTDHandler
Fields
public static final String XINCLUDE_ATTR_ACCEPT
public static final String XINCLUDE_ATTR_ACCEPT_LANGUAGE
public static final String XINCLUDE_ATTR_ENCODING
public static final String XINCLUDE_ATTR_HREF
public static final String XINCLUDE_ATTR_PARSE
public static final String XINCLUDE_FALLBACK
public static final String XINCLUDE_INCLUDE
public static final String XINCLUDE_INCLUDED
public static final String XINCLUDE_NS_URI
public static final String XINCLUDE_PARSE_TEXT
public static final String XINCLUDE_PARSE_XML
protected Stack fBaseURI
protected IntStack fBaseURIScope
protected int fBufferSize
protected XMLParserConfiguration fChildConfig
protected XMLResourceIdentifier fCurrentBaseURI
protected String fCurrentLanguage
protected XMLDTDHandler fDTDHandler
protected XMLDTDSource fDTDSource
protected XMLLocator fDocLocation
protected XMLDocumentHandler fDocumentHandler
protected XMLDocumentSource fDocumentSource
protected XMLEntityResolver fEntityResolver
protected XMLErrorReporter fErrorReporter
protected Stack fExpandedSystemID
protected String fHrefFromParent
protected IntStack fLanguageScope
protected Stack fLanguageStack
protected Stack fLiteralSystemID
protected XIncludeNamespaceSupport fNamespaceContext
protected String fParentRelativeURI
protected XIncludeHandler fParentXIncludeHandler
protected SecurityManager fSecurityManager
protected ParserConfigurationSettings fSettings
protected SymbolTable fSymbolTable
protected XIncludeTextReader fXInclude10TextReader
protected XIncludeTextReader fXInclude11TextReader
protected XMLParserConfiguration fXIncludeChildConfig
protected XIncludeMessageFormatter fXIncludeMessageFormatter
protected XMLParserConfiguration fXPointerChildConfig
protected XPointerProcessor fXPtrProcessor
Public Constructors
XIncludeHandler()
Public Methods
void attributeDecl(String elementName, String attributeName, String type, String[] enumeration, 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(String rootElement, String publicId, String systemId, Augmentations augs)
Notifies of the presence of the DOCTYPE line in the document.
void elementDecl(String name, 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 endDTD(Augmentations augmentations)
The end of the DTD.
void endDocument(Augmentations augs)
The end of the document.
void endElement(QName element, Augmentations augs)
The end of an element.
void endExternalSubset(Augmentations augmentations)
The end of the DTD external subset.
void endGeneralEntity(String name, Augmentations augs)
This method notifies the end of a general entity.
void endParameterEntity(String name, Augmentations augmentations)
This method notifies the end of a parameter entity.
void externalEntityDecl(String name, XMLResourceIdentifier identifier, Augmentations augmentations)
An external entity declaration.
String getBaseURI(int depth)
Gets the base URI that was in use at that depth
XMLDTDHandler getDTDHandler()
Returns the DTD handler.
XMLDTDSource getDTDSource()
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.
String getLanguage(int depth)
Gets the language that was in use at that depth.
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.
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(String name, XMLString text, XMLString nonNormalizedText, Augmentations augmentations)
An internal entity declaration.
void notationDecl(String name, XMLResourceIdentifier identifier, Augmentations augmentations)
A notation declaration
void processingInstruction(String target, XMLString data, Augmentations augs)
A processing instruction.
void reset(XMLComponentManager componentManager)
Resets the component.
String restoreLanguage()
Discards the language at the top of the stack, and returns the one beneath it.
void setDTDHandler(XMLDTDHandler handler)
Sets the DTD handler.
void setDTDSource(XMLDTDSource source)
void setDocumentHandler(XMLDocumentHandler handler)
Sets the document handler.
void setDocumentSource(XMLDocumentSource source)
Sets the document source.
void setFeature(String featureId, boolean state)
Sets the state of a feature.
void setProperty(String propertyId, Object value)
Sets the value of a property.
void startAttlist(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 startDTD(XMLLocator locator, Augmentations augmentations)
The start of the DTD.
void startDocument(XMLLocator locator, String encoding, NamespaceContext namespaceContext, Augmentations augs)
Event sent at the start of the document.
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(String name, XMLResourceIdentifier resId, String encoding, Augmentations augs)
This method notifies the start of a general entity.
void startParameterEntity(String name, XMLResourceIdentifier identifier, String encoding, Augmentations augmentations)
This method notifies of the start of a parameter entity.
void textDecl(String version, String encoding, Augmentations augs)
Notifies of the presence of a TextDecl line in an entity.
void unparsedEntityDecl(String name, XMLResourceIdentifier identifier, String notation, Augmentations augmentations)
An unparsed entity declaration.
void xmlDecl(String version, String encoding, String standalone, Augmentations augs)
Notifies of the presence of an XMLDecl line in the document.
Protected Methods
void addNotation(String name, XMLResourceIdentifier identifier, Augmentations augmentations)
Caches a notation.
void addUnparsedEntity(String name, XMLResourceIdentifier identifier, String notation, Augmentations augmentations)
Caches an unparsed entity.
void checkAndSendNotation(XIncludeHandler.Notation not)
The purpose of this method is to check if a Notation conflicts with a previously declared notation in the current pipeline stack.
void checkAndSendUnparsedEntity(XIncludeHandler.UnparsedEntity ent)
The purpose of this method is to check if an UnparsedEntity conflicts with a previously declared entity in the current pipeline stack.
void checkNotation(String notName)
Checks if a Notation with the given name was declared in the DTD of the document for the current pipeline.
void checkUnparsedEntity(String entName)
Checks if an UnparsedEntity with the given name was declared in the DTD of the document for the current pipeline.
void copyFeatures(XMLComponentManager from, XMLParserConfiguration to)
void copyFeatures(XMLComponentManager from, ParserConfigurationSettings to)
String getRelativeBaseURI()
Returns a URI, relative to the include parent's base URI, of the current [base URI].
boolean getSawFallback(int depth)
Returns whether an <fallback> was encountered at the specified depth, as an ancestor of the current element, or as a sibling of an ancestor of the current element.
boolean getSawInclude(int depth)
Return whether an <include> was encountered at the specified depth, as an ancestor of the current item.
int getState()
int getState(int depth)
void handleFallbackElement()
boolean handleIncludeElement(XMLAttributes attributes)
boolean hasXIncludeNamespace(QName element)
Returns true if the element has the namespace "http://www.w3.org/2001/XInclude"
boolean isFallbackElement(QName element)
Checks if the element is an <fallback> element.
boolean isIncludeElement(QName element)
Checks if the element is an <include> element.
boolean isRootDocument()
boolean isTopLevelIncludedItem()
Returns true if the current element is a top level included item.
boolean isTopLevelIncludedItemViaFallback()
boolean isTopLevelIncludedItemViaInclude()
Augmentations modifyAugmentations(Augmentations augs)
Modify the augmentations.
Augmentations modifyAugmentations(Augmentations augs, boolean force)
Modify the augmentations.
XMLAttributes processAttributes(XMLAttributes attributes)
Processes the XMLAttributes object of startElement() calls.
void processXMLBaseAttributes(XMLAttributes attributes)
Search for a xml:base attribute, and if one is found, put the new base URI into effect.
void processXMLLangAttributes(XMLAttributes attributes)
Search for a xml:lang attribute, and if one is found, put the new [language] into effect.
void reportFatalError(String key)
void reportFatalError(String key, Object[] args)
void reportResourceError(String key)
void reportResourceError(String key, Object[] args)
void restoreBaseURI()
Discards the URIs at the top of the stack, and restores the ones beneath it.
boolean sameBaseURIAsIncludeParent()
Returns true if the current [base URI] is the same as the [base URI] that was in effect on the include parent.
boolean sameLanguageAsIncludeParent()
Returns true if the current [language] is equivalent to the [language] that was in effect on the include parent, taking case-insensitivity into account as per [RFC 3066].
void saveBaseURI()
Saves the current base URI to the top of the stack.
void saveLanguage(String language)
Saves the given language on the top of the stack.
boolean searchForRecursiveIncludes(String includedSysId)
Checks if the file indicated by the given system id has already been included in the current stack.
void setHref(String href)
void setParent(XIncludeHandler parent)
Set the parent of this XIncludeHandler in the tree
void setSawFallback(int depth, boolean val)
Records that an <fallback> was encountered at the specified depth, as an ancestor of the current element, or as a sibling of an ancestor of the current element.
void setSawInclude(int depth, boolean val)
Records that an <include> was encountered at the specified depth, as an ancestor of the current item.
void setState(int state)
void setupCurrentBaseURI(XMLLocator locator)
[Expand]
Inherited Methods
From class java.lang.Object
From interface org.apache.xerces.xni.XMLDTDHandler
From interface org.apache.xerces.xni.XMLDocumentHandler
From interface org.apache.xerces.xni.parser.XMLComponent
From interface org.apache.xerces.xni.parser.XMLDTDSource
From interface org.apache.xerces.xni.parser.XMLDocumentSource

Constants

protected static final String ALLOW_UE_AND_NOTATION_EVENTS

Feature identifier: allow notation and unparsed entity events to be sent out of order.

Constant Value: "http://xml.org/sax/features/allow-dtd-events-after-endDTD"

protected static final String BUFFER_SIZE

property identifier: buffer size.

Constant Value: "http://apache.org/xml/properties/input-buffer-size"

public static final String CURRENT_BASE_URI

The identifier for the Augmentation that contains the current base URI

Constant Value: "currentBaseURI"

protected static final String DYNAMIC_VALIDATION

Feature identifier: dynamic validation.

Constant Value: "http://apache.org/xml/features/validation/dynamic"

protected static final String ENTITY_RESOLVER

Property identifier: entity resolver.

Constant Value: "http://apache.org/xml/properties/internal/entity-resolver"

protected static final String ERROR_REPORTER

Property identifier: error reporter.

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

public static final String HTTP_ACCEPT

Constant Value: "Accept"

public static final String HTTP_ACCEPT_LANGUAGE

Constant Value: "Accept-Language"

protected static final String JAXP_SCHEMA_LANGUAGE

Property identifier: JAXP schema language.

Constant Value: "http://java.sun.com/xml/jaxp/properties/schemaLanguage"

protected static final String PARSER_SETTINGS

Constant Value: "http://apache.org/xml/features/internal/parser-settings"

protected static final String SCHEMA_VALIDATION

Feature identifier: schema validation.

Constant Value: "http://apache.org/xml/features/validation/schema"

protected static final String SECURITY_MANAGER

property identifier: security manager.

Constant Value: "http://apache.org/xml/properties/security-manager"

protected static final String SYMBOL_TABLE

Property identifier: symbol table.

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

protected static final String VALIDATION

Feature identifier: validation.

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

public static final String XINCLUDE_DEFAULT_CONFIGURATION

Constant Value: "org.apache.xerces.parsers.XIncludeParserConfiguration"

protected static final String XINCLUDE_FIXUP_BASE_URIS

Feature identifier: fixup base URIs.

Constant Value: "http://apache.org/xml/features/xinclude/fixup-base-uris"

protected static final String XINCLUDE_FIXUP_LANGUAGE

Feature identifier: fixup language.

Constant Value: "http://apache.org/xml/features/xinclude/fixup-language"

public static final String XPOINTER

Constant Value: "xpointer"

Fields

public static final String XINCLUDE_ATTR_ACCEPT

public static final String XINCLUDE_ATTR_ACCEPT_LANGUAGE

public static final String XINCLUDE_ATTR_ENCODING

public static final String XINCLUDE_ATTR_HREF

public static final String XINCLUDE_ATTR_PARSE

public static final String XINCLUDE_FALLBACK

public static final String XINCLUDE_INCLUDE

public static final String XINCLUDE_INCLUDED

public static final String XINCLUDE_NS_URI

public static final String XINCLUDE_PARSE_TEXT

public static final String XINCLUDE_PARSE_XML

protected Stack fBaseURI

protected IntStack fBaseURIScope

protected int fBufferSize

protected XMLParserConfiguration fChildConfig

protected XMLResourceIdentifier fCurrentBaseURI

protected String fCurrentLanguage

protected XMLDTDHandler fDTDHandler

protected XMLDTDSource fDTDSource

protected XMLLocator fDocLocation

protected XMLDocumentHandler fDocumentHandler

protected XMLDocumentSource fDocumentSource

protected XMLEntityResolver fEntityResolver

protected XMLErrorReporter fErrorReporter

protected Stack fExpandedSystemID

protected String fHrefFromParent

protected IntStack fLanguageScope

protected Stack fLanguageStack

protected Stack fLiteralSystemID

protected XIncludeNamespaceSupport fNamespaceContext

protected String fParentRelativeURI

protected XIncludeHandler fParentXIncludeHandler

protected SecurityManager fSecurityManager

protected ParserConfigurationSettings fSettings

protected SymbolTable fSymbolTable

protected XIncludeTextReader fXInclude10TextReader

protected XIncludeTextReader fXInclude11TextReader

protected XMLParserConfiguration fXIncludeChildConfig

protected XIncludeMessageFormatter fXIncludeMessageFormatter

protected XMLParserConfiguration fXPointerChildConfig

protected XPointerProcessor fXPtrProcessor

Public Constructors

public XIncludeHandler ()

Public Methods

public void attributeDecl (String elementName, String attributeName, String type, String[] enumeration, String defaultType, XMLString defaultValue, XMLString nonNormalizedDefaultValue, Augmentations augmentations)

An attribute declaration.

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

public void characters (XMLString text, Augmentations augs)

Character content.

Parameters
text The content.
augs Additional information that may include infoset augmentations
Throws
XNIException

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

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

public void elementDecl (String name, String contentModel, Augmentations augmentations)

An element declaration.

Parameters
name The name of the element.
contentModel The element content model.
augmentations Additional information that may include infoset augmentations.
Throws
XNIException

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

public void endAttlist (Augmentations augmentations)

The end of an attribute list.

Parameters
augmentations Additional information that may include infoset augmentations.
Throws
XNIException

public void endCDATA (Augmentations augs)

The end of a CDATA section.

Parameters
augs Additional information that may include infoset augmentations
Throws
XNIException

public void endConditional (Augmentations augmentations)

The end of a conditional section.

Parameters
augmentations Additional information that may include infoset augmentations.
Throws
XNIException

public void endDTD (Augmentations augmentations)

The end of the DTD.

Parameters
augmentations Additional information that may include infoset augmentations.
Throws
XNIException

public void endDocument (Augmentations augs)

The end of the document.

Parameters
augs Additional information that may include infoset augmentations
Throws
XNIException

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

public void endExternalSubset (Augmentations augmentations)

The end of the DTD external subset.

Parameters
augmentations Additional information that may include infoset augmentations.
Throws
XNIException

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

public void endParameterEntity (String name, Augmentations augmentations)

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

Parameters
name The name of the parameter entity.
augmentations Additional information that may include infoset augmentations.
Throws
XNIException

public void externalEntityDecl (String name, XMLResourceIdentifier identifier, Augmentations augmentations)

An external entity declaration.

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

public String getBaseURI (int depth)

Gets the base URI that was in use at that depth

Returns
  • the base URI

public XMLDTDHandler getDTDHandler ()

Returns the DTD handler.

public XMLDTDSource getDTDSource ()

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 String getLanguage (int depth)

Gets the language that was in use at that depth.

Returns
  • the language

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

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

public void ignoredCharacters (XMLString text, Augmentations augmentations)

Characters within an IGNORE conditional section.

Parameters
text The ignored text.
augmentations Additional information that may include infoset augmentations.
Throws
XNIException

public void internalEntityDecl (String name, XMLString text, XMLString nonNormalizedText, Augmentations augmentations)

An internal entity declaration.

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

public void notationDecl (String name, XMLResourceIdentifier identifier, Augmentations augmentations)

A notation declaration

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

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

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
XNIException

public String restoreLanguage ()

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

public void setDTDHandler (XMLDTDHandler handler)

Sets the DTD handler.

public void setDTDSource (XMLDTDSource source)

public void setDocumentHandler (XMLDocumentHandler handler)

Sets the document handler.

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 setProperty (String propertyId, Object value)

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.

Parameters
propertyId The property identifier.
value The value of the property.
Throws
The component should not throw this exception.
The component should not throw this exception.
XMLConfigurationException

public void startAttlist (String elementName, Augmentations augmentations)

The start of an attribute list.

Parameters
elementName The name of the element that this attribute list is associated with.
augmentations Additional information that may include infoset augmentations.
Throws
XNIException

public void startCDATA (Augmentations augs)

The start of a CDATA section.

Parameters
augs Additional information that may include infoset augmentations
Throws
XNIException

public void startConditional (short type, Augmentations augmentations)

The start of a conditional section.

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

public void startDTD (XMLLocator locator, Augmentations augmentations)

The start of the DTD.

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

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

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.

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

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

The start of an element.

Parameters
element The name of the element.
attributes The element attributes.
augs Additional information that may include infoset augmentations
Throws
XNIException

public void startExternalSubset (XMLResourceIdentifier identifier, Augmentations augmentations)

The start of the DTD external subset.

Parameters
identifier The resource identifier.
augmentations Additional information that may include infoset augmentations.
Throws
XNIException

public void startGeneralEntity (String name, XMLResourceIdentifier resId, 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.
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

public void startParameterEntity (String name, XMLResourceIdentifier identifier, String encoding, Augmentations augmentations)

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

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

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 is only called for external parameter entities referenced in the DTD.

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

public void unparsedEntityDecl (String name, XMLResourceIdentifier identifier, String notation, Augmentations augmentations)

An unparsed entity declaration.

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

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

Protected Methods

protected void addNotation (String name, XMLResourceIdentifier identifier, Augmentations augmentations)

Caches a notation.

Parameters
name the name of the notation
identifier the location of the notation
augmentations any Augmentations that were on the original notation declaration

protected void addUnparsedEntity (String name, XMLResourceIdentifier identifier, String notation, Augmentations augmentations)

Caches an unparsed entity.

Parameters
name the name of the unparsed entity
identifier the location of the unparsed entity
augmentations any Augmentations that were on the original unparsed entity declaration

protected void checkAndSendNotation (XIncludeHandler.Notation not)

The purpose of this method is to check if a Notation conflicts with a previously declared notation in the current pipeline stack. If there is no conflict, the Notation is sent by the root pipeline.

Parameters
not the Notation to check for conflicts

protected void checkAndSendUnparsedEntity (XIncludeHandler.UnparsedEntity ent)

The purpose of this method is to check if an UnparsedEntity conflicts with a previously declared entity in the current pipeline stack. If there is no conflict, the UnparsedEntity is sent by the root pipeline.

Parameters
ent the UnparsedEntity to check for conflicts

protected void checkNotation (String notName)

Checks if a Notation with the given name was declared in the DTD of the document for the current pipeline. If so, that Notation is passed to the root pipeline to be checked for conflicts, and sent to the root DTDHandler

Parameters
notName the name of the Notation to check

protected void checkUnparsedEntity (String entName)

Checks if an UnparsedEntity with the given name was declared in the DTD of the document for the current pipeline. If so, then the notation for the UnparsedEntity is checked. If that turns out okay, then the UnparsedEntity is passed to the root pipeline to be checked for conflicts, and sent to the root DTDHandler.

Parameters
entName the name of the UnparsedEntity to check

protected void copyFeatures (XMLComponentManager from, XMLParserConfiguration to)

protected void copyFeatures (XMLComponentManager from, ParserConfigurationSettings to)

protected String getRelativeBaseURI ()

Returns a URI, relative to the include parent's base URI, of the current [base URI]. For instance, if the current [base URI] was "dir1/dir2/file.xml" and the include parent's [base URI] was "dir/", this would return "dir2/file.xml".

Returns
  • the relative URI

protected boolean getSawFallback (int depth)

Returns whether an <fallback> was encountered at the specified depth, as an ancestor of the current element, or as a sibling of an ancestor of the current element.

protected boolean getSawInclude (int depth)

Return whether an <include> was encountered at the specified depth, as an ancestor of the current item.

Returns
  • true if an include was seen at the given depth, false otherwise

protected int getState ()

protected int getState (int depth)

protected void handleFallbackElement ()

protected boolean handleIncludeElement (XMLAttributes attributes)

Throws
XNIException

protected boolean hasXIncludeNamespace (QName element)

Returns true if the element has the namespace "http://www.w3.org/2001/XInclude"

Parameters
element the element to check
Returns
  • true if the element has the namespace "http://www.w3.org/2001/XInclude"

protected boolean isFallbackElement (QName element)

Checks if the element is an <fallback> element. The element must have the XInclude namespace, and a local name of "fallback".

Parameters
element the element to check
Returns
  • true if the element is an <fallback; element

protected boolean isIncludeElement (QName element)

Checks if the element is an <include> element. The element must have the XInclude namespace, and a local name of "include".

Parameters
element the element to check
Returns
  • true if the element is an <include> element

protected boolean isRootDocument ()

protected boolean isTopLevelIncludedItem ()

Returns true if the current element is a top level included item. This means it's either the child of a fallback element, or the top level item in an included document

Returns
  • true if the current element is a top level included item

protected boolean isTopLevelIncludedItemViaFallback ()

protected boolean isTopLevelIncludedItemViaInclude ()

protected Augmentations modifyAugmentations (Augmentations augs)

Modify the augmentations. Add an [included] infoset item, if the current element is a top level included item.

Parameters
augs the Augmentations to modify.
Returns
  • the modified Augmentations

protected Augmentations modifyAugmentations (Augmentations augs, boolean force)

Modify the augmentations. Add an [included] infoset item, if force is true, or if the current element is a top level included item.

Parameters
augs the Augmentations to modify.
force whether to force modification
Returns
  • the modified Augmentations

protected XMLAttributes processAttributes (XMLAttributes attributes)

Processes the XMLAttributes object of startElement() calls. Performs the following tasks:

  • If the element is a top level included item whose [base URI] is different from the [base URI] of the include parent, then an xml:base attribute is added to specify the true [base URI]
  • For all namespace prefixes which are in-scope in an included item, but not in scope in the include parent, a xmlns:prefix attribute is added
  • For all attributes with a type of ENTITY, ENTITIES or NOTATIONS, the notations and unparsed entities are processed as described in the spec, sections 4.5.1 and 4.5.2

Returns
  • the processed XMLAttributes

protected void processXMLBaseAttributes (XMLAttributes attributes)

Search for a xml:base attribute, and if one is found, put the new base URI into effect.

protected void processXMLLangAttributes (XMLAttributes attributes)

Search for a xml:lang attribute, and if one is found, put the new [language] into effect.

protected void reportFatalError (String key)

protected void reportFatalError (String key, Object[] args)

protected void reportResourceError (String key)

protected void reportResourceError (String key, Object[] args)

protected void restoreBaseURI ()

Discards the URIs at the top of the stack, and restores the ones beneath it.

protected boolean sameBaseURIAsIncludeParent ()

Returns true if the current [base URI] is the same as the [base URI] that was in effect on the include parent. This method should only be called when the current element is a top level included element, i.e. the direct child of a fallback element, or the root elements in an included document. The "include parent" is the element which, in the result infoset, will be the direct parent of the current element.

Returns
  • true if the [base URIs] are the same string

protected boolean sameLanguageAsIncludeParent ()

Returns true if the current [language] is equivalent to the [language] that was in effect on the include parent, taking case-insensitivity into account as per [RFC 3066]. This method should only be called when the current element is a top level included element, i.e. the direct child of a fallback element, or the root elements in an included document. The "include parent" is the element which, in the result infoset, will be the direct parent of the current element.

Returns
  • true if the [language] properties have the same value taking case-insensitivity into account as per [RFC 3066].

protected void saveBaseURI ()

Saves the current base URI to the top of the stack.

protected void saveLanguage (String language)

Saves the given language on the top of the stack.

Parameters
language the language to push onto the stack.

protected boolean searchForRecursiveIncludes (String includedSysId)

Checks if the file indicated by the given system id has already been included in the current stack.

Parameters
includedSysId the system id to check for inclusion
Returns
  • true if the source has already been included

protected void setHref (String href)

protected void setParent (XIncludeHandler parent)

Set the parent of this XIncludeHandler in the tree

protected void setSawFallback (int depth, boolean val)

Records that an <fallback> was encountered at the specified depth, as an ancestor of the current element, or as a sibling of an ancestor of the current element.

protected void setSawInclude (int depth, boolean val)

Records that an <include> was encountered at the specified depth, as an ancestor of the current item.

protected void setState (int state)

protected void setupCurrentBaseURI (XMLLocator locator)