DataSourceInfo

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.

Constructors

Constructor Description
DataSourceInfo() Creates a new instance of this class without any properties specified.
DataSourceInfo(Object dataSource) Creates a new instance of this class with the data source object specified.
DataSourceInfo(Object dataSource, String name) Creates a new instance of this class with the data source object and its name specified.

Methods

Method Description
getDataSource() Gets the data source object.
setDataSource(Object value) Sets the data source object.
getName() Gets the name of the data source object to be used to access the data source object in a template document.
setName(String value) Sets the name of the data source object to be used to access the data source object in a template document.

DataSourceInfo()

public DataSourceInfo()

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

DataSourceInfo(Object dataSource)

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:

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:

Parameter Type Description
dataSource java.lang.Object The data source object.

DataSourceInfo(Object dataSource, String name)

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:

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:

Parameter Type Description
dataSource java.lang.Object The data source object.
name java.lang.String The name of the data source object to be used to access the data source object in a template document.

getDataSource()

public Object getDataSource()

Gets the data source object.

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

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.

setDataSource(Object value)

public void setDataSource(Object value)

Sets the data source object.

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

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:

Parameter Type Description
value java.lang.Object The data source object.

getName()

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.

setName(String value)

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:

Parameter Type Description
value java.lang.String The name of the data source object to be used to access the data source object in a template document.
CsvDataSource DocumentAssembler