DataSourceInfo Leave feedback

Inheritance: java.lang.Object

public class DataSourceInfo

Provides information on a single data source object to be used to assemble a document from a template.

public DataSourceInfo()

Creates a new instance of this class without any properties specified.

public DataSourceInfo(Object dataSource)

Creates a new instance of this class with the data source object specified.

The data source object can be of one of the following types:

• XmlDataSource
• JsonDataSource
• CsvDataSource
• DocumentTableSet
• DocumentTable
• DataSet
• DataTable
• DataRow
• IDataReader
• IDataRecord
• DataView
• DataRowView
• Any other arbitrary Java type

For information on how to work with data sources of different types in template documents, see template syntax reference(https://docs.groupdocs.com/display/assemblyjava/Template+Syntax+-+Part+1+of+2#TemplateSyntax-Part1of2-UsingDataSources).

Parameters:

public DataSourceInfo(Object dataSource, String name)

Creates a new instance of this class with the data source object and its name specified.

The data source object can be of one of the following types:

• XmlDataSource
• JsonDataSource
• CsvDataSource
• DocumentTableSet
• DocumentTable
• DataSet
• DataTable
• DataRow
• IDataReader
• IDataRecord
• DataView
• DataRowView
• Any other arbitrary Java type

For information on how to work with data sources of different types in template documents, see template syntax reference(https://docs.groupdocs.com/display/assemblyjava/Template+Syntax+-+Part+1+of+2#TemplateSyntax-Part1of2-UsingDataSources).

When the name of the data source object is specified, you can access the data source object and its members in a template document using the name.

When the name of the data source object is null or empty, you can still access members of the data source object in a template document using context object member access (see Template Syntax Reference for more information), but you cannot access the data source object itself.

When passing multiple DataSourceInfo instances to DocumentAssembler, only the name of the first data source object can be null or empty. Names of the rest ones must be specified and unique.

Parameters:

public Object getDataSource()

Gets the data source object.

The data source object can be of one of the following types:

• XmlDataSource
• JsonDataSource
• CsvDataSource
• DocumentTableSet
• DocumentTable
• DataSet
• DataTable
• DataRow
• IDataReader
• IDataRecord
• DataView
• DataRowView
• Any other arbitrary Java type

For information on how to work with data sources of different types in template documents, see template syntax reference(https://docs.groupdocs.com/display/assemblyjava/Template+Syntax+-+Part+1+of+2#TemplateSyntax-Part1of2-UsingDataSources).

Returns: java.lang.Object - The data source object.

public void setDataSource(Object value)

Sets the data source object.

The data source object can be of one of the following types:

• XmlDataSource
• JsonDataSource
• CsvDataSource
• DocumentTableSet
• DocumentTable
• DataSet
• DataTable
• DataRow
• IDataReader
• IDataRecord
• DataView
• DataRowView
• Any other arbitrary Java type

For information on how to work with data sources of different types in template documents, see template syntax reference(https://docs.groupdocs.com/display/assemblyjava/Template+Syntax+-+Part+1+of+2#TemplateSyntax-Part1of2-UsingDataSources).

Parameters:

public String getName()

Gets the name of the data source object to be used to access the data source object in a template document.

When the name of the data source object is specified, you can access the data source object and its members in a template document using the name.

When the name of the data source object is null or empty, you can still access members of the data source object in a template document using context object member access (see Template Syntax Reference for more information), but you cannot access the data source object itself.

When passing multiple DataSourceInfo instances to DocumentAssembler, only the name of the first data source object can be null or empty. Names of the rest ones must be specified and unique.

Returns: java.lang.String - The name of the data source object to be used to access the data source object in a template document.

public void setName(String value)

Sets the name of the data source object to be used to access the data source object in a template document.

When the name of the data source object is specified, you can access the data source object and its members in a template document using the name.

When the name of the data source object is null or empty, you can still access members of the data source object in a template document using context object member access (see Template Syntax Reference for more information), but you cannot access the data source object itself.

When passing multiple DataSourceInfo instances to DocumentAssembler, only the name of the first data source object can be null or empty. Names of the rest ones must be specified and unique.

Parameters: