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.
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");
Constructors
| Constructor | Description |
|---|---|
| JsonDataLoadOptions() | Initializes a new instance of this class with default options. |
Methods
| Method | Description |
|---|---|
| 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.
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");
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: 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:
- 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: 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 .
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: 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.
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: 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 .
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:
| Parameter | Type | Description |
|---|---|---|
| value | boolean | A 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:
- 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:
| Parameter | Type | Description |
|---|---|---|
| value | java.lang.Iterable | Exact 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 .
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:
| Parameter | Type | Description |
|---|---|---|
| value | boolean | A 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.
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:
| Parameter | Type | Description |
|---|---|---|
| value | int | A mode for parsing JSON simple values (null, boolean, number, integer, and string) while loading JSON. The value must be one of JsonSimpleValueParseMode constants. |
