Package net.sf.saxon.event

Class StartTagBuffer

java.lang.Object
net.sf.saxon.event.SequenceReceiver
net.sf.saxon.event.ProxyReceiver
net.sf.saxon.event.StartTagBuffer
All Implemented Interfaces:
Result, Receiver, NamespaceResolver
Direct Known Subclasses:
IDFilter
public class StartTagBuffer extends ProxyReceiver implements NamespaceResolver
StartTagBuffer is a ProxyReceiver that buffers attributes and namespace events within a start tag. It maintains details of the namespace context, and a full set of attribute information, on behalf of other filters that need access to namespace information or need to process attributes in arbitrary order.

StartTagBuffer also implements namespace fixup (the process of creating namespace nodes|bindings on behalf of constructed element and attribute nodes). Although this would be done anyway, further down the pipeline, it has to be done early in the case of a validating pipeline, because the namespace bindings must be created before any namespace-sensitive attribute content is validated.

The StartTagBuffer also allows error conditions to be buffered. This is because the XSIAttributeHandler validates attributes such as xsi:type and xsi:nil before attempting to match its parent element against a particle of its containing type. It is possible that the parent element will match a wildcard particle with processContents="skip", in which case an invalid xsi:type or xsi:nil attribute is not an error.

  • Field Details

    • elementNameCode

      protected NodeName elementNameCode

    • elementTypeCode

      protected SchemaType elementTypeCode

    • elementLocationId

      protected Location elementLocationId

    • elementProperties

      protected int elementProperties

    • bufferedAttributes

      protected AttributeCollectionImpl bufferedAttributes

    • namespaces

      protected NamespaceBinding[] namespaces

    • namespacesSize

      protected int namespacesSize

  • Constructor Details

    • StartTagBuffer

      public StartTagBuffer(Receiver next)

  • Method Details

    • setPipelineConfiguration

      public void setPipelineConfiguration(PipelineConfiguration pipe)
      Set the pipeline configuration
      Specified by:
      setPipelineConfiguration in interface Receiver
      Overrides:
      setPipelineConfiguration in class ProxyReceiver
      Parameters:
      pipe - the pipeline configuration

    • startDocument

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

    • endDocument

      public void endDocument() throws XPathException
      Notify the end of a document node
      Specified by:
      endDocument in interface Receiver
      Overrides:
      endDocument in class ProxyReceiver
      Throws:
      XPathException - if an error occurs

    • startElement

      public void startElement(NodeName nameCode, SchemaType typeCode, Location location, int properties) throws XPathException
      startElement
      Specified by:
      startElement in interface Receiver
      Overrides:
      startElement in class ProxyReceiver
      Parameters:
      nameCode - integer code identifying the name of the element within the name pool.
      typeCode - the element's type annotation.
      location - a location associated with the event (typically either a location in the source document or the stylesheet)
      properties - properties of the element node
      Throws:
      XPathException - if an error occurs

    • namespace

      public void namespace(NamespaceBindingSet namespaceBindings, 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:
      namespaceBindings - the prefix/uri pair representing the namespace binding
      properties - any special properties to be passed on this call
      Throws:
      XPathException - if an error occurs

    • attribute

      public void attribute(NodeName attName, SimpleType typeCode, CharSequence value, Location 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.
      Specified by:
      attribute in interface Receiver
      Overrides:
      attribute in class ProxyReceiver
      Parameters:
      attName - 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
      Throws:
      XPathException - if an error occurs

    • setHasChildren

      public void setHasChildren(boolean hasChildren)

    • startContent

      public void startContent() throws XPathException
      startContent: Add any namespace undeclarations needed to stop namespaces being inherited from parent elements
      Specified by:
      startContent in interface Receiver
      Overrides:
      startContent in class ProxyReceiver
      Throws:
      XPathException - if an error occurs

    • declareNamespacesForStartElement

      protected void declareNamespacesForStartElement() throws XPathException
      Throws:
      XPathException

    • getLocalNamespaces

      public NamespaceBinding[] getLocalNamespaces()
      Get the namespaces declared (or undeclared) at the current level
      Returns:
      an array of namespace bindings

    • declareAllNamespaces

      protected void declareAllNamespaces() throws XPathException
      Signal namespace events for all in-scope namespaces to the current receiver in the pipeline
      Throws:
      XPathException - if any downstream error occurs

    • endElement

      public void endElement() throws XPathException
      endElement: Discard the namespaces declared locally on this element.
      Specified by:
      endElement in interface Receiver
      Overrides:
      endElement in class ProxyReceiver
      Throws:
      XPathException - if an error occurs

    • undeclareNamespacesForElement

      protected void undeclareNamespacesForElement()

    • hasAttributes

      public boolean hasAttributes()
      Determine if the current element has any attributes
      Returns:
      true if the element has one or more attributes

    • getAttribute

      public String getAttribute(int nameCode)
      Get the value of the current attribute with a given nameCode
      Parameters:
      nameCode - the name of the required attribute
      Returns:
      the attribute value, or null if the attribute is not present

    • getAttribute

      public String getAttribute(String uri, String local)
      Get the value of the current attribute with a given name
      Parameters:
      uri - the uri of the name of the required attribute
      local - the local part of the name of the required attribute
      Returns:
      the attribute value, or null if the attribute is not present

    • getAllAttributes

      public AttributeCollection getAllAttributes()
      Get all the attributes on the current element start tag
      Returns:
      an AttributeCollection containing all the attributes

    • hasAttributeInNamespace

      public boolean hasAttributeInNamespace(String uri)
      Ask whether the attribute collection contains any attributes in a specified namespace
      Parameters:
      uri - the specified namespace
      Returns:
      true if there are one or more attributes in this namespace

    • getURIForPrefix

      public String getURIForPrefix(String prefix, boolean useDefault)
      Get the namespace URI corresponding to a given prefix. Return null if the prefix is not in scope. f
      Specified by:
      getURIForPrefix in interface NamespaceResolver
      Parameters:
      prefix - the namespace prefix
      useDefault - true if the default namespace is to be used when the prefix is ""
      Returns:
      the uri for the namespace, or null if the prefix is not in scope

    • iteratePrefixes

      public Iterator<String> iteratePrefixes()
      Get an iterator over all the prefixes declared in this namespace context. This will include the default namespace (prefix="") and the XML namespace where appropriate
      Specified by:
      iteratePrefixes in interface NamespaceResolver
      Returns:
      an iterator over all the prefixes for which a namespace binding exists, including the zero-length string to represent the null/absent prefix if it is bound

    • characters

      public void characters(CharSequence chars, Location locationId, int properties) throws XPathException
      Character data
      Specified by:
      characters in interface Receiver
      Overrides:
      characters in class ProxyReceiver
      Parameters:
      chars -
      locationId - the location of the node in the source, or of the instruction that created it
      properties -
      Throws:
      XPathException - if an error occurs

    • processingInstruction

      public void processingInstruction(String target, CharSequence data, Location locationId, int properties) throws XPathException
      Processing Instruction
      Specified by:
      processingInstruction in interface Receiver
      Overrides:
      processingInstruction in class ProxyReceiver
      Parameters:
      target -
      data -
      locationId - the location of the node in the source, or of the instruction that created it
      properties -
      Throws:
      XPathException - if an error occurs

    • comment

      public void comment(CharSequence chars, Location locationId, int properties) throws XPathException
      Output a comment
      Specified by:
      comment in interface Receiver
      Overrides:
      comment in class ProxyReceiver
      Parameters:
      chars -
      locationId - the location of the node in the source, or of the instruction that created it
      properties -
      Throws:
      XPathException - if an error occurs