Package net.sf.saxon.event
Class ComplexContentOutputter
- java.lang.Object
-
- net.sf.saxon.event.SequenceReceiver
-
- net.sf.saxon.event.ComplexContentOutputter
-
- All Implemented Interfaces:
javax.xml.transform.Result
,Receiver
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
-
-
Field Summary
-
Fields inherited from class net.sf.saxon.event.SequenceReceiver
pipelineConfiguration, previousAtomic, systemId
-
-
Constructor Summary
Constructors Constructor Description ComplexContentOutputter()
Create a ComplexContentOutputter
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description void
append(Item item, int locationId, int copyNamespaces)
Append an arbitrary item (node or atomic value) to the outputvoid
attribute(int nameCode, int typeCode, java.lang.CharSequence value, int locationId, int properties)
Output an attribute value.void
characters(java.lang.CharSequence s, int locationId, int properties)
Produce text content output.void
close()
Close the outputvoid
comment(java.lang.CharSequence comment, int locationId, int properties)
Write a commentboolean
contentHasBeenWritten()
Test whether any content has been written to this ComplexContentOutputtervoid
endDocument()
Notify the end of a document nodevoid
endElement()
Output an element end tag.void
namespace(int nscode, int properties)
Output a namespace declaration.void
open()
Start the output processvoid
processingInstruction(java.lang.String target, java.lang.CharSequence data, int locationId, int properties)
Write a processing instructionvoid
setHostLanguage(int language)
Set the host languagevoid
setPipelineConfiguration(PipelineConfiguration pipe)
Set the pipeline configurationvoid
setReceiver(Receiver receiver)
Set the receiver (to handle the next stage in the pipeline) directlyvoid
startContent()
Flush out a pending start tagvoid
startDocument(int properties)
Start of a document node.void
startElement(int nameCode, int typeCode, int locationId, int properties)
Output an element start tag.-
Methods inherited from class net.sf.saxon.event.SequenceReceiver
getConfiguration, getNamePool, getPipelineConfiguration, getSystemId, setSystemId, setUnparsedEntity
-
-
-
-
Method Detail
-
setPipelineConfiguration
public void setPipelineConfiguration(PipelineConfiguration pipe)
Description copied from interface:Receiver
Set the pipeline configuration- Specified by:
setPipelineConfiguration
in interfaceReceiver
- Overrides:
setPipelineConfiguration
in classSequenceReceiver
- Parameters:
pipe
- the pipeline configuration
-
setHostLanguage
public void setHostLanguage(int language)
Set the host language- Parameters:
language
- the host language, for exampleConfiguration.XQUERY
-
setReceiver
public void setReceiver(Receiver receiver)
Set the receiver (to handle the next stage in the pipeline) directly- Parameters:
receiver
- the receiver to handle the next stage in the pipeline
-
contentHasBeenWritten
public boolean contentHasBeenWritten()
Test whether any content has been written to this ComplexContentOutputter- Returns:
- true if content has been written
-
open
public void open() throws XPathException
Start the output process- Specified by:
open
in interfaceReceiver
- Overrides:
open
in classSequenceReceiver
- Throws:
XPathException
-
startDocument
public void startDocument(int properties) throws XPathException
Start of a document node.- Parameters:
properties
- bit-significant integer indicating properties of the document node. The definitions of the bits are in classReceiverOptions
- Throws:
XPathException
-
endDocument
public void endDocument() throws XPathException
Notify the end of a document node- Throws:
XPathException
-
characters
public void characters(java.lang.CharSequence s, int locationId, int properties) throws XPathException
Produce text content output.
Special characters are escaped using XML/HTML conventions if the output format requires it.- Parameters:
s
- The String to be outputlocationId
- an integer which can be interpreted using aLocationProvider
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
- for any failure
-
startElement
public void startElement(int nameCode, int typeCode, int locationId, int properties) throws XPathException
Output an element start tag.
The actual output of the tag is deferred until all attributes have been output using attribute().- Parameters:
nameCode
- The element name codetypeCode
- integer code identifying the element's type within the name pool. The value -1 indicates the default type, xs:untyped.locationId
- an integer which can be interpreted using aLocationProvider
to return information such as line number and system ID. If no location information is available, the value zero is supplied.properties
- bit-significant properties of the element node. If there are no revelant properties, zero is supplied. The definitions of the bits are in classReceiverOptions
- Throws:
XPathException
-
namespace
public void namespace(int nscode, int properties) throws XPathException
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 codeproperties
- The most important property is REJECT_DUPLICATES. If this property is set, the namespace declaration will be rejected if it conflicts with a previous declaration of the same prefix. If the property is not set, the namespace declaration will be ignored if it conflicts with a previous declaration. This reflects the fact that when copying a tree, namespaces for child elements are emitted before the namespaces of their parent element. Unfortunately this conflicts with the XSLT rule for complex content construction, where the recovery action in the event of conflicts is to take the namespace that comes last. XSLT therefore doesn't recover from this error: it sets the REJECT_DUPLICATES flag, and this is treated as a hard error.- 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.
-
attribute
public void attribute(int nameCode, int typeCode, java.lang.CharSequence value, int locationId, int properties) throws XPathException
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 attributevalue
- The value of the attributeproperties
- Bit fields containing properties of the attribute to be writtentypeCode
- The type of the attribute, as held in the name pool. The additional bit NodeInfo.IS_DTD_TYPE may be set to indicate a DTD-derived type.locationId
- an integer which can be interpreted using aLocationProvider
to return information such as line number and system ID. If no location information is available, the value zero is supplied.- 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.
-
endElement
public void endElement() throws XPathException
Output an element end tag.- Throws:
XPathException
-
comment
public void comment(java.lang.CharSequence comment, int locationId, int properties) throws XPathException
Write a comment- Parameters:
comment
- The content of the commentlocationId
- an integer which can be interpreted using aLocationProvider
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
-
processingInstruction
public void processingInstruction(java.lang.String target, java.lang.CharSequence data, int locationId, int properties) throws XPathException
Write a processing instruction- Parameters:
target
- The PI name. This must be a legal name (it will not be checked).data
- The data portion of the processing instructionlocationId
- an integer which can be interpreted using aLocationProvider
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
-
append
public void append(Item item, int locationId, int copyNamespaces) throws XPathException
Append an arbitrary item (node or atomic value) to the output- Specified by:
append
in classSequenceReceiver
- Parameters:
item
- the item to be appendedlocationId
- the location of the calling instruction, for diagnosticscopyNamespaces
- if the item is an element node, this indicates whether its namespaces need to be copied. Values areNodeInfo.ALL_NAMESPACES
,NodeInfo.LOCAL_NAMESPACES
,NodeInfo.NO_NAMESPACES
- Throws:
XPathException
-
close
public void close() throws XPathException
Close the output- Throws:
XPathException
-
startContent
public void startContent() throws XPathException
Flush out a pending start tag- Throws:
XPathException
-
-