Package net.sf.saxon.ma.json

Class JsonReceiver

java.lang.Object

net.sf.saxon.ma.json.JsonReceiver

All Implemented Interfaces:

Result, Receiver

public class JsonReceiver
extends 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	Description
JsonReceiver(PipelineConfiguration pipe)

Method Summary

Modifier and Type	Method	Description
void	attribute(NodeName attName, SimpleType typeCode, CharSequence value, Location locationId, int properties)	Notify an attribute.
void	characters(CharSequence chars, Location locationId, int properties)	Notify character data.
void	close()	Notify the end of the event stream
void	comment(CharSequence 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 CharSequence	escape(CharSequence in, boolean forXml, IntPredicate hexEscapes)	Escape a string using backslash escape sequences as defined in JSON
String	getJsonString()	On completion, get the assembled JSON string
PipelineConfiguration	getPipelineConfiguration()	Get the pipeline configuration
String	getSystemId()
boolean	isIndenting()
void	namespace(NamespaceBindingSet namespaceBindings, int properties)	Notify one or more namespaces.
void	open()	Notify the start of the event stream
void	processingInstruction(String name, CharSequence data, Location locationId, int properties)	Output a processing instruction
void	setIndenting(boolean indenting)
void	setPipelineConfiguration(PipelineConfiguration pipe)	Set the pipeline configuration
void	setSystemId(String systemId)	Set the System ID of the tree represented by this event stream
void	setUnparsedEntity(String name, String systemID, String publicID)	Notify an unparsed entity URI.
void	startContent()	Notify the start of the content, that is, the completion of all attributes and namespaces.
void	startDocument(int properties)	Notify the start of a document node
void	startElement(NodeName elemName, SchemaType typeCode, 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)

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(String systemId)

Description copied from interface: Receiver

Set the System ID of the tree represented by this event stream

Specified by:

setSystemId in interface Receiver

Specified by:

setSystemId in interface Result

Parameters:

systemId - the system ID (which is used as the base URI of the nodes if there is no xml:base attribute)

setIndenting

public void setIndenting(boolean indenting)

isIndenting

public boolean isIndenting()

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 ReceiverOptions

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(String name,
                              String systemID,
                              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 typeCode,
                         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.

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 revelant properties, zero is supplied. The definitions of the bits are in class ReceiverOptions

Throws:

XPathException - if an error occurs

namespace

public void namespace(NamespaceBindingSet namespaceBindings,
                      int properties)
               throws XPathException

Description copied from interface: Receiver

Notify one or more namespaces. Namespaces are notified after the startElement event, and before any children for the element. The namespaces that are reported are only required to include those that are different from the parent element. The events represent namespace declarations and undeclarations rather than in-scope namespace nodes: an undeclaration is represented by a namespace code of zero. If the sequence of namespace events contains two A namespace must not conflict with any namespaces already used for element or attribute names.

Specified by:

namespace in interface Receiver

Parameters:

namespaceBindings - contains the namespace prefix and namespace URI

properties - The most important property is REJECT_DUPLICATES. If this property is 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

attribute

public void attribute(NodeName attName,
                      SimpleType typeCode,
                      CharSequence value,
                      Location locationId,
                      int properties)
               throws XPathException

Description copied from interface: Receiver

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

Specified by:

attribute in interface Receiver

Parameters:

attName - The name of the attribute

typeCode - The type annotation of the attribute

value - the string value of the attribute

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 attribute

NO_SPECIAL_CHARACTERS

Attribute value contains no special characters

Throws:

XPathException - if an error occurs

startContent

public void startContent()
                  throws XPathException

Description copied from interface: Receiver

Notify the start of the content, that is, the completion of all attributes and namespaces. Note that the initial receiver 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.

Specified by:

startContent in interface Receiver

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 CharSequence escape(CharSequence in,
                                  boolean forXml,
                                  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 functino

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

Returns:

the escaped string

Throws:

XPathException

characters

public void characters(CharSequence 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(String name,
                                  CharSequence 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(CharSequence 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 String getSystemId()

Specified by:

getSystemId in interface Result

getJsonString

public String getJsonString()

On completion, get the assembled JSON string

Returns:

the JSON string representing the supplied XML content.