| java.lang.Object
 net.sf.saxon.event.SequenceReceiver
net.sf.saxon.event.SequenceWriter
All known Subclasses: net.sf.saxon.event.SequenceOutputter,
| SequenceWriter | | abstract public class SequenceWriter extends SequenceReceiver (Code) | | This outputter is used when writing a sequence of atomic values and nodes, for
example, when xsl:variable is used with content and an "as" attribute. The outputter
builds the sequence; the concrete subclass is responsible for deciding what to do with the
resulting items.
This class is not used to build temporary trees. For that, the ComplexContentOutputter
is used.
author:
Michael H. Kay |
| Method Summary | |
| public void | append(Item item, int locationId, int copyNamespaces)
| | public void | attribute(int nameCode, int typeCode, CharSequence value, int locationId, int properties)
Output an attribute value. | | public void | characters(CharSequence s, int locationId, int properties)
Produce text content output. | | public void | close()
| | public void | comment(CharSequence comment, int locationId, int properties)
Write a comment. | | public void | endDocument()
| | public void | endElement()
Output an element end tag. | | public String | getSystemId()
| | public boolean | hasOpenNodes()
| | public void | namespace(int nscode, int properties)
Output a namespace declaration. | | public void | processingInstruction(String target, CharSequence data, int locationId, int properties)
| | public void | setSystemId(String systemId)
| | public void | startContent()
The startContent() event is notified after all namespaces and attributes of an element
have been notified, and before any child nodes are notified. | | public void | startDocument(int properties)
Start of a document node. | | public void | startElement(int nameCode, int typeCode, int locationId, int properties)
Output an element start tag.
Parameters:
nameCode - The element name code - a code held in the Name Pool
Parameters:
typeCode - Integer code identifying the type of this element. | | abstract public void | write(Item item)
Abstract method to be supplied by subclasses: output one item in the sequence. |
| append | | public void append(Item item, int locationId, int copyNamespaces) throws XPathException(Code) | | Append an item to the sequence, performing any necessary type-checking and conversion
|
| attribute | | public void attribute(int nameCode, int typeCode, CharSequence value, int locationId, int properties) throws XPathException(Code) | | Output an attribute value.
Parameters:
nameCode - An integer code representing the name of the attribute, as held in the Name Pool
Parameters:
typeCode - Integer code identifying the type annotation of the attribute; zero representsthe default type (xs:untypedAtomic)
Parameters:
value - The value of the attribute
Parameters:
properties - Bit significant flags for passing extra information to the serializer, e.g.to disable escaping
throws:
net.sf.saxon.trans.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) throws XPathException(Code) | | Produce text content output.
Parameters:
s - The String to be output
Parameters:
properties - bit-significant flags for extra information, e.g. disable-output-escaping
throws:
net.sf.saxon.trans.XPathException - for any failure |
| getSystemId | | public String getSystemId()(Code) | | Get the system ID
the system ID that was supplied using the setSystemId() method |
| hasOpenNodes | | public boolean hasOpenNodes()(Code) | | Determine whether there are any open document or element nodes in the output
|
| namespace | | public void namespace(int nscode, int properties) throws XPathException(Code) | | 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.
Note that unlike SAX2 startPrefixMapping(), this call is made AFTER writing the start tag.
Parameters:
nscode - The namespace code
Parameters:
properties - Allows special properties to be passed if required
throws:
net.sf.saxon.trans.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. |
| processingInstruction | | public void processingInstruction(String target, CharSequence data, int locationId, int properties) throws XPathException(Code) | | Write a processing instruction
No-op in this implementation
|
| setSystemId | | public void setSystemId(String systemId)(Code) | | Set the system ID
Parameters:
systemId - the URI used to identify the tree being passed across this interface |
| startContent | | public void startContent() throws XPathException(Code) | | The startContent() event is notified after all namespaces and attributes of an element
have been notified, and before any child nodes are notified.
throws:
net.sf.saxon.trans.XPathException - for any failure |
| startDocument | | public void startDocument(int properties) throws XPathException(Code) | | Start of a document node.
|
| startElement | | public void startElement(int nameCode, int typeCode, int locationId, int properties) throws XPathException(Code) | | Output an element start tag.
Parameters:
nameCode - The element name code - a code held in the Name Pool
Parameters:
typeCode - Integer code identifying the type of this element. Zero identifies the defaulttype, that is xs:anyType
Parameters:
properties - bit-significant flags indicating any special information |
| write | | abstract public void write(Item item) throws XPathException(Code) | | Abstract method to be supplied by subclasses: output one item in the sequence.
|
|
|