public class TypeCheckingFilter extends ProxyOutputter
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.
pipelineConfiguration, systemId
Constructor and Description |
---|
TypeCheckingFilter(Outputter next) |
Modifier and Type | Method and Description |
---|---|
void |
append(Item item)
Output an item (atomic value or node) to the sequence
|
void |
append(Item item,
Location locationId,
int copyNamespaces)
Output an item (atomic value or node) to the sequence
|
void |
attribute(NodeName attName,
SimpleType typeCode,
java.lang.String value,
Location location,
int properties)
Notify an attribute.
|
void |
characters(UnicodeString chars,
Location locationId,
int properties)
Character data
|
void |
close()
End of event stream
|
void |
comment(UnicodeString chars,
Location locationId,
int properties)
Output a comment
|
void |
endDocument()
Notify the end of a document node
|
void |
endElement()
End of element
|
void |
finalCheck() |
void |
namespace(java.lang.String prefix,
java.lang.String namespaceUri,
int properties)
Notify a namespace binding.
|
void |
processingInstruction(java.lang.String target,
UnicodeString data,
Location locationId,
int properties)
Processing Instruction
|
void |
setRequiredType(ItemType type,
int cardinality,
RoleDiagnostic role,
Location locator) |
void |
startDocument(int properties)
Start of a document node.
|
void |
startElement(NodeName elemName,
SchemaType type,
AttributeMap attributes,
NamespaceMap namespaces,
Location location,
int properties)
Notify the start of an element, supplying all attributes and namespaces
|
void |
startElement(NodeName elemName,
SchemaType elemType,
Location location,
int properties)
Notify the start of an element
|
boolean |
usesTypeAnnotations()
Ask whether this Receiver (or the downstream pipeline) makes any use of the type annotations
supplied on element and attribute events
|
getNextOutputter, open, setUnparsedEntity, startContent
getConfiguration, getPipelineConfiguration, getStringReceiver, getSystemId, namespaces, setPipelineConfiguration, setSystemId
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
handlesAppend
public TypeCheckingFilter(Outputter next)
public void setRequiredType(ItemType type, int cardinality, RoleDiagnostic role, Location locator)
public void namespace(java.lang.String prefix, java.lang.String namespaceUri, int properties) throws XPathException
namespace
in class ProxyOutputter
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:XPathException
- if an error occurspublic void attribute(NodeName attName, SimpleType typeCode, java.lang.String value, Location location, int properties) throws XPathException
attribute
in class ProxyOutputter
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:
XPathException
- if an error occurspublic void characters(UnicodeString chars, Location locationId, int properties) throws XPathException
characters
in interface Receiver
characters
in class ProxyOutputter
chars
- The characterslocationId
- provides information such as line number and system ID.properties
- Bit significant value. The following bits are defined:
XPathException
- if an error occurspublic void comment(UnicodeString chars, Location locationId, int properties) throws XPathException
comment
in interface Receiver
comment
in class ProxyOutputter
chars
- The content of the commentlocationId
- provides information such as line number and system ID.properties
- Additional information about the comment.XPathException
- if an error occurspublic void processingInstruction(java.lang.String target, UnicodeString data, Location locationId, int properties) throws XPathException
processingInstruction
in interface Receiver
processingInstruction
in class ProxyOutputter
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.XPathException
- if an error occurspublic void startDocument(int properties) throws XPathException
startDocument
in interface Receiver
startDocument
in class ProxyOutputter
properties
- bit-significant integer indicating properties of the document node.
The definitions of the bits are in class ReceiverOption
XPathException
- if an error occurspublic void startElement(NodeName elemName, SchemaType elemType, Location location, int properties) throws XPathException
startElement
in class ProxyOutputter
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 class ReceiverOption
XPathException
- if an error occurspublic void startElement(NodeName elemName, SchemaType type, AttributeMap attributes, NamespaceMap namespaces, Location location, int properties) throws XPathException
startElement
in interface Receiver
startElement
in class ProxyOutputter
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 class ReceiverOption
XPathException
- if an error occurspublic void endDocument() throws XPathException
endDocument
in interface Receiver
endDocument
in class ProxyOutputter
XPathException
- if an error occurspublic void endElement() throws XPathException
endElement
in interface Receiver
endElement
in class ProxyOutputter
XPathException
- if an error occurspublic void close() throws XPathException
close
in interface Receiver
close
in class ProxyOutputter
XPathException
- if an error occurspublic void finalCheck() throws XPathException
XPathException
public void append(Item item, Location locationId, int copyNamespaces) throws XPathException
append
in interface Receiver
append
in class ProxyOutputter
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 are ReceiverOption.ALL_NAMESPACES
; the default (0) meansXPathException
- if an error occurspublic void append(Item item) throws XPathException
append
in interface Receiver
append
in class ProxyOutputter
item
- the item to be appendedXPathException
- if the operation failspublic boolean usesTypeAnnotations()
usesTypeAnnotations
in interface Receiver
usesTypeAnnotations
in class ProxyOutputter
Copyright (c) 2004-2022 Saxonica Limited. All rights reserved.