Saxon XQuery and XSLT Processor API

Overview

Package

Class

Tree

Deprecated

Index

Help

Home

PREV CLASS NEXT CLASS

FRAMES NO FRAMES

SUMMARY: NESTED | FIELD | CONSTR | METHOD

DETAIL: FIELD | CONSTR | METHOD

com.saxonica.validate
Class XSIAttributeHandler

java.lang.Object
  |
  +--net.sf.saxon.event.ProxyReceiver
        |
        +--net.sf.saxon.event.NamespaceReducer
              |
              +--com.saxonica.validate.XSIAttributeHandler

All Implemented Interfaces:: NamespaceResolver, Receiver, javax.xml.transform.Result

public class XSIAttributeHandler
extends NamespaceReducer
implements Receiver, NamespaceResolver

This class acts as the first stage in a a validation pipeline. It processes attributes such as xsi:schemaLocation and xsi:type. To achieve this, it buffers all attributes and namespaces, because the xsi:type and schemaLocation need to be processed before the start element event. The class extends NamespaceReducer because NamespaceReducer keeps track of in-scope namespaces, which is needed to resolve xsi:type attributes.

Field Summary

Fields inherited from class net.sf.saxon.event.ProxyReceiver

baseReceiver, config, systemId

Fields inherited from interface javax.xml.transform.Result

PI_DISABLE_OUTPUT_ESCAPING, PI_ENABLE_OUTPUT_ESCAPING

Constructor Summary

XSIAttributeHandler(Configuration config, ValidationStack out)


Method Summary

void attribute(int nameCode, int typeCode, java.lang.CharSequence value, int properties)
          Notify an attribute.

void characters(java.lang.CharSequence chars, int properties)
          Character data

void comment(java.lang.CharSequence chars, int properties)
          Output a comment

void endElement()
          End of element

int getFingerprint(java.lang.String qname, boolean useDefault, NamePool pool)
          Use this NamespaceContext to resolve a lexical QName

java.lang.String getURIForPrefix(java.lang.String prefix, boolean useDefault)
          Get the namespace URI corresponding to a given prefix.

void namespace(int namespaceCode, int properties)
          Notify a namespace.

void processingInstruction(java.lang.String target, java.lang.CharSequence data, int properties)
          Processing Instruction

void startContent()
          Notify the start of the content, that is, the completion of all attributes and namespaces.

void startElement(int nameCode, int typeCode, int properties)
          Notify the start of an element

Methods inherited from class net.sf.saxon.event.NamespaceReducer

getURICode, setConfiguration

Methods inherited from class net.sf.saxon.event.ProxyReceiver

endDocument, getConfiguration, getNamePool, getSystemId, getUnderlyingReceiver, setDocumentLocator, setSystemId, setUnderlyingReceiver, setUnparsedEntity, startDocument

Methods inherited from class java.lang.Object

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

Methods inherited from interface net.sf.saxon.event.Receiver

endDocument, getConfiguration, setConfiguration, setDocumentLocator, setSystemId, setUnparsedEntity, startDocument

Methods inherited from interface javax.xml.transform.Result

getSystemId

Constructor Detail

XSIAttributeHandler

public XSIAttributeHandler(Configuration config,
                           ValidationStack out)

Method Detail

startElement

public void startElement(int nameCode,
                         int typeCode,
                         int properties)
                  throws javax.xml.transform.TransformerException

Notify the start of an element

Specified by:: startElement in interface Receiver
Overrides:: startElement in class NamespaceReducer

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.; javax.xml.transform.TransformerException

namespace

public void namespace(int namespaceCode,
                      int properties)
               throws javax.xml.transform.TransformerException

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 NamespaceReducer

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.; javax.xml.transform.TransformerException

attribute

public void attribute(int nameCode,
                      int typeCode,
                      java.lang.CharSequence value,
                      int properties)
               throws javax.xml.transform.TransformerException

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 NamespaceReducer

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
Throws:: java.lang.IllegalStateException: - attempt to output an attribute when there is no open element start tag; javax.xml.transform.TransformerException

startContent

public void startContent()
                  throws javax.xml.transform.TransformerException

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.

Specified by:: startContent in interface Receiver
Overrides:: startContent in class NamespaceReducer

javax.xml.transform.TransformerException

getURIForPrefix

public java.lang.String getURIForPrefix(java.lang.String prefix,
                                        boolean useDefault)

Get the namespace URI corresponding to a given prefix. Return null if the prefix is not in scope.

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

getFingerprint

public int getFingerprint(java.lang.String qname,
                          boolean useDefault,
                          NamePool pool)
                   throws XPathException

Description copied from interface: NamespaceResolver

Use this NamespaceContext to resolve a lexical QName

Specified by:: getFingerprint in interface NamespaceResolver

Parameters:: qname - the lexical QName; this must have already been lexically validated; useDefault - true if the default namespace is to be used to resolve an unprefixed QName; pool - the NamePool to be used
Returns:: the integer fingerprint that uniquely identifies this name; XPathException

endElement

public void endElement()
                throws javax.xml.transform.TransformerException

End of element

Specified by:: endElement in interface Receiver
Overrides:: endElement in class NamespaceReducer