org.apache.xml.serializer
Interface SerializationHandler

All Superinterfaces:

ContentHandler, DeclHandler, DOMSerializer, DTDHandler, ErrorHandler, org.apache.xml.serializer.ExtendedContentHandler, org.apache.xml.serializer.ExtendedLexicalHandler, LexicalHandler, Serializer, org.apache.xml.serializer.XSLOutputAttributes

All Known Implementing Classes:

EmptySerializer, SerializerBase

public interface SerializationHandler

extends org.apache.xml.serializer.ExtendedContentHandler, org.apache.xml.serializer.ExtendedLexicalHandler, org.apache.xml.serializer.XSLOutputAttributes, DeclHandler, DTDHandler, ErrorHandler, DOMSerializer, Serializer

This interface is the one that a serializer implements. It is a group of other interfaces, such as ExtendedContentHandler, ExtendedLexicalHandler etc. In addition there are other methods, such as reset(). This class is public only because it is used in another package, it is not a public API.

Usage:

**For internal use only**

Field Summary

static int	HTML_ATTREMPTY
static int	HTML_ATTRURL
static int	NO_BAD_CHARS

Method Summary

void	addAttribute(String qName, String value) Add an attribute to the current element.
void	addAttribute(String uri, String localName, String rawName, String type, String value) Add at attribute to the current element, not from an xsl:attribute element.
void	addAttribute(String uri, String localName, String rawName, String type, String value, boolean XSLAttribute) Add at attribute to the current element
void	addAttributes(Attributes atts) Add attributes to the current element
void	addUniqueAttribute(String qName, String value, int flags) Add a unique attribute to the current element.
void	addXSLAttribute(String qName, String value, String uri) Add an attribute from an xsl:attribute element.
void	characters(Node node) This method is used to notify of a character event, but passing the data as a DOM Node rather than the standard character array.
void	characters(String chars) This method is used to notify of a character event, but passing the data as a character String rather than the standard character array.
void	close()
void	comment(String comment) This method is used to notify of a comment
void	endElement(String elemName) This method is used to notify that an element has ended.
void	entityReference(String entityName) Notify of an entity reference.
void	flushPending() Flush any pending events currently queued up in the serializer.
String	getDoctypePublic() Returns the previously set value of the value to be used as the public identifier in the document type declaration (DTD).
String	getDoctypeSystem() Returns the previously set value of the value to be used as the system identifier in the document type declaration (DTD).
String	getEncoding()
boolean	getIndent()
int	getIndentAmount()
String	getMediaType()
NamespaceMappings	getNamespaceMappings() This method returns an object that has the current namespace mappings in effect.
String	getNamespaceURI(String name, boolean isElement) This method gets the prefix associated with a current element or attribute name.
String	getNamespaceURIFromPrefix(String prefix) This method returns the namespace URI currently associated with the prefix.
boolean	getOmitXMLDeclaration()
String	getPrefix(String uri) This method returns the prefix that currently maps to the given namespace URI.
String	getStandalone()
Transformer	getTransformer() Get the transformer associated with the serializer.
String	getVersion()
void	namespaceAfterStartElement(String uri, String prefix) This method is used to notify that a prefix mapping is to start, but after an element is started.
void	serialize(Node node) Notify that the serializer should take this DOM node as input to be serialized.
void	setCdataSectionElements(Vector URI_and_localNames) Sets the value coming from the xsl:output cdata-section-elements stylesheet property.
void	setContentHandler(ContentHandler ch) Set the SAX Content handler that the serializer sends its output to.
void	setDoctype(String system, String pub) Set the value coming from the xsl:output doctype-public and doctype-system stylesheet properties
void	setDoctypePublic(String doctype) Set the value coming from the xsl:output doctype-public stylesheet attribute.
void	setDoctypeSystem(String doctype) Set the value coming from the xsl:output doctype-system stylesheet attribute.
void	setDTDEntityExpansion(boolean expand) Default behavior is to expand DTD entities, that is the initall default value is true.
void	setEncoding(String encoding) Sets the character encoding coming from the xsl:output encoding stylesheet attribute.
boolean	setEscaping(boolean escape) Turns special character escaping on/off.
void	setIndent(boolean indent) Sets the value coming from the xsl:output indent stylesheet attribute.
void	setIndentAmount(int spaces) Set the number of spaces to indent for each indentation level.
void	setMediaType(String mediatype) Sets the value coming from the xsl:output media-type stylesheet attribute.
void	setNamespaceMappings(NamespaceMappings mappings) Used only by TransformerSnapshotImpl to restore the serialization to a previous state.
void	setOmitXMLDeclaration(boolean b) Sets the value coming from the xsl:output omit-xml-declaration stylesheet attribute
void	setSourceLocator(SourceLocator locator) This method is used to set the source locator, which might be used to generated an error message.
void	setStandalone(String standalone) Sets the value coming from the xsl:output standalone stylesheet attribute.
void	setTransformer(Transformer transformer) Set the transformer associated with the serializer.
void	setVersion(String version) Sets the value coming from the xsl:output version attribute.
void	startElement(String qName) This method is used to notify of the start of an element
void	startElement(String uri, String localName, String qName) This method is used to notify that an element is starting.
boolean	startPrefixMapping(String prefix, String uri, boolean shouldFlush) This method is used to notify that a prefix maping is to start, which can be for the current element, or for the one to come.

Methods inherited from interface org.xml.sax.ContentHandler

characters, endDocument, endElement, endPrefixMapping, ignorableWhitespace, processingInstruction, setDocumentLocator, skippedEntity, startDocument, startElement, startPrefixMapping

Methods inherited from interface org.xml.sax.ext.LexicalHandler

comment, endCDATA, endDTD, endEntity, startCDATA, startDTD, startEntity

Methods inherited from interface org.xml.sax.ext.DeclHandler

attributeDecl, elementDecl, externalEntityDecl, internalEntityDecl

Methods inherited from interface org.xml.sax.DTDHandler

notationDecl, unparsedEntityDecl

Methods inherited from interface org.xml.sax.ErrorHandler

error, fatalError, warning

Methods inherited from interface org.apache.xml.serializer.Serializer

asContentHandler, asDOMSerializer, getOutputFormat, getOutputStream, getWriter, reset, setOutputFormat, setOutputStream, setWriter

Field Detail

NO_BAD_CHARS

public static final int NO_BAD_CHARS

See Also:

Constant Field Values

HTML_ATTREMPTY

public static final int HTML_ATTREMPTY

See Also:

Constant Field Values

HTML_ATTRURL

public static final int HTML_ATTRURL

See Also:

Constant Field Values

Method Detail

setContentHandler

public void setContentHandler(ContentHandler ch)

Set the SAX Content handler that the serializer sends its output to. This method only applies to a ToSAXHandler, not to a ToStream serializer.

See Also:

Serializer.asContentHandler(), ToSAXHandler

close

public void close()

serialize

public void serialize(Node node)
               throws IOException

Notify that the serializer should take this DOM node as input to be serialized.

Specified by:

serialize in interface DOMSerializer

Parameters:

node - the DOM node to be serialized.

Throws:

IOException

setEscaping

public boolean setEscaping(boolean escape)
                    throws SAXException

Turns special character escaping on/off. Note that characters will never, even if this option is set to 'true', be escaped within CDATA sections in output XML documents.

Parameters:

escape - true if escaping is to be set on.

Throws:

SAXException

setIndentAmount

public void setIndentAmount(int spaces)

Set the number of spaces to indent for each indentation level.

Parameters:

spaces - the number of spaces to indent for each indentation level.

setTransformer

public void setTransformer(Transformer transformer)

Set the transformer associated with the serializer.

Parameters:

transformer - the transformer associated with the serializer.

getTransformer

public Transformer getTransformer()

Get the transformer associated with the serializer.

Returns:

Transformer the transformer associated with the serializer.

setNamespaceMappings

public void setNamespaceMappings(NamespaceMappings mappings)

Used only by TransformerSnapshotImpl to restore the serialization to a previous state.

Parameters:

mappings - NamespaceMappings

flushPending

public void flushPending()
                  throws SAXException

Flush any pending events currently queued up in the serializer. This will flush any input that the serializer has which it has not yet sent as output.

Throws:

SAXException

setDTDEntityExpansion

public void setDTDEntityExpansion(boolean expand)

Default behavior is to expand DTD entities, that is the initall default value is true.

Parameters:

expand - true if DTD entities are to be expanded, false if they are to be left as DTD entity references.

addAttribute

public void addAttribute(String uri,
                         String localName,
                         String rawName,
                         String type,
                         String value,
                         boolean XSLAttribute)
                  throws SAXException

Add at attribute to the current element

Parameters:

uri - the namespace URI of the attribute name

localName - the local name of the attribute (without prefix)

rawName - the qualified name of the attribute

type - the attribute type typically character data (CDATA)

value - the value of the attribute

XSLAttribute - true if the added attribute is coming from an xsl:attribute element

Throws:

SAXException

addAttributes

public void addAttributes(Attributes atts)
                   throws SAXException

Add attributes to the current element

Parameters:

atts - the attributes to add.

Throws:

SAXException

addAttribute

public void addAttribute(String qName,
                         String value)

Add an attribute to the current element. The namespace URI of the attribute will be calculated from the prefix of qName. The local name will be derived from qName and the type will be assumed to be "CDATA".

Parameters:

qName -

value -

characters

public void characters(String chars)
                throws SAXException

This method is used to notify of a character event, but passing the data as a character String rather than the standard character array.

Parameters:

chars - the character data

Throws:

SAXException

characters

public void characters(Node node)
                throws SAXException

This method is used to notify of a character event, but passing the data as a DOM Node rather than the standard character array.

Parameters:

node - a DOM Node containing text.

Throws:

SAXException

endElement

public void endElement(String elemName)
                throws SAXException

This method is used to notify that an element has ended. Unlike the standard SAX method

 endElement(namespaceURI,localName,qName)
 

only the last parameter is passed. If needed the serializer can derive the localName from the qualified name and derive the namespaceURI from its implementation.

Parameters:

elemName - the fully qualified element name.

Throws:

SAXException

startElement

public void startElement(String uri,
                         String localName,
                         String qName)
                  throws SAXException

This method is used to notify that an element is starting. This method is just like the standard SAX method

 startElement(uri,localName,qname,atts)
 

but without the attributes.

Parameters:

uri - the namespace URI of the element

localName - the local name (without prefix) of the element

qName - the qualified name of the element

Throws:

SAXException

startElement

public void startElement(String qName)
                  throws SAXException

This method is used to notify of the start of an element

Parameters:

qName - the fully qualified name of the element

Throws:

SAXException

namespaceAfterStartElement

public void namespaceAfterStartElement(String uri,
                                       String prefix)
                                throws SAXException

This method is used to notify that a prefix mapping is to start, but after an element is started. The SAX method call

 startPrefixMapping(prefix,uri)
 

is used just before an element starts and applies to the element to come, not to the current element. This method applies to the current element. For example one could make the calls in this order:

 startElement("prfx8:elem9")
 namespaceAfterStartElement("http://namespace8","prfx8")
 

Parameters:

uri - the namespace URI being declared

prefix - the prefix that maps to the given namespace

Throws:

SAXException

startPrefixMapping

public boolean startPrefixMapping(String prefix,
                                  String uri,
                                  boolean shouldFlush)
                           throws SAXException

This method is used to notify that a prefix maping is to start, which can be for the current element, or for the one to come.

Parameters:

prefix - the prefix that maps to the given URI

uri - the namespace URI of the given prefix

shouldFlush - if true this call is like the SAX startPrefixMapping(prefix,uri) call and the mapping applies to the element to come. If false the mapping applies to the current element.

Returns:

boolean false if the prefix mapping was already in effect (in other words we are just re-declaring), true if this is a new, never before seen mapping for the element.

Throws:

SAXException

entityReference

public void entityReference(String entityName)
                     throws SAXException

Notify of an entity reference.

Parameters:

entityName - the name of the entity

Throws:

SAXException

getNamespaceMappings

public NamespaceMappings getNamespaceMappings()

This method returns an object that has the current namespace mappings in effect.

Returns:

NamespaceMappings an object that has the current namespace mappings in effect.

getPrefix

public String getPrefix(String uri)

This method returns the prefix that currently maps to the given namespace URI.

Parameters:

uri - the namespace URI

Returns:

String the prefix that currently maps to the given URI.

getNamespaceURI

public String getNamespaceURI(String name,
                              boolean isElement)

This method gets the prefix associated with a current element or attribute name.

Parameters:

name - the qualified name of an element, or attribute

isElement - true if it is an element name, false if it is an atttribute name

Returns:

String the namespace URI associated with the element or attribute.

getNamespaceURIFromPrefix

public String getNamespaceURIFromPrefix(String prefix)

This method returns the namespace URI currently associated with the prefix.

Parameters:

prefix - a prefix of an element or attribute.

Returns:

String the namespace URI currently associated with the prefix.

setSourceLocator

public void setSourceLocator(SourceLocator locator)

This method is used to set the source locator, which might be used to generated an error message.

Parameters:

locator - the source locator

addUniqueAttribute

public void addUniqueAttribute(String qName,
                               String value,
                               int flags)
                        throws SAXException

Add a unique attribute to the current element. The attribute is guaranteed to be unique here. The serializer can write it out immediately without saving it in a table first. The integer flag contains information about the attribute, which helps the serializer to decide whether a particular processing is needed.

Parameters:

qName - the fully qualified attribute name.

value - the attribute value

flags - a bitwise flag

Throws:

SAXException

addXSLAttribute

public void addXSLAttribute(String qName,
                            String value,
                            String uri)

Add an attribute from an xsl:attribute element.

Parameters:

qName - the qualified attribute name (prefix:localName)

value - the attributes value

uri - the uri that the prefix of the qName is mapped to.

addAttribute

public void addAttribute(String uri,
                         String localName,
                         String rawName,
                         String type,
                         String value)
                  throws SAXException

Add at attribute to the current element, not from an xsl:attribute element.

Parameters:

uri - the namespace URI of the attribute name

localName - the local name of the attribute (without prefix)

rawName - the qualified name of the attribute

type - the attribute type typically character data (CDATA)

value - the value of the attribute

Throws:

SAXException

comment

public void comment(String comment)
             throws SAXException

This method is used to notify of a comment

Parameters:

comment - the comment, but unlike the SAX comment() method this method takes a String rather than a character array.

Throws:

SAXException

getDoctypePublic

public String getDoctypePublic()

Returns the previously set value of the value to be used as the public identifier in the document type declaration (DTD).

Returns:

the public identifier to be used in the DOCTYPE declaration in the output document.

getDoctypeSystem

public String getDoctypeSystem()

Returns the previously set value of the value to be used as the system identifier in the document type declaration (DTD).

Returns:

the system identifier to be used in the DOCTYPE declaration in the output document.

getEncoding

public String getEncoding()

Returns:

the character encoding to be used in the output document.

getIndent

public boolean getIndent()

Returns:

true if the output document should be indented to visually indicate its structure.

getIndentAmount

public int getIndentAmount()

Returns:

the number of spaces to indent for each indentation level.

getMediaType

public String getMediaType()

Returns:

the mediatype the media-type or MIME type associated with the output document.

getOmitXMLDeclaration

public boolean getOmitXMLDeclaration()

Returns:

true if the XML declaration is to be omitted from the output document.

getStandalone

public String getStandalone()

Returns:

a value of "yes" if the standalone delaration is to be included in the output document.

getVersion

public String getVersion()

Returns:

the version of the output format.

setCdataSectionElements

public void setCdataSectionElements(Vector URI_and_localNames)

Sets the value coming from the xsl:output cdata-section-elements stylesheet property. This sets the elements whose text elements are to be output as CDATA sections.

Parameters:

URI_and_localNames - pairs of namespace URI and local names that identify elements whose text elements are to be output as CDATA sections. The namespace of the local element must be the given URI to match. The qName is not given because the prefix does not matter, only the namespace URI to which that prefix would map matters, so the prefix itself is not relevant in specifying which elements have their text to be output as CDATA sections.

setDoctype

public void setDoctype(String system,
                       String pub)

Set the value coming from the xsl:output doctype-public and doctype-system stylesheet properties

Parameters:

system - the system identifier to be used in the DOCTYPE declaration in the output document.

pub - the public identifier to be used in the DOCTYPE declaration in the output document.

setDoctypePublic

public void setDoctypePublic(String doctype)

Set the value coming from the xsl:output doctype-public stylesheet attribute.

Parameters:

doctype - the public identifier to be used in the DOCTYPE declaration in the output document.

setDoctypeSystem

public void setDoctypeSystem(String doctype)

Set the value coming from the xsl:output doctype-system stylesheet attribute.

Parameters:

doctype - the system identifier to be used in the DOCTYPE declaration in the output document.

setEncoding

public void setEncoding(String encoding)

Sets the character encoding coming from the xsl:output encoding stylesheet attribute.

Parameters:

encoding - the character encoding

setIndent

public void setIndent(boolean indent)

Sets the value coming from the xsl:output indent stylesheet attribute.

Parameters:

indent - true if the output document should be indented to visually indicate its structure.

setMediaType

public void setMediaType(String mediatype)

Sets the value coming from the xsl:output media-type stylesheet attribute.

Parameters:

mediatype - the media-type or MIME type associated with the output document.

setOmitXMLDeclaration

public void setOmitXMLDeclaration(boolean b)

Sets the value coming from the xsl:output omit-xml-declaration stylesheet attribute

Parameters:

b - true if the XML declaration is to be omitted from the output document.

setStandalone

public void setStandalone(String standalone)

Sets the value coming from the xsl:output standalone stylesheet attribute.

Parameters:

standalone - a value of "yes" indicates that the standalone delaration is to be included in the output document.

setVersion

public void setVersion(String version)

Sets the value coming from the xsl:output version attribute.

Parameters:

version - the version of the output format.