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

Interface IGPMappingRule

public interface IGPMappingRule

A mapping rule describes the behaviour of a mapping. By default a mapping rule is empty. It doesn't transfer any data. To transfer data we need to specify a source and destination paths.

Version:

1.0

Method Summary

void	addAttributeFallback(String fallBack) Adds a fallabk attribute value to the mapping rule
IGPMappingLocator	addSourceLocator() Append new empty source locator.
void	addStructureFallback(IGPStructure structure) Adds a structure fallback
IGPMappingLocator	addTargetLocator() Append new empty target locator.
String[]	getAttributeFallbacks() Returns all fallbacks for an attribute
IGPMappingLocator	getFirstSourceLocator() Get the first (and most used) source locator of this rule.
IGPMappingLocator	getFirstTargetLocator() Get the first (and most used) target locator of this rule.
Iterator	getSourceLocators() Iterate over the source locators of this rule.
IGPStructure[]	getStructureFallbacks() Returns all structure fallbacks
Iterator	getTargetLocators() Iterate over the target locators of this rule.
void	removeAttributeFallbacks() Removes all attribute fallbacks
boolean	removeSourceLocator(IGPMappingLocator locator) Remove a given locator from the sources of this rule.
void	removeStructureFallbacks() Remove all structure fallbacks
boolean	removeTargetLocator(IGPMappingLocator locator) Remove a given locator from the targets of this rule.
String	toString() Overriden default-method.

Method Detail

addSourceLocator

IGPMappingLocator addSourceLocator()

Append new empty source locator.

Returns:

the new added locator.

addTargetLocator

IGPMappingLocator addTargetLocator()

Append new empty target locator.

Returns:

the new added locator.

removeSourceLocator

boolean removeSourceLocator(IGPMappingLocator locator)

Remove a given locator from the sources of this rule.

Parameters:

locator - locator to be deleted.

Returns:

whether the specified locator existed in this rule or not.

removeTargetLocator

boolean removeTargetLocator(IGPMappingLocator locator)

Remove a given locator from the targets of this rule.

Parameters:

locator - locator to be deleted.

Returns:

whether the specified locator existed in this rule or not.

getSourceLocators

Iterator getSourceLocators()

Iterate over the source locators of this rule.

Returns:

iterator of IGPMappingLocator elements

getTargetLocators

Iterator getTargetLocators()

Iterate over the target locators of this rule.

Returns:

iterator of IGPMappingLocator elements

getFirstSourceLocator

IGPMappingLocator getFirstSourceLocator()

Get the first (and most used) source locator of this rule. This accessor is a shortcut for rules with only one source - target pair. If this rule has no source locators, new empty locator will be created.

Returns:

the first source locator

getFirstTargetLocator

IGPMappingLocator getFirstTargetLocator()

Get the first (and most used) target locator of this rule. This accessor is a shortcut for rules with only one source - target pair. If this rule has no target locators, new empty locator will be created.

Returns:

the first target locator

addAttributeFallback

void addAttributeFallback(String fallBack)

Adds a fallabk attribute value to the mapping rule

Parameters:

fallBack -

getAttributeFallbacks

String[] getAttributeFallbacks()

Returns all fallbacks for an attribute

Returns:

removeAttributeFallbacks

void removeAttributeFallbacks()

Removes all attribute fallbacks

getStructureFallbacks

IGPStructure[] getStructureFallbacks()

Returns all structure fallbacks

Returns:

addStructureFallback

void addStructureFallback(IGPStructure structure)

Adds a structure fallback

Parameters:

structure -

removeStructureFallbacks

void removeStructureFallbacks()

Remove all structure fallbacks

toString

String toString()

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

Overrides:

toString in class Object