net.sf.saxon.event
Class PathMaintainer

java.lang.Object
  extended by net.sf.saxon.event.SequenceReceiver
      extended by net.sf.saxon.event.ProxyReceiver
          extended by net.sf.saxon.event.PathMaintainer
All Implemented Interfaces:
Result, Receiver

public class PathMaintainer
extends ProxyReceiver

This class sits in a receiver (push) pipeline and maintains the current path.

Author:
Michael H. Kay

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
PathMaintainer(Receiver next)
           
 
Method Summary
 void endElement()
          Handle an end-of-element event
 String getPath(boolean useURIs)
          Get the path to the current location in the stream
 void startElement(NodeName elemName, SchemaType type, int locationId, int properties)
          Notify the start of an element
 
Methods inherited from class net.sf.saxon.event.ProxyReceiver
append, attribute, characters, close, comment, endDocument, getNamePool, getUnderlyingReceiver, namespace, open, processingInstruction, setPipelineConfiguration, 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

PathMaintainer

public PathMaintainer(Receiver next)
Method Detail

startElement

public void startElement(NodeName elemName,
                         SchemaType type,
                         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.
type - 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

endElement

public void endElement()
                throws XPathException
Handle an end-of-element event

Specified by:
endElement in interface Receiver
Overrides:
endElement in class ProxyReceiver
Throws:
XPathException - if an error occurs

getPath

public String getPath(boolean useURIs)
Get the path to the current location in the stream

Parameters:
useURIs - set to true if namespace URIs are to appear in the path; false if prefixes are to be used instead. The prefix will be the one that is used in the source document, and is potentially ambiguous.
Returns:
the path to the current location, as a string.


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