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.
boolean	equals(java.lang.Object obj)
KnownTypeSet	getKnownTypes() Gets an unordered set (i.e.
int	getOptions() Gets a set of flags controlling behavior of this ReportingEngine instance while building a report.
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.
int	hashCode()
void	setOptions(int value) Sets a set of flags controlling behavior of this ReportingEngine instance while building a report.
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, finalize, getClass, 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.

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.

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).

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.

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).

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

hashCode

public final int hashCode()

Overrides:

hashCode in class java.lang.Object

equals

public final boolean equals(java.lang.Object obj)

Overrides:

equals in class java.lang.Object

getOptions

public int getOptions()

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

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.

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.

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. 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. 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.