Package 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
-
-
Constructor Summary
Constructors Constructor Description JsonReceiver(PipelineConfiguration pipe, CharSequenceConsumer output)
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description voidcharacters(java.lang.CharSequence chars, Location locationId, int properties)Notify character data.voidclose()Notify the end of the event streamvoidcomment(java.lang.CharSequence content, Location locationId, int properties)Notify a comment.voidendDocument()Notify the end of a document nodevoidendElement()Notify the end of an element.static java.lang.CharSequenceescape(java.lang.CharSequence in, boolean forXml, java.util.function.IntPredicate hexEscapes)Escape a string using backslash escape sequences as defined in JSONFunctiongetNumberFormatter()PipelineConfigurationgetPipelineConfiguration()Get the pipeline configurationjava.lang.StringgetSystemId()booleanisIndenting()voidopen()Notify the start of the event streamvoidprocessingInstruction(java.lang.String name, java.lang.CharSequence data, Location locationId, int properties)Output a processing instructionvoidsetIndenting(boolean indenting)voidsetNumberFormatter(Function formatter)voidsetPipelineConfiguration(PipelineConfiguration pipe)Set the pipeline configurationvoidsetSystemId(java.lang.String systemId)Set the System ID of the tree represented by this event streamvoidsetUnparsedEntity(java.lang.String name, java.lang.String systemID, java.lang.String publicID)Notify an unparsed entity URI.voidstartDocument(int properties)Notify the start of a document nodevoidstartElement(NodeName elemName, SchemaType type, AttributeMap attributes, NamespaceMap namespaces, Location location, int properties)Notify the start of an elementbooleanusesTypeAnnotations()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, CharSequenceConsumer output)
-
-
Method Detail
-
setPipelineConfiguration
public void setPipelineConfiguration(PipelineConfiguration pipe)
Description copied from interface:ReceiverSet the pipeline configuration- Specified by:
setPipelineConfigurationin interfaceReceiver- Parameters:
pipe- the pipeline configuration
-
getPipelineConfiguration
public PipelineConfiguration getPipelineConfiguration()
Description copied from interface:ReceiverGet the pipeline configuration- Specified by:
getPipelineConfigurationin interfaceReceiver- Returns:
- the pipeline configuration
-
setSystemId
public void setSystemId(java.lang.String systemId)
Description copied from interface:ReceiverSet the System ID of the tree represented by this event stream- Specified by:
setSystemIdin interfaceReceiver- Specified by:
setSystemIdin interfacejavax.xml.transform.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()
-
setNumberFormatter
public void setNumberFormatter(Function formatter)
-
getNumberFormatter
public Function getNumberFormatter()
-
open
public void open() throws XPathExceptionDescription copied from interface:ReceiverNotify the start of the event stream- Specified by:
openin interfaceReceiver- Throws:
XPathException- if an error occurs
-
startDocument
public void startDocument(int properties) throws XPathExceptionDescription copied from interface:ReceiverNotify the start of a document node- Specified by:
startDocumentin interfaceReceiver- Parameters:
properties- bit-significant integer indicating properties of the document node. The definitions of the bits are in classReceiverOption- Throws:
XPathException- if an error occurs
-
endDocument
public void endDocument() throws XPathExceptionDescription copied from interface:ReceiverNotify the end of a document node- Specified by:
endDocumentin interfaceReceiver- Throws:
XPathException- if an error occurs
-
setUnparsedEntity
public void setUnparsedEntity(java.lang.String name, java.lang.String systemID, java.lang.String publicID) throws XPathExceptionDescription copied from interface:ReceiverNotify an unparsed entity URI.- Specified by:
setUnparsedEntityin interfaceReceiver- Parameters:
name- The name of the unparsed entitysystemID- The system identifier of the unparsed entitypublicID- 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:ReceiverNotify the start of an element- Specified by:
startElementin interfaceReceiver- Parameters:
elemName- the name of the element.type- the type annotation of the element.attributes- the attributes of this elementnamespaces- the in-scope namespaces of this element: generally this is all the in-scope namespaces, without relying on inheriting namespaces from parent elementslocation- an object providing information about the module, line, and column where the node originatedproperties- bit-significant properties of the element node. If there are no relevant properties, zero is supplied. The definitions of the bits are in classReceiverOption- Throws:
XPathException- if an error occurs
-
endElement
public void endElement() throws XPathExceptionDescription copied from interface:ReceiverNotify the end of an element. The receiver must maintain a stack if it needs to know which element is ending.- Specified by:
endElementin interfaceReceiver- Throws:
XPathException- if an error occurs
-
escape
public static java.lang.CharSequence escape(java.lang.CharSequence in, boolean forXml, java.util.function.IntPredicate hexEscapes) throws XPathExceptionEscape a string using backslash escape sequences as defined in JSON- Parameters:
in- the input stringforXml- true if the output is for the json-to-xml functionhexEscapes- 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(java.lang.CharSequence chars, Location locationId, int properties) throws XPathExceptionDescription copied from interface:ReceiverNotify 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:
charactersin interfaceReceiver- Parameters:
chars- The characterslocationId- 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, java.lang.CharSequence data, Location locationId, int properties) throws XPathExceptionDescription copied from interface:ReceiverOutput a processing instruction- Specified by:
processingInstructionin interfaceReceiver- Parameters:
name- The PI name. This must be a legal name (it will not be checked).data- The data portion of the processing instructionlocationId- 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(java.lang.CharSequence content, Location locationId, int properties) throws XPathExceptionDescription copied from interface:ReceiverNotify a comment. Comments are only notified if they are outside the DTD.- Specified by:
commentin interfaceReceiver- Parameters:
content- The content of the commentlocationId- 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 XPathExceptionDescription copied from interface:ReceiverNotify the end of the event stream- Specified by:
closein interfaceReceiver- Throws:
XPathException- if an error occurs
-
usesTypeAnnotations
public boolean usesTypeAnnotations()
Description copied from interface:ReceiverAsk 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:
usesTypeAnnotationsin interfaceReceiver- 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:
getSystemIdin interfacejavax.xml.transform.Result
-
-