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:

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, namespaces, namespacesSize

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 and Description
IDFilter(Receiver next, String id)

Method Summary

Methods

Modifier and Type	Method and Description
void	attribute(NodeName attName, SimpleType typeCode, CharSequence value, int locationId, int properties) Notify an attribute.
void	characters(CharSequence chars, int locationId, int properties) Character data
void	comment(CharSequence chars, int locationId, int properties) Output a comment
protected void	declareNamespacesForStartElement()
void	endElement() endElement:
void	processingInstruction(String target, 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(NodeName nameCode, SchemaType typeCode, int locationId, int properties) startElement
boolean	usesTypeAnnotations() Ask whether this Receiver (or the downstream pipeline) makes any use of the type annotations supplied on element and attribute events

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

declareAllNamespaces, endDocument, getAllAttributes, getAttribute, getAttribute, getLocalNamespaces, getURIForPrefix, hasAttributeInNamespace, hasAttributes, iteratePrefixes, namespace, setPipelineConfiguration, startDocument, undeclareNamespacesForElement

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

append, close, getNamePool, getUnderlyingReceiver, open, setSystemId, setUnderlyingReceiver, setUnparsedEntity

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

append, getConfiguration, getPipelineConfiguration, getSystemId, isTrueSequenceReceiver

Methods inherited from class java.lang.Object

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

Constructor Detail

IDFilter

public IDFilter(Receiver next,
        String id)

Method Detail

startElement

public void startElement(NodeName nameCode,
                SchemaType 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 - if an error occurs

attribute

public void attribute(NodeName attName,
             SimpleType typeCode,
             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:

attName - 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, inter alia:

DISABLE_ESCAPING

Disable escaping for this attribute

NO_SPECIAL_CHARACTERS

Attribute value contains no special characters

IS_ID

Attribute is an ID

value - the string value of the attribute

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:

IllegalStateException: - attempt to output an attribute when there is no open element start tag

XPathException - if an error occurs

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 - if an error occurs

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 - if an error occurs

characters

public void characters(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

Throws:

XPathException - if an error occurs

processingInstruction

public void processingInstruction(String target,
                         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.

Throws:

XPathException - if an error occurs

comment

public void comment(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.

Throws:

XPathException - if an error occurs

usesTypeAnnotations

public boolean usesTypeAnnotations()

Ask whether this Receiver (or the downstream pipeline) makes any use of the type annotations supplied on element and attribute events

Specified by:

usesTypeAnnotations in interface Receiver

Overrides:

usesTypeAnnotations in class ProxyReceiver

Returns:

true if the Receiver makes any use of this information. If false, the caller may supply untyped nodes instead of supplying the type annotation