Package net.sf.saxon.s9api

Class MessageListener2Proxy

java.lang.Object

net.sf.saxon.event.SequenceReceiver

net.sf.saxon.event.SequenceWriter

net.sf.saxon.s9api.MessageListener2Proxy

All Implemented Interfaces:

Result, Receiver

class MessageListener2Proxy
extends SequenceWriter

This class implements a Receiver that can receive xsl:message output and send it to a user-supplied MessageListener.

Field Summary

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

pipelineConfiguration, previousAtomic, systemId

Fields inherited from interface javax.xml.transform.Result

PI_DISABLE_OUTPUT_ESCAPING, PI_ENABLE_OUTPUT_ESCAPING

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	MessageListener2Proxy(MessageListener2 listener, PipelineConfiguration pipe)

Method Summary

Modifier and Type	Method	Description
void	append(Item item, Location locationId, int copyNamespaces)	Append an item to the sequence, performing any necessary type-checking and conversion
void	characters(CharSequence s, Location locationId, int properties)	Produce text content output.
MessageListener2	getMessageListener()	Get the wrapped MessageListener
void	processingInstruction(String target, CharSequence data, Location locationId, int properties)	Output a processing instruction
void	startDocument(int properties)	Start of a document node.
void	startElement(NodeName nameCode, SchemaType typeCode, Location location, int properties)	Output an element start tag.
void	write(Item item)	Abstract method to be supplied by subclasses: output one item in the sequence.

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

attribute, bulkCopyElementNode, close, comment, endDocument, endElement, getTreeModel, graftElementNode, isReadyForBulkCopy, isReadyForGrafting, namespace, setTreeModel, setUnparsedEntity, startContent, usesTypeAnnotations

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

append, decompose, flatten, getConfiguration, getErrorCodeForDecomposingFunctionItems, getNamePool, getPipelineConfiguration, getSystemId, handlesAppend, open, setPipelineConfiguration, setSystemId

Methods inherited from class java.lang.Object

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

Constructor Details

MessageListener2Proxy

protected MessageListener2Proxy(MessageListener2 listener,
 PipelineConfiguration pipe)

Method Details

getMessageListener

public MessageListener2 getMessageListener()

Get the wrapped MessageListener

Returns:

the wrapped MessageListener

startDocument

public void startDocument(int properties)
                   throws XPathException

Start of a document node.

Specified by:

startDocument in interface Receiver

Overrides:

startDocument in class SequenceWriter

Parameters:

properties - bit-significant integer indicating properties of the document node. The definitions of the bits are in class ReceiverOptions

Throws:

XPathException - if an error occurs

startElement

public void startElement(NodeName nameCode,
 SchemaType typeCode,
 Location location,
 int properties)
                  throws XPathException

Output an element start tag.

Specified by:

startElement in interface Receiver

Overrides:

startElement in class SequenceWriter

Parameters:

nameCode - The element name code - a code held in the Name Pool

typeCode - Integer code identifying the type of this element. Zero identifies the default type, that is xs:anyType

location -

properties - bit-significant flags indicating any special information

Throws:

XPathException - if an error occurs

characters

public void characters(CharSequence s,
 Location locationId,
 int properties)
                throws XPathException

Produce text content output.

Specified by:

characters in interface Receiver

Overrides:

characters in class SequenceWriter

Parameters:

s - The String to be output

locationId - the location of the node in the source, or of the instruction that created it

properties - bit-significant flags for extra information, e.g. disable-output-escaping @throws net.sf.saxon.trans.XPathException for any failure

Throws:

XPathException - if an error occurs

processingInstruction

public void processingInstruction(String target,
 CharSequence data,
 Location locationId,
 int properties)
                           throws XPathException

Description copied from interface: Receiver

Output a processing instruction

Specified by:

processingInstruction in interface Receiver

Overrides:

processingInstruction in class SequenceWriter

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

append

public void append(Item item,
 Location locationId,
 int copyNamespaces)
            throws XPathException

Append an item to the sequence, performing any necessary type-checking and conversion

Specified by:

append in interface Receiver

Overrides:

append in class SequenceWriter

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 ReceiverOptions.ALL_NAMESPACES, ReceiverOptions.LOCAL_NAMESPACES; the default (0) means no namespaces

Throws:

XPathException

write

public void write(Item item)
           throws XPathException

Abstract method to be supplied by subclasses: output one item in the sequence.

Specified by:

write in class SequenceWriter

Parameters:

item - the item to be written to the sequence

Throws:

XPathException - if any failure occurs while writing the item