Index (Frames) | Index (No Frames) | Package | Package Tree | Tree
gnu.xml.pipeline

Class XIncludeFilter

java.lang.Object
|
+--gnu.xml.pipeline.EventFilter
   |
   +--gnu.xml.pipeline.XIncludeFilter

All Implemented Interfaces:

Locator, EventConsumer, ContentHandler, DTDHandler, LexicalHandler, DeclHandler


public class XIncludeFilter

extends EventFilter

implements Locator

Filter to process an XPointer-free subset of XInclude, supporting its use as a kind of replacement for parsed general entities. XInclude works much like the #include of C/C++ but works for XML documents as well as unparsed text files. Restrictions from the 17-Sept-2002 CR draft of XInclude are as follows:

XML documents that are included will normally be processed using the default SAX namespace rules, meaning that prefix information may be discarded. This may be changed with #setSavingPrefixes setSavingPrefixes(). You are strongly advised to do this.

Note that XInclude allows highly incompatible implementations, which are specialized to handle application-specific infoset extensions. Some such implementations can be implemented by subclassing this one, but they may only be substituted in applications at "user option".

TBD: "IURI" handling.

Author:

Constructor Summary

XIncludeFilter(gnu.xml.pipeline.EventConsumer next)

Method Summary

voidcharacters(char ch[][] , int start, int length)

voidcomment(char ch[][] , int start, int length)

voidendCDATA()

voidendDocument()

voidendElement(java.lang.String uri, java.lang.String localName, java.lang.String qName)

voidendEntity(java.lang.String name)

voidendPrefixMapping(java.lang.String prefix)

voidexternalEntityDecl(java.lang.String name, java.lang.String publicId, java.lang.String systemId)

intgetColumnNumber()

Used for proxy locator; do not call directly.
intgetLineNumber()

Used for proxy locator; do not call directly.
java.lang.StringgetPublicId()

Used for proxy locator; do not call directly.
java.lang.StringgetSystemId()

Used for proxy locator; do not call directly.
voidignorableWhitespace(char ch[][] , int start, int length)

booleanisSavingPrefixes()

Returns the flag controlling the setting of the SAX2 namespace-prefixes flag when parsing included documents.
voidprocessingInstruction(java.lang.String target, java.lang.String value)

voidsetDocumentLocator(org.xml.sax.Locator locator)

Passes "this" down the filter chain as a proxy locator.
voidsetSavingPrefixes(boolean flag)

Assigns the flag controlling the setting of the SAX2 namespace-prefixes flag.
voidskippedEntity(java.lang.String name)

voidstartCDATA()

voidstartDocument()

voidstartElement(java.lang.String uri, java.lang.String localName, java.lang.String qName, org.xml.sax.Attributes atts)

voidstartEntity(java.lang.String name)

voidstartPrefixMapping(java.lang.String prefix, java.lang.String uri)

Constructor Details

XIncludeFilter

public XIncludeFilter(gnu.xml.pipeline.EventConsumer next)

Parameters:


Method Details

characters

public void characters(char ch[][] , int start, int length)

Parameters:


comment

public void comment(char ch[][] , int start, int length)

Parameters:


endCDATA

public void endCDATA()


endDocument

public void endDocument()


endElement

public void endElement(java.lang.String uri, java.lang.String localName, java.lang.String qName)

Parameters:


endEntity

public void endEntity(java.lang.String name)

Parameters:


endPrefixMapping

public void endPrefixMapping(java.lang.String prefix)

Parameters:


externalEntityDecl

public void externalEntityDecl(java.lang.String name, java.lang.String publicId, java.lang.String systemId)

Parameters:


getColumnNumber

public int getColumnNumber()

Used for proxy locator; do not call directly.


getLineNumber

public int getLineNumber()

Used for proxy locator; do not call directly.


getPublicId

public String getPublicId()

Used for proxy locator; do not call directly.


getSystemId

public String getSystemId()

Used for proxy locator; do not call directly.


ignorableWhitespace

public void ignorableWhitespace(char ch[][] , int start, int length)

Parameters:


isSavingPrefixes

public boolean isSavingPrefixes()

Returns the flag controlling the setting of the SAX2 namespace-prefixes flag when parsing included documents. The default value is the SAX2 default (false), which discards information that can be useful.


processingInstruction

public void processingInstruction(java.lang.String target, java.lang.String value)

Parameters:


setDocumentLocator

public void setDocumentLocator(org.xml.sax.Locator locator)

Passes "this" down the filter chain as a proxy locator.

Parameters:


setSavingPrefixes

public void setSavingPrefixes(boolean flag)

Assigns the flag controlling the setting of the SAX2 namespace-prefixes flag.

Parameters:


skippedEntity

public void skippedEntity(java.lang.String name)

Parameters:


startCDATA

public void startCDATA()


startDocument

public void startDocument()


startElement

public void startElement(java.lang.String uri, java.lang.String localName, java.lang.String qName, org.xml.sax.Attributes atts)

Parameters:


startEntity

public void startEntity(java.lang.String name)

Parameters:


startPrefixMapping

public void startPrefixMapping(java.lang.String prefix, java.lang.String uri)

Parameters: