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, namespaces, namespacesSize
-
Fields inherited from class net.sf.saxon.event.ProxyReceiver
nextReceiver
-
Fields inherited from class net.sf.saxon.event.SequenceReceiver
pipelineConfiguration, previousAtomic, systemId
-
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description void
attribute(NodeName attName, SimpleType typeCode, java.lang.CharSequence value, int locationId, int properties)
Notify an attribute.void
characters(java.lang.CharSequence chars, int locationId, int properties)
Character datavoid
comment(java.lang.CharSequence chars, int locationId, int properties)
Output a commentprotected void
declareNamespacesForStartElement()
void
endElement()
endElement:void
processingInstruction(java.lang.String target, java.lang.CharSequence data, int locationId, int properties)
Processing Instructionvoid
startContent()
startContent: Test if a matching ID attribute was found; if so, start outputting.void
startElement(NodeName nameCode, SchemaType typeCode, int locationId, int properties)
startElementboolean
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, getLocalNamespaces, getURIForPrefix, 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
-
-
-
-
Constructor Detail
-
IDFilter
public IDFilter(Receiver next, java.lang.String id)
-
-
Method Detail
-
startElement
public void startElement(NodeName nameCode, SchemaType typeCode, int locationId, int properties) throws XPathException
startElement- Specified by:
startElement
in interfaceReceiver
- Overrides:
startElement
in classStartTagBuffer
- 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 aLocationProvider
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, 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 interfaceReceiver
- Overrides:
attribute
in classStartTagBuffer
- Parameters:
attName
- The name of the attribute, as held in the name pooltypeCode
- The type of the attribute, as held in the name poolproperties
- 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 attributelocationId
- an integer which can be interpreted using aLocationProvider
to return information such as line number and system ID. If no location information is available, the value zero is supplied.- Throws:
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 interfaceReceiver
- Overrides:
startContent
in classStartTagBuffer
- Throws:
XPathException
- if an error occurs
-
declareNamespacesForStartElement
protected void declareNamespacesForStartElement() throws XPathException
- Overrides:
declareNamespacesForStartElement
in classStartTagBuffer
- Throws:
XPathException
-
endElement
public void endElement() throws XPathException
endElement:- Specified by:
endElement
in interfaceReceiver
- Overrides:
endElement
in classStartTagBuffer
- Throws:
XPathException
- if an error occurs
-
characters
public void characters(java.lang.CharSequence chars, int locationId, int properties) throws XPathException
Character data- Specified by:
characters
in interfaceReceiver
- Overrides:
characters
in classProxyReceiver
- Parameters:
chars
- The characterslocationId
- an integer which can be interpreted using aLocationProvider
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(java.lang.String target, java.lang.CharSequence data, int locationId, int properties) throws XPathException
Processing Instruction- Specified by:
processingInstruction
in interfaceReceiver
- Overrides:
processingInstruction
in classProxyReceiver
- Parameters:
target
- The PI name. This must be a legal name (it will not be checked).data
- The data portion of the processing instructionlocationId
- an integer which can be interpreted using aLocationProvider
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(java.lang.CharSequence chars, int locationId, int properties) throws XPathException
Output a comment- Specified by:
comment
in interfaceReceiver
- Overrides:
comment
in classProxyReceiver
- Parameters:
chars
- The content of the commentlocationId
- an integer which can be interpreted using aLocationProvider
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 interfaceReceiver
- Overrides:
usesTypeAnnotations
in classProxyReceiver
- 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
-
-