JsonDataLoadOptions

Inheritance: java.lang.Object

public class JsonDataLoadOptions

Represents options for parsing JSON data.

To learn more, visit the LINQ Reporting Engine documentation article.

Remarks:

An instance of this class can be passed into constructors of JsonDataSource.

Constructors

ConstructorDescription
JsonDataLoadOptions()Initializes a new instance of this class with default options.

Methods

MethodDescription
getAlwaysGenerateRootObject()Gets a flag indicating whether a generated data source will always contain an object for a JSON root element.
getExactDateTimeParseFormats()Gets exact formats for parsing JSON date-time values while loading JSON.
getPreserveSpaces()Gets a flag indicating whether leading and trailing spaces should be preserved when loading string values of JSON data.
getSimpleValueParseMode()Gets a mode for parsing JSON simple values (null, boolean, number, integer, and string) while loading JSON.
setAlwaysGenerateRootObject(boolean value)Sets a flag indicating whether a generated data source will always contain an object for a JSON root element.
setExactDateTimeParseFormats(Iterable value)Sets exact formats for parsing JSON date-time values while loading JSON.
setPreserveSpaces(boolean value)Sets a flag indicating whether leading and trailing spaces should be preserved when loading string values of JSON data.
setSimpleValueParseMode(int value)Sets a mode for parsing JSON simple values (null, boolean, number, integer, and string) while loading JSON.

JsonDataLoadOptions()

public JsonDataLoadOptions()

Initializes a new instance of this class with default options.

getAlwaysGenerateRootObject()

public boolean getAlwaysGenerateRootObject()

Gets a flag indicating whether a generated data source will always contain an object for a JSON root element. If a JSON root element contains a single complex property, such an object is not created by default.

Remarks:

The default value is false .

Returns: boolean - A flag indicating whether a generated data source will always contain an object for a JSON root element.

getExactDateTimeParseFormats()

public Iterable getExactDateTimeParseFormats()

Gets exact formats for parsing JSON date-time values while loading JSON. The default is null .

Remarks:

Strings encoded using Microsoft JSON date-time format (for example, “/Date(1224043200000)/”) are always recognized as date-time values regardless of a value of this property. The property defines additional formats to be used while parsing date-time values from strings in the following way:

Returns: java.lang.Iterable - Exact formats for parsing JSON date-time values while loading JSON.

getPreserveSpaces()

public boolean getPreserveSpaces()

Gets a flag indicating whether leading and trailing spaces should be preserved when loading string values of JSON data.

Remarks:

The default value is false .

Returns: boolean - A flag indicating whether leading and trailing spaces should be preserved when loading string values of JSON data.

getSimpleValueParseMode()

public int getSimpleValueParseMode()

Gets a mode for parsing JSON simple values (null, boolean, number, integer, and string) while loading JSON. Such a mode does not affect parsing of date-time values. The default is JsonSimpleValueParseMode.LOOSE.

Returns: int - A mode for parsing JSON simple values (null, boolean, number, integer, and string) while loading JSON. The returned value is one of JsonSimpleValueParseMode constants.

setAlwaysGenerateRootObject(boolean value)

public void setAlwaysGenerateRootObject(boolean value)

Sets a flag indicating whether a generated data source will always contain an object for a JSON root element. If a JSON root element contains a single complex property, such an object is not created by default.

Remarks:

The default value is false .

Parameters:

ParameterTypeDescription
valuebooleanA flag indicating whether a generated data source will always contain an object for a JSON root element.

setExactDateTimeParseFormats(Iterable value)

public void setExactDateTimeParseFormats(Iterable value)

Sets exact formats for parsing JSON date-time values while loading JSON. The default is null .

Remarks:

Strings encoded using Microsoft JSON date-time format (for example, “/Date(1224043200000)/”) are always recognized as date-time values regardless of a value of this property. The property defines additional formats to be used while parsing date-time values from strings in the following way:

Parameters:

ParameterTypeDescription
valuejava.lang.IterableExact formats for parsing JSON date-time values while loading JSON.

setPreserveSpaces(boolean value)

public void setPreserveSpaces(boolean value)

Sets a flag indicating whether leading and trailing spaces should be preserved when loading string values of JSON data.

Remarks:

The default value is false .

Parameters:

ParameterTypeDescription
valuebooleanA flag indicating whether leading and trailing spaces should be preserved when loading string values of JSON data.

setSimpleValueParseMode(int value)

public void setSimpleValueParseMode(int value)

Sets a mode for parsing JSON simple values (null, boolean, number, integer, and string) while loading JSON. Such a mode does not affect parsing of date-time values. The default is JsonSimpleValueParseMode.LOOSE.

Parameters:

ParameterTypeDescription
valueintA mode for parsing JSON simple values (null, boolean, number, integer, and string) while loading JSON. The value must be one of JsonSimpleValueParseMode constants.