JsonExpr (MarkLogic Java Client API 4.0.1 2017-05-03)

```
public interface JsonExpr
```
Builds expressions to call functions in the json server library for a row pipeline.

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method and Description
`JsonArrayExpr`	`array()` Creates a (JSON) array, which is like a sequence of values, but allows for nesting.
`JsonArrayExpr`	`array(ElementNodeExpr array)` Creates a (JSON) array, which is like a sequence of values, but allows for nesting.
`JsonArraySeqExpr`	`arraySeq(JsonArrayExpr... items)` Constructs a sequence of JsonArrayExpr items.
`XsUnsignedLongExpr`	`arraySize(JsonArrayExpr array)` Returns the size of the array.
`ItemSeqExpr`	`arrayValues(JsonArrayExpr array)` Returns the array values as an XQuery sequence.
`ItemSeqExpr`	`arrayValues(JsonArrayExpr array, boolean flatten)` Returns the array values as an XQuery sequence.
`ItemSeqExpr`	`arrayValues(JsonArrayExpr array, XsBooleanExpr flatten)` Returns the array values as an XQuery sequence.
`JsonObjectExpr`	`object()` Creates a JSON object, which is a kind of map with a fixed and ordered set of keys.
`JsonObjectExpr`	`object(ElementNodeExpr map)` Creates a JSON object, which is a kind of map with a fixed and ordered set of keys.
`JsonObjectExpr`	`objectDefine()` Creates a JSON object.
`JsonObjectExpr`	`objectDefine(XsStringSeqExpr keys)` Creates a JSON object.
`JsonObjectSeqExpr`	`objectSeq(JsonObjectExpr... items)` Constructs a sequence of JsonObjectExpr items.
`JsonArrayExpr`	`subarray(JsonArrayExpr array, double startingLoc)` Extract a subarray from an array, producing a new array.
`JsonArrayExpr`	`subarray(JsonArrayExpr array, double startingLoc, double length)` Extract a subarray from an array, producing a new array.
`JsonArrayExpr`	`subarray(JsonArrayExpr array, XsNumericExpr startingLoc)` Extract a subarray from an array, producing a new array.
`JsonArrayExpr`	`subarray(JsonArrayExpr array, XsNumericExpr startingLoc, XsNumericExpr length)` Extract a subarray from an array, producing a new array.
`JsonArrayExpr`	`toArray()` Constructs an array from a sequence of items.
`JsonArrayExpr`	`toArray(ItemSeqExpr items)` Constructs an array from a sequence of items.
`JsonArrayExpr`	`toArray(ItemSeqExpr items, double limit)` Constructs an array from a sequence of items.
`JsonArrayExpr`	`toArray(ItemSeqExpr items, double limit, ItemExpr zero)` Constructs an array from a sequence of items.
`JsonArrayExpr`	`toArray(ItemSeqExpr items, XsNumericExpr limit)` Constructs an array from a sequence of items.
`JsonArrayExpr`	`toArray(ItemSeqExpr items, XsNumericExpr limit, ItemExpr zero)` Constructs an array from a sequence of items.

- Method Detail
  - array
```
JsonArrayExpr array()
```
    Creates a (JSON) array, which is like a sequence of values, but allows for nesting.
    Provides a client interface to a server function. See json:array
    
    Returns:
    
    a JsonArrayExpr expression
  - array
```
JsonArrayExpr array(ElementNodeExpr array)
```
    Creates a (JSON) array, which is like a sequence of values, but allows for nesting.
    Provides a client interface to a server function. See json:array
    
    Parameters:
    
    array - A serialized array element.
    
    Returns:
    
    a JsonArrayExpr expression
  - arraySize
```
XsUnsignedLongExpr arraySize(JsonArrayExpr array)
```
    Returns the size of the array.
    Provides a client interface to a server function. See json:array-size
    
    Parameters:
    
    array - An array.
    
    Returns:
    
    a XsUnsignedLongExpr expression
  - arrayValues
```
ItemSeqExpr arrayValues(JsonArrayExpr array)
```
    Returns the array values as an XQuery sequence.
    Provides a client interface to a server function. See json:array-values
    
    Parameters:
    
    array - An array.
    
    Returns:
    
    a ItemSeqExpr expression sequence
  - arrayValues
```
ItemSeqExpr arrayValues(JsonArrayExpr array,
                        boolean flatten)
```
    Returns the array values as an XQuery sequence.
    Provides a client interface to a server function. See json:array-values
    
    Parameters:
    
    array - An array.
    
    flatten - Include values from subarrays in the sequence. The default is false, meaning that subarrays are returned as array values.
    
    Returns:
    
    a ItemSeqExpr expression sequence
  - arrayValues
```
ItemSeqExpr arrayValues(JsonArrayExpr array,
                        XsBooleanExpr flatten)
```
    Returns the array values as an XQuery sequence.
    Provides a client interface to a server function. See json:array-values
    
    Parameters:
    
    array - An array.
    
    flatten - Include values from subarrays in the sequence. The default is false, meaning that subarrays are returned as array values.
    
    Returns:
    
    a ItemSeqExpr expression sequence
  - object
```
JsonObjectExpr object()
```
    Creates a JSON object, which is a kind of map with a fixed and ordered set of keys.
    Provides a client interface to a server function. See json:object
    
    Returns:
    
    a JsonObjectExpr expression
  - object
```
JsonObjectExpr object(ElementNodeExpr map)
```
    Creates a JSON object, which is a kind of map with a fixed and ordered set of keys.
    Provides a client interface to a server function. See json:object
    
    Parameters:
    
    map - A serialized JSON object.
    
    Returns:
    
    a JsonObjectExpr expression
  - objectDefine
```
JsonObjectExpr objectDefine()
```
    Creates a JSON object.
    Provides a client interface to a server function. See json:object-define
    
    Returns:
    
    a JsonObjectExpr expression
  - objectDefine
```
JsonObjectExpr objectDefine(XsStringSeqExpr keys)
```
    Creates a JSON object.
    Provides a client interface to a server function. See json:object-define
    
    Parameters:
    
    keys - The sequence of keys in this object.
    
    Returns:
    
    a JsonObjectExpr expression
  - subarray
```
JsonArrayExpr subarray(JsonArrayExpr array,
                       double startingLoc)
```
    Extract a subarray from an array, producing a new array. The second and third arguments to this function operate similarly to those of fn:subsequence for XQuery sequences.
    Provides a client interface to a server function. See json:subarray
    
    Parameters:
    
    array - An array.
    
    startingLoc - The starting position of the start of the subarray.
    
    Returns:
    
    a JsonArrayExpr expression
  - subarray
```
JsonArrayExpr subarray(JsonArrayExpr array,
                       XsNumericExpr startingLoc)
```
    Extract a subarray from an array, producing a new array. The second and third arguments to this function operate similarly to those of fn:subsequence for XQuery sequences.
    Provides a client interface to a server function. See json:subarray
    
    Parameters:
    
    array - An array.
    
    startingLoc - The starting position of the start of the subarray.
    
    Returns:
    
    a JsonArrayExpr expression
  - subarray
```
JsonArrayExpr subarray(JsonArrayExpr array,
                       double startingLoc,
                       double length)
```
    Extract a subarray from an array, producing a new array. The second and third arguments to this function operate similarly to those of fn:subsequence for XQuery sequences.
    Provides a client interface to a server function. See json:subarray
    
    Parameters:
    
    array - An array.
    
    startingLoc - The starting position of the start of the subarray.
    
    length - The length of the subarray.
    
    Returns:
    
    a JsonArrayExpr expression
  - subarray
```
JsonArrayExpr subarray(JsonArrayExpr array,
                       XsNumericExpr startingLoc,
                       XsNumericExpr length)
```
    Extract a subarray from an array, producing a new array. The second and third arguments to this function operate similarly to those of fn:subsequence for XQuery sequences.
    Provides a client interface to a server function. See json:subarray
    
    Parameters:
    
    array - An array.
    
    startingLoc - The starting position of the start of the subarray.
    
    length - The length of the subarray.
    
    Returns:
    
    a JsonArrayExpr expression
  - toArray
```
JsonArrayExpr toArray()
```
    Constructs an array from a sequence of items.
    Provides a client interface to a server function. See json:to-array
    
    Returns:
    
    a JsonArrayExpr expression
  - toArray
```
JsonArrayExpr toArray(ItemSeqExpr items)
```
    Constructs an array from a sequence of items.
    Provides a client interface to a server function. See json:to-array
    
    Parameters:
    
    items - A sequence of items.
    
    Returns:
    
    a JsonArrayExpr expression
  - toArray
```
JsonArrayExpr toArray(ItemSeqExpr items,
                      double limit)
```
    Constructs an array from a sequence of items.
    Provides a client interface to a server function. See json:to-array
    
    Parameters:
    
    items - A sequence of items.
    
    limit - The size of the array to construct. If the size is less than the length of the item sequence, only as “limit” items are put into the array. If the size is more than the length of the sequence, the array is filled with null values up to the limit.
    
    Returns:
    
    a JsonArrayExpr expression
  - toArray
```
JsonArrayExpr toArray(ItemSeqExpr items,
                      XsNumericExpr limit)
```
    Constructs an array from a sequence of items.
    Provides a client interface to a server function. See json:to-array
    
    Parameters:
    
    items - A sequence of items.
    
    limit - The size of the array to construct. If the size is less than the length of the item sequence, only as “limit” items are put into the array. If the size is more than the length of the sequence, the array is filled with null values up to the limit.
    
    Returns:
    
    a JsonArrayExpr expression
  - toArray
```
JsonArrayExpr toArray(ItemSeqExpr items,
                      double limit,
                      ItemExpr zero)
```
    Constructs an array from a sequence of items.
    Provides a client interface to a server function. See json:to-array
    
    Parameters:
    
    items - A sequence of items.
    
    limit - The size of the array to construct. If the size is less than the length of the item sequence, only as “limit” items are put into the array. If the size is more than the length of the sequence, the array is filled with null values up to the limit.
    
    zero - The value to use to pad out the array, if necessary. By default the empty sequence is used.
    
    Returns:
    
    a JsonArrayExpr expression
  - toArray
```
JsonArrayExpr toArray(ItemSeqExpr items,
                      XsNumericExpr limit,
                      ItemExpr zero)
```
    Constructs an array from a sequence of items.
    Provides a client interface to a server function. See json:to-array
    
    Parameters:
    
    items - A sequence of items.
    
    limit - The size of the array to construct. If the size is less than the length of the item sequence, only as “limit” items are put into the array. If the size is more than the length of the sequence, the array is filled with null values up to the limit.
    
    zero - The value to use to pad out the array, if necessary. By default the empty sequence is used.
    
    Returns:
    
    a JsonArrayExpr expression
  - arraySeq
```
JsonArraySeqExpr arraySeq(JsonArrayExpr... items)
```
    Constructs a sequence of JsonArrayExpr items.
  - objectSeq
```
JsonObjectSeqExpr objectSeq(JsonObjectExpr... items)
```
    Constructs a sequence of JsonObjectExpr items.

Interface JsonExpr

Method Summary

Method Detail

array

array

arraySize

arrayValues

arrayValues

arrayValues

object

object

objectDefine

objectDefine

subarray

subarray

subarray

subarray

toArray

toArray

toArray

toArray

toArray

toArray

arraySeq

objectSeq