com.aspose.words

Class CsvDataLoadOptions

java.lang.Object

com.aspose.words.CsvDataLoadOptions

public class CsvDataLoadOptions
extends java.lang.Object

Represents options for parsing CSV data.

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

Remarks:

An instance of this class can be passed into constructors of CsvDataSource.

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
CsvDataLoadOptions() Initializes a new instance of this class with default options.
CsvDataLoadOptions(boolean hasHeaders) Initializes a new instance of this class with specifying whether CSV data contains column names at the first line.

Method Summary

Modifier and Type	Method and Description
char	getCommentChar() Gets the character that is used to comment lines of CSV data.
char	getDelimiter() Gets the character to be used as a column delimiter.
char	getQuoteChar() Gets the character that is used to quote field values.
boolean	hasHeaders() Gets a value indicating whether the first record of CSV data contains column names.
void	hasHeaders(boolean value) Sets a value indicating whether the first record of CSV data contains column names.
void	setCommentChar(char value) Sets the character that is used to comment lines of CSV data.
void	setDelimiter(char value) Sets the character to be used as a column delimiter.
void	setQuoteChar(char value) Sets the character that is used to quote field values.

Methods inherited from class java.lang.Object

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

Constructor Detail

CsvDataLoadOptions

public CsvDataLoadOptions()

Initializes a new instance of this class with default options.

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");
 
 

CsvDataLoadOptions

public CsvDataLoadOptions(boolean hasHeaders)

Initializes a new instance of this class with specifying whether CSV data contains column names at the first line.

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");
 
 

Method Detail

hasHeaders

public boolean hasHeaders()

Gets a value indicating whether the first record of CSV data contains column names.

Remarks:

The default value is false.

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");
 
 

Returns:

A value indicating whether the first record of CSV data contains column names.

hasHeaders

public void hasHeaders(boolean value)

Sets a value indicating whether the first record of CSV data contains column names.

Remarks:

The default value is false.

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:

value - A value indicating whether the first record of CSV data contains column names.

getDelimiter

public char getDelimiter()

Gets the character to be used as a column delimiter.

Remarks:

The default value is ',' (comma).

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");
 
 

Returns:

The character to be used as a column delimiter.

setDelimiter

public void setDelimiter(char value)

Sets the character to be used as a column delimiter.

Remarks:

The default value is ',' (comma).

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:

value - The character to be used as a column delimiter.

getQuoteChar

public char getQuoteChar()

Gets the character that is used to quote field values.

Remarks:

The default value is '"' (quotation mark).

Double the character to place it into quoted text.

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");
 
 

Returns:

The character that is used to quote field values.

setQuoteChar

public void setQuoteChar(char value)

Sets the character that is used to quote field values.

Remarks:

The default value is '"' (quotation mark).

Double the character to place it into quoted text.

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:

value - The character that is used to quote field values.

getCommentChar

public char getCommentChar()

Gets the character that is used to comment lines of CSV data.

Remarks:

The default value is '#' (number sign).

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");
 
 

Returns:

The character that is used to comment lines of CSV data.

setCommentChar

public void setCommentChar(char value)

Sets the character that is used to comment lines of CSV data.

Remarks:

The default value is '#' (number sign).

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:

value - The character that is used to comment lines of CSV data.