com.aspose.words

Class ReportBuilder

java.lang.Object

com.aspose.words.Processor

com.aspose.words.ReportBuilder

public class ReportBuilder
extends Processor

Provides methods intended to fill template with data using LINQ Reporting Engine.

Field Summary

Fields inherited from class com.aspose.words.Processor

mResultDocument

Method Summary

Modifier and Type	Method and Description
static void	buildReport(java.io.InputStream inputStream, java.io.OutputStream outputStream, int saveFormat, java.lang.Object data)
static void	buildReport(java.io.InputStream inputStream, java.io.OutputStream outputStream, int saveFormat, java.lang.Object[] data, java.lang.String[] dataSourceNames)
static void	buildReport(java.io.InputStream inputStream, java.io.OutputStream outputStream, int saveFormat, java.lang.Object[] data, java.lang.String[] dataSourceNames, ReportBuilderOptions reportBuilderOptions)
static void	buildReport(java.io.InputStream inputStream, java.io.OutputStream outputStream, int saveFormat, java.lang.Object data, ReportBuilderOptions reportBuilderOptions)
static void	buildReport(java.io.InputStream inputStream, java.io.OutputStream outputStream, int saveFormat, java.lang.Object data, java.lang.String dataSourceName)
static void	buildReport(java.io.InputStream inputStream, java.io.OutputStream outputStream, int saveFormat, java.lang.Object data, java.lang.String dataSourceName, ReportBuilderOptions reportBuilderOptions)
static void	buildReport(java.io.InputStream inputStream, java.io.OutputStream outputStream, SaveOptions saveOptions, java.lang.Object data)
static void	buildReport(java.io.InputStream inputStream, java.io.OutputStream outputStream, SaveOptions saveOptions, java.lang.Object[] data, java.lang.String[] dataSourceNames)
static void	buildReport(java.io.InputStream inputStream, java.io.OutputStream outputStream, SaveOptions saveOptions, java.lang.Object[] data, java.lang.String[] dataSourceNames, ReportBuilderOptions reportBuilderOptions)
static void	buildReport(java.io.InputStream inputStream, java.io.OutputStream outputStream, SaveOptions saveOptions, java.lang.Object data, ReportBuilderOptions reportBuilderOptions)
static void	buildReport(java.io.InputStream inputStream, java.io.OutputStream outputStream, SaveOptions saveOptions, java.lang.Object data, java.lang.String dataSourceName)
static void	buildReport(java.io.InputStream inputStream, java.io.OutputStream outputStream, SaveOptions saveOptions, java.lang.Object data, java.lang.String dataSourceName, ReportBuilderOptions reportBuilderOptions)
static void	buildReport(java.lang.String inputFileName, java.lang.String outputFileName, int saveFormat, java.lang.Object data)
static void	buildReport(java.lang.String inputFileName, java.lang.String outputFileName, int saveFormat, java.lang.Object[] data, java.lang.String[] dataSourceNames)
static void	buildReport(java.lang.String inputFileName, java.lang.String outputFileName, int saveFormat, java.lang.Object[] data, java.lang.String[] dataSourceNames, ReportBuilderOptions reportBuilderOptions)
static void	buildReport(java.lang.String inputFileName, java.lang.String outputFileName, int saveFormat, java.lang.Object data, ReportBuilderOptions reportBuilderOptions)
static void	buildReport(java.lang.String inputFileName, java.lang.String outputFileName, int saveFormat, java.lang.Object data, java.lang.String dataSourceName)
static void	buildReport(java.lang.String inputFileName, java.lang.String outputFileName, int saveFormat, java.lang.Object data, java.lang.String dataSourceName, ReportBuilderOptions reportBuilderOptions)
static void	buildReport(java.lang.String inputFileName, java.lang.String outputFileName, java.lang.Object data)
static void	buildReport(java.lang.String inputFileName, java.lang.String outputFileName, java.lang.Object[] data, java.lang.String[] dataSourceNames)
static void	buildReport(java.lang.String inputFileName, java.lang.String outputFileName, java.lang.Object[] data, java.lang.String[] dataSourceNames, ReportBuilderOptions reportBuilderOptions) Populates the template document with data from multiple sources, generating a completed report with additional options.
static void	buildReport(java.lang.String inputFileName, java.lang.String outputFileName, java.lang.Object data, ReportBuilderOptions reportBuilderOptions) Populates the template document with data from the specified source, generating a completed report with additional options.
static void	buildReport(java.lang.String inputFileName, java.lang.String outputFileName, java.lang.Object data, java.lang.String dataSourceName)
static void	buildReport(java.lang.String inputFileName, java.lang.String outputFileName, java.lang.Object data, java.lang.String dataSourceName, ReportBuilderOptions reportBuilderOptions) Populates the template document with data from the specified source, generating a completed report with a named data source reference and additional options.
static void	buildReport(java.lang.String inputFileName, java.lang.String outputFileName, SaveOptions saveOptions, java.lang.Object data)
static void	buildReport(java.lang.String inputFileName, java.lang.String outputFileName, SaveOptions saveOptions, java.lang.Object[] data, java.lang.String[] dataSourceNames)
static void	buildReport(java.lang.String inputFileName, java.lang.String outputFileName, SaveOptions saveOptions, java.lang.Object[] data, java.lang.String[] dataSourceNames, ReportBuilderOptions reportBuilderOptions) Populates the template document with data from multiple sources, generating a completed report with a specified output format and additional options.
static void	buildReport(java.lang.String inputFileName, java.lang.String outputFileName, SaveOptions saveOptions, java.lang.Object data, ReportBuilderOptions reportBuilderOptions) Populates the template document with data from the specified source, generating a completed report with specified output format and additional options.
static void	buildReport(java.lang.String inputFileName, java.lang.String outputFileName, SaveOptions saveOptions, java.lang.Object data, java.lang.String dataSourceName)
static void	buildReport(java.lang.String inputFileName, java.lang.String outputFileName, SaveOptions saveOptions, java.lang.Object data, java.lang.String dataSourceName, ReportBuilderOptions reportBuilderOptions) Populates the template document with data from the specified source, generating a completed report with specified output format, a named data source reference, and additional options.
static java.io.OutputStream[]	buildReportToImages(java.io.InputStream inputStream, ImageSaveOptions saveOptions, java.lang.Object[] data, java.lang.String[] dataSourceNames)
static java.io.OutputStream[]	buildReportToImages(java.io.InputStream inputStream, ImageSaveOptions saveOptions, java.lang.Object[] data, java.lang.String[] dataSourceNames, ReportBuilderOptions reportBuilderOptions) Populates the template document with data from multiple sources.
static java.io.OutputStream[]	buildReportToImages(java.lang.String inputFileName, ImageSaveOptions saveOptions, java.lang.Object[] data, java.lang.String[] dataSourceNames)
static java.io.OutputStream[]	buildReportToImages(java.lang.String inputFileName, ImageSaveOptions saveOptions, java.lang.Object[] data, java.lang.String[] dataSourceNames, ReportBuilderOptions reportBuilderOptions) Populates the template document with data from multiple sources.
static ReportBuilder	create() Creates new instance of the report builder processor.
static ReportBuilder	create(ReportBuilderContext context) Creates new instance of the report builder processor.
protected void	executeCore()

Methods inherited from class com.aspose.words.Processor

checkArgumentsSet, execute, from, from, from, from, getPartFileName, to, to, to, to, to, to, to, toOutput, toOutput

Methods inherited from class java.lang.Object

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

Method Detail

create

public static ReportBuilder create()

Creates new instance of the report builder processor.

create

public static ReportBuilder create(ReportBuilderContext context)

Creates new instance of the report builder processor.

Examples:

Shows how to populate document with data sources using documents from the stream.

 
 // There is a several ways to populate document with data sources using documents from the stream:
 MessageTestClass sender = new MessageTestClass("LINQ Reporting Engine", "Hello World");

 try (FileInputStream streamIn = new FileInputStream(getMyDir() + "Report building.docx")) {
     try (FileOutputStream streamOut = new FileOutputStream(getArtifactsDir() + "LowCode.BuildReportDataSourceStream.1.docx")) {
         ReportBuilder.buildReport(streamIn, streamOut, SaveFormat.DOCX, new Object[]{sender}, new String[]{"s"});
     }

     try (FileOutputStream streamOut1 = new FileOutputStream(getArtifactsDir() + "LowCode.BuildReportDataSourceStream.2.docx")) {
         ReportBuilder.buildReport(streamIn, streamOut1, SaveFormat.DOCX, sender, "s");
     }

     try (FileOutputStream streamOut2 = new FileOutputStream(getArtifactsDir() + "LowCode.BuildReportDataSourceStream.3.docx")) {
         ReportBuilderOptions options = new ReportBuilderOptions();
         options.setOptions(ReportBuildOptions.ALLOW_MISSING_MEMBERS);
         ReportBuilder.buildReport(streamIn, streamOut2, SaveFormat.DOCX, sender, "s", options);
     }

     ReportBuilderOptions options = new ReportBuilderOptions();
     options.setOptions(ReportBuildOptions.ALLOW_MISSING_MEMBERS);
     OutputStream[] images = ReportBuilder.buildReportToImages(streamIn, new ImageSaveOptions(SaveFormat.PNG), new Object[]{sender}, new String[]{"s"}, options);

     ReportBuilderContext reportBuilderContext = new ReportBuilderContext();
     reportBuilderContext.getReportBuilderOptions().setMissingMemberMessage("Missed members");
     reportBuilderContext.getDataSources().put(sender, "s");

     try (FileOutputStream streamOut3 = new FileOutputStream(getArtifactsDir() + "LowCode.BuildReportDataSourceStream.4.docx")) {
         ReportBuilder.create(reportBuilderContext)
                 .from(streamIn)
                 .to(streamOut3, SaveFormat.DOCX)
                 .execute();
     }
 }
 
 

Shows how to populate document with data sources.

 
 public void buildReportDataSource() throws Exception {
     // There is a several ways to populate document with data sources:
     String doc = getMyDir() + "Report building.docx";

     MessageTestClass sender = new MessageTestClass("LINQ Reporting Engine", "Hello World");

     ReportBuilderOptions options = new ReportBuilderOptions();
     options.setOptions(ReportBuildOptions.ALLOW_MISSING_MEMBERS);

     ReportBuilder.buildReport(doc, getArtifactsDir() + "LowCode.BuildReportDataSource.1.docx", sender, "s");
     ReportBuilder.buildReport(doc, getArtifactsDir() + "LowCode.BuildReportDataSource.2.docx", new Object[]{sender}, new String[]{"s"});
     ReportBuilder.buildReport(doc, getArtifactsDir() + "LowCode.BuildReportDataSource.3.docx", sender, "s", options);
     ReportBuilder.buildReport(doc, getArtifactsDir() + "LowCode.BuildReportDataSource.4.docx", SaveFormat.DOCX, sender, "s");
     ReportBuilder.buildReport(doc, getArtifactsDir() + "LowCode.BuildReportDataSource.5.docx", SaveFormat.DOCX, new Object[]{sender}, new String[]{"s"});
     ReportBuilder.buildReport(doc, getArtifactsDir() + "LowCode.BuildReportDataSource.6.docx", SaveFormat.DOCX, sender, "s", options);
     ReportBuilder.buildReport(doc, getArtifactsDir() + "LowCode.BuildReportDataSource.7.docx", SaveFormat.DOCX, new Object[]{sender}, new String[]{"s"}, options);
     ReportBuilder.buildReport(doc, getArtifactsDir() + "LowCode.BuildReportDataSource.8.docx", new Object[]{sender}, new String[]{"s"}, options);

     options = new ReportBuilderOptions();
     options.setOptions(ReportBuildOptions.ALLOW_MISSING_MEMBERS);
     OutputStream[] images = ReportBuilder.buildReportToImages(doc, new ImageSaveOptions(SaveFormat.PNG), new Object[]{sender}, new String[]{"s"}, options);

     ReportBuilderContext reportBuilderContext = new ReportBuilderContext();
     reportBuilderContext.getReportBuilderOptions().setMissingMemberMessage("Missed members");
     reportBuilderContext.getDataSources().put(sender, "s");

     ReportBuilder.create(reportBuilderContext)
             .from(doc)
             .to(getArtifactsDir() + "LowCode.BuildReportDataSource.9.docx")
             .execute();
 }

 public static class MessageTestClass {
     public String getName() {
         return mName;
     }

     public void setName(String value) {
         mName = value;
     }

     private String mName;

     public String getMessage() {
         return mMessage;
     }

     public void setMessage(String value) {
         mMessage = value;
     }

     private String mMessage;

     public MessageTestClass(String name, String message) {
         setName(name);
         setMessage(message);
     }
 }
 
 

executeCore

protected void executeCore()
                    throws java.lang.Exception

Overrides:

executeCore in class Processor

Throws:

java.lang.Exception

buildReport

public static void buildReport(java.lang.String inputFileName,
                               java.lang.String outputFileName,
                               java.lang.Object data)
                        throws java.lang.Exception

Throws:

java.lang.Exception

buildReport

public static void buildReport(java.lang.String inputFileName,
                               java.lang.String outputFileName,
                               java.lang.Object data,
                               ReportBuilderOptions reportBuilderOptions)
                        throws java.lang.Exception

Populates the template document with data from the specified source, generating a completed report with additional options.

Remarks:

If the output format is an image (BMP, EMF, EPS, GIF, JPEG, PNG, or WebP), each page of the output will be saved as a separate file. The specified output file name will be used to generate file names for each part following the rule: outputFile_partIndex.extension.

If the output format is TIFF, the output will be saved as a single multi-frame TIFF file.

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:

inputFileName - The input file name.

outputFileName - The output file name.

data - A data source object.

reportBuilderOptions - Additional report build options.

Throws:

java.lang.Exception

buildReport

public static void buildReport(java.lang.String inputFileName,
                               java.lang.String outputFileName,
                               int saveFormat,
                               java.lang.Object data)
                        throws java.lang.Exception

Throws:

java.lang.Exception

buildReport

public static void buildReport(java.lang.String inputFileName,
                               java.lang.String outputFileName,
                               int saveFormat,
                               java.lang.Object data,
                               ReportBuilderOptions reportBuilderOptions)
                        throws java.lang.Exception

Throws:

java.lang.Exception

buildReport

public static void buildReport(java.lang.String inputFileName,
                               java.lang.String outputFileName,
                               SaveOptions saveOptions,
                               java.lang.Object data)
                        throws java.lang.Exception

Throws:

java.lang.Exception

buildReport

public static void buildReport(java.lang.String inputFileName,
                               java.lang.String outputFileName,
                               SaveOptions saveOptions,
                               java.lang.Object data,
                               ReportBuilderOptions reportBuilderOptions)
                        throws java.lang.Exception

Populates the template document with data from the specified source, generating a completed report with specified output format and additional options.

Remarks:

If the output format is an image (BMP, EMF, EPS, GIF, JPEG, PNG, or WebP), each page of the output will be saved as a separate file. The specified output file name will be used to generate file names for each part following the rule: outputFile_partIndex.extension.

If the output format is TIFF, the output will be saved as a single multi-frame TIFF file.

Parameters:

inputFileName - The input file name.

outputFileName - The output file name.

saveOptions - The output's save options.

data - A data source object.

reportBuilderOptions - Additional report build options.

Throws:

java.lang.Exception

buildReport

public static void buildReport(java.io.InputStream inputStream,
                               java.io.OutputStream outputStream,
                               int saveFormat,
                               java.lang.Object data)
                        throws java.lang.Exception

Throws:

java.lang.Exception

buildReport

public static void buildReport(java.io.InputStream inputStream,
                               java.io.OutputStream outputStream,
                               int saveFormat,
                               java.lang.Object data,
                               ReportBuilderOptions reportBuilderOptions)
                        throws java.lang.Exception

Throws:

java.lang.Exception

buildReport

public static void buildReport(java.io.InputStream inputStream,
                               java.io.OutputStream outputStream,
                               SaveOptions saveOptions,
                               java.lang.Object data)
                        throws java.lang.Exception

Throws:

java.lang.Exception

buildReport

public static void buildReport(java.io.InputStream inputStream,
                               java.io.OutputStream outputStream,
                               SaveOptions saveOptions,
                               java.lang.Object data,
                               ReportBuilderOptions reportBuilderOptions)
                        throws java.lang.Exception

Throws:

java.lang.Exception

buildReport

public static void buildReport(java.lang.String inputFileName,
                               java.lang.String outputFileName,
                               java.lang.Object data,
                               java.lang.String dataSourceName)
                        throws java.lang.Exception

Throws:

java.lang.Exception

buildReport

public static void buildReport(java.lang.String inputFileName,
                               java.lang.String outputFileName,
                               java.lang.Object data,
                               java.lang.String dataSourceName,
                               ReportBuilderOptions reportBuilderOptions)
                        throws java.lang.Exception

Populates the template document with data from the specified source, generating a completed report with a named data source reference and additional options.

Remarks:

If the output format is an image (BMP, EMF, EPS, GIF, JPEG, PNG, or WebP), each page of the output will be saved as a separate file. The specified output file name will be used to generate file names for each part following the rule: outputFile_partIndex.extension.

If the output format is TIFF, the output will be saved as a single multi-frame TIFF file.

Examples:

Shows how to populate document with data sources.

 
 public void buildReportDataSource() throws Exception {
     // There is a several ways to populate document with data sources:
     String doc = getMyDir() + "Report building.docx";

     MessageTestClass sender = new MessageTestClass("LINQ Reporting Engine", "Hello World");

     ReportBuilderOptions options = new ReportBuilderOptions();
     options.setOptions(ReportBuildOptions.ALLOW_MISSING_MEMBERS);

     ReportBuilder.buildReport(doc, getArtifactsDir() + "LowCode.BuildReportDataSource.1.docx", sender, "s");
     ReportBuilder.buildReport(doc, getArtifactsDir() + "LowCode.BuildReportDataSource.2.docx", new Object[]{sender}, new String[]{"s"});
     ReportBuilder.buildReport(doc, getArtifactsDir() + "LowCode.BuildReportDataSource.3.docx", sender, "s", options);
     ReportBuilder.buildReport(doc, getArtifactsDir() + "LowCode.BuildReportDataSource.4.docx", SaveFormat.DOCX, sender, "s");
     ReportBuilder.buildReport(doc, getArtifactsDir() + "LowCode.BuildReportDataSource.5.docx", SaveFormat.DOCX, new Object[]{sender}, new String[]{"s"});
     ReportBuilder.buildReport(doc, getArtifactsDir() + "LowCode.BuildReportDataSource.6.docx", SaveFormat.DOCX, sender, "s", options);
     ReportBuilder.buildReport(doc, getArtifactsDir() + "LowCode.BuildReportDataSource.7.docx", SaveFormat.DOCX, new Object[]{sender}, new String[]{"s"}, options);
     ReportBuilder.buildReport(doc, getArtifactsDir() + "LowCode.BuildReportDataSource.8.docx", new Object[]{sender}, new String[]{"s"}, options);

     options = new ReportBuilderOptions();
     options.setOptions(ReportBuildOptions.ALLOW_MISSING_MEMBERS);
     OutputStream[] images = ReportBuilder.buildReportToImages(doc, new ImageSaveOptions(SaveFormat.PNG), new Object[]{sender}, new String[]{"s"}, options);

     ReportBuilderContext reportBuilderContext = new ReportBuilderContext();
     reportBuilderContext.getReportBuilderOptions().setMissingMemberMessage("Missed members");
     reportBuilderContext.getDataSources().put(sender, "s");

     ReportBuilder.create(reportBuilderContext)
             .from(doc)
             .to(getArtifactsDir() + "LowCode.BuildReportDataSource.9.docx")
             .execute();
 }

 public static class MessageTestClass {
     public String getName() {
         return mName;
     }

     public void setName(String value) {
         mName = value;
     }

     private String mName;

     public String getMessage() {
         return mMessage;
     }

     public void setMessage(String value) {
         mMessage = value;
     }

     private String mMessage;

     public MessageTestClass(String name, String message) {
         setName(name);
         setMessage(message);
     }
 }
 
 

Parameters:

inputFileName - The input file name.

outputFileName - The output file name.

data - A data source object.

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

reportBuilderOptions - Additional report build options.

Throws:

java.lang.Exception

buildReport

public static void buildReport(java.lang.String inputFileName,
                               java.lang.String outputFileName,
                               int saveFormat,
                               java.lang.Object data,
                               java.lang.String dataSourceName)
                        throws java.lang.Exception

Throws:

java.lang.Exception

buildReport

public static void buildReport(java.lang.String inputFileName,
                               java.lang.String outputFileName,
                               int saveFormat,
                               java.lang.Object data,
                               java.lang.String dataSourceName,
                               ReportBuilderOptions reportBuilderOptions)
                        throws java.lang.Exception

Throws:

java.lang.Exception

buildReport

public static void buildReport(java.lang.String inputFileName,
                               java.lang.String outputFileName,
                               SaveOptions saveOptions,
                               java.lang.Object data,
                               java.lang.String dataSourceName)
                        throws java.lang.Exception

Throws:

java.lang.Exception

buildReport

public static void buildReport(java.lang.String inputFileName,
                               java.lang.String outputFileName,
                               SaveOptions saveOptions,
                               java.lang.Object data,
                               java.lang.String dataSourceName,
                               ReportBuilderOptions reportBuilderOptions)
                        throws java.lang.Exception

Populates the template document with data from the specified source, generating a completed report with specified output format, a named data source reference, and additional options.

Remarks:

If the output format is an image (BMP, EMF, EPS, GIF, JPEG, PNG, or WebP), each page of the output will be saved as a separate file. The specified output file name will be used to generate file names for each part following the rule: outputFile_partIndex.extension.

If the output format is TIFF, the output will be saved as a single multi-frame TIFF file.

Parameters:

inputFileName - The input file name.

outputFileName - The output file name.

saveOptions - The output's save options.

data - A data source object.

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

reportBuilderOptions - Additional report build options.

Throws:

java.lang.Exception

buildReport

public static void buildReport(java.io.InputStream inputStream,
                               java.io.OutputStream outputStream,
                               int saveFormat,
                               java.lang.Object data,
                               java.lang.String dataSourceName)
                        throws java.lang.Exception

Throws:

java.lang.Exception

buildReport

public static void buildReport(java.io.InputStream inputStream,
                               java.io.OutputStream outputStream,
                               int saveFormat,
                               java.lang.Object data,
                               java.lang.String dataSourceName,
                               ReportBuilderOptions reportBuilderOptions)
                        throws java.lang.Exception

Throws:

java.lang.Exception

buildReport

public static void buildReport(java.io.InputStream inputStream,
                               java.io.OutputStream outputStream,
                               SaveOptions saveOptions,
                               java.lang.Object data,
                               java.lang.String dataSourceName)
                        throws java.lang.Exception

Throws:

java.lang.Exception

buildReport

public static void buildReport(java.io.InputStream inputStream,
                               java.io.OutputStream outputStream,
                               SaveOptions saveOptions,
                               java.lang.Object data,
                               java.lang.String dataSourceName,
                               ReportBuilderOptions reportBuilderOptions)
                        throws java.lang.Exception

Throws:

java.lang.Exception

buildReport

public static void buildReport(java.lang.String inputFileName,
                               java.lang.String outputFileName,
                               java.lang.Object[] data,
                               java.lang.String[] dataSourceNames)
                        throws java.lang.Exception

Throws:

java.lang.Exception

buildReport

public static void buildReport(java.lang.String inputFileName,
                               java.lang.String outputFileName,
                               java.lang.Object[] data,
                               java.lang.String[] dataSourceNames,
                               ReportBuilderOptions reportBuilderOptions)
                        throws java.lang.Exception

Populates the template document with data from multiple sources, generating a completed report with additional options. This overload automatically determines the save format based on the output file extension.

Remarks:

If the output format is an image (BMP, EMF, EPS, GIF, JPEG, PNG, or WebP), each page of the output will be saved as a separate file. The specified output file name will be used to generate file names for each part following the rule: outputFile_partIndex.extension.

If the output format is TIFF, the output will be saved as a single multi-frame TIFF file.

Examples:

Shows how to populate document with data sources.

 
 public void buildReportDataSource() throws Exception {
     // There is a several ways to populate document with data sources:
     String doc = getMyDir() + "Report building.docx";

     MessageTestClass sender = new MessageTestClass("LINQ Reporting Engine", "Hello World");

     ReportBuilderOptions options = new ReportBuilderOptions();
     options.setOptions(ReportBuildOptions.ALLOW_MISSING_MEMBERS);

     ReportBuilder.buildReport(doc, getArtifactsDir() + "LowCode.BuildReportDataSource.1.docx", sender, "s");
     ReportBuilder.buildReport(doc, getArtifactsDir() + "LowCode.BuildReportDataSource.2.docx", new Object[]{sender}, new String[]{"s"});
     ReportBuilder.buildReport(doc, getArtifactsDir() + "LowCode.BuildReportDataSource.3.docx", sender, "s", options);
     ReportBuilder.buildReport(doc, getArtifactsDir() + "LowCode.BuildReportDataSource.4.docx", SaveFormat.DOCX, sender, "s");
     ReportBuilder.buildReport(doc, getArtifactsDir() + "LowCode.BuildReportDataSource.5.docx", SaveFormat.DOCX, new Object[]{sender}, new String[]{"s"});
     ReportBuilder.buildReport(doc, getArtifactsDir() + "LowCode.BuildReportDataSource.6.docx", SaveFormat.DOCX, sender, "s", options);
     ReportBuilder.buildReport(doc, getArtifactsDir() + "LowCode.BuildReportDataSource.7.docx", SaveFormat.DOCX, new Object[]{sender}, new String[]{"s"}, options);
     ReportBuilder.buildReport(doc, getArtifactsDir() + "LowCode.BuildReportDataSource.8.docx", new Object[]{sender}, new String[]{"s"}, options);

     options = new ReportBuilderOptions();
     options.setOptions(ReportBuildOptions.ALLOW_MISSING_MEMBERS);
     OutputStream[] images = ReportBuilder.buildReportToImages(doc, new ImageSaveOptions(SaveFormat.PNG), new Object[]{sender}, new String[]{"s"}, options);

     ReportBuilderContext reportBuilderContext = new ReportBuilderContext();
     reportBuilderContext.getReportBuilderOptions().setMissingMemberMessage("Missed members");
     reportBuilderContext.getDataSources().put(sender, "s");

     ReportBuilder.create(reportBuilderContext)
             .from(doc)
             .to(getArtifactsDir() + "LowCode.BuildReportDataSource.9.docx")
             .execute();
 }

 public static class MessageTestClass {
     public String getName() {
         return mName;
     }

     public void setName(String value) {
         mName = value;
     }

     private String mName;

     public String getMessage() {
         return mMessage;
     }

     public void setMessage(String value) {
         mMessage = value;
     }

     private String mMessage;

     public MessageTestClass(String name, String message) {
         setName(name);
         setMessage(message);
     }
 }
 
 

Parameters:

inputFileName - The input file name.

outputFileName - The output file name.

data - An array of data source objects.

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

reportBuilderOptions - Additional report build options.

Throws:

java.lang.Exception

buildReport

public static void buildReport(java.lang.String inputFileName,
                               java.lang.String outputFileName,
                               int saveFormat,
                               java.lang.Object[] data,
                               java.lang.String[] dataSourceNames)
                        throws java.lang.Exception

Throws:

java.lang.Exception

buildReport

public static void buildReport(java.lang.String inputFileName,
                               java.lang.String outputFileName,
                               int saveFormat,
                               java.lang.Object[] data,
                               java.lang.String[] dataSourceNames,
                               ReportBuilderOptions reportBuilderOptions)
                        throws java.lang.Exception

Throws:

java.lang.Exception

buildReport

public static void buildReport(java.lang.String inputFileName,
                               java.lang.String outputFileName,
                               SaveOptions saveOptions,
                               java.lang.Object[] data,
                               java.lang.String[] dataSourceNames)
                        throws java.lang.Exception

Throws:

java.lang.Exception

buildReport

public static void buildReport(java.lang.String inputFileName,
                               java.lang.String outputFileName,
                               SaveOptions saveOptions,
                               java.lang.Object[] data,
                               java.lang.String[] dataSourceNames,
                               ReportBuilderOptions reportBuilderOptions)
                        throws java.lang.Exception

Populates the template document with data from multiple sources, generating a completed report with a specified output format and additional options.

Remarks:

If the output format is an image (BMP, EMF, EPS, GIF, JPEG, PNG, or WebP), each page of the output will be saved as a separate file. The specified output file name will be used to generate file names for each part following the rule: outputFile_partIndex.extension.

If the output format is TIFF, the output will be saved as a single multi-frame TIFF file.

Parameters:

inputFileName - The input file name.

outputFileName - The output file name.

saveOptions - The output's save options.

data - An array of data source objects.

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

reportBuilderOptions - Additional report build options.

Throws:

java.lang.Exception

buildReport

public static void buildReport(java.io.InputStream inputStream,
                               java.io.OutputStream outputStream,
                               int saveFormat,
                               java.lang.Object[] data,
                               java.lang.String[] dataSourceNames)
                        throws java.lang.Exception

Throws:

java.lang.Exception

buildReport

public static void buildReport(java.io.InputStream inputStream,
                               java.io.OutputStream outputStream,
                               int saveFormat,
                               java.lang.Object[] data,
                               java.lang.String[] dataSourceNames,
                               ReportBuilderOptions reportBuilderOptions)
                        throws java.lang.Exception

Throws:

java.lang.Exception

buildReport

public static void buildReport(java.io.InputStream inputStream,
                               java.io.OutputStream outputStream,
                               SaveOptions saveOptions,
                               java.lang.Object[] data,
                               java.lang.String[] dataSourceNames)
                        throws java.lang.Exception

Throws:

java.lang.Exception

buildReport

public static void buildReport(java.io.InputStream inputStream,
                               java.io.OutputStream outputStream,
                               SaveOptions saveOptions,
                               java.lang.Object[] data,
                               java.lang.String[] dataSourceNames,
                               ReportBuilderOptions reportBuilderOptions)
                        throws java.lang.Exception

Throws:

java.lang.Exception

buildReportToImages

public static java.io.OutputStream[] buildReportToImages(java.lang.String inputFileName,
                                                         ImageSaveOptions saveOptions,
                                                         java.lang.Object[] data,
                                                         java.lang.String[] dataSourceNames)
                                                  throws java.lang.Exception

Throws:

java.lang.Exception

buildReportToImages

public static java.io.OutputStream[] buildReportToImages(java.lang.String inputFileName,
                                                         ImageSaveOptions saveOptions,
                                                         java.lang.Object[] data,
                                                         java.lang.String[] dataSourceNames,
                                                         ReportBuilderOptions reportBuilderOptions)
                                                  throws java.lang.Exception

Populates the template document with data from multiple sources. Renders the output to images.

Examples:

Shows how to populate document with data sources.

 
 public void buildReportDataSource() throws Exception {
     // There is a several ways to populate document with data sources:
     String doc = getMyDir() + "Report building.docx";

     MessageTestClass sender = new MessageTestClass("LINQ Reporting Engine", "Hello World");

     ReportBuilderOptions options = new ReportBuilderOptions();
     options.setOptions(ReportBuildOptions.ALLOW_MISSING_MEMBERS);

     ReportBuilder.buildReport(doc, getArtifactsDir() + "LowCode.BuildReportDataSource.1.docx", sender, "s");
     ReportBuilder.buildReport(doc, getArtifactsDir() + "LowCode.BuildReportDataSource.2.docx", new Object[]{sender}, new String[]{"s"});
     ReportBuilder.buildReport(doc, getArtifactsDir() + "LowCode.BuildReportDataSource.3.docx", sender, "s", options);
     ReportBuilder.buildReport(doc, getArtifactsDir() + "LowCode.BuildReportDataSource.4.docx", SaveFormat.DOCX, sender, "s");
     ReportBuilder.buildReport(doc, getArtifactsDir() + "LowCode.BuildReportDataSource.5.docx", SaveFormat.DOCX, new Object[]{sender}, new String[]{"s"});
     ReportBuilder.buildReport(doc, getArtifactsDir() + "LowCode.BuildReportDataSource.6.docx", SaveFormat.DOCX, sender, "s", options);
     ReportBuilder.buildReport(doc, getArtifactsDir() + "LowCode.BuildReportDataSource.7.docx", SaveFormat.DOCX, new Object[]{sender}, new String[]{"s"}, options);
     ReportBuilder.buildReport(doc, getArtifactsDir() + "LowCode.BuildReportDataSource.8.docx", new Object[]{sender}, new String[]{"s"}, options);

     options = new ReportBuilderOptions();
     options.setOptions(ReportBuildOptions.ALLOW_MISSING_MEMBERS);
     OutputStream[] images = ReportBuilder.buildReportToImages(doc, new ImageSaveOptions(SaveFormat.PNG), new Object[]{sender}, new String[]{"s"}, options);

     ReportBuilderContext reportBuilderContext = new ReportBuilderContext();
     reportBuilderContext.getReportBuilderOptions().setMissingMemberMessage("Missed members");
     reportBuilderContext.getDataSources().put(sender, "s");

     ReportBuilder.create(reportBuilderContext)
             .from(doc)
             .to(getArtifactsDir() + "LowCode.BuildReportDataSource.9.docx")
             .execute();
 }

 public static class MessageTestClass {
     public String getName() {
         return mName;
     }

     public void setName(String value) {
         mName = value;
     }

     private String mName;

     public String getMessage() {
         return mMessage;
     }

     public void setMessage(String value) {
         mMessage = value;
     }

     private String mMessage;

     public MessageTestClass(String name, String message) {
         setName(name);
         setMessage(message);
     }
 }
 
 

Parameters:

inputFileName - The input file name.

saveOptions - The output's save options.

data - An array of data source objects.

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

reportBuilderOptions - Additional report build options.

Throws:

java.lang.Exception

buildReportToImages

public static java.io.OutputStream[] buildReportToImages(java.io.InputStream inputStream,
                                                         ImageSaveOptions saveOptions,
                                                         java.lang.Object[] data,
                                                         java.lang.String[] dataSourceNames)
                                                  throws java.lang.Exception

Throws:

java.lang.Exception

buildReportToImages

public static java.io.OutputStream[] buildReportToImages(java.io.InputStream inputStream,
                                                         ImageSaveOptions saveOptions,
                                                         java.lang.Object[] data,
                                                         java.lang.String[] dataSourceNames,
                                                         ReportBuilderOptions reportBuilderOptions)
                                                  throws java.lang.Exception

Populates the template document with data from multiple sources. Renders the output to images.

Examples:

Shows how to populate document with data sources using documents from the stream.

 
 // There is a several ways to populate document with data sources using documents from the stream:
 MessageTestClass sender = new MessageTestClass("LINQ Reporting Engine", "Hello World");

 try (FileInputStream streamIn = new FileInputStream(getMyDir() + "Report building.docx")) {
     try (FileOutputStream streamOut = new FileOutputStream(getArtifactsDir() + "LowCode.BuildReportDataSourceStream.1.docx")) {
         ReportBuilder.buildReport(streamIn, streamOut, SaveFormat.DOCX, new Object[]{sender}, new String[]{"s"});
     }

     try (FileOutputStream streamOut1 = new FileOutputStream(getArtifactsDir() + "LowCode.BuildReportDataSourceStream.2.docx")) {
         ReportBuilder.buildReport(streamIn, streamOut1, SaveFormat.DOCX, sender, "s");
     }

     try (FileOutputStream streamOut2 = new FileOutputStream(getArtifactsDir() + "LowCode.BuildReportDataSourceStream.3.docx")) {
         ReportBuilderOptions options = new ReportBuilderOptions();
         options.setOptions(ReportBuildOptions.ALLOW_MISSING_MEMBERS);
         ReportBuilder.buildReport(streamIn, streamOut2, SaveFormat.DOCX, sender, "s", options);
     }

     ReportBuilderOptions options = new ReportBuilderOptions();
     options.setOptions(ReportBuildOptions.ALLOW_MISSING_MEMBERS);
     OutputStream[] images = ReportBuilder.buildReportToImages(streamIn, new ImageSaveOptions(SaveFormat.PNG), new Object[]{sender}, new String[]{"s"}, options);

     ReportBuilderContext reportBuilderContext = new ReportBuilderContext();
     reportBuilderContext.getReportBuilderOptions().setMissingMemberMessage("Missed members");
     reportBuilderContext.getDataSources().put(sender, "s");

     try (FileOutputStream streamOut3 = new FileOutputStream(getArtifactsDir() + "LowCode.BuildReportDataSourceStream.4.docx")) {
         ReportBuilder.create(reportBuilderContext)
                 .from(streamIn)
                 .to(streamOut3, SaveFormat.DOCX)
                 .execute();
     }
 }
 
 

Parameters:

inputStream - The input file stream.

saveOptions - The output's save options.

data - An array of data source objects.

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

reportBuilderOptions - Additional report build options.

Throws:

java.lang.Exception