net.sf.saxon.ma.json

Class JsonReceiver

java.lang.Object

net.sf.saxon.ma.json.JsonReceiver

All Implemented Interfaces:

javax.xml.transform.Result, Receiver

public class JsonReceiver
extends java.lang.Object
implements Receiver

A Receiver which receives a stream of XML events using the vocabulary defined for the XML representation of JSON in XSLT 3.0, and which generates the corresponding JSON text as a string

Field Summary

Fields inherited from interface javax.xml.transform.Result

PI_DISABLE_OUTPUT_ESCAPING, PI_ENABLE_OUTPUT_ESCAPING

Constructor Summary

Constructors

Constructor and Description
JsonReceiver(PipelineConfiguration pipe, XPathContext context, UniStringConsumer output)

Method Summary

Modifier and Type	Method and Description
void	characters(UnicodeString chars, Location locationId, int properties) Notify character data.
void	close() Notify the end of the event stream
void	comment(UnicodeString content, Location locationId, int properties) Notify a comment.
void	endDocument() Notify the end of a document node
void	endElement() Notify the end of an element.
static java.lang.String	escape(java.lang.String in, boolean forXml, java.util.function.IntPredicate hexEscapes) Escape a string using backslash escape sequences as defined in JSON
Function	getNumberFormatter()
PipelineConfiguration	getPipelineConfiguration() Get the pipeline configuration
java.lang.String	getSystemId()
boolean	isIndenting()
void	open() Notify the start of the event stream
void	processingInstruction(java.lang.String name, UnicodeString data, Location locationId, int properties) Output a processing instruction
void	setIndenting(boolean indenting)
void	setNumberFormatter(Function formatter)
void	setPipelineConfiguration(PipelineConfiguration pipe) Set the pipeline configuration
void	setSystemId(java.lang.String systemId)
void	setUnparsedEntity(java.lang.String name, java.lang.String systemID, java.lang.String publicID) Notify an unparsed entity URI.
void	startDocument(int properties) Notify the start of a document node
void	startElement(NodeName elemName, SchemaType type, AttributeMap attributes, NamespaceMap namespaces, Location location, int properties) Notify the start of an element
boolean	usesTypeAnnotations() Ask whether this Receiver (or the downstream pipeline) makes any use of the type annotations supplied on element and attribute events.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

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

append, append, handlesAppend

Constructor Detail

JsonReceiver

public JsonReceiver(PipelineConfiguration pipe,
                    XPathContext context,
                    UniStringConsumer output)

Method Detail

setPipelineConfiguration

public void setPipelineConfiguration(PipelineConfiguration pipe)

Description copied from interface: Receiver

Set the pipeline configuration

Specified by:

setPipelineConfiguration in interface Receiver

Parameters:

pipe - the pipeline configuration

getPipelineConfiguration

public PipelineConfiguration getPipelineConfiguration()

Description copied from interface: Receiver

Get the pipeline configuration

Specified by:

getPipelineConfiguration in interface Receiver

Returns:

the pipeline configuration

setSystemId

public void setSystemId(java.lang.String systemId)

Specified by:

setSystemId in interface javax.xml.transform.Result

setIndenting

public void setIndenting(boolean indenting)

isIndenting

public boolean isIndenting()

setNumberFormatter

public void setNumberFormatter(Function formatter)

getNumberFormatter

public Function getNumberFormatter()

open

public void open()
          throws XPathException

Description copied from interface: Receiver

Notify the start of the event stream

Specified by:

open in interface Receiver

Throws:

XPathException - if an error occurs

startDocument

public void startDocument(int properties)
                   throws XPathException

Description copied from interface: Receiver

Notify the start of a document node

Specified by:

startDocument in interface Receiver

Parameters:

properties - bit-significant integer indicating properties of the document node. The definitions of the bits are in class ReceiverOption

Throws:

XPathException - if an error occurs

endDocument

public void endDocument()
                 throws XPathException

Description copied from interface: Receiver

Notify the end of a document node

Specified by:

endDocument in interface Receiver

Throws:

XPathException - if an error occurs

setUnparsedEntity

public void setUnparsedEntity(java.lang.String name,
                              java.lang.String systemID,
                              java.lang.String publicID)
                       throws XPathException

Description copied from interface: Receiver

Notify an unparsed entity URI.

Specified by:

setUnparsedEntity in interface Receiver

Parameters:

name - The name of the unparsed entity

systemID - The system identifier of the unparsed entity

publicID - The identifier of the unparsed entity

Throws:

XPathException - if an error occurs

startElement

public void startElement(NodeName elemName,
                         SchemaType type,
                         AttributeMap attributes,
                         NamespaceMap namespaces,
                         Location location,
                         int properties)
                  throws XPathException

Description copied from interface: Receiver

Notify the start of an element

Specified by:

startElement in interface Receiver

Parameters:

elemName - the name of the element.

type - the type annotation of the element.

attributes - the attributes of this element

namespaces - the in-scope namespaces of this element: generally this is all the in-scope namespaces, without relying on inheriting namespaces from parent elements

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

endElement

public void endElement()
                throws XPathException

Description copied from interface: Receiver

Notify the end of an element. The receiver must maintain a stack if it needs to know which element is ending.

Specified by:

endElement in interface Receiver

Throws:

XPathException - if an error occurs

escape

public static java.lang.String escape(java.lang.String in,
                                      boolean forXml,
                                      java.util.function.IntPredicate hexEscapes)
                               throws XPathException

Escape a string using backslash escape sequences as defined in JSON

Parameters:

in - the input string

forXml - true if the output is for the json-to-xml function

hexEscapes - a predicate identifying characters that should be output as hex escapes using \ u XXXX notation.

Returns:

the escaped string

Throws:

XPathException - if the input contains invalid escape sequences

characters

public void characters(UnicodeString chars,
                       Location locationId,
                       int properties)
                throws XPathException

Description copied from interface: Receiver

Notify character data. Note that some receivers may require the character data to be sent in a single event, but in general this is not a requirement.

Specified by:

characters in interface Receiver

Parameters:

chars - The characters

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

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

DISABLE_ESCAPING

Disable escaping for this text node

USE_CDATA

Output as a CDATA section

Throws:

XPathException - if an error occurs

processingInstruction

public void processingInstruction(java.lang.String name,
                                  UnicodeString data,
                                  Location locationId,
                                  int properties)
                           throws XPathException

Description copied from interface: Receiver

Output a processing instruction

Specified by:

processingInstruction in interface Receiver

Parameters:

name - The PI name. This must be a legal name (it will not be checked).

data - The data portion of the processing instruction

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

properties - Additional information about the PI.

Throws:

XPathException - if an error occurs

comment

public void comment(UnicodeString content,
                    Location locationId,
                    int properties)
             throws XPathException

Description copied from interface: Receiver

Notify a comment. Comments are only notified if they are outside the DTD.

Specified by:

comment in interface Receiver

Parameters:

content - The content of the comment

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

properties - Additional information about the comment.

Throws:

XPathException - if an error occurs

close

public void close()
           throws XPathException

Description copied from interface: Receiver

Notify the end of the event stream

Specified by:

close in interface Receiver

Throws:

XPathException - if an error occurs

usesTypeAnnotations

public boolean usesTypeAnnotations()

Description copied from interface: Receiver

Ask whether this Receiver (or the downstream pipeline) makes any use of the type annotations supplied on element and attribute events. The default implementation of this method returns false.

Specified by:

usesTypeAnnotations in interface Receiver

Returns:

true if the Receiver makes any use of this information. If false, the caller may supply untyped nodes instead of supplying the type annotation (or conversely, it may avoid stripping unwanted type annotations)

getSystemId

public java.lang.String getSystemId()

Specified by:

getSystemId in interface javax.xml.transform.Result