Package net.sf.saxon.event
Class TypeCheckingFilter
- java.lang.Object
-
- net.sf.saxon.event.Outputter
-
- net.sf.saxon.event.ProxyOutputter
-
- net.sf.saxon.event.TypeCheckingFilter
-
- All Implemented Interfaces:
javax.xml.transform.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.
-
-
Field Summary
-
Fields inherited from class net.sf.saxon.event.Outputter
pipelineConfiguration, systemId
-
-
Constructor Summary
Constructors Constructor Description TypeCheckingFilter(Outputter next)
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description voidappend(Item item)Output an item (atomic value or node) to the sequencevoidappend(Item item, Location locationId, int copyNamespaces)Output an item (atomic value or node) to the sequencevoidattribute(NodeName attName, SimpleType typeCode, java.lang.CharSequence value, Location location, int properties)Notify an attribute.voidcharacters(java.lang.CharSequence chars, Location locationId, int properties)Character datavoidclose()End of event streamvoidcomment(java.lang.CharSequence chars, Location locationId, int properties)Output a commentvoidendDocument()Notify the end of a document nodevoidendElement()End of elementvoidfinalCheck()voidnamespace(java.lang.String prefix, java.lang.String namespaceUri, int properties)Notify a namespace binding.voidprocessingInstruction(java.lang.String target, java.lang.CharSequence data, Location locationId, int properties)Processing InstructionvoidsetRequiredType(ItemType type, int cardinality, RoleDiagnostic role, Location locator)voidstartDocument(int properties)Start of a document node.voidstartElement(NodeName elemName, SchemaType type, AttributeMap attributes, NamespaceMap namespaces, Location location, int properties)Notify the start of an element, supplying all attributes and namespacesvoidstartElement(NodeName elemName, SchemaType elemType, Location location, int properties)Notify the start of an elementbooleanusesTypeAnnotations()Ask whether this Receiver (or the downstream pipeline) makes any use of the type annotations supplied on element and attribute events-
Methods inherited from class net.sf.saxon.event.ProxyOutputter
getNextOutputter, open, setLocation, setUnparsedEntity, startContent
-
Methods inherited from class net.sf.saxon.event.Outputter
getConfiguration, getPipelineConfiguration, getStringReceiver, getSystemId, namespaces, setPipelineConfiguration, setSystemId
-
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
handlesAppend
-
-
-
-
Constructor Detail
-
TypeCheckingFilter
public TypeCheckingFilter(Outputter next)
-
-
Method Detail
-
setRequiredType
public void setRequiredType(ItemType type, int cardinality, RoleDiagnostic role, Location locator)
-
namespace
public void namespace(java.lang.String prefix, java.lang.String namespaceUri, int properties) throws XPathExceptionNotify a namespace binding.- Overrides:
namespacein classProxyOutputter- Parameters:
prefix- The namespace prefix; zero-length string for the default namespacenamespaceUri- 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, java.lang.CharSequence value, Location location, int properties) throws XPathException
Notify an attribute.- Overrides:
attributein classProxyOutputter- Parameters:
attName- The name of the attributetypeCode- The type annotation of the attributevalue- the string value of the attributelocation- 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(java.lang.CharSequence chars, Location locationId, int properties) throws XPathExceptionCharacter data- Specified by:
charactersin interfaceReceiver- Overrides:
charactersin classProxyOutputter- Parameters:
chars- The characterslocationId- 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(java.lang.CharSequence chars, Location locationId, int properties) throws XPathExceptionOutput a comment- Specified by:
commentin interfaceReceiver- Overrides:
commentin classProxyOutputter- Parameters:
chars- The content of the commentlocationId- 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(java.lang.String target, java.lang.CharSequence data, Location locationId, int properties) throws XPathExceptionProcessing Instruction- Specified by:
processingInstructionin interfaceReceiver- Overrides:
processingInstructionin classProxyOutputter- Parameters:
target- The PI name. This must be a legal name (it will not be checked).data- The data portion of the processing instructionlocationId- 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 XPathExceptionStart of a document node.- Specified by:
startDocumentin interfaceReceiver- Overrides:
startDocumentin classProxyOutputter- Parameters:
properties- bit-significant integer indicating properties of the document node. The definitions of the bits are in classReceiverOption- 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:
startElementin classProxyOutputter- 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 originatedproperties- bit-significant properties of the element node. If there are no relevant properties, zero is supplied. The definitions of the bits are in classReceiverOption- 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:
startElementin interfaceReceiver- Overrides:
startElementin classProxyOutputter- Parameters:
elemName- the name of the element.type- the type annotation of the element.attributes- the attributes of this elementnamespaces- the in-scope namespaces of this element: generally this is all the in-scope namespaces, without relying on inheriting namespaces from parent elementslocation- an object providing information about the module, line, and column where the node originatedproperties- bit-significant properties of the element node. If there are no relevant properties, zero is supplied. The definitions of the bits are in classReceiverOption- Throws:
XPathException- if an error occurs
-
endDocument
public void endDocument() throws XPathExceptionNotify the end of a document node- Specified by:
endDocumentin interfaceReceiver- Overrides:
endDocumentin classProxyOutputter- Throws:
XPathException- if an error occurs
-
endElement
public void endElement() throws XPathExceptionEnd of element- Specified by:
endElementin interfaceReceiver- Overrides:
endElementin classProxyOutputter- Throws:
XPathException- if an error occurs
-
close
public void close() throws XPathExceptionEnd of event stream- Specified by:
closein interfaceReceiver- Overrides:
closein classProxyOutputter- 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:
appendin interfaceReceiver- Overrides:
appendin classProxyOutputter- Parameters:
item- the item to be appendedlocationId- the location of the calling instruction, for diagnosticscopyNamespaces- if the item is an element node, this indicates whether its namespaces need to be copied. Values areReceiverOption.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:
appendin interfaceReceiver- Overrides:
appendin classProxyOutputter- 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:
usesTypeAnnotationsin interfaceReceiver- Overrides:
usesTypeAnnotationsin classProxyOutputter- 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
-
-