public abstract class SequenceWriter extends SequenceReceiver
This class is not used to build temporary trees. For that, the ComplexContentOutputter is used.
pipelineConfiguration, previousAtomic
PI_DISABLE_OUTPUT_ESCAPING, PI_ENABLE_OUTPUT_ESCAPING
Constructor and Description |
---|
SequenceWriter() |
Modifier and Type | Method and Description |
---|---|
void |
append(Item item,
int locationId,
int copyNamespaces)
Append an item to the sequence, performing any necessary type-checking and conversion
|
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.
|
String |
getSystemId()
Get the system ID
|
boolean |
hasOpenNodes()
Determine whether there are any open document or element nodes in the output
|
void |
namespace(int nscode,
int properties)
Output a namespace declaration.
|
void |
processingInstruction(String target,
CharSequence data,
int locationId,
int properties)
Write a processing instruction
No-op in this implementation
|
void |
setSystemId(String systemId)
Set the system ID
|
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.
|
void |
startDocument(int properties)
Start of a document node.
|
void |
startElement(int nameCode,
int typeCode,
int locationId,
int properties)
Output an element start tag.
|
abstract void |
write(Item item)
Abstract method to be supplied by subclasses: output one item in the sequence.
|
getConfiguration, getNamePool, getPipelineConfiguration, open, setPipelineConfiguration, setUnparsedEntity
public abstract void write(Item item) throws XPathException
XPathException
public void setSystemId(String systemId)
setSystemId
in interface Result
setSystemId
in interface Receiver
setSystemId
in class SequenceReceiver
systemId
- the URI used to identify the tree being passed across this interfacepublic String getSystemId()
getSystemId
in interface Result
getSystemId
in class SequenceReceiver
public boolean hasOpenNodes()
public void startDocument(int properties) throws XPathException
XPathException
public void endDocument() throws XPathException
XPathException
public void startElement(int nameCode, int typeCode, int locationId, int properties) throws XPathException
nameCode
- The element name code - a code held in the Name PooltypeCode
- Integer code identifying the type of this element. Zero identifies the default
type, that is xs:anyTypeproperties
- bit-significant flags indicating any special informationlocationId
- an integer which can be interpreted using a LocationMap to return
information such as line number and system ID. If no location information is available,
the value zero is supplied.XPathException
public void endElement() throws XPathException
XPathException
public void namespace(int nscode, int properties) throws XPathException
nscode
- The namespace codeproperties
- Allows special properties to be passed if requiredXPathException
- 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.public void attribute(int nameCode, int typeCode, CharSequence value, int locationId, int properties) throws XPathException
nameCode
- An integer code representing the name of the attribute, as held in the Name PooltypeCode
- Integer code identifying the type annotation of the attribute; zero represents
the default type (xs:untypedAtomic)value
- The value of the attributeproperties
- Bit significant flags for passing extra information to the serializer, e.g.
to disable escapinglocationId
- an integer which can be interpreted using a LocationMap to return
information such as line number and system ID. If no location information is available,
the value zero is supplied.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.public void startContent() throws XPathException
XPathException
- for any failurepublic void characters(CharSequence s, int locationId, int properties) throws XPathException
s
- The String to be outputproperties
- bit-significant flags for extra information, e.g. disable-output-escapinglocationId
- an integer which can be interpreted using a LocationMap to return
information such as line number and system ID. If no location information is available,
the value zero is supplied.XPathException
- for any failurepublic void comment(CharSequence comment, int locationId, int properties) throws XPathException
comment
- The content of the commentlocationId
- an integer which can be interpreted using a LocationMap 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:
XPathException
public void processingInstruction(String target, CharSequence data, int locationId, int properties) throws XPathException
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 a LocationMap 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:
XPathException
public void close() throws XPathException
XPathException
public void append(Item item, int locationId, int copyNamespaces) throws XPathException
append
in class SequenceReceiver
XPathException