com.aspose.words

Class ReportingEngine

java.lang.Object

com.aspose.words.ReportingEngine

public class ReportingEngine
extends java.lang.Object

Provides routines to populate template documents with data and a set of settings to control these routines.

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

Constructor Summary

Constructors

Constructor and Description
ReportingEngine() Initializes a new instance of this class.

Method Summary

Modifier and Type	Method and Description
boolean	buildReport(Document document, java.lang.Object dataSource) Populates the specified template document with data from the specified source making it a ready report.
boolean	buildReport(Document document, java.lang.Object[] dataSources, java.lang.String[] dataSourceNames) Populates the specified template document with data from the specified sources making it a ready report.
boolean	buildReport(Document document, java.lang.Object dataSource, java.lang.String dataSourceName) Populates the specified template document with data from the specified source making it a ready report.
KnownTypeSet	getKnownTypes() Gets an unordered set (i.e.
java.lang.String	getMissingMemberMessage() Gets a string value printed instead of a template expression that represents a plain reference to a missing member of an object.
int	getOptions() Gets a set of flags controlling behavior of this ReportingEngine instance while building a report.
static java.lang.Class[]	getRestrictedTypes() Returns types, which members as well as which derived types' members should be inaccessible by the engine through template syntax.
static boolean	getUseReflectionOptimization() Gets a value indicating whether invocations of custom type members performed via reflection API are optimized using dynamic class generation or not.
void	setMissingMemberMessage(java.lang.String value) Sets a string value printed instead of a template expression that represents a plain reference to a missing member of an object.
void	setOptions(int value) Sets a set of flags controlling behavior of this ReportingEngine instance while building a report.
static void	setRestrictedTypes(java.lang.Class... types) Specifies types, which members as well as which derived types' members should be inaccessible by the engine through template syntax.
static void	setUseReflectionOptimization(boolean value) Sets a value indicating whether invocations of custom type members performed via reflection API are optimized using dynamic class generation or not.

Methods inherited from class java.lang.Object

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

Constructor Detail

ReportingEngine

public ReportingEngine()

Initializes a new instance of this class.

Method Detail

buildReport

public boolean buildReport(Document document,
                           java.lang.Object dataSource)
                    throws java.lang.Exception

Populates the specified template document with data from the specified source making it a ready report.

Remarks:

Using this overload you can reference the data source's members in the template document, but you cannot reference the data source object itself. You should use the buildReport(com.aspose.words.Document, java.lang.Object, java.lang.String) overload to achieve this.

A data source object can be of one of the following types:

• XmlDataSource
• JsonDataSource
• CsvDataSource
• DataSet
• DataTable
• DataRow
• IDataReader
• IDataRecord
• DataView
• DataRowView
• Any other arbitrary Java type

For information on how to work with data sources of different types in template documents, see template syntax reference(https://docs.aspose.com/display/wordsjava/Template+Syntax).

Parameters:

document - A template document to be populated with data.

dataSource - A data source object.

Returns:

A flag indicating whether parsing of the template document was successful. The returned flag makes sense only if a value of the getOptions() / setOptions(int) property includes the ReportBuildOptions.INLINE_ERROR_MESSAGES option.

Throws:

java.lang.Exception

buildReport

public boolean buildReport(Document document,
                           java.lang.Object dataSource,
                           java.lang.String dataSourceName)
                    throws java.lang.Exception

Populates the specified template document with data from the specified source making it a ready report.

Remarks:

Using this overload you can reference the data source's members and the data source object itself in the template. If you are not going to reference the data source object itself, you can omit dataSourceName passing null or use the buildReport(com.aspose.words.Document, java.lang.Object) overload.

A data source object can be of one of the following types:

• XmlDataSource
• JsonDataSource
• CsvDataSource
• DataSet
• DataTable
• DataRow
• IDataReader
• IDataRecord
• DataView
• DataRowView
• Any other arbitrary Java type

For information on how to work with data sources of different types in template documents, see template syntax reference(https://docs.aspose.com/display/wordsjava/Template+Syntax).

Examples:

Shows how to remove paragraphs selectively.

 
 // Template contains tags with an exclamation mark. For such tags, empty paragraphs will be removed.
 Document doc = new Document(getMyDir() + "Reporting engine template - Selective remove paragraphs.docx");

 ReportingEngine engine = new ReportingEngine();
 engine.buildReport(doc, false, "value");

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

Shows how to allow missinng members.

 
 DocumentBuilder builder = new DocumentBuilder();
 builder.writeln("<<[missingObject.First().id]>>");
 builder.writeln("<<foreach [in missingObject]>><<[id]>><</foreach>>");

 ReportingEngine engine = new ReportingEngine(); { engine.setOptions(ReportBuildOptions.ALLOW_MISSING_MEMBERS); }
 engine.setMissingMemberMessage("Missed");
 engine.buildReport(builder.getDocument(), new DataSet(), "");
 
 

Shows how to display values as dollar text.

 
 Document doc = new Document();
 DocumentBuilder builder = new DocumentBuilder(doc);

 builder.writeln("<<[ds.getValue1()]:dollarText>>\r<<[ds.getValue2()]:dollarText>>");

 NumericTestClass testData = new NumericTestBuilder().withValues(1234, 5621718.589).build();

 ReportingEngine report = new ReportingEngine();
 report.getKnownTypes().add(NumericTestClass.class);
 report.buildReport(doc, testData, "ds");

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

Parameters:

document - A template document to be populated with data.

dataSource - A data source object.

dataSourceName - A name to reference the data source object in the template.

Returns:

A flag indicating whether parsing of the template document was successful. The returned flag makes sense only if a value of the getOptions() / setOptions(int) property includes the ReportBuildOptions.INLINE_ERROR_MESSAGES option.

Throws:

java.lang.Exception

buildReport

public boolean buildReport(Document document,
                           java.lang.Object[] dataSources,
                           java.lang.String[] dataSourceNames)
                    throws java.lang.Exception

Populates the specified template document with data from the specified sources making it a ready report.

Remarks:

Using this overload you can reference multiple data source objects and their members in the template. The name of the first data source can be omitted (i.e. be an empty string or null) if you are going to reference the data source's members but not the data source object itself. Names of the other data sources must be specified and unique.

If you are going to use a single data source, consider using of buildReport(com.aspose.words.Document, java.lang.Object) and buildReport(com.aspose.words.Document, java.lang.Object, java.lang.String) overloads instead.

A data source object can be of one of the following types:

• XmlDataSource
• JsonDataSource
• CsvDataSource
• DataSet
• DataTable
• DataRow
• IDataReader
• IDataRecord
• DataView
• DataRowView
• Any other arbitrary Java type

For information on how to work with data sources of different types in template documents, see template syntax reference(https://docs.aspose.com/display/wordsjava/Template+Syntax).

Examples:

Shows how to work with charts from word 2016.

 
 Document doc = new Document(getMyDir() + "Reporting engine template - Word 2016 Charts (Java).docx");

 ReportingEngine engine = new ReportingEngine();
 engine.buildReport(doc, new Object[] { Common.getShares(), Common.getShareQuotes() },
         new String[] { "shares", "quotes" });

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

Shows how to keep inserted numbering as is.

 
 // By default, numbered lists from a template document are continued when their identifiers match those from a document being inserted.
 // With "-sourceNumbering" numbering should be separated and kept as is.
 Document template = DocumentHelper.createSimpleDocument("<<doc [src.getDocument()]>>" + System.lineSeparator() + "<<doc [src.getDocument()] -sourceNumbering>>");

 DocumentTestClass doc = new DocumentTestBuilder()
         .withDocument(new Document(getMyDir() + "List item.docx")).build();

 ReportingEngine engine = new ReportingEngine(); { engine.setOptions(ReportBuildOptions.REMOVE_EMPTY_PARAGRAPHS); }
 engine.buildReport(template, new Object[] { doc }, new String[] { "src" });

 template.save(getArtifactsDir() + "ReportingEngine.SourseListNumbering.docx");
 
 

Parameters:

document - A template document to be populated with data.

dataSources - An array of data source objects.

dataSourceNames - An array of names to reference the data source objects within the template.

Returns:

A flag indicating whether parsing of the template document was successful. The returned flag makes sense only if a value of the getOptions() / setOptions(int) property includes the ReportBuildOptions.INLINE_ERROR_MESSAGES option.

Throws:

java.lang.Exception

setRestrictedTypes

public static void setRestrictedTypes(java.lang.Class... types)

Specifies types, which members as well as which derived types' members should be inaccessible by the engine through template syntax.

Remarks:

Restricted types should be set before the very first building of a report. After BuildReportbuildReport is invoked, restricted types cannot be modified and an exception is thrown on attempt to do this. The best place to set restricted types is application startup.

Note that a big amount of restricted types may affect performance, so it is better to restrict only those types, access to which members is really sensitive.

Throws IllegalArgumentException in the following cases:

- types is null.

- One of types items is null.

- One of types items represents an invisible type, i.e. a non-public type or a public nested type which has a non-public outer type.

- One of types items represents an array type.

- types contain duplicate entries.

Examples:

Shows how to deny access to members of types considered insecure.

 
 Document doc =
         DocumentHelper.createSimpleDocument(
                 "<<var [typeVar = \"\".getClass().getName()]>><<[typeVar]>>");

 // Note, that you can't set restricted types during or after building a report.
 ReportingEngine.setRestrictedTypes(Class.class);
 // We set "AllowMissingMembers" option to avoid exceptions during building a report.
 ReportingEngine engine = new ReportingEngine();
 engine.setOptions(ReportBuildOptions.ALLOW_MISSING_MEMBERS);
 engine.buildReport(doc, new Object());

 // We get an empty string because we can't access the GetType() method.
 Assert.assertEquals(doc.getText().trim(), "");
 
 

Parameters:

types - Types to be restricted.

getRestrictedTypes

public static java.lang.Class[] getRestrictedTypes()

Returns types, which members as well as which derived types' members should be inaccessible by the engine through template syntax.

Remarks:

The returned array contains items previously set using setRestrictedTypes(java.lang.Class[]).

Changing items of the returned array has no effect on restricted types. To change restricted types, use setRestrictedTypes(java.lang.Class[]) instead.

Returns:

Types, which members as well as which derived types' members should be inaccessible by the engine through template syntax.

getOptions

public int getOptions()

Gets a set of flags controlling behavior of this ReportingEngine instance while building a report.

Examples:

Shows how to allow missinng members.

 
 DocumentBuilder builder = new DocumentBuilder();
 builder.writeln("<<[missingObject.First().id]>>");
 builder.writeln("<<foreach [in missingObject]>><<[id]>><</foreach>>");

 ReportingEngine engine = new ReportingEngine(); { engine.setOptions(ReportBuildOptions.ALLOW_MISSING_MEMBERS); }
 engine.setMissingMemberMessage("Missed");
 engine.buildReport(builder.getDocument(), new DataSet(), "");
 
 

Shows how to set options for Reporting Engine

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

 // Note that enabling of the option makes the engine to update fields while building a report,
 // so there is no need to update fields separately after that.
 ReportingEngine engine = new ReportingEngine();
 engine.setOptions(ReportBuildOptions.UPDATE_FIELDS_SYNTAX_AWARE);
 engine.buildReport(doc, new String[] { "First topic", "Second topic", "Third topic" }, "topics");

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

Returns:

A set of flags controlling behavior of this ReportingEngine instance while building a report. The returned value is a bitwise combination of ReportBuildOptions constants.

setOptions

public void setOptions(int value)

Sets a set of flags controlling behavior of this ReportingEngine instance while building a report.

Examples:

Shows how to allow missinng members.

 
 DocumentBuilder builder = new DocumentBuilder();
 builder.writeln("<<[missingObject.First().id]>>");
 builder.writeln("<<foreach [in missingObject]>><<[id]>><</foreach>>");

 ReportingEngine engine = new ReportingEngine(); { engine.setOptions(ReportBuildOptions.ALLOW_MISSING_MEMBERS); }
 engine.setMissingMemberMessage("Missed");
 engine.buildReport(builder.getDocument(), new DataSet(), "");
 
 

Shows how to set options for Reporting Engine

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

 // Note that enabling of the option makes the engine to update fields while building a report,
 // so there is no need to update fields separately after that.
 ReportingEngine engine = new ReportingEngine();
 engine.setOptions(ReportBuildOptions.UPDATE_FIELDS_SYNTAX_AWARE);
 engine.buildReport(doc, new String[] { "First topic", "Second topic", "Third topic" }, "topics");

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

Parameters:

value - A set of flags controlling behavior of this ReportingEngine instance while building a report. The value must be a bitwise combination of ReportBuildOptions constants.

getMissingMemberMessage

public java.lang.String getMissingMemberMessage()

Gets a string value printed instead of a template expression that represents a plain reference to a missing member of an object. The default value is an empty string.

Remarks:

The property should be used in conjunction with the ReportBuildOptions.ALLOW_MISSING_MEMBERS option. Otherwise, an exception is thrown when a missing member of an object is encountered.

The property affects only printing of a template expression representing a plain reference to a missing object member. For example, printing of a binary operator, one of which operands references a missing object member, is not affected.

The value of this property cannot be set to null.

Examples:

Shows how to allow missinng members.

 
 DocumentBuilder builder = new DocumentBuilder();
 builder.writeln("<<[missingObject.First().id]>>");
 builder.writeln("<<foreach [in missingObject]>><<[id]>><</foreach>>");

 ReportingEngine engine = new ReportingEngine(); { engine.setOptions(ReportBuildOptions.ALLOW_MISSING_MEMBERS); }
 engine.setMissingMemberMessage("Missed");
 engine.buildReport(builder.getDocument(), new DataSet(), "");
 
 

Returns:

A string value printed instead of a template expression that represents a plain reference to a missing member of an object.

setMissingMemberMessage

public void setMissingMemberMessage(java.lang.String value)

Sets a string value printed instead of a template expression that represents a plain reference to a missing member of an object. The default value is an empty string.

Remarks:

The property should be used in conjunction with the ReportBuildOptions.ALLOW_MISSING_MEMBERS option. Otherwise, an exception is thrown when a missing member of an object is encountered.

The property affects only printing of a template expression representing a plain reference to a missing object member. For example, printing of a binary operator, one of which operands references a missing object member, is not affected.

The value of this property cannot be set to null.

Examples:

Shows how to allow missinng members.

 
 DocumentBuilder builder = new DocumentBuilder();
 builder.writeln("<<[missingObject.First().id]>>");
 builder.writeln("<<foreach [in missingObject]>><<[id]>><</foreach>>");

 ReportingEngine engine = new ReportingEngine(); { engine.setOptions(ReportBuildOptions.ALLOW_MISSING_MEMBERS); }
 engine.setMissingMemberMessage("Missed");
 engine.buildReport(builder.getDocument(), new DataSet(), "");
 
 

Parameters:

value - A string value printed instead of a template expression that represents a plain reference to a missing member of an object.

getKnownTypes

public KnownTypeSet getKnownTypes()

Gets an unordered set (i.e. a collection of unique items) containing Class objects which fully or partially qualified names can be used within report templates processed by this engine instance to invoke the corresponding types' static members, perform type casts, etc.

Returns:

An unordered set (i.e.

getUseReflectionOptimization

public static boolean getUseReflectionOptimization()

Gets a value indicating whether invocations of custom type members performed via reflection API are optimized using dynamic class generation or not. The default value is true.

Remarks:

There are some scenarios where it is preferrable to disable this optimization. For example, if you are dealing with small collections of data items all the time, then an overhead of dynamic class generation can be more noticeable than an overhead of direct reflection API calls. The option does not have effect when run on iOS and reflection optimization is not used.

Returns:

A value indicating whether invocations of custom type members performed via reflection API are optimized using dynamic class generation or not.

setUseReflectionOptimization

public static void setUseReflectionOptimization(boolean value)

Sets a value indicating whether invocations of custom type members performed via reflection API are optimized using dynamic class generation or not. The default value is true.

Remarks:

There are some scenarios where it is preferrable to disable this optimization. For example, if you are dealing with small collections of data items all the time, then an overhead of dynamic class generation can be more noticeable than an overhead of direct reflection API calls. The option does not have effect when run on iOS and reflection optimization is not used.

Parameters:

value - A value indicating whether invocations of custom type members performed via reflection API are optimized using dynamic class generation or not.