Package net.sf.saxon.event

Class CDATAFilter

java.lang.Object

net.sf.saxon.event.SequenceReceiver

net.sf.saxon.event.ProxyReceiver

net.sf.saxon.event.CDATAFilter

All Implemented Interfaces:

javax.xml.transform.Result, Receiver

public class CDATAFilter
extends ProxyReceiver

CDATAFilter: This ProxyEmitter converts character data to CDATA sections, if the character data belongs to one of a set of element types to be handled this way.

Author:

Michael Kay

Field Summary

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

nextReceiver

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

Constructor	Description
CDATAFilter()

Method Summary

Modifier and Type	Method	Description
void	characters(java.lang.CharSequence chars, int locationId, int properties)	Output character data
void	comment(java.lang.CharSequence chars, int locationId, int properties)	Output a comment
void	endElement()	Output element end tag
void	flush(FastStringBuffer buffer)	Flush the buffer containing accumulated character data, generating it as CDATA where appropriate
void	processingInstruction(java.lang.String target, java.lang.CharSequence data, int locationId, int properties)	Output a processing instruction
void	setOutputProperties(java.util.Properties details)	Set the properties for this CDATA filter
void	startElement(int nameCode, int typeCode, int locationId, int properties)	Output element start tag

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

attribute, close, endDocument, getConfiguration, getDocumentLocator, getNamePool, getUnderlyingReceiver, namespace, open, setPipelineConfiguration, setSystemId, setUnderlyingReceiver, setUnparsedEntity, startContent, startDocument

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

append, getPipelineConfiguration, getSystemId

Methods inherited from class java.lang.Object

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

Constructor Detail

CDATAFilter

public CDATAFilter()
            throws XPathException

Throws:

XPathException

Method Detail

setOutputProperties

public void setOutputProperties(java.util.Properties details)
                         throws XPathException

Set the properties for this CDATA filter

Throws:

XPathException

startElement

public void startElement(int nameCode,
                         int typeCode,
                         int locationId,
                         int properties)
                  throws XPathException

Output element start tag

Specified by:

startElement in interface Receiver

Overrides:

startElement in class ProxyReceiver

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.

locationId - an integer which can be interpreted using a LocationProvider to return information such as line number and system ID. If no location information is available, the value zero is supplied.

properties - properties of the element node

Throws:

XPathException

endElement

public void endElement()
                throws XPathException

Output element end tag

Specified by:

endElement in interface Receiver

Overrides:

endElement in class ProxyReceiver

Throws:

XPathException

processingInstruction

public void processingInstruction(java.lang.String target,
                                  java.lang.CharSequence data,
                                  int locationId,
                                  int properties)
                           throws XPathException

Output a processing instruction

Specified by:

processingInstruction in interface Receiver

Overrides:

processingInstruction in class ProxyReceiver

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 - an integer which can be interpreted using a LocationProvider to return information such as line number and system ID. If no location information is available, the value zero is supplied.

properties - Additional information about the PI. The following bits are defined:

CHECKED

Data is known to be legal (e.g. doesn't contain "?>")

Throws:

XPathException

characters

public void characters(java.lang.CharSequence chars,
                       int locationId,
                       int properties)
                throws XPathException

Output character data

Specified by:

characters in interface Receiver

Overrides:

characters in class ProxyReceiver

Parameters:

chars - The characters

locationId - an integer which can be interpreted using a LocationProvider to return information such as line number and system ID. If no location information is available, the value zero is supplied.

properties - Bit significant value. The following bits are defined:

DISABLE_ESCAPING

Disable escaping for this text node

USE_CDATA

Output as a CDATA section

NO_SPECIAL_CHARACTERS

Value contains no special characters

WHITESPACE

Text is all whitespace

Throws:

XPathException

comment

public void comment(java.lang.CharSequence chars,
                    int locationId,
                    int properties)
             throws XPathException

Output a comment

Specified by:

comment in interface Receiver

Overrides:

comment in class ProxyReceiver

Parameters:

chars - The content of the comment

locationId - an integer which can be interpreted using a LocationProvider to return information such as line number and system ID. If no location information is available, the value zero is supplied.

properties - Additional information about the comment. The following bits are defined:

CHECKED

Comment is known to be legal (e.g. doesn't contain "--")

Throws:

XPathException

flush

public void flush(FastStringBuffer buffer)
           throws XPathException

Flush the buffer containing accumulated character data, generating it as CDATA where appropriate

Throws:

XPathException