Package com.nomagic.magicdraw.emfuml2xmi

Class BaseEmfUml2Helper

java.lang.Object

com.nomagic.magicdraw.emfuml2xmi.BaseEmfUml2Helper

All Implemented Interfaces:

BaseEElementNameRetriever, BaseEmfUml2Helper

Direct Known Subclasses:

EmfUml2Helper

@OpenApi
public abstract class BaseEmfUml2Helper
extends Object
implements BaseEmfUml2Helper

Eclipse UML2 XMI helper.

Field Summary

Fields

Modifier and Type	Field	Description
protected static final String	MAGICDRAW_SOURCE
static final String	MD_ID
static final String	MD_PROPERTY_NAME

Constructor Summary

Constructors

Constructor	Description
BaseEmfUml2Helper(Project project, com.nomagic.magicdraw.emfuml2xmi.helpers.BaseEmfUml2PersistenceHelper persistenceHelper, com.nomagic.magicdraw.emfuml2xmi.export.BaseEmfUml2IDManager idManager, BaseEmfOptionsGroup emfOptionsGroup, EmfUml2Logger logger)

Method Summary

Modifier and Type	Method	Description
void	addCreatedElementIDData(Object createdElement, Object relatedElement, String extra)
void	addFinalizeActivity(FinalizeActivity activity)
void	clearCreatedElementsIDData()
protected abstract com.nomagic.magicdraw.emfuml2xmi.helpers.BaseEmfUml2DataTypeMap	createDataTypeMap()
protected abstract BaseEElementNameRetriever	createEElementNameRetriever()
Map	getCreatedElementsIDData()
final String	getEElementName(Object eElement)	Returns element human name.
static String	getElementName(Element mdElement, boolean qualifiedName)	Returns element human name.
BaseEmfOptionsGroup	getEmfOptionsGroup()	Deprecated. Use BaseEmfUml2Helper.getOptions()
List<FinalizeActivity>	getFinalizeActivities()
EmfUml2Logger	getLogger()	Returns logger.
abstract Map	getMagicDrawAnnotationDetails(Object eElement, boolean create)
List<String>	getMDProjectBuiltinProfiles()	Returns profiles that are "built-in" in MagicDraw project
static List	getMDStandardProfiles()
BaseOptions	getOptions()
com.nomagic.magicdraw.emfuml2xmi.helpers.BaseEmfUml2PersistenceHelper	getPersistenceHelper()
Project	getProject()	Returns current project
com.nomagic.magicdraw.emfuml2xmi.helpers.BaseEmfUml2DataTypeMap	getUml2DataTypeMap()	Returns datatype map
abstract Object	getUml2MetaModel()
static void	initProgressStatus(ProgressStatus progress, String description, boolean indeterminate)
boolean	isMappedElement(Object element)	Checks if given element is mapped.
boolean	isRemovableElement(Object element)	Checks if element will be removed or already disposed.
boolean	isSkippedElement(Object element)	Checks if given element is skipped.
void	markMappedElement(Object element)	Marks that element is mapped.
void	markRemovableElement(Object element)	Mark element that will be removed or already disposed
void	markSkippedElement(Object element)	Mark skipped element.
static void	removeElement(Element element, Collection collection)
void	setMDElementID(BaseElement mdElement, Object eElement)	Set MD element id according given EMF element id.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Details

MAGICDRAW_SOURCE

protected static final String MAGICDRAW_SOURCE

See Also:

• Constant Field Values

MD_ID

public static final String MD_ID

See Also:

• Constant Field Values

MD_PROPERTY_NAME

public static final String MD_PROPERTY_NAME

See Also:

• Constant Field Values

Constructor Details

BaseEmfUml2Helper

public BaseEmfUml2Helper(Project project,
 com.nomagic.magicdraw.emfuml2xmi.helpers.BaseEmfUml2PersistenceHelper persistenceHelper,
 com.nomagic.magicdraw.emfuml2xmi.export.BaseEmfUml2IDManager idManager,
 BaseEmfOptionsGroup emfOptionsGroup,
 EmfUml2Logger logger)

Method Details

getUml2DataTypeMap

public com.nomagic.magicdraw.emfuml2xmi.helpers.BaseEmfUml2DataTypeMap getUml2DataTypeMap()

Returns datatype map

Specified by:

getUml2DataTypeMap in interface BaseEmfUml2Helper

Returns:

datatypes map

createDataTypeMap

protected abstract com.nomagic.magicdraw.emfuml2xmi.helpers.BaseEmfUml2DataTypeMap createDataTypeMap()

createEElementNameRetriever

protected abstract BaseEElementNameRetriever createEElementNameRetriever()

getMagicDrawAnnotationDetails

public abstract Map getMagicDrawAnnotationDetails(Object eElement,
 boolean create)

Specified by:

getMagicDrawAnnotationDetails in interface BaseEmfUml2Helper

getProject

@OpenApi
public Project getProject()

Returns current project

Specified by:

getProject in interface BaseEmfUml2Helper

Returns:

project

getMDStandardProfiles

public static List getMDStandardProfiles()

getMDProjectBuiltinProfiles

public List<String> getMDProjectBuiltinProfiles()

Description copied from interface: BaseEmfUml2Helper

Returns profiles that are "built-in" in MagicDraw project

Specified by:

getMDProjectBuiltinProfiles in interface BaseEmfUml2Helper

Returns:

getLogger

@OpenApi
public EmfUml2Logger getLogger()

Returns logger.

Specified by:

getLogger in interface BaseEmfUml2Helper

Returns:

logger

markMappedElement

@OpenApi
public void markMappedElement(Object element)

Marks that element is mapped. Mapped element - element is not created, but used in UML2 model.

Specified by:

markMappedElement in interface BaseEmfUml2Helper

Parameters:

element -

isMappedElement

@OpenApi
public boolean isMappedElement(Object element)

Checks if given element is mapped.

Specified by:

isMappedElement in interface BaseEmfUml2Helper

Parameters:

element -

Returns:

true - if mapped.

markSkippedElement

@OpenApi
public void markSkippedElement(Object element)

Mark skipped element.

Specified by:

markSkippedElement in interface BaseEmfUml2Helper

Parameters:

element -

isRemovableElement

@OpenApi
public boolean isRemovableElement(Object element)

Checks if element will be removed or already disposed. Element can be disposed if during export/import differs composite reference multiplicity (* to 1)

Specified by:

isRemovableElement in interface BaseEmfUml2Helper

Parameters:

element -

Returns:

true - if will element should be removed or are alredy removed.

markRemovableElement

public void markRemovableElement(Object element)

Mark element that will be removed or already disposed

Specified by:

markRemovableElement in interface BaseEmfUml2Helper

Parameters:

element -

getFinalizeActivities

public List<FinalizeActivity> getFinalizeActivities()

Specified by:

getFinalizeActivities in interface BaseEmfUml2Helper

isSkippedElement

@OpenApi
public boolean isSkippedElement(Object element)

Checks if given element is skipped.

Specified by:

isSkippedElement in interface BaseEmfUml2Helper

Parameters:

element -

getPersistenceHelper

public com.nomagic.magicdraw.emfuml2xmi.helpers.BaseEmfUml2PersistenceHelper getPersistenceHelper()

Specified by:

getPersistenceHelper in interface BaseEmfUml2Helper

addCreatedElementIDData

public void addCreatedElementIDData(Object createdElement,
 Object relatedElement,
 String extra)

Specified by:

addCreatedElementIDData in interface BaseEmfUml2Helper

getCreatedElementsIDData

public Map getCreatedElementsIDData()

Specified by:

getCreatedElementsIDData in interface BaseEmfUml2Helper

clearCreatedElementsIDData

public void clearCreatedElementsIDData()

Specified by:

clearCreatedElementsIDData in interface BaseEmfUml2Helper

getElementName

@OpenApi
public static String getElementName(Element mdElement,
 boolean qualifiedName)

Returns element human name.

Parameters:

mdElement -

qualifiedName -

Returns:

element type + [qualified] name

initProgressStatus

public static void initProgressStatus(ProgressStatus progress,
 String description,
 boolean indeterminate)

removeElement

public static void removeElement(Element element,
 Collection collection)

setMDElementID

public void setMDElementID(BaseElement mdElement,
 Object eElement)

Set MD element id according given EMF element id. If there is id's conflict id is not changed.

Specified by:

setMDElementID in interface BaseEmfUml2Helper

Parameters:

mdElement - MD element

eElement - EMF element

getEmfOptionsGroup

@Deprecated
public BaseEmfOptionsGroup getEmfOptionsGroup()

Deprecated.

Use BaseEmfUml2Helper.getOptions()

Returns:

getOptions

public BaseOptions getOptions()

Specified by:

getOptions in interface BaseEmfUml2Helper

getEElementName

@OpenApi
public final String getEElementName(Object eElement)

Returns element human name.

Specified by:

getEElementName in interface BaseEElementNameRetriever

Specified by:

getEElementName in interface BaseEmfUml2Helper

Parameters:

eElement -

Returns:

element type + qualified name

addFinalizeActivity

public void addFinalizeActivity(FinalizeActivity activity)

Specified by:

addFinalizeActivity in interface BaseEmfUml2Helper

getUml2MetaModel

public abstract Object getUml2MetaModel()