com.saxonica.stream

Class Projector

java.lang.Object

net.sf.saxon.event.SequenceReceiver

net.sf.saxon.event.ProxyReceiver

com.saxonica.stream.Projector

All Implemented Interfaces:

Result, Receiver

public class Projector
extends ProxyReceiver

This class uses a PathMap to do document projection. It acts as a push filter, passing through only those events that are necessary to evaluate the expression that was used to generate the PathMap.

Field Summary

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
Projector(PathMap.PathMapRoot pathMapRoot, Receiver next) Create a document projector

Method Summary

Methods

Modifier and Type	Method and Description
void	attribute(NodeName nameCode, 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
void	endDocument() Notify the end of a document node
void	endElement() End of element
void	namespace(NamespaceBinding namespaceBinding, int properties) Notify a namespace.
void	outputStatistics(PrintStream out) Output statistics showing the effectiveness of filtering
void	processingInstruction(String target, CharSequence data, int locationId, int properties) Processing Instruction
void	setPipelineConfiguration(PipelineConfiguration pipe) Set the pipeline configuration
void	startElement(NodeName elemName, SchemaType typeCode, int locationId, int properties) Notify the start of an element

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

append, close, getNamePool, getUnderlyingReceiver, open, setSystemId, setUnderlyingReceiver, setUnparsedEntity, startContent, startDocument, usesTypeAnnotations

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

append, getConfiguration, getPipelineConfiguration, getSystemId

Methods inherited from class java.lang.Object

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

Constructor Detail

Projector

public Projector(PathMap.PathMapRoot pathMapRoot,
         Receiver next)

Create a document projector

Parameters:

pathMapRoot - defines the paths within the document that need to be retained

next - the next receiver in the pipeline

Method Detail

setPipelineConfiguration

public void setPipelineConfiguration(PipelineConfiguration pipe)

Description copied from interface: Receiver

Set the pipeline configuration

Specified by:

setPipelineConfiguration in interface Receiver

Overrides:

setPipelineConfiguration in class ProxyReceiver

Parameters:

pipe - the pipeline configuration

startElement

public void startElement(NodeName elemName,
                SchemaType typeCode,
                int locationId,
                int properties)
                  throws XPathException

Description copied from class: ProxyReceiver

Notify the start of an element

Specified by:

startElement in interface Receiver

Overrides:

startElement in class ProxyReceiver

Parameters:

elemName - 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 nameCode,
             SimpleType typeCode,
             CharSequence value,
             int locationId,
             int properties)
               throws XPathException

Description copied from class: ProxyReceiver

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 ProxyReceiver

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

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.

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

Throws:

XPathException - if an error occurs

namespace

public void namespace(NamespaceBinding namespaceBinding,
             int properties)
               throws XPathException

Description copied from class: ProxyReceiver

Notify a namespace. Namespaces are notified after the startElement event, and before any children for the element. The namespaces that are reported are only required to include those that are different from the parent element; however, duplicates may be reported. A namespace must not conflict with any namespaces already used for element or attribute names.

Specified by:

namespace in interface Receiver

Overrides:

namespace in class ProxyReceiver

Parameters:

namespaceBinding - the prefix/uri pair representing the namespace binding

properties - any special properties to be passed on this call

Throws:

XPathException - if an error occurs

characters

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

Description copied from class: ProxyReceiver

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

comment

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

Description copied from class: ProxyReceiver

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

processingInstruction

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

Description copied from class: ProxyReceiver

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

endElement

public void endElement()
                throws XPathException

Description copied from class: ProxyReceiver

End of element

Specified by:

endElement in interface Receiver

Overrides:

endElement in class ProxyReceiver

Throws:

XPathException - if an error occurs

endDocument

public void endDocument()
                 throws XPathException

Description copied from class: ProxyReceiver

Notify the end of a document node

Specified by:

endDocument in interface Receiver

Overrides:

endDocument in class ProxyReceiver

Throws:

XPathException - if an error occurs

outputStatistics

public void outputStatistics(PrintStream out)

Output statistics showing the effectiveness of filtering

Parameters:

out - the output destination