XProc 3.0: JSON steps2018@@FIXME:XMLNorman WalshAchim BerndzenGerrit ImsiekeErik SiegelThis specification describes the p:json-join step
for
XProc 3.0: An XML Pipeline Language.This section describes the status of this document at
the time of its publication. Other documents may supersede this
document.This document is derived from
XProc:
An XML Pipeline Language published by the W3C.IntroductionThis specification describes the
p:json-join XProc step.
A machine-readable description of
these steps may be found in
steps.xpl.
Familarity with the
general nature of
steps is assumed; for background details, see
.p:json-joinThe p:json-join step joins a sequence of JSON
documents into a single JSON document (an array). If the sequence on
port source is empty, the empty sequence is returned on
port result.If option flatten-arrays is
false, a member in the array is created for each
document in the sequence appearing on portsource.
Therefore the produced array with have the same number of members as
the number of documents appearing on port source. However
if flatten-arrays is true, for each
member of an array appearing at the top level of a JSON document on
port source a new member in the resulting array will be
created.Step ErrorsThis step can raise
dynamic errors.
A dynamic
error is one which occurs while a pipeline is being
evaluated. Examples of dynamic errors include references to
URIs that cannot be resolved, steps which fail, and pipelines that
exhaust the capacity of an implementation (such as memory or disk
space). For a more complete discussion of dynamic errors, see
.
If a step fails due to a dynamic error, failure propagates
upwards until either a p:try is encountered or the entire
pipeline fails. In other words, outside of a p:try, step
failure causes the entire pipeline to fail.The following errors can be raised by this step:ConformanceConformant processors must implement all of the features
described in this specification except those that are explicitly identified
as optional.Some aspects of processor behavior are not completely specified; those
features are either implementation-dependent or
implementation-defined.An
implementation-dependent feature is one where the
implementation has discretion in how it is performed.
Implementations are not required to document or explain
how implementation-dependent features are performed.An
implementation-defined feature is one where the
implementation has discretion in how it is performed.
Conformant implementations must document
how implementation-defined features are performed.Implementation-defined featuresThe following features are implementation-defined:Implementation-dependent featuresThe following features are implementation-dependent:ReferencesXProc 3.0XProc 3.0:
An XML Pipeline Language.
Norman Walsh, Achim Berndzen, Gerrit Imsieke and Erik Siegel, editors.
XProc 3.0 StepsXProc 3.0 Steps:
An Introduction.
Norman Walsh, Achim Berndzen, Gerrit Imsieke and Erik Siegel, editors.
Glossarydynamic
errorA dynamic
error is one which occurs while a pipeline is being
evaluated.implementation-definedAn
implementation-defined feature is one where the
implementation has discretion in how it is performed.
Conformant implementations must document
how implementation-defined features are performed.implementation-dependentAn
implementation-dependent feature is one where the
implementation has discretion in how it is performed.
Implementations are not required to document or explain
how implementation-dependent features are performed.Ancillary filesThis specification includes by reference a number of
ancillary files.An XProc step library for the declared steps.