com.aspose.words

Class OdsoFieldMapData

java.lang.Object

com.aspose.words.OdsoFieldMapData

All Implemented Interfaces:

java.lang.Cloneable

public class OdsoFieldMapData
extends java.lang.Object
implements java.lang.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.

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.

See Also:

OdsoFieldMapDataCollection, Odso

Method Summary

Modifier and Type	Method and Description
OdsoFieldMapData	deepClone() Returns a deep clone of this object.
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.
java.lang.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.
java.lang.String	getName() Specifies the column name within an external data source for the column whose index is specified by the getColumn() / setColumn(int) property.
int	getType() Specifies if a given mail merge field has been mapped to a column in the given external data source or not.
protected java.lang.Object	memberwiseClone()
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.
void	setMappedName(java.lang.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.
void	setName(java.lang.String value) Specifies the column name within an external data source for the column whose index is specified by the getColumn() / setColumn(int) property.
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.

Methods inherited from class java.lang.Object

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

Method Detail

deepClone

public OdsoFieldMapData deepClone()

Returns a deep clone of this object.

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:

The corresponding int value.

setColumn

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:

value - The corresponding int value.

getMappedName

public java.lang.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:

The corresponding String value.

setMappedName

public void setMappedName(java.lang.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:

value - The corresponding String value.

getName

public java.lang.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:

The corresponding String value.

setName

public void setName(java.lang.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:

value - The corresponding 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:

The corresponding int value. The returned value is one of OdsoFieldMappingType constants.

setType

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:

value - The corresponding int value. The value must be one of OdsoFieldMappingType constants.

memberwiseClone

protected java.lang.Object memberwiseClone()