Overview

Package

Class

Use

Tree

Deprecated

Index

Help

PREV CLASS NEXT CLASS

FRAMES NO FRAMES

SUMMARY: NESTED | FIELD | CONSTR | METHOD

DETAIL: FIELD | CONSTR | METHOD

org.eclipse.emf.mapping
Interface Mapping

All Superinterfaces:

EObject, Notifier

All Known Subinterfaces:

Ecore2EcoreMappingRoot, MappingRoot

All Known Implementing Classes:

Ecore2EcoreMappingRootImpl, MappingImpl, MappingRootImpl

public interface Mapping

extends EObject

A representation of the model object 'Mapping'.

The following features are supported:

• Helper
• Nested
• Nested In
• Inputs
• Outputs
• Type Mapping

See Also:

MappingPackage.getMapping()

Method Summary

EList	getBottoms() This returns the same as either getInputs() or getOutputs() depending on the mapping root's isTopToBottom.
MappingHelper	getEffectiveHelper() This returns the mapping helper for this mapping, if it has one.
MappingHelper	getHelper() Returns the value of the 'Helper' containment reference.
EList	getInputs() Returns the value of the 'Inputs' reference list.
Collection	getMappedObjects() This returns a set containing the results of getInputs() and getOutputs().
MappingRoot	getMappingRoot() This returns either the containing mapping root or the object itself, if it is a mapping root.
EList	getNested() Returns the value of the 'Nested' containment reference list.
Mapping	getNestedIn() Returns the value of the 'Nested In' container reference.
EList	getOutputs() Returns the value of the 'Outputs' reference list.
EList	getReceivers() This returns the same as getOutputs() if isReverse() returns false.
EList	getSenders() This returns the same as getInputs() if isReverse() returns false.
EList	getTops() This returns the same as either getInputs() or getOutputs() depending on the mapping root's isTopToBottom.
Mapping	getTypeMapping() Returns the value of the 'Type Mapping' reference
boolean	isReverse() This method is delegated to the containing mapping if one exists, or returns false otherwise.
void	setHelper(MappingHelper value) Sets the value of the 'Helper' containment reference
void	setNestedIn(Mapping value) Sets the value of the 'Nested In' container reference
void	setTypeMapping(Mapping value) Sets the value of the 'Type Mapping' reference
TreeIterator	treeIterator() This returns a tree iterator that iterates over this mapping, all it's nested mappings, and their nested mappings, and so on.
TreeIterator	treeIterator(boolean includeRoot) This returns a tree iterator that iterates over this mapping (but only if includeRoot is true), all it's nested mappings, and their nested mappings, and so on.

Methods inherited from interface org.eclipse.emf.ecore.EObject

eAllContents, eClass, eContainer, eContainingFeature, eContainmentFeature, eContents, eCrossReferences, eGet, eGet, eIsProxy, eIsSet, eResource, eSet, eUnset

Methods inherited from interface org.eclipse.emf.common.notify.Notifier

eAdapters, eDeliver, eNotify, eSetDeliver

Method Detail

getHelper

public MappingHelper getHelper()

Returns the value of the 'Helper' containment reference. It is bidirectional and its opposite is 'Mapper'.

If the meaning of the 'Helper' containment reference isn't clear, there really should be more of a description here...

Returns:

the value of the 'Helper' containment reference.

See Also:

setHelper(MappingHelper), MappingPackage.getMapping_Helper(), MappingHelper.getMapper()

setHelper

public void setHelper(MappingHelper value)

Sets the value of the 'Helper' containment reference.

Parameters:

value - the new value of the 'Helper' containment reference.

See Also:

getHelper()

getNested

public EList getNested()

Returns the value of the 'Nested' containment reference list. The list contents are of type Mapping. It is bidirectional and its opposite is 'Nested In'.

If the meaning of the 'Nested' containment reference list isn't clear, there really should be more of a description here...

Returns:

the value of the 'Nested' containment reference list.

See Also:

MappingPackage.getMapping_Nested(), getNestedIn()

getNestedIn

public Mapping getNestedIn()

Returns the value of the 'Nested In' container reference. It is bidirectional and its opposite is 'Nested'.

If the meaning of the 'Nested In' container reference isn't clear, there really should be more of a description here...

Returns:

the value of the 'Nested In' container reference.

See Also:

setNestedIn(Mapping), MappingPackage.getMapping_NestedIn(), getNested()

setNestedIn

public void setNestedIn(Mapping value)

Sets the value of the 'Nested In' container reference.

Parameters:

value - the new value of the 'Nested In' container reference.

See Also:

getNestedIn()

getInputs

public EList getInputs()

Returns the value of the 'Inputs' reference list. The list contents are of type EObject.

If the meaning of the 'Inputs' reference list isn't clear, there really should be more of a description here...

Returns:

the value of the 'Inputs' reference list.

See Also:

MappingPackage.getMapping_Inputs()

getOutputs

public EList getOutputs()

Returns the value of the 'Outputs' reference list. The list contents are of type EObject.

If the meaning of the 'Outputs' reference list isn't clear, there really should be more of a description here...

Returns:

the value of the 'Outputs' reference list.

See Also:

MappingPackage.getMapping_Outputs()

getTypeMapping

public Mapping getTypeMapping()

Returns the value of the 'Type Mapping' reference.

If the meaning of the 'Type Mapping' reference isn't clear, there really should be more of a description here...

Returns:

the value of the 'Type Mapping' reference.

See Also:

setTypeMapping(Mapping), MappingPackage.getMapping_TypeMapping()

setTypeMapping

public void setTypeMapping(Mapping value)

Sets the value of the 'Type Mapping' reference.

Parameters:

value - the new value of the 'Type Mapping' reference.

See Also:

getTypeMapping()

getMappedObjects

public Collection getMappedObjects()

This returns a set containing the results of getInputs() and getOutputs().

getTops

public EList getTops()

This returns the same as either getInputs() or getOutputs() depending on the mapping root's isTopToBottom.

getBottoms

public EList getBottoms()

This returns the same as either getInputs() or getOutputs() depending on the mapping root's isTopToBottom.

getMappingRoot

public MappingRoot getMappingRoot()

This returns either the containing mapping root or the object itself, if it is a mapping root.

isReverse

public boolean isReverse()

This method is delegated to the containing mapping if one exists, or returns false otherwise. Subclasses can override this method to return true when the logical direction of a mapping is reversed (i.e., from outputs to inputs).

getSenders

public EList getSenders()

This returns the same as getInputs() if isReverse() returns false. Otherwise it returns the same as getOutputs().

getReceivers

public EList getReceivers()

This returns the same as getOutputs() if isReverse() returns false. Otherwise it returns the same as getInputs().

getEffectiveHelper

public MappingHelper getEffectiveHelper()

This returns the mapping helper for this mapping, if it has one. Otherwise, if the mapping has an associated type mapping it returns the type mapping's helper.

treeIterator

public TreeIterator treeIterator()

This returns a tree iterator that iterates over this mapping, all it's nested mappings, and their nested mappings, and so on.

treeIterator

public TreeIterator treeIterator(boolean includeRoot)

This returns a tree iterator that iterates over this mapping (but only if includeRoot is true), all it's nested mappings, and their nested mappings, and so on.