com.aspose.words

Class JsonDataLoadOptions

java.lang.Object

com.aspose.words.JsonDataLoadOptions

public class JsonDataLoadOptions
extends java.lang.Object

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.

Examples:

Shows how to use JSON as a data source (string).

 
 Document doc = new Document(getMyDir() + "Reporting engine template - JSON data destination (Java).docx");

 JsonDataLoadOptions options = new JsonDataLoadOptions();
 {
     options.setExactDateTimeParseFormats(Arrays.asList(new String[]{"MM/dd/yyyy", "MM.d.yy", "MM d yy"}));
 }

 JsonDataSource dataSource = new JsonDataSource(getMyDir() + "List of people.json", options);
 buildReport(doc, dataSource, "persons");

 doc.save(getArtifactsDir() + "ReportingEngine.JsonDataString.docx");
 
 

Constructor Summary

Constructors

Constructor and Description
JsonDataLoadOptions() Initializes a new instance of this class with default options.

Method Summary

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

Methods inherited from class java.lang.Object

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

Constructor Detail

JsonDataLoadOptions

public JsonDataLoadOptions()

Initializes a new instance of this class with default options.

Examples:

Shows how to use JSON as a data source (string).

 
 Document doc = new Document(getMyDir() + "Reporting engine template - JSON data destination (Java).docx");

 JsonDataLoadOptions options = new JsonDataLoadOptions();
 {
     options.setExactDateTimeParseFormats(Arrays.asList(new String[]{"MM/dd/yyyy", "MM.d.yy", "MM d yy"}));
 }

 JsonDataSource dataSource = new JsonDataSource(getMyDir() + "List of people.json", options);
 buildReport(doc, dataSource, "persons");

 doc.save(getArtifactsDir() + "ReportingEngine.JsonDataString.docx");
 
 

Method Detail

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.

Examples:

Shows how to use JSON as a data source (string).

 
 Document doc = new Document(getMyDir() + "Reporting engine template - JSON data destination (Java).docx");

 JsonDataLoadOptions options = new JsonDataLoadOptions();
 {
     options.setExactDateTimeParseFormats(Arrays.asList(new String[]{"MM/dd/yyyy", "MM.d.yy", "MM d yy"}));
 }

 JsonDataSource dataSource = new JsonDataSource(getMyDir() + "List of people.json", options);
 buildReport(doc, dataSource, "persons");

 doc.save(getArtifactsDir() + "ReportingEngine.JsonDataString.docx");
 
 

Returns:

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

setSimpleValueParseMode

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.

Examples:

Shows how to use JSON as a data source (string).

 
 Document doc = new Document(getMyDir() + "Reporting engine template - JSON data destination (Java).docx");

 JsonDataLoadOptions options = new JsonDataLoadOptions();
 {
     options.setExactDateTimeParseFormats(Arrays.asList(new String[]{"MM/dd/yyyy", "MM.d.yy", "MM d yy"}));
 }

 JsonDataSource dataSource = new JsonDataSource(getMyDir() + "List of people.json", options);
 buildReport(doc, dataSource, "persons");

 doc.save(getArtifactsDir() + "ReportingEngine.JsonDataString.docx");
 
 

Parameters:

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

getExactDateTimeParseFormats

public java.lang.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:

• When getExactDateTimeParseFormats() / setExactDateTimeParseFormats(java.lang.Iterable) is null, the ISO-8601 format and all date-time formats supported for the current, English USA, and English New Zealand cultures are used additionally in the mentioned order.
• When getExactDateTimeParseFormats() / setExactDateTimeParseFormats(java.lang.Iterable) contains strings, they are used as additional date-time formats utilizing the current culture.
• When getExactDateTimeParseFormats() / setExactDateTimeParseFormats(java.lang.Iterable) is empty, no additional date-time formats are used.

Examples:

Shows how to use JSON as a data source (string).

 
 Document doc = new Document(getMyDir() + "Reporting engine template - JSON data destination (Java).docx");

 JsonDataLoadOptions options = new JsonDataLoadOptions();
 {
     options.setExactDateTimeParseFormats(Arrays.asList(new String[]{"MM/dd/yyyy", "MM.d.yy", "MM d yy"}));
 }

 JsonDataSource dataSource = new JsonDataSource(getMyDir() + "List of people.json", options);
 buildReport(doc, dataSource, "persons");

 doc.save(getArtifactsDir() + "ReportingEngine.JsonDataString.docx");
 
 

Returns:

Exact formats for parsing JSON date-time values while loading JSON.

setExactDateTimeParseFormats

public void setExactDateTimeParseFormats(java.lang.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:

• When getExactDateTimeParseFormats() / setExactDateTimeParseFormats(java.lang.Iterable) is null, the ISO-8601 format and all date-time formats supported for the current, English USA, and English New Zealand cultures are used additionally in the mentioned order.
• When getExactDateTimeParseFormats() / setExactDateTimeParseFormats(java.lang.Iterable) contains strings, they are used as additional date-time formats utilizing the current culture.
• When getExactDateTimeParseFormats() / setExactDateTimeParseFormats(java.lang.Iterable) is empty, no additional date-time formats are used.

Examples:

Shows how to use JSON as a data source (string).

 
 Document doc = new Document(getMyDir() + "Reporting engine template - JSON data destination (Java).docx");

 JsonDataLoadOptions options = new JsonDataLoadOptions();
 {
     options.setExactDateTimeParseFormats(Arrays.asList(new String[]{"MM/dd/yyyy", "MM.d.yy", "MM d yy"}));
 }

 JsonDataSource dataSource = new JsonDataSource(getMyDir() + "List of people.json", options);
 buildReport(doc, dataSource, "persons");

 doc.save(getArtifactsDir() + "ReportingEngine.JsonDataString.docx");
 
 

Parameters:

value - Exact formats for parsing JSON date-time values while loading JSON.

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.

Examples:

Shows how to use JSON as a data source (string).

 
 Document doc = new Document(getMyDir() + "Reporting engine template - JSON data destination (Java).docx");

 JsonDataLoadOptions options = new JsonDataLoadOptions();
 {
     options.setExactDateTimeParseFormats(Arrays.asList(new String[]{"MM/dd/yyyy", "MM.d.yy", "MM d yy"}));
 }

 JsonDataSource dataSource = new JsonDataSource(getMyDir() + "List of people.json", options);
 buildReport(doc, dataSource, "persons");

 doc.save(getArtifactsDir() + "ReportingEngine.JsonDataString.docx");
 
 

Returns:

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

setAlwaysGenerateRootObject

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.

Examples:

Shows how to use JSON as a data source (string).

 
 Document doc = new Document(getMyDir() + "Reporting engine template - JSON data destination (Java).docx");

 JsonDataLoadOptions options = new JsonDataLoadOptions();
 {
     options.setExactDateTimeParseFormats(Arrays.asList(new String[]{"MM/dd/yyyy", "MM.d.yy", "MM d yy"}));
 }

 JsonDataSource dataSource = new JsonDataSource(getMyDir() + "List of people.json", options);
 buildReport(doc, dataSource, "persons");

 doc.save(getArtifactsDir() + "ReportingEngine.JsonDataString.docx");
 
 

Parameters:

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

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.

Examples:

Shows how to use JSON as a data source (string).

 
 Document doc = new Document(getMyDir() + "Reporting engine template - JSON data destination (Java).docx");

 JsonDataLoadOptions options = new JsonDataLoadOptions();
 {
     options.setExactDateTimeParseFormats(Arrays.asList(new String[]{"MM/dd/yyyy", "MM.d.yy", "MM d yy"}));
 }

 JsonDataSource dataSource = new JsonDataSource(getMyDir() + "List of people.json", options);
 buildReport(doc, dataSource, "persons");

 doc.save(getArtifactsDir() + "ReportingEngine.JsonDataString.docx");
 
 

Returns:

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

setPreserveSpaces

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.

Examples:

Shows how to use JSON as a data source (string).

 
 Document doc = new Document(getMyDir() + "Reporting engine template - JSON data destination (Java).docx");

 JsonDataLoadOptions options = new JsonDataLoadOptions();
 {
     options.setExactDateTimeParseFormats(Arrays.asList(new String[]{"MM/dd/yyyy", "MM.d.yy", "MM d yy"}));
 }

 JsonDataSource dataSource = new JsonDataSource(getMyDir() + "List of people.json", options);
 buildReport(doc, dataSource, "persons");

 doc.save(getArtifactsDir() + "ReportingEngine.JsonDataString.docx");
 
 

Parameters:

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