[This is preliminary documentation and is subject to change.]
Produce a table of field values from a SIF Data Object.
This form of the map method allows the client to specify
whether it is performing an inbound or outbound mapping operation.
Currently, the direction flag is used to invoke automatic ValueSet
translations on fields that have a ValueSet attribute.
| C# | Visual Basic | Visual C++ |
public void Map( SifDataObject data, IDictionary results, MappingDirection direction, SifVersion version )
Public Sub Map ( _ data As SifDataObject, _ results As IDictionary, _ direction As MappingDirection, _ version As SifVersion _ )
public: void Map ( SifDataObject^ data, IDictionary^ results, MappingDirection direction, SifVersion^ version )
- data (SifDataObject)
- The SifDataObject from which to retrieve element and attribute values from when performing the mapping operation.
- results (IDictionary)
- A IDictionary to receive the results of the mapping, where each entry in the map is keyed by the local application-defined name of a field and the value is the text value of the corresponding element or attribute in the SifDataObject.
- direction (MappingDirection)
- The direction of mapping
- version (SifVersion)
- The SifVersion associated with the mapping operation. For inbound SIF_Event and SIF_Response messages, this value should be obtained by calling getSIFVersion on the SifMessageInfo parameter passed to the message handler. For inbound SIF_Request messages, it should be obtained by calling the SifMessageInfo.getSIFRequestVersion method. For outbound messages, this value should be obtained by calling Adk.getSIFVersion to get the version of SIF the class framework was initialized with. Note when this parameter is null, no SIF Version filtering will be applied to field mapping rules.
| Exception | Condition |
|---|---|
| AdkMappingException | thrown if an error occurs while evaluating
a field rule
@since Adk 1.5
|