Package net.sf.saxon.event

Class IDFilter

java.lang.Object

net.sf.saxon.event.SequenceReceiver

net.sf.saxon.event.ProxyReceiver

net.sf.saxon.event.StartTagBuffer

net.sf.saxon.event.IDFilter

All Implemented Interfaces:

javax.xml.transform.Result, Receiver, NamespaceResolver

public class IDFilter
extends StartTagBuffer

IDFilter is a ProxyReceiver that extracts the subtree of a document rooted at the element with a given ID value. Namespace declarations outside this subtree are treated as if they were present on the identified element.

Field Summary

Fields inherited from class net.sf.saxon.event.StartTagBuffer

bufferedAttributes, elementLocationId, elementNameCode, elementProperties, elementTypeCode

Fields inherited from class net.sf.saxon.event.ProxyReceiver

nextReceiver

Fields inherited from class net.sf.saxon.event.SequenceReceiver

pipelineConfiguration, previousAtomic, systemId

Fields inherited from interface javax.xml.transform.Result

PI_DISABLE_OUTPUT_ESCAPING, PI_ENABLE_OUTPUT_ESCAPING

Constructor Summary

Constructors

Constructor	Description
IDFilter(java.lang.String id)

Method Summary

Modifier and Type	Method	Description
void	attribute(int nameCode, int typeCode, java.lang.CharSequence value, int locationId, int properties)	Notify an attribute.
void	characters(java.lang.CharSequence chars, int locationId, int properties)	Character data
void	comment(java.lang.CharSequence chars, int locationId, int properties)	Output a comment
protected void	declareNamespacesForStartElement()
void	endElement()	endElement:
void	processingInstruction(java.lang.String target, java.lang.CharSequence data, int locationId, int properties)	Processing Instruction
void	startContent()	startContent: Test if a matching ID attribute was found; if so, start outputting.
void	startElement(int nameCode, int typeCode, int locationId, int properties)	startElement

Methods inherited from class net.sf.saxon.event.StartTagBuffer

declareAllNamespaces, getAttribute, getElementNameCode, getURICode, getURIForPrefix, hasAttributes, iteratePrefixes, namespace, setPipelineConfiguration, undeclareNamespacesForElement

Methods inherited from class net.sf.saxon.event.ProxyReceiver

close, endDocument, getConfiguration, getDocumentLocator, getNamePool, getUnderlyingReceiver, open, setSystemId, setUnderlyingReceiver, setUnparsedEntity, startDocument

Methods inherited from class net.sf.saxon.event.SequenceReceiver

append, getPipelineConfiguration, getSystemId

Methods inherited from class java.lang.Object

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

Constructor Detail

IDFilter

public IDFilter(java.lang.String id)

Method Detail

startElement

public void startElement(int nameCode,
                         int typeCode,
                         int locationId,
                         int properties)
                  throws XPathException

startElement

Specified by:

startElement in interface Receiver

Overrides:

startElement in class StartTagBuffer

Parameters:

nameCode - integer code identifying the name of the element within the name pool.

typeCode - integer code identifying the element's type within the name pool.

locationId - an integer which can be interpreted using a LocationProvider to return information such as line number and system ID. If no location information is available, the value zero is supplied.

properties - properties of the element node

Throws:

XPathException

attribute

public void attribute(int nameCode,
                      int typeCode,
                      java.lang.CharSequence value,
                      int locationId,
                      int properties)
               throws XPathException

Notify an attribute. Attributes are notified after the startElement event, and before any children. Namespaces and attributes may be intermingled.

Specified by:

attribute in interface Receiver

Overrides:

attribute in class StartTagBuffer

Parameters:

nameCode - The name of the attribute, as held in the name pool

typeCode - The type of the attribute, as held in the name pool

properties - Bit significant value. The following bits are defined:

DISABLE_ESCAPING

Disable escaping for this attribute

NO_SPECIAL_CHARACTERS

Attribute value contains no special characters

locationId - an integer which can be interpreted using a LocationProvider to return information such as line number and system ID. If no location information is available, the value zero is supplied.

Throws:

XPathException

startContent

public void startContent()
                  throws XPathException

startContent: Test if a matching ID attribute was found; if so, start outputting.

Specified by:

startContent in interface Receiver

Overrides:

startContent in class StartTagBuffer

Throws:

XPathException

declareNamespacesForStartElement

protected void declareNamespacesForStartElement()
                                         throws XPathException

Overrides:

declareNamespacesForStartElement in class StartTagBuffer

Throws:

XPathException

endElement

public void endElement()
                throws XPathException

endElement:

Specified by:

endElement in interface Receiver

Overrides:

endElement in class StartTagBuffer

Throws:

XPathException

characters

public void characters(java.lang.CharSequence chars,
                       int locationId,
                       int properties)
                throws XPathException

Character data

Specified by:

characters in interface Receiver

Overrides:

characters in class ProxyReceiver

Parameters:

chars - The characters

locationId - an integer which can be interpreted using a LocationProvider to return information such as line number and system ID. If no location information is available, the value zero is supplied.

properties - Bit significant value. The following bits are defined:

DISABLE_ESCAPING

Disable escaping for this text node

USE_CDATA

Output as a CDATA section

NO_SPECIAL_CHARACTERS

Value contains no special characters

WHITESPACE

Text is all whitespace

Throws:

XPathException

processingInstruction

public void processingInstruction(java.lang.String target,
                                  java.lang.CharSequence data,
                                  int locationId,
                                  int properties)
                           throws XPathException

Processing Instruction

Specified by:

processingInstruction in interface Receiver

Overrides:

processingInstruction in class ProxyReceiver

Parameters:

target - The PI name. This must be a legal name (it will not be checked).

data - The data portion of the processing instruction

locationId - an integer which can be interpreted using a LocationProvider to return information such as line number and system ID. If no location information is available, the value zero is supplied.

properties - Additional information about the PI. The following bits are defined:

CHECKED

Data is known to be legal (e.g. doesn't contain "?>")

Throws:

XPathException

comment

public void comment(java.lang.CharSequence chars,
                    int locationId,
                    int properties)
             throws XPathException

Output a comment

Specified by:

comment in interface Receiver

Overrides:

comment in class ProxyReceiver

Parameters:

chars - The content of the comment

locationId - an integer which can be interpreted using a LocationProvider to return information such as line number and system ID. If no location information is available, the value zero is supplied.

properties - Additional information about the comment. The following bits are defined:

CHECKED

Comment is known to be legal (e.g. doesn't contain "--")

Throws:

XPathException