com.aspose.words
Class JsonDataLoadOptions

java.lang.Object
    extended by 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.

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

Example:

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
JsonDataLoadOptions()
           Initializes a new instance of this class with default options.
 
Property Getters/Setters Summary
booleangetAlwaysGenerateRootObject()
voidsetAlwaysGenerateRootObject(boolean value)
           Gets or 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.
java.lang.Iterable<java.lang.String>getExactDateTimeParseFormats()
voidsetExactDateTimeParseFormats(java.lang.Iterable<java.lang.String> value)
           Gets or sets exact formats for parsing JSON date-time values while loading JSON. The default is null.
booleangetPreserveSpaces()
voidsetPreserveSpaces(boolean value)
           Gets or sets a flag indicating whether leading and trailing spaces should be preserved when loading string values of JSON data.
intgetSimpleValueParseMode()
voidsetSimpleValueParseMode(int value)
           Gets or 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. The value of the property is JsonSimpleValueParseMode integer constant.
 

Constructor Detail

JsonDataLoadOptions

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

Example:

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");

Property Getters/Setters Detail

getAlwaysGenerateRootObject/setAlwaysGenerateRootObject

public boolean getAlwaysGenerateRootObject() / public void setAlwaysGenerateRootObject(boolean value)
Gets or 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. The default value is false.

Example:

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");

getExactDateTimeParseFormats/setExactDateTimeParseFormats

public java.lang.Iterable<java.lang.String> getExactDateTimeParseFormats() / public void setExactDateTimeParseFormats(java.lang.Iterable<java.lang.String> value)
Gets or sets exact formats for parsing JSON date-time values while loading JSON. The default is null.

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 ExactDateTimeParseFormats 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 ExactDateTimeParseFormats contains strings, they are used as additional date-time formats utilizing the current culture.
  • When ExactDateTimeParseFormats is empty, no additional date-time formats are used.

Example:

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");

getPreserveSpaces/setPreserveSpaces

public boolean getPreserveSpaces() / public void setPreserveSpaces(boolean value)
Gets or sets a flag indicating whether leading and trailing spaces should be preserved when loading string values of JSON data. The default value is false.

Example:

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");

getSimpleValueParseMode/setSimpleValueParseMode

public int getSimpleValueParseMode() / public void setSimpleValueParseMode(int value)
Gets or 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. The value of the property is JsonSimpleValueParseMode integer constant.

Example:

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");

See Also:
          Aspose.Words Documentation - the home page for the Aspose.Words Product Documentation.
          Aspose.Words Support Forum - our preferred method of support.