net.sf.saxon.tree.linked
Class LinkedBuilderMonitor

java.lang.Object
  extended by net.sf.saxon.event.SequenceReceiver
      extended by net.sf.saxon.event.ProxyReceiver
          extended by net.sf.saxon.event.BuilderMonitor
              extended by net.sf.saxon.tree.linked.LinkedBuilderMonitor
All Implemented Interfaces:
Result, Receiver

public class LinkedBuilderMonitor
extends BuilderMonitor

Monitor construction of a TinyTree. This allows a marker to be set during tree construction, in such a way that the node corresponding to the marker can be retrieved at the end of tree construction. This is used in the implementation of the XSLT 3.0 snapshot function.


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
LinkedBuilderMonitor(LinkedTreeBuilder builder)
           
 
Method Summary
 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
 NodeInfo getMarkedNode()
          On completion of tree building, get the node that was marked using markNextNode().
 void markNextNode(int nodeKind)
          Indicate that the next node to be created will be of a given type, and request the monitor to remember the identity of this node.
 void namespace(NamespaceBinding namespaceBinding, int properties)
          Notify a namespace.
 void processingInstruction(String target, CharSequence data, int locationId, int properties)
          Processing Instruction
 void startContent()
          Notify the start of the content, that is, the completion of all attributes and namespaces.
 void startDocument(int properties)
          Start of a document node.
 
Methods inherited from class net.sf.saxon.event.ProxyReceiver
append, close, endDocument, endElement, getNamePool, getUnderlyingReceiver, open, setPipelineConfiguration, setSystemId, setUnderlyingReceiver, setUnparsedEntity, startElement, 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

LinkedBuilderMonitor

public LinkedBuilderMonitor(LinkedTreeBuilder builder)
Method Detail

markNextNode

public void markNextNode(int nodeKind)
Description copied from class: BuilderMonitor
Indicate that the next node to be created will be of a given type, and request the monitor to remember the identity of this node.

Specified by:
markNextNode in class BuilderMonitor
Parameters:
nodeKind - the kind of node that will be created next

startDocument

public void startDocument(int properties)
                   throws XPathException
Description copied from class: ProxyReceiver
Start of a document node.

Specified by:
startDocument in interface Receiver
Overrides:
startDocument in class ProxyReceiver
Parameters:
properties - bit-significant integer indicating properties of the document node. The definitions of the bits are in class ReceiverOptions
Throws:
XPathException - if an error occurs

startContent

public void startContent()
                  throws XPathException
Description copied from class: ProxyReceiver
Notify the start of the content, that is, the completion of all attributes and namespaces. Note that the initial receiver of output from XSLT instructions will not receive this event, it has to detect it itself. Note that this event is reported for every element even if it has no attributes, no namespaces, and no content.

Specified by:
startContent in interface Receiver
Overrides:
startContent in class ProxyReceiver
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

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

getMarkedNode

public NodeInfo getMarkedNode()
Description copied from class: BuilderMonitor
On completion of tree building, get the node that was marked using markNextNode().

Specified by:
getMarkedNode in class BuilderMonitor
Returns:
the marked node, or null if none was marked


Copyright (c) 2004-2011 Saxonica Limited. All rights reserved.