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 java.lang.Object implements BaseEmfUml2Helper
Eclipse UML2 XMI helper.
-
-
Field Summary
Fields Modifier and Type Field Description protected static java.lang.StringMAGICDRAW_SOURCEprivate java.util.Set<java.lang.String>mChangedIDsSet of changed original idsprivate java.util.Map<java.lang.Object,com.nomagic.magicdraw.emfuml2xmi.export.CreatedElementData>mCreatedElementsIDDatastatic java.lang.StringMD_IDstatic java.lang.StringMD_PROPERTY_NAMEprivate BaseEElementNameRetrievermEElementNameRetrieverprivate BaseEmfOptionsGroupmEmfOptionsGroupprivate java.util.List<FinalizeActivity>mFinalizeActivitiesprivate com.nomagic.magicdraw.emfuml2xmi.export.BaseEmfUml2IDManagermIDManagerprivate EmfUml2LoggermLoggerprivate java.util.Set<java.lang.Object>mMappedElementsprivate static java.util.List<java.lang.String>mMDStandardProfilesprivate com.nomagic.magicdraw.emfuml2xmi.helpers.BaseEmfUml2PersistenceHelpermPersistenceHelperprivate ProjectmProjectprivate java.util.Set<java.lang.Object>mRemovableElementsprivate java.util.Map<java.lang.String,java.lang.Object>mSetIDsMap of changed ids: id --> eElement ID IS CHANGED FOR MAGICDRAW ELEMENTprivate java.util.Set<java.lang.Object>mSkippedElementsprivate com.nomagic.magicdraw.emfuml2xmi.helpers.BaseEmfUml2DataTypeMapmUml2DataTypeMap
-
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
All Methods Static Methods Instance Methods Abstract Methods Concrete Methods Deprecated Methods Modifier and Type Method Description voidaddCreatedElementIDData(java.lang.Object createdElement, java.lang.Object relatedElement, java.lang.String extra)voidaddFinalizeActivity(FinalizeActivity activity)voidclearCreatedElementsIDData()private java.lang.StringconstructID(java.lang.String base, java.lang.Object eElement)Constructs id of given base and given EMF element type and qualified nameprotected abstract com.nomagic.magicdraw.emfuml2xmi.helpers.BaseEmfUml2DataTypeMapcreateDataTypeMap()protected abstract BaseEElementNameRetrievercreateEElementNameRetriever()java.util.MapgetCreatedElementsIDData()java.lang.StringgetEElementName(java.lang.Object eElement)Returns element human name.static java.lang.StringgetElementName(Element mdElement, boolean qualifiedName)Returns element human name.BaseEmfOptionsGroupgetEmfOptionsGroup()Deprecated.java.util.List<FinalizeActivity>getFinalizeActivities()EmfUml2LoggergetLogger()Returns logger.abstract java.util.MapgetMagicDrawAnnotationDetails(java.lang.Object eElement, boolean create)java.util.List<java.lang.String>getMDProjectBuiltinProfiles()Returns profiles that are "built-in" in MagicDraw projectstatic java.util.ListgetMDStandardProfiles()BaseOptionsgetOptions()com.nomagic.magicdraw.emfuml2xmi.helpers.BaseEmfUml2PersistenceHelpergetPersistenceHelper()ProjectgetProject()Returns current projectcom.nomagic.magicdraw.emfuml2xmi.helpers.BaseEmfUml2DataTypeMapgetUml2DataTypeMap()Returns datatype mapabstract java.lang.ObjectgetUml2MetaModel()static voidinitProgressStatus(ProgressStatus progress, java.lang.String description, boolean indeterminate)booleanisMappedElement(java.lang.Object element)Checks if given element is mapped.booleanisRemovableElement(java.lang.Object element)Checks if element will be removed or already disposed.booleanisSkippedElement(java.lang.Object element)Checks if given element is skipped.voidmarkMappedElement(java.lang.Object element)Marks that element is mapped.voidmarkRemovableElement(java.lang.Object element)Mark element that will be removed or already disposedvoidmarkSkippedElement(java.lang.Object element)Mark skipped element.private static java.lang.Stringnormalize(java.lang.String id)Normalizes string to be used as part of XML idstatic voidremoveElement(Element element, java.util.Collection collection)voidsetMDElementID(BaseElement mdElement, java.lang.Object eElement)Set MD element id according given EMF element id.private booleansetMDElementID(BaseElement mdElement, java.lang.Object eElement, java.lang.String id)Set element id.
-
-
-
Field Detail
-
MAGICDRAW_SOURCE
protected static final java.lang.String MAGICDRAW_SOURCE
- See Also:
- Constant Field Values
-
MD_ID
public static final java.lang.String MD_ID
- See Also:
- Constant Field Values
-
MD_PROPERTY_NAME
public static final java.lang.String MD_PROPERTY_NAME
- See Also:
- Constant Field Values
-
mMDStandardProfiles
private static final java.util.List<java.lang.String> mMDStandardProfiles
-
mProject
private final Project mProject
-
mUml2DataTypeMap
private com.nomagic.magicdraw.emfuml2xmi.helpers.BaseEmfUml2DataTypeMap mUml2DataTypeMap
-
mLogger
private final EmfUml2Logger mLogger
-
mMappedElements
private final java.util.Set<java.lang.Object> mMappedElements
-
mSkippedElements
private final java.util.Set<java.lang.Object> mSkippedElements
-
mRemovableElements
private final java.util.Set<java.lang.Object> mRemovableElements
-
mFinalizeActivities
private final java.util.List<FinalizeActivity> mFinalizeActivities
-
mPersistenceHelper
private final com.nomagic.magicdraw.emfuml2xmi.helpers.BaseEmfUml2PersistenceHelper mPersistenceHelper
-
mCreatedElementsIDData
private final java.util.Map<java.lang.Object,com.nomagic.magicdraw.emfuml2xmi.export.CreatedElementData> mCreatedElementsIDData
-
mIDManager
private final com.nomagic.magicdraw.emfuml2xmi.export.BaseEmfUml2IDManager mIDManager
-
mEElementNameRetriever
private final BaseEElementNameRetriever mEElementNameRetriever
-
mEmfOptionsGroup
private final BaseEmfOptionsGroup mEmfOptionsGroup
-
mChangedIDs
private final java.util.Set<java.lang.String> mChangedIDs
Set of changed original ids
-
mSetIDs
private final java.util.Map<java.lang.String,java.lang.Object> mSetIDs
Map of changed ids: id --> eElement ID IS CHANGED FOR MAGICDRAW ELEMENT
-
-
Constructor Detail
-
BaseEmfUml2Helper
public BaseEmfUml2Helper(Project project, com.nomagic.magicdraw.emfuml2xmi.helpers.BaseEmfUml2PersistenceHelper persistenceHelper, com.nomagic.magicdraw.emfuml2xmi.export.BaseEmfUml2IDManager idManager, BaseEmfOptionsGroup emfOptionsGroup, EmfUml2Logger logger)
-
-
Method Detail
-
getUml2DataTypeMap
public com.nomagic.magicdraw.emfuml2xmi.helpers.BaseEmfUml2DataTypeMap getUml2DataTypeMap()
Returns datatype map- Specified by:
getUml2DataTypeMapin interfaceBaseEmfUml2Helper- Returns:
- datatypes map
-
createDataTypeMap
protected abstract com.nomagic.magicdraw.emfuml2xmi.helpers.BaseEmfUml2DataTypeMap createDataTypeMap()
-
createEElementNameRetriever
protected abstract BaseEElementNameRetriever createEElementNameRetriever()
-
getMagicDrawAnnotationDetails
public abstract java.util.Map getMagicDrawAnnotationDetails(java.lang.Object eElement, boolean create)- Specified by:
getMagicDrawAnnotationDetailsin interfaceBaseEmfUml2Helper
-
getProject
@OpenApi public Project getProject()
Returns current project- Specified by:
getProjectin interfaceBaseEmfUml2Helper- Returns:
- project
-
getMDStandardProfiles
public static java.util.List getMDStandardProfiles()
-
getMDProjectBuiltinProfiles
public java.util.List<java.lang.String> getMDProjectBuiltinProfiles()
Description copied from interface:BaseEmfUml2HelperReturns profiles that are "built-in" in MagicDraw project- Specified by:
getMDProjectBuiltinProfilesin interfaceBaseEmfUml2Helper- Returns:
-
getLogger
@OpenApi public EmfUml2Logger getLogger()
Returns logger.- Specified by:
getLoggerin interfaceBaseEmfUml2Helper- Returns:
- logger
-
markMappedElement
@OpenApi public void markMappedElement(java.lang.Object element)
Marks that element is mapped. Mapped element - element is not created, but used in UML2 model.- Specified by:
markMappedElementin interfaceBaseEmfUml2Helper- Parameters:
element-
-
isMappedElement
@OpenApi public boolean isMappedElement(java.lang.Object element)
Checks if given element is mapped.- Specified by:
isMappedElementin interfaceBaseEmfUml2Helper- Parameters:
element-- Returns:
- true - if mapped.
-
markSkippedElement
@OpenApi public void markSkippedElement(java.lang.Object element)
Mark skipped element.- Specified by:
markSkippedElementin interfaceBaseEmfUml2Helper- Parameters:
element-
-
isRemovableElement
@OpenApi public boolean isRemovableElement(java.lang.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:
isRemovableElementin interfaceBaseEmfUml2Helper- Parameters:
element-- Returns:
- true - if will element should be removed or are alredy removed.
-
markRemovableElement
public void markRemovableElement(java.lang.Object element)
Mark element that will be removed or already disposed- Specified by:
markRemovableElementin interfaceBaseEmfUml2Helper- Parameters:
element-
-
getFinalizeActivities
public java.util.List<FinalizeActivity> getFinalizeActivities()
- Specified by:
getFinalizeActivitiesin interfaceBaseEmfUml2Helper
-
isSkippedElement
@OpenApi public boolean isSkippedElement(java.lang.Object element)
Checks if given element is skipped.- Specified by:
isSkippedElementin interfaceBaseEmfUml2Helper- Parameters:
element-
-
getPersistenceHelper
public com.nomagic.magicdraw.emfuml2xmi.helpers.BaseEmfUml2PersistenceHelper getPersistenceHelper()
- Specified by:
getPersistenceHelperin interfaceBaseEmfUml2Helper
-
addCreatedElementIDData
public void addCreatedElementIDData(java.lang.Object createdElement, java.lang.Object relatedElement, java.lang.String extra)- Specified by:
addCreatedElementIDDatain interfaceBaseEmfUml2Helper
-
getCreatedElementsIDData
public java.util.Map getCreatedElementsIDData()
- Specified by:
getCreatedElementsIDDatain interfaceBaseEmfUml2Helper
-
clearCreatedElementsIDData
public void clearCreatedElementsIDData()
- Specified by:
clearCreatedElementsIDDatain interfaceBaseEmfUml2Helper
-
getElementName
@OpenApi public static java.lang.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, java.lang.String description, boolean indeterminate)
-
removeElement
public static void removeElement(Element element, java.util.Collection collection)
-
setMDElementID
public void setMDElementID(BaseElement mdElement, java.lang.Object eElement)
Set MD element id according given EMF element id. If there is id's conflict id is not changed.- Specified by:
setMDElementIDin interfaceBaseEmfUml2Helper- Parameters:
mdElement- MD elementeElement- EMF element
-
setMDElementID
private boolean setMDElementID(BaseElement mdElement, java.lang.Object eElement, java.lang.String id)
Set element id. If there is element in the project with given id - does nothing
-
getEmfOptionsGroup
@Deprecated public BaseEmfOptionsGroup getEmfOptionsGroup()
Deprecated.- Returns:
-
getOptions
public BaseOptions getOptions()
- Specified by:
getOptionsin interfaceBaseEmfUml2Helper
-
getEElementName
@OpenApi public final java.lang.String getEElementName(java.lang.Object eElement)
Returns element human name.- Specified by:
getEElementNamein interfaceBaseEElementNameRetriever- Specified by:
getEElementNamein interfaceBaseEmfUml2Helper- Parameters:
eElement-- Returns:
- element type + qualified name
-
constructID
private java.lang.String constructID(java.lang.String base, java.lang.Object eElement)Constructs id of given base and given EMF element type and qualified name- Parameters:
base-eElement-
-
normalize
private static java.lang.String normalize(java.lang.String id)
Normalizes string to be used as part of XML id
-
addFinalizeActivity
public void addFinalizeActivity(FinalizeActivity activity)
- Specified by:
addFinalizeActivityin interfaceBaseEmfUml2Helper
-
getUml2MetaModel
public abstract java.lang.Object getUml2MetaModel()
-
-