net.sf.saxon.serialize
Class CDATAFilter

java.lang.Object
  extended by net.sf.saxon.event.SequenceReceiver
      extended by net.sf.saxon.event.ProxyReceiver
          extended by net.sf.saxon.serialize.CDATAFilter
All Implemented Interfaces:
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
CDATAFilter(Receiver next)
          Create a CDATA Filter
 
Method Summary
 void characters(CharSequence chars, int locationId, int properties)
          Output character data
 void comment(CharSequence chars, int locationId, int properties)
          Output a comment
 void endElement()
          Output element end tag
 void processingInstruction(String target, CharSequence data, int locationId, int properties)
          Output a processing instruction
 void setOutputProperties(Properties details)
          Set the properties for this CDATA filter
 void startElement(NodeName elemName, SchemaType typeCode, int locationId, int properties)
          Output element start tag
 
Methods inherited from class net.sf.saxon.event.ProxyReceiver
append, attribute, close, endDocument, getNamePool, getUnderlyingReceiver, namespace, open, setPipelineConfiguration, setSystemId, setUnderlyingReceiver, setUnparsedEntity, startContent, startDocument, usesTypeAnnotations
 
Methods inherited from class net.sf.saxon.event.SequenceReceiver
append, getConfiguration, 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(Receiver next)
Create a CDATA Filter

Parameters:
next - the next receiver in the pipeline
Method Detail

setOutputProperties

public void setOutputProperties(Properties details)
                         throws XPathException
Set the properties for this CDATA filter

Parameters:
details - the output properties
Throws:
XPathException - if an error occurs

startElement

public void startElement(NodeName elemName,
                         SchemaType typeCode,
                         int locationId,
                         int properties)
                  throws XPathException
Output element start tag

Specified by:
startElement in interface Receiver
Overrides:
startElement in class ProxyReceiver
Parameters:
elemName - 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 - if an error occurs

endElement

public void endElement()
                throws XPathException
Output element end tag

Specified by:
endElement in interface Receiver
Overrides:
endElement in class ProxyReceiver
Throws:
XPathException - if an error occurs

processingInstruction

public void processingInstruction(String target,
                                  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.
Throws:
XPathException - if an error occurs

characters

public void characters(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
Throws:
XPathException - if an error occurs

comment

public void comment(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.
Throws:
XPathException - if an error occurs


Copyright (c) 2004-2011 Saxonica Limited. All rights reserved.