com.aspose.words

Class ReportBuilderOptions

java.lang.Object

com.aspose.words.ReportBuilderOptions

public class ReportBuilderOptions
extends java.lang.Object

Represents options for the LINQ Reporting Engine functionality.

Examples:

Shows how to populate document with data.

 
 public void buildReportData() throws Exception {
     // There is a several ways to populate document with data:
     String doc = getMyDir() + "Reporting engine template - If greedy (Java).docx";

     AsposeData obj = new AsposeData();
     {
         obj.setList(new ArrayList<>());
         {
             obj.getList().add("abc");
         }
     }

     ReportBuilder.buildReport(doc, getArtifactsDir() + "LowCode.BuildReportWithObject.1.docx", obj);
     ReportBuilderOptions options = new ReportBuilderOptions();
     options.setOptions(ReportBuildOptions.ALLOW_MISSING_MEMBERS);
     ReportBuilder.buildReport(doc, getArtifactsDir() + "LowCode.BuildReportWithObject.2.docx", obj, options);
     ReportBuilder.buildReport(doc, getArtifactsDir() + "LowCode.BuildReportWithObject.3.docx", SaveFormat.DOCX, obj);
     ReportBuilder.buildReport(doc, getArtifactsDir() + "LowCode.BuildReportWithObject.4.docx", SaveFormat.DOCX, obj, options);
 }

 public static class AsposeData {
     public ArrayList<String> getList() {
         return mList;
     }

     ;

     public void setList(ArrayList<String> value) {
         mList = value;
     }

     ;

     private ArrayList<String> mList;
 }
 
 

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
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.
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.

Methods inherited from class java.lang.Object

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

Constructor Detail

ReportBuilderOptions

public ReportBuilderOptions()

Initializes a new instance of this class.

Method Detail

getOptions

public int getOptions()

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

Examples:

Shows how to populate document with data.

 
 public void buildReportData() throws Exception {
     // There is a several ways to populate document with data:
     String doc = getMyDir() + "Reporting engine template - If greedy (Java).docx";

     AsposeData obj = new AsposeData();
     {
         obj.setList(new ArrayList<>());
         {
             obj.getList().add("abc");
         }
     }

     ReportBuilder.buildReport(doc, getArtifactsDir() + "LowCode.BuildReportWithObject.1.docx", obj);
     ReportBuilderOptions options = new ReportBuilderOptions();
     options.setOptions(ReportBuildOptions.ALLOW_MISSING_MEMBERS);
     ReportBuilder.buildReport(doc, getArtifactsDir() + "LowCode.BuildReportWithObject.2.docx", obj, options);
     ReportBuilder.buildReport(doc, getArtifactsDir() + "LowCode.BuildReportWithObject.3.docx", SaveFormat.DOCX, obj);
     ReportBuilder.buildReport(doc, getArtifactsDir() + "LowCode.BuildReportWithObject.4.docx", SaveFormat.DOCX, obj, options);
 }

 public static class AsposeData {
     public ArrayList<String> getList() {
         return mList;
     }

     ;

     public void setList(ArrayList<String> value) {
         mList = value;
     }

     ;

     private ArrayList<String> mList;
 }
 
 

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 populate document with data.

 
 public void buildReportData() throws Exception {
     // There is a several ways to populate document with data:
     String doc = getMyDir() + "Reporting engine template - If greedy (Java).docx";

     AsposeData obj = new AsposeData();
     {
         obj.setList(new ArrayList<>());
         {
             obj.getList().add("abc");
         }
     }

     ReportBuilder.buildReport(doc, getArtifactsDir() + "LowCode.BuildReportWithObject.1.docx", obj);
     ReportBuilderOptions options = new ReportBuilderOptions();
     options.setOptions(ReportBuildOptions.ALLOW_MISSING_MEMBERS);
     ReportBuilder.buildReport(doc, getArtifactsDir() + "LowCode.BuildReportWithObject.2.docx", obj, options);
     ReportBuilder.buildReport(doc, getArtifactsDir() + "LowCode.BuildReportWithObject.3.docx", SaveFormat.DOCX, obj);
     ReportBuilder.buildReport(doc, getArtifactsDir() + "LowCode.BuildReportWithObject.4.docx", SaveFormat.DOCX, obj, options);
 }

 public static class AsposeData {
     public ArrayList<String> getList() {
         return mList;
     }

     ;

     public void setList(ArrayList<String> value) {
         mList = value;
     }

     ;

     private ArrayList<String> mList;
 }
 
 

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.

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.

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.