Constructor Detail

• Sink

  public Sink()

Method Detail

• open

  public void open()
            throws XPathException

  Start of event stream

  Specified by:

  open in interface Receiver

  Overrides:

  open in class SequenceReceiver

  Throws:

  XPathException

• close

  public void close()
             throws XPathException

  End of event stream

  Throws:

  XPathException

• startDocument

  public void startDocument​(int properties)
                     throws XPathException

  Start of a document node.

  Parameters:

  properties - bit-significant integer indicating properties of the document node. The definitions of the bits are in class ReceiverOptions

  Throws:

  XPathException

• endDocument

  public void endDocument()
                   throws XPathException

  Notify the end of a document node

  Throws:

  XPathException

• startElement

  public void startElement​(int nameCode,
                           int typeCode,
                           int locationId,
                           int properties)
                    throws XPathException

  Notify the start of an element

  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.

  properties - for future use. Should be set to zero.

  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.

  Throws:

  XPathException

• namespace

  public void namespace​(int namespaceCode,
                        int properties)
                 throws XPathException

  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.

  Parameters:

  namespaceCode - an integer: the top half is a prefix code, the bottom half a URI code. These may be translated into an actual prefix and URI using the name pool. A prefix code of zero represents the empty prefix (that is, the default namespace). A URI code of zero represents a URI of "", that is, a namespace undeclaration.

  properties - The most important property is REJECT_DUPLICATES. If this property is set, the namespace declaration will be rejected if it conflicts with a previous declaration of the same prefix. If the property is not set, the namespace declaration will be ignored if it conflicts with a previous declaration. This reflects the fact that when copying a tree, namespaces for child elements are emitted before the namespaces of their parent element. Unfortunately this conflicts with the XSLT rule for complex content construction, where the recovery action in the event of conflicts is to take the namespace that comes last. XSLT therefore doesn't recover from this error: it sets the REJECT_DUPLICATES flag, and this is treated as a hard error.

  Throws:

  XPathException

• attribute

  public void attribute​(int nameCode,
                        int 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.

  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

  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

  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.

  Throws:

  XPathException

• startContent

  public void startContent()
                    throws XPathException

  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.

  Throws:

  XPathException

• endElement

  public void endElement()
                  throws XPathException

  End of element

  Throws:

  XPathException

• characters

  public void characters​(java.lang.CharSequence chars,
                         int locationId,
                         int properties)
                  throws XPathException

  Character data

  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

• processingInstruction

  public void processingInstruction​(java.lang.String target,
                                    java.lang.CharSequence data,
                                    int locationId,
                                    int properties)
                             throws XPathException

  Processing Instruction

  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. The following bits are defined:

  CHECKED

  Data is known to be legal (e.g. doesn't contain "?>")

  Throws:

  XPathException

• comment

  public void comment​(java.lang.CharSequence chars,
                      int locationId,
                      int properties)
               throws XPathException

  Output a comment

  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. The following bits are defined:

  CHECKED

  Comment is known to be legal (e.g. doesn't contain "--")

  Throws:

  XPathException

• append

  public void append​(Item item,
                     int locationId,
                     int copyNamespaces)
              throws XPathException

  Append an arbitrary item (node or atomic value) to the output

  Specified by:

  append in class SequenceReceiver

  Parameters:

  item - the item to be appended

  locationId - the location of the calling instruction, for diagnostics

  copyNamespaces - if the item is an element node, this indicates whether its namespaces need to be copied. Values are NodeInfo.ALL_NAMESPACES, NodeInfo.LOCAL_NAMESPACES, NodeInfo.NO_NAMESPACES

  Throws:

  XPathException

• setUnparsedEntity

  public void setUnparsedEntity​(java.lang.String name,
                                java.lang.String uri,
                                java.lang.String publicId)
                         throws XPathException

  Set the URI for an unparsed entity in the document.

  Specified by:

  setUnparsedEntity in interface Receiver

  Overrides:

  setUnparsedEntity in class SequenceReceiver

  Parameters:

  name - The name of the unparsed entity

  uri - The system identifier of the unparsed entity

  publicId - The public identifier of the unparsed entity

  Throws:

  XPathException