public class ProxyOutputter extends Outputter
pipelineConfiguration, systemId
Constructor and Description |
---|
ProxyOutputter(Outputter next) |
Modifier and Type | Method and Description |
---|---|
void |
append(Item item)
Append an arbitrary item (node, atomic value, or function) to the output.
|
void |
append(Item item,
Location locationId,
int properties)
Append an arbitrary item (node, atomic value, or function) to the output.
|
void |
attribute(NodeName attName,
SimpleType typeCode,
java.lang.String value,
Location location,
int properties)
Notify an attribute.
|
void |
characters(UnicodeString chars,
Location location,
int properties)
Notify character data.
|
void |
close()
Notify the end of the event stream
|
void |
comment(UnicodeString content,
Location location,
int properties)
Notify a comment.
|
void |
endDocument()
Notify the end of a document node
|
void |
endElement()
Notify the end of an element.
|
Outputter |
getNextOutputter() |
void |
namespace(java.lang.String prefix,
java.lang.String namespaceUri,
int properties)
Notify a namespace binding.
|
void |
open()
Notify the start of the event stream
|
void |
processingInstruction(java.lang.String name,
UnicodeString data,
Location location,
int properties)
Output a processing instruction
|
void |
setUnparsedEntity(java.lang.String name,
java.lang.String systemID,
java.lang.String publicID)
Notify an unparsed entity URI.
|
void |
startContent()
Notify the start of the content, that is, the completion of all attributes and namespaces.
|
void |
startDocument(int properties)
Notify the 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 typeCode,
Location location,
int properties)
Notify the start of an element
|
boolean |
usesTypeAnnotations()
Ask whether this Outputter (or the downstream pipeline) makes any use of the type annotations
supplied on element and attribute events.
|
getConfiguration, getPipelineConfiguration, getStringReceiver, getSystemId, namespaces, setPipelineConfiguration, setSystemId
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
handlesAppend
public ProxyOutputter(Outputter next)
public Outputter getNextOutputter()
public void open() throws XPathException
open
in interface Receiver
open
in class Outputter
XPathException
- if an error occurspublic void startDocument(int properties) throws XPathException
startDocument
in interface Receiver
startDocument
in class Outputter
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 endDocument() throws XPathException
endDocument
in interface Receiver
endDocument
in class Outputter
XPathException
- if an error occurspublic void setUnparsedEntity(java.lang.String name, java.lang.String systemID, java.lang.String publicID) throws XPathException
setUnparsedEntity
in interface Receiver
setUnparsedEntity
in class Outputter
name
- The name of the unparsed entitysystemID
- The system identifier of the unparsed entitypublicID
- The identifier of the unparsed entityXPathException
- if an error occurspublic void startElement(NodeName elemName, SchemaType typeCode, Location location, int properties) throws XPathException
startElement
in class Outputter
elemName
- the name of the element.typeCode
- 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 Outputter
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 namespace(java.lang.String prefix, java.lang.String namespaceUri, int properties) throws XPathException
namespace
in class Outputter
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 Outputter
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:
java.lang.IllegalStateException
- attempt to output an attribute when there is no open element
start tagXPathException
- if an error occurspublic void startContent() throws XPathException
startContent
in class Outputter
XPathException
- if an error occurspublic void endElement() throws XPathException
endElement
in interface Receiver
endElement
in class Outputter
XPathException
- if an error occurspublic void characters(UnicodeString chars, Location location, int properties) throws XPathException
characters
in interface Receiver
characters
in class Outputter
chars
- The characterslocation
- provides information such as line number and system ID.properties
- Bit significant value. The following bits are defined:
XPathException
- if an error occurspublic void processingInstruction(java.lang.String name, UnicodeString data, Location location, int properties) throws XPathException
processingInstruction
in interface Receiver
processingInstruction
in class Outputter
name
- The PI name. This must be a legal name (it will not be checked).data
- The data portion of the processing instructionlocation
- provides information such as line number and system ID.properties
- Additional information about the PI.java.lang.IllegalArgumentException
- the content is invalid for an XML processing instructionXPathException
- if an error occurspublic void comment(UnicodeString content, Location location, int properties) throws XPathException
comment
in interface Receiver
comment
in class Outputter
content
- The content of the commentlocation
- provides information such as line number and system ID.properties
- Additional information about the comment.java.lang.IllegalArgumentException
- the content is invalid for an XML commentXPathException
- if an error occurspublic void append(Item item, Location locationId, int properties) throws XPathException
UnsupportedOperationException
.append
in interface Receiver
append
in class Outputter
item
- the item to be appendedlocationId
- the location of the calling instruction, for diagnosticsproperties
- 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(Item, Location, int)
, whose
default implementation throws UnsupportedOperationException
append
in interface Receiver
append
in class Outputter
item
- the item to be appendedXPathException
- if the operation failspublic void close() throws XPathException
close
in interface Receiver
close
in class Outputter
XPathException
- if an error occurspublic boolean usesTypeAnnotations()
usesTypeAnnotations
in interface Receiver
usesTypeAnnotations
in class Outputter
Copyright (c) 2004-2022 Saxonica Limited. All rights reserved.