net.sf.saxon.event.OutputterEvent Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of Saxon-HE Show documentation
Show all versions of Saxon-HE Show documentation
The XSLT and XQuery Processor
////////////////////////////////////////////////////////////////////////////////////////////////////////////////////
// Copyright (c) 2018-2023 Saxonica Limited
// This Source Code Form is subject to the terms of the Mozilla Public License, v. 2.0.
// If a copy of the MPL was not distributed with this file, You can obtain one at http://mozilla.org/MPL/2.0/.
// This Source Code Form is "Incompatible With Secondary Licenses", as defined by the Mozilla Public License, v. 2.0.
////////////////////////////////////////////////////////////////////////////////////////////////////////////////////
package net.sf.saxon.event;
import net.sf.saxon.om.Item;
import net.sf.saxon.om.NamespaceUri;
import net.sf.saxon.om.NodeName;
import net.sf.saxon.s9api.Location;
import net.sf.saxon.str.UnicodeString;
import net.sf.saxon.trans.XPathException;
import net.sf.saxon.type.SchemaType;
import net.sf.saxon.type.SimpleType;
/**
* An outputter event is an object representing one of the events that can be passed to an {@link Outputter} :
* for example, a startElement, attribute, namespace
* endElement, characters, or comment event. Sufficient information is retained in order to enable a stored event to
* be "replayed" later.
*/
public abstract class OutputterEvent {
/**
* Send the event to a receiver
*
* @param out the receiver to which the event is to be sent
* @throws XPathException if the receiver reports an error
*/
public void replay(Outputter out) throws XPathException {
}
/**
* Event representing start of document
*/
public static class StartDocument extends OutputterEvent {
int properties;
public StartDocument(int properties) {
this.properties = properties;
}
@Override
public void replay(Outputter out) throws XPathException {
out.startDocument(properties);
}
}
/**
* Event representing end of document
*/
public static class EndDocument extends OutputterEvent {
public EndDocument() {
}
@Override
public void replay(Outputter out) throws XPathException {
out.endDocument();
}
}
/**
* Event representing the start of an element (including attributes or namespaces)
*/
public static class StartElement extends OutputterEvent {
NodeName name;
SchemaType type;
Location location;
int properties;
public StartElement(NodeName name, SchemaType type, Location location, int properties) {
this.name = name;
this.type = type;
this.location = location;
this.properties = properties;
}
@Override
public void replay(Outputter out) throws XPathException {
out.startElement(name, type, location, properties);
}
}
/**
* Event representing an attribute node
*/
public static class Attribute extends OutputterEvent {
NodeName name;
SimpleType type;
String value;
Location location;
int properties;
public Attribute(NodeName name, SimpleType type, String value, Location location, int properties) {
this.name = name;
this.type = type;
this.value = value;
this.location = location;
this.properties = properties;
}
@Override
public void replay(Outputter out) throws XPathException {
out.attribute(name, type, value, location, properties);
}
}
/**
* Event representing a namespace node
*/
public static class Namespace extends OutputterEvent {
String prefix;
NamespaceUri uri;
int properties;
public Namespace(String prefix, NamespaceUri uri, int properties) {
this.prefix = prefix;
this.uri = uri;
this.properties = properties;
}
@Override
public void replay(Outputter out) throws XPathException {
out.namespace(prefix, uri, properties);
}
}
/**
* Event representing the start of element content
*/
public static class StartContent extends OutputterEvent {
public StartContent() {
}
@Override
public void replay(Outputter out) throws XPathException {
out.startContent();
}
}
/**
* Event representing the end of an element
*/
public static class EndElement extends OutputterEvent {
public EndElement() {
}
@Override
public void replay(Outputter out) throws XPathException {
out.endElement();
}
}
/**
* Event representing a text node
*/
public static class Text extends OutputterEvent {
UnicodeString content;
Location location;
int properties;
public Text(UnicodeString content, Location location, int properties) {
this.content = content;
this.location = location;
this.properties = properties;
}
@Override
public void replay(Outputter out) throws XPathException {
out.characters(content, location, properties);
}
}
/**
* Event representing a comment node
*/
public static class Comment extends OutputterEvent {
UnicodeString content;
Location location;
int properties;
public Comment(UnicodeString content, Location location, int properties) {
this.content = content;
this.location = location;
this.properties = properties;
}
@Override
public void replay(Outputter out) throws XPathException {
out.comment(content, location, properties);
}
}
/**
* Event representing a processing instruction node
*/
public static class ProcessingInstruction extends OutputterEvent {
String target;
UnicodeString content;
Location location;
int properties;
public ProcessingInstruction(String target, UnicodeString content, Location location, int properties) {
this.target = target;
this.content = content;
this.location = location;
this.properties = properties;
}
@Override
public void replay(Outputter out) throws XPathException {
out.processingInstruction(target, content, location, properties);
}
}
/**
* Event representing an arbitrary item being sent to the event stream in composed form. Perhaps
* an atomic value, perhaps an entire element or document in composed form.
*/
public static class Append extends OutputterEvent {
Item item;
Location location;
int properties;
public Append(Item item, Location location, int properties) {
this.item = item;
this.location = location;
this.properties = properties;
}
@Override
public void replay(Outputter out) throws XPathException {
out.append(item, location, properties);
}
}
}