Class TypeCheckingFilter

All Implemented Interfaces:
Result, Receiver

public class TypeCheckingFilter extends ProxyOutputter
A filter on the push pipeline that performs type checking, both of the item type and the cardinality.

Note that the TypeCheckingFilter cannot currently check document node tests of the form document-node(element(X,Y)), so it is not invoked in such cases. This isn't a big problem, because most instructions that return document nodes materialize them anyway.

  • Constructor Details

    • TypeCheckingFilter

      public TypeCheckingFilter(Outputter next)
  • Method Details

    • setRequiredType

      public void setRequiredType(ItemType type, int cardinality, RoleDiagnostic roleDiagnostic, Location locator)
    • namespace

      public void namespace(String prefix, NamespaceUri namespaceUri, int properties) throws XPathException
      Notify a namespace binding.
      Overrides:
      namespace in class ProxyOutputter
      Parameters:
      prefix - The namespace prefix; zero-length string for the default namespace
      namespaceUri - The namespace URI. In some cases a zero-length string may be used to indicate a namespace undeclaration.
      properties - The REJECT_DUPLICATES property: if 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:
      Throws:
      XPathException - if an error occurs
    • attribute

      public void attribute(NodeName attName, SimpleType typeCode, String value, Location location, int properties) throws XPathException
      Notify an attribute.
      Overrides:
      attribute in class ProxyOutputter
      Parameters:
      attName - The name of the attribute
      typeCode - The type annotation of the attribute
      value - the string value of the attribute
      location - provides information such as line number and system ID.
      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
      Throws:
      XPathException - if an error occurs
    • characters

      public void characters(UnicodeString chars, Location locationId, int properties) throws XPathException
      Character data
      Specified by:
      characters in interface Receiver
      Overrides:
      characters in class ProxyOutputter
      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
      Throws:
      XPathException - if an error occurs
    • comment

      public void comment(UnicodeString chars, Location locationId, int properties) throws XPathException
      Output a comment
      Specified by:
      comment in interface Receiver
      Overrides:
      comment in class ProxyOutputter
      Parameters:
      chars - The content of the comment
      locationId - provides information such as line number and system ID.
      properties - Additional information about the comment.
      Throws:
      XPathException - if an error occurs
    • processingInstruction

      public void processingInstruction(String target, UnicodeString data, Location locationId, int properties) throws XPathException
      Processing Instruction
      Specified by:
      processingInstruction in interface Receiver
      Overrides:
      processingInstruction in class ProxyOutputter
      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.
      Throws:
      XPathException - if an error occurs
    • startDocument

      public void startDocument(int properties) throws XPathException
      Start of a document node.
      Specified by:
      startDocument in interface Receiver
      Overrides:
      startDocument in class ProxyOutputter
      Parameters:
      properties - bit-significant integer indicating properties of the document node. The definitions of the bits are in class ReceiverOption
      Throws:
      XPathException - if an error occurs
    • startElement

      public void startElement(NodeName elemName, SchemaType elemType, Location location, int properties) throws XPathException
      Notify the start of an element
      Overrides:
      startElement in class ProxyOutputter
      Parameters:
      elemName - the name of the element.
      elemType - the type annotation of the element.
      location - an object providing information about the module, line, and column where the node originated
      properties - bit-significant properties of the element node. If there are no relevant properties, zero is supplied. The definitions of the bits are in class ReceiverOption
      Throws:
      XPathException - if an error occurs
    • startElement

      public void startElement(NodeName elemName, SchemaType type, AttributeMap attributes, NamespaceMap namespaces, Location location, int properties) throws XPathException
      Notify the start of an element, supplying all attributes and namespaces
      Specified by:
      startElement in interface Receiver
      Overrides:
      startElement in class ProxyOutputter
      Parameters:
      elemName - the name of the element.
      type - the type annotation of the element.
      attributes - the attributes of this element
      namespaces - the in-scope namespaces of this element: generally this is all the in-scope namespaces, without relying on inheriting namespaces from parent elements
      location - an object providing information about the module, line, and column where the node originated
      properties - bit-significant properties of the element node. If there are no relevant properties, zero is supplied. The definitions of the bits are in class ReceiverOption
      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 ProxyOutputter
      Throws:
      XPathException - if an error occurs
    • endElement

      public void endElement() throws XPathException
      End of element
      Specified by:
      endElement in interface Receiver
      Overrides:
      endElement in class ProxyOutputter
      Throws:
      XPathException - if an error occurs
    • close

      public void close() throws XPathException
      End of event stream
      Specified by:
      close in interface Receiver
      Overrides:
      close in class ProxyOutputter
      Throws:
      XPathException - if an error occurs
    • finalCheck

      public void finalCheck() throws XPathException
      Throws:
      XPathException
    • append

      public void append(Item item, Location locationId, int copyNamespaces) throws XPathException
      Output an item (atomic value or node) to the sequence
      Specified by:
      append in interface Receiver
      Overrides:
      append in class ProxyOutputter
      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 ReceiverOption.ALL_NAMESPACES; the default (0) means
      Throws:
      XPathException - if an error occurs
    • append

      public void append(Item item) throws XPathException
      Output an item (atomic value or node) to the sequence
      Specified by:
      append in interface Receiver
      Overrides:
      append in class ProxyOutputter
      Parameters:
      item - the item to be appended
      Throws:
      XPathException - if the operation fails
    • 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
      Specified by:
      usesTypeAnnotations in interface Receiver
      Overrides:
      usesTypeAnnotations in class ProxyOutputter
      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