Package com.nomagic.magicdraw.core
Class Project
- java.lang.Object
-
- com.nomagic.magicdraw.uml.MDElementImpl
-
- com.nomagic.magicdraw.uml.ElementImpl
-
- com.nomagic.magicdraw.core.Project
-
- All Implemented Interfaces:
BaseElement
,MDElement
,com.nomagic.uml2.ext.jmi.reflect.ElementRegistry
,com.nomagic.uml2.ext.jmi.reflect.RepositoryProvider
,java.lang.Cloneable
,java.lang.Comparable
@OpenApi public class Project extends ElementImpl implements com.nomagic.uml2.ext.jmi.reflect.ElementRegistry, com.nomagic.uml2.ext.jmi.reflect.RepositoryProvider
TheProject
class represents main storage of all project data like: main package, all diagrams and diagram windows.
-
-
Field Summary
Fields Modifier and Type Field Description private com.nomagic.magicdraw.core.BinaryStreamAtticCleaner
binaryStreamAtticCleaner
private Browser
browser
private boolean
closed
Is project disposedprivate boolean
closing
Is project closingstatic java.lang.String
COMMAND_EXECUTED
The any command (adding object, deleting object, changing specifications) executing event type and naming.private com.nomagic.magicdraw.commands.CommandHistory
commandHistory
Command history of project instance.private CookieSet
cookies
private com.nomagic.magicdraw.core.MDCounter
counter
Counter for IDprivate static boolean
createBrowser
Create project with or without browser.static java.lang.String
DIAGRAM_ACTIVATED
The diagram focus on event type and naming.static java.lang.String
DIAGRAM_CLOSED
The diagram window closing event type and naming.static java.lang.String
DIAGRAM_EDITED
The any diagram properties editing event type and naming.static java.lang.String
DIAGRAM_OPENED
The diagram window opening event type and naming.static java.lang.String
DIAGRAM_WINDOW_ACTIVATED
The diagram window focus on event type and naming.private com.nomagic.utils.ExtendedPropertyChangeSupport
diagramContentListeners
private com.nomagic.magicdraw.ui.ProjectDiagramWindowsManager
diagramWindowsManager
The window managerstatic java.lang.String
DIRTY_PROPERTY
Project "dirty" flag changeprivate com.nomagic.magicdraw.ui.dsl.DSLManager
dslManager
Project customization managerprivate com.nomagic.magicdraw.core.Project.ElementByIDFetcher
elementByIDFetcher
private ElementsFactory
elementsFactory
private static java.util.Set<java.lang.String>
FEATURES
A set of ci features available in runtimeprivate com.nomagic.magicdraw.utils.ExtendedFile
file
static java.lang.String
FILE_NAME_PROPERTY
Project file name propertyprivate boolean
frozen
Is project frozen - some project data may not be accessible if project is frozenprivate java.lang.Boolean
hasUnloadedManuallyReachableModules
Determines whether there are manually reachable modules that are unloaded currently in this projectprivate boolean
intensiveActionExecuted
private boolean
loaded
private com.nomagic.magicdraw.teamwork2.esi.EsiLockProjectService
lockProjectService
static java.lang.String
MANY_CLASSES_UPDATED
Event type when many elements in project are changed (for example after project update,massive source reverse operation and etc)private boolean
needLocallySave
private java.util.Map<java.lang.String,java.lang.Object>
objectsByID
The map of all objects registered by id.private IPrimaryProject
primaryProject
Storage where project is loaded from or saved to.private java.lang.String
projectTitle
Preset project titleprivate ProxyManager
proxyManager
Proxy managerprivate java.util.concurrent.atomic.AtomicReference<com.nomagic.ci.persistence.local.query.IQueryChangeRegistry>
queryChangeRegistry
private com.nomagic.ci.persistence.local.query.IQueryFactory
queryFactory
private boolean
reloadRecommended
private boolean
relocatingIn
Is project relocatingprivate AbstractRepository
repository
private Package
rootPackage
static java.lang.String
SELECTION_CHANGED
Deprecated.now SelectionProvider fires selection changed, useSelectionProvider.SelectionChangedListener
The diagram objects selecting event type and naming.private com.nomagic.magicdraw.core.project.service.providers.ProjectServiceProvider
serviceProvider
private SmartEventSupport
smartEventSupport
private StateChangeHandler
stateChangeHandler
State changes handler.private com.nomagic.magicdraw.uml.symbols.StereotypesStyleChangeManager
stereotypesStyleChangeManager
private SymbolElementMap
symbolElementMap
private com.nomagic.magicdraw.commands.SymbolUpdater
symbolUpdater
Explicitly set symbol updater.private java.util.Map<java.lang.String,ProjectWindow>
windows
-
Constructor Summary
Constructors Constructor Description Project()
Constructor creates project.
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Deprecated Methods Modifier and Type Method Description void
accept(Visitor visitor)
Method accepts visitor, and calls method visit<class name>(this) of visitor .void
addElementByID(BaseElement obj, java.lang.String oldID)
Register the object by id.static void
addFeature(java.lang.String feature)
Register a feature for a new project.void
addToProjectRepository(Element element)
Adds element into this project repository and removes it from previous project repository.void
addWindow(ProjectWindow window)
private void
checkDuplicates(BaseElement obj, java.lang.String newID)
void
dispose()
Destroys the project.void
elementAdded(BaseElement element)
Marks element as added, if it was previously removed its id is removed from id collection.void
elementRemoved(BaseElement obj)
Marks element removed, its id added to mDeletedObjectIDS.private void
ensureLocalIDSet(BaseElement obj)
boolean
executeIntensiveAction(java.lang.String reason)
Executes time-intensive action if user agrees to.DiagramPresentationElement
getActiveDiagram()
Returns currently active diagram.java.util.Collection<BaseElement>
getAllElements()
Gets collection of all model elements in the projectjava.util.Collection<java.lang.String>
getAllIDS()
Returns the collection of all ids in the project.com.nomagic.magicdraw.core.BinaryStreamAtticCleaner
getBinaryStreamAtticCleaner()
Browser
getBrowser()
Get browser.com.nomagic.magicdraw.commands.CommandHistory
getCommandHistory()
CookieSet
getCookieSet()
com.nomagic.magicdraw.core.MDCounter
getCounter()
DiagramPresentationElement
getDiagram(Diagram diagramElement)
Returns diagram presentation element for specified diagram model element.com.nomagic.utils.ExtendedPropertyChangeSupport
getDiagramContentListeners()
Returns listeners of all diagrams content.java.util.Collection<DiagramPresentationElement>
getDiagrams()
Returns all existing diagrams stored in this Project.java.util.Collection<DiagramPresentationElement>
getDiagrams(java.lang.String type)
Returns existing diagrams of given type stored in Project.java.lang.String
getDirectory()
Deprecated.use #getFile.getParentStateChangeHandler.DirtyType
getDirtyType()
Returns project dirty type if project is dirty, otherwise - null.com.nomagic.magicdraw.ui.dsl.DSLManager
getDSLManager()
Returns project customization manager.BaseElement
getElementByID(java.lang.String id)
Return the element with given id.com.nomagic.magicdraw.core.Project.ElementByIDFetcher
getElementByIDQuerier()
java.util.Collection<? extends BaseElement>
getElementsByIDs(java.util.Collection<java.lang.String> ids)
Return the objects by given ids.java.util.Collection<? extends BaseElement>
getElementsByIDs(java.util.Collection<java.lang.String> ids, java.util.function.Supplier<java.util.Collection<BaseElement>> collectionFactory)
Return the objects by given ids.ElementsFactory
getElementsFactory()
static java.util.Collection<java.lang.String>
getElementsIDs(java.util.Collection<? extends BaseElement> elements)
Retrieves the elements ids from DTObjects collection.private com.nomagic.magicdraw.teamwork2.esi.EsiLockProjectService
getEsiLockProjectService()
XmiExporterDescription
getExporterDescription()
static java.util.Set<java.lang.String>
getFeatures()
Return registered features for a new project.com.nomagic.magicdraw.utils.ExtendedFile
getFile()
Method returns file of this project.java.lang.String
getFileName()
Method returns file name of this project.boolean
getHasUnloadedManuallyReachableModules()
ProjectDescriptor
getLoadedFrom()
Return location from were project was loaded.org.eclipse.emf.common.util.URI
getLocationUri()
Get URI location according the primary project.Model
getModel()
Deprecated.java.util.List<Package>
getModels()
Returns a list of models in the project (the primary model of the project and all the models of the modules (attached projects)).java.lang.String
getName()
Returns project name.<T> T
getOptionalService(java.lang.Class<T> type)
Returns project service of the specified type.ProjectOptions
getOptions()
Getter for project options.BaseElement
getPresentationElementByID(java.lang.String elementID)
Return the presentation element with given id from currently registered elements.Package
getPrimaryModel()
Returns the primary (main) model of the project (not including the ones from modules).IPrimaryProject
getPrimaryProject()
Primary project of MagicDraw project.Project
getProject()
static Project
getProject(BaseElement element)
Returns Project for given elementcom.nomagic.magicdraw.ui.ProjectDiagramWindowsManager
getProjectDiagramWindowsManager()
ProxyManager
getProxyManager()
private com.nomagic.ci.persistence.local.query.IQueryChangeRegistry
getQueryChangeRegistry()
private com.nomagic.ci.persistence.local.query.IQueryService
getQueryService()
java.lang.String
getRemoteID()
AbstractRepository
getRepository()
Get project repository.RepositoryListenerRegistry
getRepositoryListenerRegistry()
Return listener registry for repository.<T> T
getService(java.lang.Class<T> type)
Returns project service of the specified type.com.nomagic.magicdraw.core.project.service.providers.ProjectServiceProvider
getServiceProvider()
SmartEventSupport
getSmartEventSupport()
Returns registry that allows to register smart listener configurations by element type.StateChangeHandler
getStateChangeHandler()
com.nomagic.magicdraw.uml.symbols.StereotypesStyleChangeManager
getStereotypesStyleChangeHandler()
StyleManager
getStyleManager()
Returns style managerSymbolElementMap
getSymbolElementMap()
Get element symbol map.com.nomagic.magicdraw.commands.SymbolUpdater
getSymbolUpdater()
java.lang.String
getTitle()
com.nomagic.magicdraw.uml.transaction.MDTransactionManager
getTransactionsManager()
Return transaction manager.com.nomagic.magicdraw.uml.UMLModelProjectFeature
getUMLModelStorageFeature()
ProjectWindow
getWindow(java.lang.String id)
java.util.Collection<ProjectWindow>
getWindows()
boolean
hasWindow(java.lang.String id)
void
invalidateHasUnloadedManuallyReachableModules()
Invalidates thegetHasUnloadedManuallyReachableModules()
flagboolean
isClosing()
static boolean
isCreateBrowser()
boolean
isDirty()
Returns true if this project was modified after last save/load.boolean
isDisposed(BaseElement element)
Check if given element is unregistered from project.boolean
isEditable()
Checks if element can be edited.static boolean
isElementDisposed(Element element)
Check if given element is unregistered from project.boolean
isElementInProject(java.lang.String id)
Check if element with a given id is in this project.boolean
isEMFProxiesSupported()
boolean
isEsiProject()
Determines whether this is an ESI projectboolean
isFrozen()
boolean
isLoaded()
Return value of "loaded" flagboolean
isModel(BaseElement element)
Checks if the given element is a one of the models in this project.boolean
isNeedLocallySave()
Teamwork projects after commit can be saved locally, using flag to hold state about teamwork projects were saved locally.boolean
isNew()
boolean
isPreloadProject()
boolean
isProjectClosed()
Checks if this project was already disposed(closed).boolean
isProjectDisposed()
Deprecated.use #isProjectClosedboolean
isReady()
boolean
isReloadRecommended()
Indicates whether project reload is recommended to see the full effects of some user action.boolean
isRelocatedIn()
boolean
isRemote()
Returns the remote or not remote state of the project.boolean
isUpdatingProjectsInCurrentThread()
private BaseElement
queryElementByID(java.lang.String id)
void
refAddInstance(javax.jmi.reflect.RefBaseObject instance)
java.util.Collection<javax.jmi.reflect.RefBaseObject>
refAllOfClasses(java.util.Set<com.nomagic.uml2.ext.jmi.reflect.AbstractRefClass> classes)
void
refRemoveInstance(javax.jmi.reflect.RefBaseObject instance)
<T> void
register(java.lang.Class<T> type, T service)
Registers the specified service.void
removeElementByID(BaseElement obj)
Unregister the object by id.private void
removeElementByID(BaseElement obj, java.lang.String oldID)
Remove object from map by idstatic void
removeFeature(java.lang.String feature)
Unregister a feature for a new project.void
removeWindow(ProjectWindow window)
void
reSetDirty(boolean dirty, StateChangeHandler.DirtyType dirtyType)
Marks this project modified and sets modification type without checking previous project's dirty type.void
resetDynamicRepository()
Removes current dynamic repository if such exist and installs a new dynamic repository.private void
resetElementsByID()
Resets all records about objects and theirs ids.void
setClosing(boolean closing)
Set closing project statevoid
setCounter(com.nomagic.magicdraw.core.MDCounter c)
Sets the counter for the project.static void
setCreateBrowser(boolean createBrowser)
void
setDirectory(java.lang.String dir)
Deprecated.void
setDirty(boolean dirty)
Deprecated.void
setDirty(boolean dirty, StateChangeHandler.DirtyType dirtyType)
Marks this project modified and sets modification type depending on previous type.void
setExporterDescription(XmiExporterDescription exporterDescription)
void
setFileName(java.lang.String fileName)
Set the name of file as location of this project.void
setFrozen(boolean frozen)
Set frozen flag.void
setLoaded(boolean loaded)
Set "Loaded" flag for project.void
setModel(Package p)
void
setName(java.lang.String name)
Deprecated.void
setNeedLocallySave(boolean locallySaved)
void
setPrimaryProject(IProject primaryProject)
void
setPrimaryProject(IProject primaryProject, boolean closeOldProject, boolean changeModel)
Set primary project.void
setReloadRecommended(boolean reloadRecommended)
Sets new value forisReloadRecommended()
void
setRelocatingIn(boolean relocating)
Set project state to relocating.void
setRepository(AbstractRepository repository, com.nomagic.magicdraw.uml.transaction.InvalidModelHandler invalidModelHandler)
void
setSpecificSymbolUpdater(com.nomagic.magicdraw.commands.SymbolUpdater symbolUpdater)
void
setTitle(java.lang.String title)
private void
updateElementLockState(BaseElement obj)
-
Methods inherited from class com.nomagic.magicdraw.uml.ElementImpl
clone
-
Methods inherited from class com.nomagic.magicdraw.uml.MDElementImpl
accept, addPropertyChangeListener, atInsert, canAdd, canAdd, canAddChild, canAddChild, canAddInstance, canBeDeleted, canChangeParent, canDeleteChild, compareTo, createSortKeys, firePropertyChange, generateID, getClassType, getCommandForAppending, getHumanName, getHumanType, getID, getObjectParent, getProjectImpl, getProjectProvider, getResourceID, getSortKeys, hasListeners, isParentOf, removeAllChildren, removeAllParents, removeAllPropertyChangeListeners, removePropertyChangeListener, setID, setProjectProvider, sGetID, toString
-
-
-
-
Field Detail
-
cookies
private final CookieSet cookies
-
FEATURES
private static final java.util.Set<java.lang.String> FEATURES
A set of ci features available in runtime
-
closed
private volatile boolean closed
Is project disposed
-
frozen
private volatile boolean frozen
Is project frozen - some project data may not be accessible if project is frozen
-
closing
private volatile boolean closing
Is project closing
-
relocatingIn
private volatile boolean relocatingIn
Is project relocating
-
COMMAND_EXECUTED
@OpenApi public static final java.lang.String COMMAND_EXECUTED
The any command (adding object, deleting object, changing specifications) executing event type and naming.- See Also:
- Constant Field Values
-
SELECTION_CHANGED
@OpenApi @Deprecated public static final java.lang.String SELECTION_CHANGED
Deprecated.now SelectionProvider fires selection changed, useSelectionProvider.SelectionChangedListener
The diagram objects selecting event type and naming.- See Also:
- Constant Field Values
-
DIAGRAM_OPENED
@OpenApi public static final java.lang.String DIAGRAM_OPENED
The diagram window opening event type and naming.- See Also:
- Constant Field Values
-
DIAGRAM_CLOSED
@OpenApi public static final java.lang.String DIAGRAM_CLOSED
The diagram window closing event type and naming.- See Also:
- Constant Field Values
-
DIAGRAM_EDITED
@OpenApi public static final java.lang.String DIAGRAM_EDITED
The any diagram properties editing event type and naming.- See Also:
- Constant Field Values
-
DIAGRAM_ACTIVATED
@OpenApi public static final java.lang.String DIAGRAM_ACTIVATED
The diagram focus on event type and naming.- See Also:
- Constant Field Values
-
DIAGRAM_WINDOW_ACTIVATED
@OpenApi public static final java.lang.String DIAGRAM_WINDOW_ACTIVATED
The diagram window focus on event type and naming.- See Also:
- Constant Field Values
-
MANY_CLASSES_UPDATED
public static final java.lang.String MANY_CLASSES_UPDATED
Event type when many elements in project are changed (for example after project update,massive source reverse operation and etc)- See Also:
- Constant Field Values
-
FILE_NAME_PROPERTY
public static final java.lang.String FILE_NAME_PROPERTY
Project file name property- See Also:
- Constant Field Values
-
DIRTY_PROPERTY
public static final java.lang.String DIRTY_PROPERTY
Project "dirty" flag change- See Also:
- Constant Field Values
-
counter
private com.nomagic.magicdraw.core.MDCounter counter
Counter for ID
-
needLocallySave
private boolean needLocallySave
-
createBrowser
private static boolean createBrowser
Create project with or without browser.
-
browser
private Browser browser
-
windows
private final java.util.Map<java.lang.String,ProjectWindow> windows
-
commandHistory
private final com.nomagic.magicdraw.commands.CommandHistory commandHistory
Command history of project instance. It performs command executing, storing, undoing.
-
symbolUpdater
@CheckForNull private com.nomagic.magicdraw.commands.SymbolUpdater symbolUpdater
Explicitly set symbol updater. By default command history is used.
-
diagramWindowsManager
private final com.nomagic.magicdraw.ui.ProjectDiagramWindowsManager diagramWindowsManager
The window manager
-
objectsByID
private final java.util.Map<java.lang.String,java.lang.Object> objectsByID
The map of all objects registered by id.
-
stateChangeHandler
private StateChangeHandler stateChangeHandler
State changes handler.
-
stereotypesStyleChangeManager
private final com.nomagic.magicdraw.uml.symbols.StereotypesStyleChangeManager stereotypesStyleChangeManager
-
repository
private AbstractRepository repository
-
smartEventSupport
private final SmartEventSupport smartEventSupport
-
elementsFactory
private final ElementsFactory elementsFactory
-
rootPackage
private Package rootPackage
-
symbolElementMap
private SymbolElementMap symbolElementMap
-
proxyManager
private final ProxyManager proxyManager
Proxy manager
-
dslManager
private com.nomagic.magicdraw.ui.dsl.DSLManager dslManager
Project customization manager
-
loaded
private boolean loaded
-
file
private com.nomagic.magicdraw.utils.ExtendedFile file
-
elementByIDFetcher
private final com.nomagic.magicdraw.core.Project.ElementByIDFetcher elementByIDFetcher
-
binaryStreamAtticCleaner
private final com.nomagic.magicdraw.core.BinaryStreamAtticCleaner binaryStreamAtticCleaner
-
primaryProject
private IPrimaryProject primaryProject
Storage where project is loaded from or saved to.
-
queryFactory
private com.nomagic.ci.persistence.local.query.IQueryFactory queryFactory
-
hasUnloadedManuallyReachableModules
@CheckForNull private java.lang.Boolean hasUnloadedManuallyReachableModules
Determines whether there are manually reachable modules that are unloaded currently in this project
-
reloadRecommended
private boolean reloadRecommended
-
projectTitle
private java.lang.String projectTitle
Preset project title
-
intensiveActionExecuted
private volatile boolean intensiveActionExecuted
-
serviceProvider
private final com.nomagic.magicdraw.core.project.service.providers.ProjectServiceProvider serviceProvider
-
queryChangeRegistry
private final java.util.concurrent.atomic.AtomicReference<com.nomagic.ci.persistence.local.query.IQueryChangeRegistry> queryChangeRegistry
-
lockProjectService
private com.nomagic.magicdraw.teamwork2.esi.EsiLockProjectService lockProjectService
-
diagramContentListeners
private final com.nomagic.utils.ExtendedPropertyChangeSupport diagramContentListeners
-
-
Method Detail
-
isCreateBrowser
public static boolean isCreateBrowser()
-
setCreateBrowser
public static void setCreateBrowser(boolean createBrowser)
-
getElementsIDs
public static java.util.Collection<java.lang.String> getElementsIDs(java.util.Collection<? extends BaseElement> elements)
Retrieves the elements ids from DTObjects collection.- Parameters:
elements
- collection of elements to get ID's for- Returns:
- the collection of elements ids from the DTObjects collection.
-
executeIntensiveAction
public boolean executeIntensiveAction(java.lang.String reason)
Executes time-intensive action if user agrees to.- Parameters:
reason
- reason why the action might take a long time- Returns:
- true if execute action
-
getProxyManager
@OpenApi public ProxyManager getProxyManager()
- Returns:
- proxy manager of the project
-
getDSLManager
public com.nomagic.magicdraw.ui.dsl.DSLManager getDSLManager()
Returns project customization manager.- Returns:
- the manager.
-
getBrowser
@OpenApi public Browser getBrowser()
Get browser.- Returns:
- browser.
-
getOptions
@OpenApi public ProjectOptions getOptions()
Getter for project options.- Returns:
- project options
-
getCommandHistory
public com.nomagic.magicdraw.commands.CommandHistory getCommandHistory()
- Returns:
- project command history.
-
setSpecificSymbolUpdater
public void setSpecificSymbolUpdater(@CheckForNull com.nomagic.magicdraw.commands.SymbolUpdater symbolUpdater)
-
getSymbolUpdater
public com.nomagic.magicdraw.commands.SymbolUpdater getSymbolUpdater()
-
getElementByIDQuerier
public com.nomagic.magicdraw.core.Project.ElementByIDFetcher getElementByIDQuerier()
-
getActiveDiagram
@CheckForNull @OpenApi public DiagramPresentationElement getActiveDiagram()
Returns currently active diagram.- Returns:
- currently active diagram presentation element.
- See Also:
DiagramPresentationElement
-
getDiagrams
@OpenApi public java.util.Collection<DiagramPresentationElement> getDiagrams()
Returns all existing diagrams stored in this Project.- Returns:
- all existing DiagramPresentationElements. The collection is unmodifiable.
- See Also:
DiagramPresentationElement
-
getDiagrams
@OpenApi public java.util.Collection<DiagramPresentationElement> getDiagrams(@CheckForNull java.lang.String type)
Returns existing diagrams of given type stored in Project.- Parameters:
type
- the given diagrams type. Returns all diagrams if type is null.- Returns:
- collection of all diagram views.
- See Also:
DiagramPresentationElement
-
getDiagram
@CheckForNull @OpenApi public DiagramPresentationElement getDiagram(Diagram diagramElement)
Returns diagram presentation element for specified diagram model element.- Parameters:
diagramElement
- diagram model element- Returns:
- diagram presentation element.
-
setModel
public void setModel(Package p)
-
getTitle
public java.lang.String getTitle()
- Returns:
- project title
-
setTitle
public void setTitle(java.lang.String title)
-
getFileName
@CheckForNull @OpenApi public java.lang.String getFileName()
Method returns file name of this project. If file name is undefined returns project name.- Returns:
- file name of this project.
-
getDirectory
@Deprecated public java.lang.String getDirectory()
Deprecated.use #getFile.getParentReturns project directory.- Returns:
- project location directory.
-
setDirectory
@Deprecated public void setDirectory(java.lang.String dir)
Deprecated.Sets the project directory.- Parameters:
dir
- the new project directory.
-
setName
@Deprecated public void setName(java.lang.String name)
Deprecated.Sets the project name.- Parameters:
name
- the new project name.
-
getName
@OpenApi public java.lang.String getName()
Returns project name.
-
getFile
public com.nomagic.magicdraw.utils.ExtendedFile getFile()
Method returns file of this project.- Returns:
- file of this project
-
setFileName
public void setFileName(java.lang.String fileName)
Set the name of file as location of this project. Only local projects or locally saved remote projects can have file name.- Parameters:
fileName
- absolute file path
-
accept
public void accept(Visitor visitor) throws java.lang.Exception
Description copied from interface:MDElement
Method accepts visitor, and calls method visit<class name>(this) of visitor . See Visitor pattern for more details.
-
getCounter
public com.nomagic.magicdraw.core.MDCounter getCounter()
- Returns:
- id counter
-
getStyleManager
@CheckForNull public StyleManager getStyleManager()
Returns style manager- Returns:
- style manager
-
getProjectDiagramWindowsManager
public com.nomagic.magicdraw.ui.ProjectDiagramWindowsManager getProjectDiagramWindowsManager()
- Returns:
- diagrams windows manager
-
isRemote
@OpenApi public boolean isRemote()
Returns the remote or not remote state of the project.- Returns:
- true if project is a remote project, false otherwise.
-
isEsiProject
@OpenApi public boolean isEsiProject()
Determines whether this is an ESI project- Returns:
true
if ESI project,false
otherwise
-
isDirty
@OpenApi public boolean isDirty()
Returns true if this project was modified after last save/load.- Returns:
- true if this project was modified after last save/load.
-
setDirty
@Deprecated @OpenApi public void setDirty(boolean dirty)
Deprecated.Marks this project modified.- Parameters:
dirty
- new dirty flag.
-
setDirty
@OpenApi public void setDirty(boolean dirty, StateChangeHandler.DirtyType dirtyType)
Marks this project modified and sets modification type depending on previous type.- Parameters:
dirty
- new dirty flag.dirtyType
- specifies how much dirty is project.
IfdirtyType == null
, then default dirtyType value (DirtyType.HARD_DIRTY
) is set.
Ifdirty == true && dirtyType == DirtyType.SOFT_DIRTY
and project is already in state
dirty == true && dirtyType == DirtyType.HARD_DIRTY
, then project's state is not going to be changed.
-
getDirtyType
@CheckForNull @OpenApi public StateChangeHandler.DirtyType getDirtyType()
Returns project dirty type if project is dirty, otherwise - null.- Returns:
- project dirty type
-
reSetDirty
@OpenApi public void reSetDirty(boolean dirty, @CheckForNull StateChangeHandler.DirtyType dirtyType)
Marks this project modified and sets modification type without checking previous project's dirty type.- Parameters:
dirty
- new dirty flag.dirtyType
- specifies how much dirty is project. IfdirtyType == null
, then default dirtyType value (DirtyType.HARD_DIRTY
) is set.
-
setCounter
public void setCounter(com.nomagic.magicdraw.core.MDCounter c)
Sets the counter for the project.- Parameters:
c
- the new counter;
-
addElementByID
public void addElementByID(BaseElement obj, @CheckForNull java.lang.String oldID)
Register the object by id. The record about this object and its old id is removed.- Specified by:
addElementByID
in interfacecom.nomagic.uml2.ext.jmi.reflect.ElementRegistry
- Parameters:
obj
- the object to register.oldID
- the old id of the object.
-
getEsiLockProjectService
private com.nomagic.magicdraw.teamwork2.esi.EsiLockProjectService getEsiLockProjectService()
-
updateElementLockState
private void updateElementLockState(BaseElement obj)
-
addToProjectRepository
@OpenApi public void addToProjectRepository(Element element)
Adds element into this project repository and removes it from previous project repository. If element does not have an ID then it will be created.
After this operation element can be retrieved from project bygetElementByID(String)
.- Parameters:
element
- any element
-
ensureLocalIDSet
private void ensureLocalIDSet(BaseElement obj)
-
checkDuplicates
private void checkDuplicates(BaseElement obj, java.lang.String newID)
-
removeElementByID
private void removeElementByID(BaseElement obj, java.lang.String oldID)
Remove object from map by id- Parameters:
obj
- objectoldID
- old object id
-
removeElementByID
public void removeElementByID(BaseElement obj)
Unregister the object by id. The record about this object and is removed.- Specified by:
removeElementByID
in interfacecom.nomagic.uml2.ext.jmi.reflect.ElementRegistry
- Parameters:
obj
- the object.
-
getQueryService
private com.nomagic.ci.persistence.local.query.IQueryService getQueryService()
-
getQueryChangeRegistry
private com.nomagic.ci.persistence.local.query.IQueryChangeRegistry getQueryChangeRegistry()
-
getElementByID
@OpenApi @CheckForNull public BaseElement getElementByID(@CheckForNull java.lang.String id)
Return the element with given id.- Specified by:
getElementByID
in interfacecom.nomagic.uml2.ext.jmi.reflect.ElementRegistry
- Parameters:
id
- the id of the element.- Returns:
- the element with given id or null if element with such id is not registered in the project.
-
getPresentationElementByID
@CheckForNull public BaseElement getPresentationElementByID(java.lang.String elementID)
Return the presentation element with given id from currently registered elements.- Parameters:
elementID
- the id of the element, cannot be null- Returns:
- the element with given id or null if element with such id is not registered in the project.
-
queryElementByID
private BaseElement queryElementByID(java.lang.String id)
-
isElementDisposed
@OpenApi public static boolean isElementDisposed(@CheckForNull Element element)
Check if given element is unregistered from project.- Parameters:
element
- element- Returns:
- true if element is disposed
-
isDisposed
@OpenApi public boolean isDisposed(BaseElement element)
Check if given element is unregistered from project.- Parameters:
element
- element- Returns:
- true if element is disposed
-
getElementsByIDs
public java.util.Collection<? extends BaseElement> getElementsByIDs(java.util.Collection<java.lang.String> ids)
Return the objects by given ids.- Parameters:
ids
- the collection of the ids of the objects.- Returns:
- the collection of objects with given ids.
-
getElementsByIDs
public java.util.Collection<? extends BaseElement> getElementsByIDs(java.util.Collection<java.lang.String> ids, java.util.function.Supplier<java.util.Collection<BaseElement>> collectionFactory)
Return the objects by given ids.- Parameters:
ids
- the collection of the ids of the objects.- Returns:
- the collection of objects with given ids.
-
resetElementsByID
private void resetElementsByID()
Resets all records about objects and theirs ids.
-
getAllIDS
public java.util.Collection<java.lang.String> getAllIDS()
Returns the collection of all ids in the project.- Returns:
- the collection of all ids in the project.
-
getAllElements
public java.util.Collection<BaseElement> getAllElements()
Gets collection of all model elements in the project- Specified by:
getAllElements
in interfacecom.nomagic.uml2.ext.jmi.reflect.ElementRegistry
- Returns:
- collection of elements
-
dispose
public void dispose()
Destroys the project. After this method call project can not be used any more.- Specified by:
dispose
in interfaceBaseElement
- Overrides:
dispose
in classcom.nomagic.magicdraw.uml.MDElementImpl
-
isProjectClosed
public boolean isProjectClosed()
Checks if this project was already disposed(closed). Such project cannot be activated any more.- Returns:
- true if project was disposed (closed)
-
isProjectDisposed
@Deprecated public boolean isProjectDisposed()
Deprecated.use #isProjectClosedChecks if this project was already disposed(closed). Such project cannot be activated any more.- Returns:
- true if project was disposed (closed)
-
isClosing
public boolean isClosing()
- Returns:
- true if project is closing (preCloseFinal event is fired)
-
setClosing
public void setClosing(boolean closing)
Set closing project state- Parameters:
closing
- true if project is closing
-
getStateChangeHandler
public StateChangeHandler getStateChangeHandler()
- Returns:
- StateChangeHandler for this project.
-
elementAdded
public void elementAdded(BaseElement element)
Marks element as added, if it was previously removed its id is removed from id collection.- Parameters:
element
- element id which was added.
-
elementRemoved
public void elementRemoved(BaseElement obj)
Marks element removed, its id added to mDeletedObjectIDS.- Parameters:
obj
- element which was removed.
-
isElementInProject
public boolean isElementInProject(java.lang.String id)
Check if element with a given id is in this project.- Parameters:
id
- element id- Returns:
- true if element with given id is registered in project and is not removed.
-
addWindow
public void addWindow(ProjectWindow window)
-
removeWindow
public void removeWindow(ProjectWindow window)
-
getWindows
public java.util.Collection<ProjectWindow> getWindows()
-
hasWindow
public boolean hasWindow(java.lang.String id)
-
getWindow
public ProjectWindow getWindow(java.lang.String id)
-
getStereotypesStyleChangeHandler
public com.nomagic.magicdraw.uml.symbols.StereotypesStyleChangeManager getStereotypesStyleChangeHandler()
-
getRepository
@OpenApi public AbstractRepository getRepository()
Get project repository.- Specified by:
getRepository
in interfacecom.nomagic.uml2.ext.jmi.reflect.RepositoryProvider
- Returns:
- repository.
-
setRepository
public void setRepository(AbstractRepository repository, com.nomagic.magicdraw.uml.transaction.InvalidModelHandler invalidModelHandler)
-
resetDynamicRepository
public void resetDynamicRepository()
Removes current dynamic repository if such exist and installs a new dynamic repository.
-
getElementsFactory
@OpenApi public ElementsFactory getElementsFactory()
- Returns:
- Class for creating uml model elements.
-
getSmartEventSupport
@OpenApi public SmartEventSupport getSmartEventSupport()
Returns registry that allows to register smart listener configurations by element type.- Returns:
- smart listener registry.
-
isModel
public boolean isModel(@CheckForNull BaseElement element)
Checks if the given element is a one of the models in this project.- Parameters:
element
- element to check.- Returns:
- true if given element is a one of the models in this project.
-
getModel
@OpenApi @Deprecated @CheckForNull public Model getModel()
Deprecated.Returns root primary model - root container of all model structure. This method should not be called anymore for Cameo Enterprise Data Warehouse projects, because the returned model does not include the root models of modules (attached projects).getModels()
orgetPrimaryModel()
should be used instead as needed.- Returns:
- root model element
- Throws:
java.lang.IllegalStateException
- in case root element is not a Model, but a Package
-
getPrimaryModel
@OpenApi public Package getPrimaryModel()
Returns the primary (main) model of the project (not including the ones from modules).- Returns:
- the primary model of the project. Null is return only if project is closed or corrupted.
-
getModels
@OpenApi public java.util.List<Package> getModels()
Returns a list of models in the project (the primary model of the project and all the models of the modules (attached projects)).- Returns:
- model.
-
getSymbolElementMap
@OpenApi public SymbolElementMap getSymbolElementMap()
Get element symbol map.- Returns:
- symbol element map
-
getRepositoryListenerRegistry
@OpenApi public RepositoryListenerRegistry getRepositoryListenerRegistry()
Return listener registry for repository.- Returns:
- listener registry for repository.
-
getProject
public Project getProject()
- Specified by:
getProject
in interfaceMDElement
- Overrides:
getProject
in classcom.nomagic.magicdraw.uml.MDElementImpl
-
getRemoteID
@CheckForNull public java.lang.String getRemoteID()
-
isLoaded
public boolean isLoaded()
Return value of "loaded" flag- Returns:
- true if this project was loaded from some location or is saved to some location (is not just created from template)
-
getLoadedFrom
public ProjectDescriptor getLoadedFrom()
Return location from were project was loaded. For Teamwork project returns local file if project was saved into file (or was loaded from file).- Returns:
- location of project
-
setLoaded
public void setLoaded(boolean loaded)
Set "Loaded" flag for project. Project created from template is not "loaded"- Parameters:
loaded
- loaded flag
-
getProject
@OpenApi public static Project getProject(@CheckForNull BaseElement element)
Returns Project for given element- Parameters:
element
- project element.- Returns:
- project in which given element exists.
-
getExporterDescription
@CheckForNull public XmiExporterDescription getExporterDescription()
-
setExporterDescription
public void setExporterDescription(XmiExporterDescription exporterDescription)
-
getTransactionsManager
public com.nomagic.magicdraw.uml.transaction.MDTransactionManager getTransactionsManager()
Return transaction manager.- Returns:
- transaction manager
-
isNeedLocallySave
public boolean isNeedLocallySave()
Teamwork projects after commit can be saved locally, using flag to hold state about teamwork projects were saved locally.- Returns:
- true if project was not locally saved. Should be used only for teamwork projects.
-
setNeedLocallySave
public void setNeedLocallySave(boolean locallySaved)
-
setPrimaryProject
public void setPrimaryProject(IProject primaryProject)
-
setPrimaryProject
public void setPrimaryProject(IProject primaryProject, boolean closeOldProject, boolean changeModel)
Set primary project.- Parameters:
primaryProject
- project to set.closeOldProject
- close old project (do not close project when adding to teamwork).changeModel
- dispose old model (do not dispose UML model when adding to teamwork)
-
getPrimaryProject
@OpenApi public IPrimaryProject getPrimaryProject()
Primary project of MagicDraw project.- Returns:
- primary project.
-
addFeature
public static void addFeature(java.lang.String feature)
Register a feature for a new project.- Parameters:
feature
- feature name
-
removeFeature
public static void removeFeature(java.lang.String feature)
Unregister a feature for a new project.- Parameters:
feature
- name
-
getFeatures
public static java.util.Set<java.lang.String> getFeatures()
Return registered features for a new project.- Returns:
- registered features for a new project.
-
getUMLModelStorageFeature
public com.nomagic.magicdraw.uml.UMLModelProjectFeature getUMLModelStorageFeature()
-
getDiagramContentListeners
public com.nomagic.utils.ExtendedPropertyChangeSupport getDiagramContentListeners()
Returns listeners of all diagrams content.- Returns:
- diagrams content listeners
-
isNew
public boolean isNew()
- Returns:
- true if project is new and was never saved
-
getLocationUri
public org.eclipse.emf.common.util.URI getLocationUri()
Get URI location according the primary project.- Returns:
- URI.
-
isFrozen
public boolean isFrozen()
- Returns:
- true if project is frozen
-
setFrozen
public void setFrozen(boolean frozen)
Set frozen flag. Frozen projects do not provide some data.- Parameters:
frozen
- frozen flag
-
isReady
public boolean isReady()
- Returns:
- true if project is ready to use. It has primary project, it is not closed.
-
isEditable
public boolean isEditable()
Description copied from interface:BaseElement
Checks if element can be edited. Element can not be edited in teamwork project, or it is used "by reference" from module.- Specified by:
isEditable
in interfaceBaseElement
- Overrides:
isEditable
in classcom.nomagic.magicdraw.uml.MDElementImpl
- Returns:
- true, if element can be edited.
-
isRelocatedIn
public boolean isRelocatedIn()
- Returns:
- true if project is in relocating state
-
setRelocatingIn
public void setRelocatingIn(boolean relocating)
Set project state to relocating. Project is relocating if project content is coming from other project. This other project is in "relocated" state.- Parameters:
relocating
- relocating state
-
refAddInstance
public void refAddInstance(javax.jmi.reflect.RefBaseObject instance)
- Specified by:
refAddInstance
in interfacecom.nomagic.uml2.ext.jmi.reflect.ElementRegistry
-
refRemoveInstance
public void refRemoveInstance(javax.jmi.reflect.RefBaseObject instance)
- Specified by:
refRemoveInstance
in interfacecom.nomagic.uml2.ext.jmi.reflect.ElementRegistry
-
refAllOfClasses
public java.util.Collection<javax.jmi.reflect.RefBaseObject> refAllOfClasses(java.util.Set<com.nomagic.uml2.ext.jmi.reflect.AbstractRefClass> classes)
- Specified by:
refAllOfClasses
in interfacecom.nomagic.uml2.ext.jmi.reflect.ElementRegistry
-
isUpdatingProjectsInCurrentThread
public boolean isUpdatingProjectsInCurrentThread()
- Specified by:
isUpdatingProjectsInCurrentThread
in interfacecom.nomagic.uml2.ext.jmi.reflect.ElementRegistry
-
isPreloadProject
public boolean isPreloadProject()
- Specified by:
isPreloadProject
in interfacecom.nomagic.uml2.ext.jmi.reflect.ElementRegistry
-
getBinaryStreamAtticCleaner
public com.nomagic.magicdraw.core.BinaryStreamAtticCleaner getBinaryStreamAtticCleaner()
-
getHasUnloadedManuallyReachableModules
public boolean getHasUnloadedManuallyReachableModules()
- Returns:
- the hasUnloadedManuallyReachableModules
-
isReloadRecommended
public boolean isReloadRecommended()
Indicates whether project reload is recommended to see the full effects of some user action. This is set when certain conditions are detected during, for example, project save. So that code that controls the save can check the flag after the save and reload if possible- Returns:
true
if project reload is recommended,false
otherwise
-
setReloadRecommended
public void setReloadRecommended(boolean reloadRecommended)
Sets new value forisReloadRecommended()
- Parameters:
reloadRecommended
- the new value
-
invalidateHasUnloadedManuallyReachableModules
public void invalidateHasUnloadedManuallyReachableModules()
Invalidates thegetHasUnloadedManuallyReachableModules()
flag
-
getCookieSet
public CookieSet getCookieSet()
-
getOptionalService
@CheckForNull public <T> T getOptionalService(java.lang.Class<T> type)
Returns project service of the specified type.- Type Parameters:
T
- type.- Parameters:
type
- class of a service.- Returns:
- service.
-
getService
public <T> T getService(java.lang.Class<T> type)
Returns project service of the specified type.- Type Parameters:
T
- type.- Parameters:
type
- class of a service.- Returns:
- service.
- Throws:
java.lang.IllegalArgumentException
- if the requested service is not registered.
-
register
public <T> void register(java.lang.Class<T> type, T service)
Registers the specified service.- Type Parameters:
T
- type of the service.- Parameters:
type
- service type.service
- the service.
-
getServiceProvider
public com.nomagic.magicdraw.core.project.service.providers.ProjectServiceProvider getServiceProvider()
-
isEMFProxiesSupported
public boolean isEMFProxiesSupported()
- Specified by:
isEMFProxiesSupported
in interfacecom.nomagic.uml2.ext.jmi.reflect.ElementRegistry
-
-