OdsoFieldMapData

Inheritance: java.lang.Object

All Implemented Interfaces: java.lang.Cloneable

public class OdsoFieldMapData implements Cloneable

Specifies how a column in the external data source shall be mapped to the predefined merge fields within the document.

To learn more, visit the Mail Merge and Reporting documentation article.

Remarks:

Microsoft Word provides some predefined merge field names that it allows to insert into a document as MERGEFIELD or use in the ADDRESSBLOCK or GREETINGLINE fields. The information specified in OdsoFieldMapData allows to map one column in the external data source to a single predefined merge field.

Methods

MethodDescription
deepClone()Returns a deep clone of this object.
getColumn()Specifies the zero-based index of the column within an external data source which shall be mapped to the local name of a specific MERGEFIELD field.
getMappedName()Specifies the predefined merge field name which shall be mapped to the column number specified by the getColumn() / setColumn(int) property within this field mapping.
getName()Specifies the column name within an external data source for the column whose index is specified by the getColumn() / setColumn(int) property.
getType()Specifies if a given mail merge field has been mapped to a column in the given external data source or not.
setColumn(int value)Specifies the zero-based index of the column within an external data source which shall be mapped to the local name of a specific MERGEFIELD field.
setMappedName(String value)Specifies the predefined merge field name which shall be mapped to the column number specified by the getColumn() / setColumn(int) property within this field mapping.
setName(String value)Specifies the column name within an external data source for the column whose index is specified by the getColumn() / setColumn(int) property.
setType(int value)Specifies if a given mail merge field has been mapped to a column in the given external data source or not.

deepClone()

public OdsoFieldMapData deepClone()

Returns a deep clone of this object.

Returns: OdsoFieldMapData

getColumn()

public int getColumn()

Specifies the zero-based index of the column within an external data source which shall be mapped to the local name of a specific MERGEFIELD field. The default value is 0.

Returns: int - The corresponding int value.

getMappedName()

public String getMappedName()

Specifies the predefined merge field name which shall be mapped to the column number specified by the getColumn() / setColumn(int) property within this field mapping. The default value is an empty string.

Returns: java.lang.String - The corresponding java.lang.String value.

getName()

public String getName()

Specifies the column name within an external data source for the column whose index is specified by the getColumn() / setColumn(int) property. The default value is an empty string.

Returns: java.lang.String - The corresponding java.lang.String value.

getType()

public int getType()

Specifies if a given mail merge field has been mapped to a column in the given external data source or not. The default value is OdsoFieldMappingType.DEFAULT.

Returns: int - The corresponding int value. The returned value is one of OdsoFieldMappingType constants.

setColumn(int value)

public void setColumn(int value)

Specifies the zero-based index of the column within an external data source which shall be mapped to the local name of a specific MERGEFIELD field. The default value is 0.

Parameters:

ParameterTypeDescription
valueintThe corresponding int value.

setMappedName(String value)

public void setMappedName(String value)

Specifies the predefined merge field name which shall be mapped to the column number specified by the getColumn() / setColumn(int) property within this field mapping. The default value is an empty string.

Parameters:

ParameterTypeDescription
valuejava.lang.StringThe corresponding java.lang.String value.

setName(String value)

public void setName(String value)

Specifies the column name within an external data source for the column whose index is specified by the getColumn() / setColumn(int) property. The default value is an empty string.

Parameters:

ParameterTypeDescription
valuejava.lang.StringThe corresponding java.lang.String value.

setType(int value)

public void setType(int value)

Specifies if a given mail merge field has been mapped to a column in the given external data source or not. The default value is OdsoFieldMappingType.DEFAULT.

Parameters:

ParameterTypeDescription
valueintThe corresponding int value. The value must be one of OdsoFieldMappingType constants.