Package net.sf.saxon.ma.json

Class XMLToJsonFn

java.lang.Object

net.sf.saxon.functions.AbstractFunction

net.sf.saxon.functions.SystemFunction

net.sf.saxon.ma.json.XMLToJsonFn

All Implemented Interfaces:

Iterable<Function>, Callable, Function, GroundedValue<Function>, Item<Function>, Sequence<Function>

public class XMLToJsonFn
extends SystemFunction

Implement the XML to JSON conversion as a built-in function - fn:xml-to-json()

Constructor Summary

Constructors

Constructor	Description
XMLToJsonFn()

Method Summary

Modifier and Type	Method	Description
Sequence<?>	call(XPathContext context, Sequence[] arguments)	Invoke the function
String	getStreamerName()	Get a name that identifies the class that can be used to evaluate this function in streaming mode, that is, supplying one item or event at a time as it is delivered by the parser.
static OptionsParameter	makeOptionsParameter()

Methods inherited from class net.sf.saxon.functions.SystemFunction

dependsOnContextItem, dynamicCall, equals, export, exportAdditionalArguments, exportAttributes, fixArguments, getArity, getCardinality, getCompilerName, getContextNode, getDescription, getDetails, getErrorCodeForTypeErrors, getFunctionItemType, getFunctionName, getIntegerBounds, getNetCost, getOperandRoles, getRequiredType, getResultItemType, getResultItemType, getRetainedStaticContext, getSpecialProperties, getStaticBaseUriString, importAttributes, isTrustedResultType, makeCall, makeFunction, makeFunctionCall, makeOptimizedFunctionCall, resultIfEmpty, setArity, setDetails, setRetainedStaticContext, supplyTypeInformation, toShortString, toString, typeCheckCaller

Methods inherited from class net.sf.saxon.functions.AbstractFunction

atomize, deepEquals, effectiveBooleanValue, getAnnotations, getStringValue, getStringValueCS, isArray, isMap, makeNewContext, simplify, typeCheck

Methods inherited from class java.lang.Object

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

Methods inherited from interface net.sf.saxon.om.Function

getGenre

Methods inherited from interface net.sf.saxon.om.GroundedValue

asIterable, materialize

Methods inherited from interface net.sf.saxon.om.Item

getLength, head, isStreamed, itemAt, iterate, iterator, reduce, subsequence

Methods inherited from interface java.lang.Iterable

forEach, spliterator

Methods inherited from interface net.sf.saxon.om.Sequence

makeRepeatable

Constructor Details

XMLToJsonFn

public XMLToJsonFn()

Method Details

makeOptionsParameter

public static OptionsParameter makeOptionsParameter()

call

public Sequence<?> call(XPathContext context,
 Sequence[] arguments)
                 throws XPathException

Description copied from interface: Function

Invoke the function

Parameters:

context - the XPath dynamic evaluation context

arguments - the actual arguments to be supplied

Returns:

the result of invoking the function

Throws:

XPathException - if a dynamic error occurs within the function

getStreamerName

public String getStreamerName()

Description copied from class: SystemFunction

Get a name that identifies the class that can be used to evaluate this function in streaming mode, that is, supplying one item or event at a time as it is delivered by the parser. Special streaming support is generally available in Saxon-EE for all system functions that take a sequence as their argument.

Overrides:

getStreamerName in class SystemFunction

Returns:

a name that identifies a class that supports streamed evaluation of this system function, or null if no such class is available. The mapping of names to classes is defined in the Saxon-EE class StreamerMap. In non-streaming Saxon editions (HE and PE) the method always returns null.