net.sf.saxon.event

## Class ContentHandlerProxyLocator

- java.lang.Object
- - net.sf.saxon.event.ContentHandlerProxyLocator

- All Implemented Interfaces:
    Locator

      public class ContentHandlerProxyLocator
      extends Object
      implements Locator

  Implementation of Locator, used to supply location information to the ContentHandler.

  When the ContentHandler is used to receive the results of a query or stylesheet, the information supplied by the standard methods such as `getSystemId()` and `getLineNumber()` relates to the position of the expression/instruction in the stylesheet or query that caused the relevant nodes to be output.

  If the ContentHandler is used in other contexts, for example as the destination of an IdentityTransformer, the information reflects the position in the source document.

  If the output property `saxon:supply-source-locator` was set to the value "yes" (which in turn requires that tracing was enabled at compile time), the Locator will also contain information about the current location in the source document (specifically, the position of the context node). This will not always be 100% accurate, since there is some buffering of events in the output pipeline: it reflects the context node at the time the event reaches the ContentHandler, which may not be the same as the context node at the time the relevant instruction was executed; however, it still provides some information that may be useful for diagnostics.

- - ### Constructor Summary

    Constructors
    Constructor and Description
    `ContentHandlerProxyLocator(ContentHandlerProxy parent)` Create the Locator for a ContentHandlerProxy

  - ### Method Summary

    Methods
    Modifier and Type | Method and Description
    --- | ---
    `int` | `getColumnNumber()` Get the column number
    `Stack` | `getContextItemStack()` Get the current item stack.
    `int` | `getLineNumber()` Get the line number
    `String` | `getPublicId()` Get the Public ID
    `String` | `getSystemId()` Get the System ID

    - ### Methods inherited from class java.lang.Object

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

- - ### Constructor Detail

    - #### ContentHandlerProxyLocator

          public ContentHandlerProxyLocator(ContentHandlerProxy parent)

      Create the Locator for a ContentHandlerProxy
      Parameters:
        `parent` - the ContentHandlerProxy

  - ### Method Detail

    - #### getPublicId

          public String getPublicId()

      Get the Public ID
      Specified by:
        `getPublicId` in interface `Locator`
      Returns:
        null (always)

    - #### getSystemId

          public String getSystemId()

      Get the System ID
      Specified by:
        `getSystemId` in interface `Locator`
      Returns:
        the system ID giving the location in the query or stylesheet of the most recent event notified

    - #### getLineNumber

          public int getLineNumber()

      Get the line number
      Specified by:
        `getLineNumber` in interface `Locator`
      Returns:
        the line number giving the location of the most recent event notified

    - #### getColumnNumber

          public int getColumnNumber()

      Get the column number
      Specified by:
        `getColumnNumber` in interface `Locator`
      Returns:
        -1 (always)

    - #### getContextItemStack

          public Stack getContextItemStack()

      Get the current item stack. This is a Stack, whose members are objects of class `Item`. The top item in the stack is the context node or atomic value; items further down the stack represent previous context node or atomic value
      Returns:
        the stack of context items

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