|
|
json:config(
|
|
$strategy as xs:string
|
| ) as map:map |
|
 |
Summary:
This function creates a configuration object
for a specified strategy.
|
Parameters:
$strategy
:
The name of
the strategy. One of basic (simple default JSON
conversion, starting from JSON), full (starting from
XML), or custom.
|
|
Usage Notes:
Use this function to when you want to use a custom strategy.
Supported strategies are basic, full,
custom.
The basic strategy is used if you supply no
parameters and has no user customizable properties.
The following properties are user customizable to configure the
behavior of the transformation.
full strategy properties
Property |
Description |
Default value |
json-attributes
|
The member named used to contain
attributes |
_attributes
|
json-children
|
The member named used to contain the
children array |
_children
|
whitespace
|
How to treat whitespace in XML text
values when converting to JSON. If
ignore then skip the value
otherwise include it. |
empty string |
custom strategy properties
Property |
Description |
Direction |
Type |
Default value |
array-element-names
|
A list of XML element names which will be
treated as an Array in JSON. These can be
xs:QName or xs:string.
If an xs:string is used then the
default namespace is used to construct the
QName. |
XML to JSON |
(xs:QName | xs:string)*
|
() |
text-value
|
The JSON member name to use for text when
an element contains both attributes and
text. |
BOTH |
xs:string |
"_value"
|
attribute-names
|
A list of JSON names which are converted to
XML attribute. |
JSON to XML |
xs:string*
|
() |
camel-case
|
A boolean value indicating if camel case
transformation is applied to all element and
attribute names when translating to and from
JSON. |
BOTH |
xs:boolean
|
fn:false()
|
element-namespace
|
The default namespace for elements |
JSON to XML |
xs:string
|
() |
element-namespace-prefix
|
The default prefix for elements |
JSON to XML |
xs:string
|
() |
attribute-namespace
|
The default namespace for attributes |
JSON to XML |
xs:string
|
() |
atribute-namespace-prefix
|
The default prefix for attributes |
JSON to XML |
xs:string |
() |
attribute-prefix
|
If specified then when converting to
JSON attributes are prefixed with this string.
When converting to XML all names starting with
this prefix are converted to attributes with
the prefix removed. |
BOTH |
xs:string |
() |
full-element-names
|
A list of XML element names which will
be treated as an full expansion in
JSON similar to the full strategy.
These can be xs:QName or
xs:string. If an xs:string
is used then the default namespace is used to
construct the QName. |
BOTH |
(xs:QName | xs:string)* |
() |
json-attributes
|
The member named used to contain
attributes when using the
full-element-names
expansion. |
|
xs:string |
"_attributes"
|
json-children
|
The member named used to
contain the children array when using the
full-element-names
expansion |
|
xs:string
|
"_children"
|
whitespace
|
How to treat whitespace in
XML text values when converting to JSON.
If ignore then skip the value
otherwise include it. |
|
xs:string
|
"" |
|
Example:
xquery version "1.0-ml";
import module namespace json="http://marklogic.com/xdmp/json"
at "/MarkLogic/json/json.xqy";
let $c := json:config("full"),
return json:transform-to-json( fn:doc("sample.xml") , $c )
|
Example:
xquery version "1.0-ml";
import module namespace search = "http://marklogic.com/appservices/search"
at "/MarkLogic/appservices/search/search.xqy";
import module namespace json="http://marklogic.com/xdmp/json"
at "/MarkLogic/json/json.xqy";
let $custom :=
let $config := json:config("custom")
return
(map:put($config, "array-element-names",
("text","point","value","operator-state",
"annotation","uri","qtext")),
map:put($config, "element-namespace",
"http://marklogic.com/appservices/search"),
map:put($config, "element-namespace-prefix", "search"),
map:put($config, "attribute-names",("warning","name")),
map:put($config, "full-element-names",
("query","and-query","near-query","or-query")),
map:put($config, "json-children","queries"),
$config)
let $struct := search:parse("hello world", (), "search:query")
return (
json:transform-to-json($struct, $custom),
$struct )
(: returns the json and corresponding XML for the structured query :)
=>
{"query":{"queries":
[{"and-query":{"queries":
[{"term-query":{"text":["hello"]}},
{"term-query":{"text":["world"]}}]}
}]
}}
<search:query xmlns:search="http://marklogic.com/appservices/search">
<search:and-query>
<search:term-query>
<search:text>hello</search:text>
</search:term-query>
<search:term-query>
<search:text>world</search:text>
</search:term-query>
</search:and-query>
</search:query>
|
|
|
|
json:transform-from-json(
|
|
$json as item(),
|
|
[$config as map:map]
|
| ) as item()* |
|
 |
Summary:
This function transforms a JSON document to
XML using the default ("basic") strategy.
|
Parameters:
$json
:
The JSON document
(typically a string) to transform.
|
$config
(optional):
The
configuration object
|
|
Usage Notes:
The supplied JSON document (as a string, element,
object or array) is transformed to XML using the default
(basic) strategy and returned as an
element.
|
Example:
xquery version "1.0-ml";
import module namespace json="http://marklogic.com/xdmp/json"
at "/MarkLogic/json/json.xqy";
declare variable $j := '{
"first Key":"first value",
"secondKey":["first item","second item",null,"third item",false],
"thirdKey":3,
"fourthKey":{"subKey":"sub value", "boolKey" : true, "empty" : null }
,"fifthKey": null,
"sixthKey" : []
}' ;
json:transform-from-json( $j)
==>
<json type="object" xmlns="http://marklogic.com/xdmp/json/basic">
<first_20_Key type="string">first value</first_20_Key>
<secondKey type="array">
<item type="string">first item</item>
<item type="string">second item</item>
<item type="null"/>
<item type="string">third item</item>
<item type="boolean">false</item>
</secondKey>
<thirdKey type="number">3</thirdKey>
<fourthKey type="object">
<subKey type="string">sub value</subKey>
<boolKey type="boolean">true</boolKey>
<empty type="null"/>
</fourthKey>
<fifthKey type="null"/>
<sixthKey type="array"/>
</json>
|
Example:
xquery version "1.0-ml";
import module namespace json="http://marklogic.com/xdmp/json"
at "/MarkLogic/json/json.xqy";
declare variable $j := '{
"object" : {
"firstKey":"first value",
"secondKey":["first item","second item","","third item",false],
"thirdKey":3,
"fourthKey":{"subKey":"sub value", "boolKey" : true, "empty" : null }
,"fifthKey": null,
"sixthKey" : []
}}' ;
let $config := json:config("custom") ,
$cx := map:put( $config, "attribute-names" , ("subKey" , "boolKey" , "empty" ) )
return
json:transform-from-json( $j, $config )
==>
<object>
<firstKey>first value</firstKey>
<secondKey>first item</secondKey>
<secondKey>second item</secondKey>
<secondKey/>
<secondKey>third item</secondKey>
<secondKey>false</secondKey>
<thirdKey>3</thirdKey>
<fourthKey subKey="sub value" boolKey="true" empty=""/>
<fifthKey/>
</object>
|
|
|