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
```
The Project class represents main storage of all project data like: main package, all diagrams and diagram windows.

Field Summary

Fields
Modifier and Type	Field and Description
`static java.lang.String`	`COMMAND_EXECUTED` The any command (adding object, deleting object, changing specifications) executing event type and naming.
`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.
`static java.lang.String`	`SELECTION_CHANGED` Deprecated. now SelectionProvider fires selection changed, use `SelectionProvider.SelectionChangedListener` The diagram objects selecting event type and naming.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods Deprecated Methods
Modifier and Type	Method and Description
`void`	`addToProjectRepository(Element element)` Adds element into this project repository and removes it from previous project repository.
`DiagramPresentationElement`	`getActiveDiagram()` Returns currently active diagram.
`Browser`	`getBrowser()` Get browser.
`DiagramPresentationElement`	`getDiagram(Diagram diagramElement)` Returns diagram presentation element for specified diagram model element.
`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.
`StateChangeHandler.DirtyType`	`getDirtyType()` Returns project dirty type if project is dirty, otherwise - null.
`BaseElement`	`getElementByID(java.lang.String id)` Return the element with given id.
`ElementsFactory`	`getElementsFactory()`
`java.lang.String`	`getFileName()` Method returns file name of this 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.
`ProjectOptions`	`getOptions()` Getter for project options.
`Package`	`getPrimaryModel()` Returns the primary (main) model of the project (not including the ones from modules).
`IPrimaryProject`	`getPrimaryProject()` Primary project of MagicDraw project.
`static Project`	`getProject(BaseElement element)` Returns Project for given element
`ProxyManager`	`getProxyManager()`
`AbstractRepository`	`getRepository()` Get project repository.
`RepositoryListenerRegistry`	`getRepositoryListenerRegistry()` Return listener registry for repository.
`SmartEventSupport`	`getSmartEventSupport()` Returns registry that allows to register smart listener configurations by element type.
`SymbolElementMap`	`getSymbolElementMap()` Get element symbol map.
`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.
`static boolean`	`isElementDisposed(Element element)` Check if given element is unregistered from project.
`boolean`	`isEsiProject()` Determines whether this is an ESI project
`boolean`	`isRemote()` Returns the remote or not remote state of the project.
`boolean`	`isTeamworkServerProject()` Returns the state of project, whether it teamwork server project or not.
`void`	`reSetDirty(boolean dirty, StateChangeHandler.DirtyType dirtyType)` Marks this project modified and sets modification type without checking previous project's dirty type.
`void`	`setDirty(boolean dirty)` Deprecated. Use `#setDirty(boolean dirty, DirtyType dirtyType)`.
`void`	`setDirty(boolean dirty, StateChangeHandler.DirtyType dirtyType)` Marks this project modified and sets modification type depending on previous type.

Methods inherited from class com.nomagic.magicdraw.uml.ElementImpl
clone

Methods inherited from class com.nomagic.magicdraw.uml.MDElementImpl
accept, accept, addPropertyChangeListener, atInsert, canAdd, canAdd, canAddChild, canAddChild, canAddInstance, canBeDeleted, canChangeParent, canDeleteChild, compareTo, createSortKeys, dispose, firePropertyChange, generateID, getClassType, getCommandForAppending, getHumanName, getHumanType, getID, getObjectParent, getProject, getProjectImpl, getProjectProvider, getResourceID, getSortKeys, hasListeners, isEditable, isParentOf, removeAllChildren, removeAllParents, removeAllPropertyChangeListeners, removePropertyChangeListener, setID, setMDElement, setProjectProvider, sGetID, toString

Methods inherited from class java.lang.Object
equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface com.nomagic.uml2.ext.jmi.reflect.ElementRegistry
addElementByID, getAllElements, isPreloadProject, isUpdatingProjectsInCurrentThread, refAddInstance, refAllOfClasses, refRemoveInstance, removeElementByID

- Field Detail
  - 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, use SelectionProvider.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
- Method Detail
  - getProxyManager
```
@OpenApi
public ProxyManager getProxyManager()
```
    Returns:
    
    proxy manager of the project
  - getBrowser
```
@OpenApi
public Browser getBrowser()
```
    Get browser.
    
    Returns:
    
    browser.
  - getOptions
```
@OpenApi
public ProjectOptions getOptions()
```
    Getter for project options.
    
    Returns:
    
    project options
  - 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.
  - 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.
  - getName
```
@OpenApi
public java.lang.String getName()
```
    Returns project name.
    
    Specified by:
    
    getName in interface MDElement
    
    Overrides:
    
    getName in class com.nomagic.magicdraw.uml.MDElementImpl
    
    Returns:
    
    project name.
  - 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.
  - isTeamworkServerProject
```
@OpenApi
public boolean isTeamworkServerProject()
```
    Returns the state of project, whether it teamwork server project or not.
    
    Returns:
    
    true if project is a remote teamwork server 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. Use #setDirty(boolean dirty, DirtyType dirtyType).
    
    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.
    If dirtyType == null, then default dirtyType value (DirtyType.HARD_DIRTY) is set.
    If dirty == 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
```
@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,
                                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. If dirtyType == null, then default dirtyType value (DirtyType.HARD_DIRTY) is set.
  - 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 by getElementByID(String).
    
    Parameters:
    
    element - any element
  - getElementByID
```
@OpenApi
 @CheckForNull
public BaseElement getElementByID(@CheckForNull
                                                          java.lang.String id)
```
    Return the element with given id.
    
    Specified by:
    
    getElementByID in interface com.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.
  - 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
  - getRepository
```
@OpenApi
public AbstractRepository getRepository()
```
    Get project repository.
    
    Specified by:
    
    getRepository in interface com.nomagic.uml2.ext.jmi.reflect.RepositoryProvider
    
    Returns:
    
    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.
  - 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() or getPrimaryModel() 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
```
@OpenApi
public static Project getProject(@CheckForNull
                                          BaseElement element)
```
    Returns Project for given element
    
    Parameters:
    
    element - project element.
    
    Returns:
    
    project in which given element exists.
  - getPrimaryProject
```
@OpenApi
public IPrimaryProject getPrimaryProject()
```
    Primary project of MagicDraw project.
    
    Returns:
    
    primary project.

Class Project

Field Summary

Method Summary

Methods inherited from class com.nomagic.magicdraw.uml.ElementImpl

Methods inherited from class com.nomagic.magicdraw.uml.MDElementImpl

Methods inherited from class java.lang.Object

Methods inherited from interface com.nomagic.uml2.ext.jmi.reflect.ElementRegistry

Field Detail

COMMAND_EXECUTED

SELECTION_CHANGED

DIAGRAM_OPENED

DIAGRAM_CLOSED

DIAGRAM_EDITED

DIAGRAM_ACTIVATED

DIAGRAM_WINDOW_ACTIVATED

Method Detail

getProxyManager

getBrowser

getOptions

getActiveDiagram

getDiagrams

getDiagrams

getDiagram

getFileName

getName

isRemote

isTeamworkServerProject

isEsiProject

isDirty

setDirty

setDirty

getDirtyType

reSetDirty

addToProjectRepository

getElementByID

isElementDisposed

isDisposed

getRepository

getElementsFactory

getSmartEventSupport

getModel

getPrimaryModel

getModels

getSymbolElementMap

getRepositoryListenerRegistry

getProject

getPrimaryProject