com.aspose.words

Class MappedDataFieldCollection

java.lang.Object

com.aspose.words.MappedDataFieldCollection

All Implemented Interfaces:

java.lang.Iterable

public class MappedDataFieldCollection
extends java.lang.Object
implements java.lang.Iterable

Allows to automatically map between names of fields in your data source and names of mail merge fields in the document.

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

This is implemented as a collection of string keys into string values. The keys are the names of mail merge fields in the document and the values are the names of fields in your data source.

See Also:

MailMerge, MailMerge.getMappedDataFields()

Method Summary

Modifier and Type	Method and Description
void	add(java.lang.String documentFieldName, java.lang.String dataSourceFieldName) Adds a new field mapping.
void	clear() Removes all elements from the collection.
boolean	containsKey(java.lang.String documentFieldName) Determines whether a mapping from the specified field in the document exists in the collection.
boolean	containsValue(java.lang.String dataSourceFieldName) Determines whether a mapping from the specified field in the data source exists in the collection.
java.lang.String	get(java.lang.String documentFieldName) Gets the name of the field in the data source associated with the specified mail merge field.
int	getCount() Gets the number of elements contained in the collection.
java.util.Iterator	iterator() Returns a dictionary iterator object that can be used to iterate over all items in the collection.
void	remove(java.lang.String documentFieldName) Removes a field mapping.
void	set(java.lang.String documentFieldName, java.lang.String value) Sets the name of the field in the data source associated with the specified mail merge field.

Methods inherited from class java.lang.Object

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

Methods inherited from interface java.lang.Iterable

forEach, spliterator

Method Detail

getCount

public int getCount()

Gets the number of elements contained in the collection.

Returns:

The number of elements contained in the collection.

get

public java.lang.String get(java.lang.String documentFieldName)

Gets the name of the field in the data source associated with the specified mail merge field.

Returns:

The name of the field in the data source associated with the specified mail merge field.

set

public void set(java.lang.String documentFieldName,
                java.lang.String value)

Sets the name of the field in the data source associated with the specified mail merge field.

Parameters:

value - The name of the field in the data source associated with the specified mail merge field.

iterator

public java.util.Iterator iterator()

Returns a dictionary iterator object that can be used to iterate over all items in the collection.

Specified by:

iterator in interface java.lang.Iterable

add

public void add(java.lang.String documentFieldName,
                java.lang.String dataSourceFieldName)

Adds a new field mapping.

Parameters:

documentFieldName - Case-sensitive name of the mail merge field in the document.

dataSourceFieldName - Case-sensitive name of the field in the data source.

containsKey

public boolean containsKey(java.lang.String documentFieldName)

Determines whether a mapping from the specified field in the document exists in the collection.

Parameters:

documentFieldName - Case-sensitive name of the mail merge field in the document.

Returns:

True if item is found in the collection; otherwise, false.

containsValue

public boolean containsValue(java.lang.String dataSourceFieldName)

Determines whether a mapping from the specified field in the data source exists in the collection.

Parameters:

dataSourceFieldName - Case-sensitive name of the field in the data source.

Returns:

True if item is found in the collection; otherwise, false.

remove

public void remove(java.lang.String documentFieldName)

Removes a field mapping.

Parameters:

documentFieldName - Case-sensitive name of the mail merge field in the document.

clear

public void clear()

Removes all elements from the collection.