com.aspose.words
Class ReportingEngine

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

Constructor Summary
ReportingEngine()
           Initializes a new instance of this class.
 
Property Getters/Setters Summary
KnownTypeSetgetKnownTypes()
           Gets an unordered set (i.e. a collection of unique items) containing java.lang.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.
static booleangetUseReflectionOptimization()
static voidsetUseReflectionOptimization(boolean value)
           Gets or 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.
 
Method Summary
voidbuildReport(Document document, java.lang.Object dataSource)
           Populates the specified template document with data from the specified source making it a ready report.
voidbuildReport(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.
 

Constructor Detail

ReportingEngine

public ReportingEngine()
Initializes a new instance of this class.

Property Getters/Setters Detail

getKnownTypes

public KnownTypeSet getKnownTypes()
Gets an unordered set (i.e. a collection of unique items) containing java.lang.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.

getUseReflectionOptimization/setUseReflectionOptimization

public static boolean getUseReflectionOptimization() / public static void setUseReflectionOptimization(boolean value)
Gets or 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.

Method Detail

buildReport

public void 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 can not 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.
Parameters:
document - A template document to be populated with data.
dataSource - A data source object.

buildReport

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

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