net.sf.saxon.event

Class ComplexContentOutputter

public final class ComplexContentOutputter extends SequenceReceiver

This class is used for generating complex content, that is, the content of an element or document node. It enforces the rules on the order of events within complex content (attributes and namespaces must come first), and it implements part of the namespace fixup rules, in particular, it ensures that there is a namespace node for the namespace used in the element name and in each attribute name.

The same ComplexContentOutputter may be used for generating an entire XML document; it is not necessary to create a new outputter for each element node.

Author: Michael H. Kay

Constructor Summary
	ComplexContentOutputter()

Method Summary
void	append(Item item, int locationId, int copyNamespaces) Append an arbitrary item (node or atomic value) to the output
void	attribute(int nameCode, int typeCode, CharSequence value, int locationId, int properties) Output an attribute value.
void	characters(CharSequence s, int locationId, int properties) Produce text content output.
void	close() Close the output
void	comment(CharSequence comment, int locationId, int properties) Write a comment
void	endDocument() Notify the end of a document node
void	endElement() Output an element end tag.
NamePool	getNamePool()
String	getSystemId()
void	namespace(int nscode, int properties) Output a namespace declaration.
void	open() Start the output process
void	processingInstruction(String target, CharSequence data, int locationId, int properties) Write a processing instruction
void	setHostLanguage(int language)
void	setPipelineConfiguration(PipelineConfiguration pipelineConfiguration)
void	setReceiver(Receiver receiver) Set the receiver (to handle the next stage in the pipeline) directly
void	setSystemId(String systemId)
void	startContent() Flush out a pending start tag
void	startDocument(int properties) Start of a document node.
void	startElement(int nameCode, int typeCode, int locationId, int properties) Output an element start tag.

Constructor Detail

ComplexContentOutputter

public ComplexContentOutputter()

Method Detail

append

public void append(Item item, int locationId, int copyNamespaces)

Append an arbitrary item (node or atomic value) to the output

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

attribute

public void attribute(int nameCode, int typeCode, CharSequence value, int locationId, int properties)

Output an attribute value.
This is added to a list of pending attributes for the current start tag, overwriting any previous attribute with the same name.
This method should NOT be used to output namespace declarations.

Parameters: nameCode The name of the attribute value The value of the attribute properties Bit fields containing properties of the attribute to be written

Throws: XPathException if there is no start tag to write to (created using writeStartTag), or if character content has been written since the start tag was written.

characters

public void characters(CharSequence s, int locationId, int properties)

Produce text content output.
Special characters are escaped using XML/HTML conventions if the output format requires it.

Parameters: s The String to be output

Throws: XPathException for any failure

close

public void close()

Close the output

comment

public void comment(CharSequence comment, int locationId, int properties)

Write a comment

endDocument

public void endDocument()

Notify the end of a document node

endElement

public void endElement()

Output an element end tag.

getNamePool

public NamePool getNamePool()

getSystemId

public String getSystemId()

namespace

public void namespace(int nscode, int properties)

Output a namespace declaration.
This is added to a list of pending namespaces for the current start tag. If there is already another declaration of the same prefix, this one is ignored, unless the REJECT_DUPLICATES flag is set, in which case this is an error. Note that unlike SAX2 startPrefixMapping(), this call is made AFTER writing the start tag.

Parameters: nscode The namespace code

Throws: XPathException if there is no start tag to write to (created using writeStartTag), or if character content has been written since the start tag was written.

Parameters: nameCode The element name code