com.sap.caf.eu.gp.structure.api

Interface IGPMappingGroup

public interface IGPMappingGroup

The mapping group serves as a container for mapping rules, all of which are applied when mapping from a source structure to a target structure is performed.

Version:

1.0

Method Summary

IGPMappingRule	addMappingRule() Add new empty rule to this mapping group.
IGPMappingRule	addMappingRule(IGPLabel[] sourcePath, IGPLabel[] targetPath) Add a rule with given source locator path and target locator path.
IGPMappingRule	addMappingRule(String[] sourcePath, String[] targetPath) Add a rule with given source locator path and target locator path.
Iterator	getMappingRules() Get all rules assigned to this mapping group in insertion order.
boolean	removeMappingRule(IGPMappingRule m) Remove a mapping rule from this mapping group.
String	toString() Overriden default-method.

Method Detail

addMappingRule

IGPMappingRule addMappingRule()

Add new empty rule to this mapping group.

Returns:

the new added rule

addMappingRule

IGPMappingRule addMappingRule(String[] sourcePath,
                              String[] targetPath)
                              throws GPInvocationException

Add a rule with given source locator path and target locator path. This is a shortcut for construction of rules with only one source - target pair.

Parameters:

sourcePath - array of names

targetPath - array of names

Returns:

the new added rule

Throws:

GPInvocationException - if some name in the source or target path is inapropriate.

addMappingRule

IGPMappingRule addMappingRule(IGPLabel[] sourcePath,
                              IGPLabel[] targetPath)
                              throws GPInvocationException

Add a rule with given source locator path and target locator path. This is a shortcut for construction of rules with only one source - target pair.

Parameters:

sourcePath - array of (name, namespace) pairs

targetPath - array of (name, namespace) pairs

Returns:

the new added rule

Throws:

GPInvocationException - if some name in the source or target path is inapropriate.

removeMappingRule

boolean removeMappingRule(IGPMappingRule m)

Remove a mapping rule from this mapping group.

Parameters:

m - the rule to remove

Returns:

whether the rule existed in this group or not

getMappingRules

Iterator getMappingRules()

Get all rules assigned to this mapping group in insertion order.

Returns:

iterator of IGPMappingRule elements

toString

String toString()

Overriden default-method. Returns an XML representation of IGPMappingGroup.

Overrides:

toString in class Object