TFORMer SDK - JAVA  7.0
Public Member Functions
DSFieldMapping Class Reference

DSFieldMapping defines the field-mappings between a DataSource and the DataFields used in a Formlayout. More...

List of all members.

Public Member Functions

void dispose () throws TFormerException
 Releases the resources allocated by this instance.
void dump (PrintStream s) throws IOException, TFormerException
 Dumps the current instance into a text stream.
String getDataField () throws TFormerException
 Gets the target DataField-name of the DSFieldMapping.
DSFieldMapping getNext () throws TFormerException
 Gets the next DSFieldMapping in the DataSource.
String getSourceField () throws TFormerException
 Gets the source-field name of the DSFieldMapping.
void setDataField (String sDataField) throws TFormerException
 Sets the target DataField name of the DSFieldMapping.
void setSourceField (String sSourceField) throws TFormerException
 Sets the source-field name of the DSFieldMapping.
String toString ()
 Returns a string representation of the instance.

Detailed Description

DSFieldMapping defines the field-mappings between a DataSource and the DataFields used in a Formlayout.

Overview

Defines the field mapping between the fields in a DataSource (the source fields) and the DataFields used in a Formlayout.When printing a Job with JobData it is required, that the DataField names in the JobData matches the names of the DataFields in the FormLayout. DSFieldMappings are only available for user-defined DataSources (see JobDataDataSource) and can be adjusted with TFORMer Designer as part of a DataSource definition.The main properties to characterize a DSFieldMapping are:

More Information

See also:
DataSource


Member Function Documentation

void dispose ( ) throws TFormerException

Releases the resources allocated by this instance.

Call this method in every case (even in case of exceptions) is this instance is not required anymore.

void dump ( PrintStream  s) throws IOException, TFormerException

Dumps the current instance into a text stream.

Parameters:
sInstance of the stream
String getDataField ( ) throws TFormerException

Gets the target DataField-name of the DSFieldMapping.

This property specifies the name of the target DataField (as used in the FormLayout), which receives the data from the source-field (see setSourceField).

Returns:
The target DataField of the DSFieldMapping

Gets the next DSFieldMapping in the DataSource.

A DataSource stores a list of DSFieldMapping objects. You can use this method to iterate through the list. To retrieve the first DataSource in the DataSource see DataSource.getFirstDSFieldMapping.

Returns:
The next DSFieldMapping object in the list or null
String getSourceField ( ) throws TFormerException

Gets the source-field name of the DSFieldMapping.

This property specifies the column name of the DataSource

Returns:
The source-field of the DSFieldMapping
void setDataField ( String  sDataField) throws TFormerException

Sets the target DataField name of the DSFieldMapping.

This property specifies the name of the target DataField (as used in the Formlayout), which receives the data from the source-field (see setSourceField()).

Parameters:
sDataFieldThe target DataField of the DSFieldMapping
void setSourceField ( String  sSourceField) throws TFormerException

Sets the source-field name of the DSFieldMapping.

This property specifies the column name of the DataSource

Parameters:
sSourceFieldThe source-field of the DSFieldMapping
String toString ( )

Returns a string representation of the instance.

Returns:
A string representation of the instance

© 2006-2012 - all rights reserved by TEC-IT Datenverarbeitung GmbH
Generated on Tue Oct 23 2012 16:33:20 for TFORMer SDK - JAVA with doxygen 1.8.0