Package net.sf.saxon.event

Class Sink

  • All Implemented Interfaces:
    Result, Receiver
    public class Sink
extends SequenceReceiver
    A Sink is an Receiver that discards all information passed to it

    • Method Detail

      • close

        public void close()
        End of event stream

      • startDocument

        public void startDocument​(int properties)
        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

      • endDocument

        public void endDocument()
        Notify the end of a document node

      • startElement

        public void startElement​(NodeName nameCode,
                         SchemaType typeCode,
                         Location location,
                         int properties)
        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.
        location -
        properties - for future use. Should be set to zero.

      • namespace

        public void namespace​(NamespaceBindingSet namespaceBindings,
                      int properties)
        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:
        namespaceBindings - the prefix/uri pair representing the namespace binding to be written
        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:

      • attribute

        public void attribute​(NodeName nameCode,
                      SimpleType typeCode,
                      CharSequence value,
                      Location locationId,
                      int properties)
        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
        typeCode - The type of the attribute
        locationId - the location of the node in the source, or of the instruction that created it
        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

      • startContent

        public void startContent()
        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.

      • endElement

        public void endElement()
        End of element

      • characters

        public void characters​(CharSequence chars,
                       Location locationId,
                       int properties)
        Character data
        Parameters:
        chars - The characters
        locationId - provides information such as line number and system ID.
        properties - Bit significant value. The following bits are defined:
        DISABLE_ESCAPING
        Disable escaping for this text node
        USE_CDATA
        Output as a CDATA section

      • processingInstruction

        public void processingInstruction​(String target,
                                  CharSequence data,
                                  Location locationId,
                                  int properties)
        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 - provides information such as line number and system ID.
        properties - Additional information about the PI.

      • comment

        public void comment​(CharSequence chars,
                    Location locationId,
                    int properties)
        Output a comment
        Parameters:
        chars - The content of the comment
        locationId - provides information such as line number and system ID.
        properties - Additional information about the comment.

      • append

        public void append​(Item item,
                   Location locationId,
                   int copyNamespaces)
        Append an arbitrary item (node or atomic value) to the output
        Specified by:
        append in interface Receiver
        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 ReceiverOptions.ALL_NAMESPACES, ReceiverOptions.LOCAL_NAMESPACES; the default (0) means no namespaces

      • setUnparsedEntity

        public void setUnparsedEntity​(String name,
                              String uri,
                              String publicId)
        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

      • usesTypeAnnotations

        public boolean usesTypeAnnotations()
        Ask whether this Receiver (or the downstream pipeline) makes any use of the type annotations supplied on element and attribute events
        Returns:
        true if the Receiver makes any use of this information. If false, the caller may supply untyped nodes instead of supplying the type annotation