|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectnet.sf.saxon.event.SequenceReceiver
net.sf.saxon.event.SequenceOutputter
This outputter is used when writing a sequence of atomic values and nodes, that is, when xsl:variable is used with content and an "as" attribute. The outputter builds the sequence and provides access to it. (It isn't really an outputter at all, it doesn't pass the events to anyone, it merely constructs the sequence in memory and provides access to it). Note that the event sequence can include calls such as startElement and endElement that require trees to be built. If nodes such as attributes and text nodes are received while an element is being constructed, the nodes are added to the tree. Otherwise, "orphan" nodes (nodes with no parent) are created and added directly to the sequence.
This class is not used to build temporary trees. For that, the ComplexContentOutputter is used.
Field Summary |
Fields inherited from class net.sf.saxon.event.SequenceReceiver |
pipelineConfiguration, previousAtomic |
Fields inherited from interface javax.xml.transform.Result |
PI_DISABLE_OUTPUT_ESCAPING, PI_ENABLE_OUTPUT_ESCAPING |
Constructor Summary | |
SequenceOutputter()
Create a new SequenceOutputter |
|
SequenceOutputter(int estimatedSize)
|
Method Summary | |
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,
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 output |
void |
comment(java.lang.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. |
Item |
getFirstItem()
Get the first item in the sequence that has been built |
java.util.ArrayList |
getList()
Get the list containing the sequence of items |
ValueRepresentation |
getSequence()
Get the sequence that has been built |
java.lang.String |
getSystemId()
Get the system ID |
boolean |
hasOpenNodes()
Determine whether there are any open document or element nodes in the output |
SequenceIterator |
iterate()
Get an iterator over the sequence of items that has been constructed |
void |
namespace(int nscode,
int properties)
Output a namespace declaration. |
Item |
popLastItem()
Get the last item in the sequence that has been built, and remove it |
void |
processingInstruction(java.lang.String target,
java.lang.CharSequence data,
int locationId,
int properties)
Write a processing instruction No-op in this implementation |
void |
setSystemId(java.lang.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. |
Methods inherited from class net.sf.saxon.event.SequenceReceiver |
getConfiguration, getNamePool, getPipelineConfiguration, open, setPipelineConfiguration, setUnparsedEntity |
Methods inherited from class java.lang.Object |
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Constructor Detail |
public SequenceOutputter()
public SequenceOutputter(int estimatedSize)
Method Detail |
public void setSystemId(java.lang.String systemId)
setSystemId
in interface Receiver
setSystemId
in class SequenceReceiver
systemId
- the URI used to identify the tree being passed across this interfacepublic java.lang.String getSystemId()
getSystemId
in interface javax.xml.transform.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 required
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 attribute(int nameCode, int typeCode, java.lang.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(java.lang.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(java.lang.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(java.lang.String target, java.lang.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()
public void append(Item item, int locationId, int copyNamespaces) throws XPathException
append
in class SequenceReceiver
XPathException
public ValueRepresentation getSequence()
public SequenceIterator iterate()
public java.util.ArrayList getList()
public Item getFirstItem()
public Item popLastItem()
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |