Package net.sf.saxon.event

Interface Outputter

All Superinterfaces:

Receiver, Result

All Known Implementing Classes:

AbsorptionFeed, AbstractOutputter, ApplyImportsAction, ApplyTemplatesAction, ApplyTemplatesFeed, AtomicItemFeed, BooleanFnFeed, BooleanFnFeed.Negative, BooleanFnFeed.Positive, BufferingApplyTemplatesFeed, BufferingFeed, BufferingFilterExpressionFeed, BufferingForEachExpressionFeed, CallableFeed, CardinalityCheckingFeed, CoercerAdjunct.CoercingItemFeed, ComplexContentOutputter, ComplexNodeEventFeed, ConditionalBlockAdjunct.ConditionalBlockFeed, CopyOfFeed, DecomposingFeed, DelegatingFeed, DocumentInstrAdjunct.DocumentInstrFeed, ElementCreatorFeed, EventMonitor, ExistenceFeed, FeedToEventBuffer, FilteringFeed, ForEachAction, ForEachGroupParallelAction, ForEachGroupPartitionAction, ForExpressionAdjunct.ForExpressionFeed, GeneralComparisonEqualityFeed, GeneralComparisonInequalityFeed, GeneralComparisonMinimaxFeed, GNodeCoercerFeed, GroundedItemFeed, ItemCheckingFeed, ItemFeed, ItemMappingFeed, IterateAction, LiteralAdjunct.LiteralItemFeed, MotionlessFeed, NextIterationFeed, NextMatchAction, NoCloseFeed, NoOpenFeed, NoOpenOrCloseFeed, OutputterEventBuffer, ProxyOutputter, ResultDocumentAdjunct.ResultDocumentFeed, ShallowCopyEventFeed, SignificantItemDetector, SimpleContentFeed, SimpleNodeConstructorFeed, SinkFeed, SinkOutputter, SnapshotFeed, StringValueFeed, TryCatchAdjunct.TryCatchFeed, TypeCheckingFilter, TypedValueFeed, WherePopulatedOutputter

public interface Outputter
extends Receiver

Outputter: This interface represents a recipient of XML tree-walking (push) events. It was originally based on SAX2's ContentHandler, but adapted to handle additional events. Namespaces and Attributes are handled by separate events following the startElement event. Schema types can be defined for elements and attributes.

The Outputter interface is an important internal interface within Saxon, and provides a powerful mechanism for integrating Saxon with other applications. It has been designed with extensibility and stability in mind. However, it should be considered as an interface designed primarily for internal use, and not as a completely stable part of the public Saxon API.

Since:

10.0; derived from the original Outputter interface and SequenceReceiver class. This interface is now used primarily for capturing the results of push-mode evaluation of tree construction expressions in XSLT and XQuery., 12.10; the original Outputter abstract class was renamed to AbstractOutputter and refactored into this (minimal) interface. The refactoring was part of an effort to work around what appears to be a bug in .NET Core. Refactoring the Java code was simpler than trying to adapt the transpiler to make an interface here.

Field Summary

Fields inherited from interface javax.xml.transform.Result

PI_DISABLE_OUTPUT_ESCAPING, PI_ENABLE_OUTPUT_ESCAPING

Method Summary

Modifier and Type	Method	Description
void	attribute(NodeName attName, SimpleType typeCode, String value, Location location, int properties)	Notify an attribute.
UniStringConsumer	getStringReceiver(boolean asTextNode, Location loc)	Get a string-value consumer object that allows an item of type xs:string to be appended one fragment at a time.
void	namespace(String prefix, NamespaceUri namespaceUri, int properties)	Notify a namespace binding.
void	namespaces(NamespaceBindingSet bindings, int properties)	Output a set of namespace bindings.
void	startContent()	Notify the start of the content, that is, the completion of all attributes and namespaces.
void	startElement(NodeName elemName, SchemaType typeCode, Location location, int properties)	Notify the start of an element.

Methods inherited from interface net.sf.saxon.event.Receiver

append, append, characters, close, comment, endDocument, endElement, getPipelineConfiguration, handlesAppend, open, processingInstruction, setPipelineConfiguration, setUnparsedEntity, startDocument, startElement, usesTypeAnnotations

Methods inherited from interface javax.xml.transform.Result

getSystemId, setSystemId

Method Details

startElement

void startElement(NodeName elemName,
 SchemaType typeCode,
 Location location,
 int properties)
           throws XPathException

Notify the start of an element. This version of startElement() must be followed by calls on attribute(NodeName, SimpleType, String, Location, int) and namespace(String, NamespaceUri, int) to supply the attributes and namespaces; these calls may be terminated by a call on startContent() but this is not mandatory.

Parameters:

elemName - the name of the element.

typeCode - the type annotation of the element.

location - an object providing information about the module, line, and column where the node originated

properties - bit-significant properties of the element node. If there are no relevant properties, zero is supplied. The definitions of the bits are in class ReceiverOption

Throws:

XPathException - if an error occurs

namespace

void namespace(String prefix,
 NamespaceUri namespaceUri,
 int properties)
        throws XPathException

Notify a namespace binding. This method is called at some point after startElement(). The semantics are similar to the xsl:namespace instruction in XSLT, or the namespace node constructor in XQuery. A namespace must not conflict with any namespaces already used for element or attribute names.

Parameters:

prefix - The namespace prefix; zero-length string for the default namespace

namespaceUri - The namespace URI. In some cases a zero-length string may be used to indicate a namespace undeclaration.

properties - The REJECT_DUPLICATES property: if 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:

Throws:

XPathException - if an error occurs

Since:

changed in 10.0 to report all the in-scope namespaces for an element, and to do so in a single call.

namespaces

void namespaces(NamespaceBindingSet bindings,
 int properties)
         throws XPathException

Output a set of namespace bindings. This should have the same effect as outputting the namespace bindings individually using namespace(String, NamespaceUri, int), but it may be more efficient. It is used only when copying an element node together with all its namespaces, so less checking is needed that the namespaces form a consistent and complete set

Parameters:

bindings - the set of namespace bindings

properties - any special properties. The property ReceiverOption.NAMESPACE_OK means that no checking is needed.

Throws:

XPathException - if any failure occurs

attribute

void attribute(NodeName attName,
 SimpleType typeCode,
 String value,
 Location location,
 int properties)
        throws XPathException

Notify an attribute. Attributes are notified after the startElement event, and before any children. Namespaces and attributes may be intermingled.

Parameters:

attName - The name of the attribute

typeCode - The type annotation of the attribute

value - the string value of the attribute

location - provides information such as line number and system ID.

properties - Bit significant value. The following bits are defined:

DISABLE_ESCAPING

Disable escaping for this attribute

NO_SPECIAL_CHARACTERS

Attribute value contains no special characters

Throws:

IllegalStateException - attempt to output an attribute when there is no open element start tag

XPathException - if an error occurs

startContent

void startContent()
           throws XPathException

Notify the start of the content, that is, the completion of all attributes and namespaces. Note that the initial Outputter of output from XSLT instructions will not receive this event, it has to detect it itself. Note that this event is reported for every element even if it has no attributes, no namespaces, and no content.

Throws:

XPathException - if an error occurs

getStringReceiver

UniStringConsumer getStringReceiver(boolean asTextNode,
 Location loc)

Get a string-value consumer object that allows an item of type xs:string to be appended one fragment at a time. This potentially allows operations that output large strings to avoid building the entire string in memory. The default implementation, however, simply assembles the string in a buffer and releases the entire string on completion.

Parameters:

asTextNode - set to true if the concatenated string values are to be treated as a text node item rather than a string

Returns:

an object that accepts xs:string values via a sequence of append() calls