com.aspose.words

Class CsvDataSource

java.lang.Object

com.aspose.words.CsvDataSource

public class CsvDataSource
extends java.lang.Object

Provides access to data of a CSV file or stream to be used within a report.

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

Remarks:

To access data of the corresponding file or stream while generating a report, pass an instance of this class as a data source to one of ReportingEngine. buildReport overloads.

In template documents, a CsvDataSource instance should be treated in the same way as if it was a DataTable instance. For more information, see template syntax reference(https://docs.aspose.com/display/wordsjava/Template+Syntax).

Data types of comma-separated values are determined automatically upon their string representations. So in template documents, you can work with typed values rather than just strings. The engine is capable to automatically recognize values of the following types:

• long
• double
• boolean
• Date
• String

Note that for automatic recognition of data types to work, string representations of comma-separated values should be formed using invariant culture settings.

To override default behavior of CSV data loading, initialize and pass a CsvDataLoadOptions instance to a constructor of this class.

Examples:

Shows how to use CSV as a data source (string).

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

 CsvDataLoadOptions loadOptions = new CsvDataLoadOptions(true);
 loadOptions.setDelimiter(';');
 loadOptions.setCommentChar('$');
 loadOptions.hasHeaders(true);
 loadOptions.setQuoteChar('"');

 CsvDataSource dataSource = new CsvDataSource(getMyDir() + "List of people.csv", loadOptions);
 buildReport(doc, dataSource, "persons");

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

Constructor Summary

Constructors

Constructor and Description
CsvDataSource(java.io.InputStream csvStream) Initializes a new instance of this class.
CsvDataSource(java.io.InputStream csvStream, CsvDataLoadOptions options) Initializes a new instance of this class.
CsvDataSource(java.lang.String csvPath) Creates a new data source with data from a CSV file using default options for parsing CSV data.
CsvDataSource(java.lang.String csvPath, CsvDataLoadOptions options) Creates a new data source with data from a CSV file using the specified options for parsing CSV data.

Method Summary

Methods inherited from class java.lang.Object

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

Constructor Detail

CsvDataSource

public CsvDataSource(java.lang.String csvPath)
              throws java.lang.Exception

Creates a new data source with data from a CSV file using default options for parsing CSV data.

Parameters:

csvPath - The path to the CSV file to be used as the data source.

Throws:

java.lang.Exception

CsvDataSource

public CsvDataSource(java.lang.String csvPath,
                     CsvDataLoadOptions options)
              throws java.lang.Exception

Creates a new data source with data from a CSV file using the specified options for parsing CSV data.

Examples:

Shows how to use CSV as a data source (string).

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

 CsvDataLoadOptions loadOptions = new CsvDataLoadOptions(true);
 loadOptions.setDelimiter(';');
 loadOptions.setCommentChar('$');
 loadOptions.hasHeaders(true);
 loadOptions.setQuoteChar('"');

 CsvDataSource dataSource = new CsvDataSource(getMyDir() + "List of people.csv", loadOptions);
 buildReport(doc, dataSource, "persons");

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

Parameters:

csvPath - The path to the CSV file to be used as the data source.

options - Options for parsing the CSV data.

Throws:

java.lang.Exception

CsvDataSource

public CsvDataSource(java.io.InputStream csvStream)
              throws java.lang.Exception

Initializes a new instance of this class.

Throws:

java.lang.Exception

CsvDataSource

public CsvDataSource(java.io.InputStream csvStream,
                     CsvDataLoadOptions options)
              throws java.lang.Exception

Initializes a new instance of this class.

Throws:

java.lang.Exception