com.nomagic.magicdraw.magicreport.tools

Class ProjectTool

java.lang.Object

java.util.Observable

com.nomagic.magicreport.engine.Tool

com.nomagic.magicdraw.magicreport.tools.ProjectTool

All Implemented Interfaces:

com.nomagic.magicreport.engine.ITool, com.nomagic.magicreport.IVariable, java.io.Serializable, java.lang.Cloneable

@OpenApiAll
public class ProjectTool
extends com.nomagic.magicreport.engine.Tool

A MagicDraw project wrapper.

Since:

Dec 7, 2007

See Also:

Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from interface com.nomagic.magicreport.engine.ITool

com.nomagic.magicreport.engine.ITool.HTMLString, com.nomagic.magicreport.engine.ITool.RetainedString, com.nomagic.magicreport.engine.ITool.Void

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	CONTEXT_NAME Contains a context name.

Fields inherited from class com.nomagic.magicreport.engine.Tool

context, properties

Fields inherited from interface com.nomagic.magicreport.engine.ITool

VOID

Constructor Summary

Constructors

Constructor and Description
ProjectTool()

Method Summary

Modifier and Type	Method and Description
java.util.Collection<java.lang.String>	getAllElementId() Return the collection of all element id in the project.
java.util.List<Package>	getAllModels() 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	getDescription() Get project description.
java.util.Collection<Diagram>	getDiagrams() Return all existing diagrams stored in this Project.
java.util.Collection<Diagram>	getDiagrams(java.lang.String type) Return existing diagrams of given type stored in Project.
java.lang.String	getDirectory() Return project directory.
BaseElement	getElementByID(java.lang.String id) Return the Element with given id.
java.lang.String	getExtension() Return project file extension.
java.lang.String	getFileName() Method returns file name of this project.
Model	getModel() Deprecated. use ProjectTool#getPrimaryModel()
java.lang.String	getName() Return project name.
java.util.Collection<DiagramPresentationElement>	getPresentationDiagrams() Return all existing presentation diagrams stored in this Project.
java.util.Collection<DiagramPresentationElement>	getPresentationDiagrams(java.lang.String type) Return existing presentation diagrams of given type stored in Project.
Package	getPrimaryModel() Returns the primary (main) model of the project (not including the ones from modules).
java.lang.String	getTitle() Return project title.
long	getVersion() Return project version number.
java.util.List<com.nomagic.magicdraw.magicreport.tools.ProjectVersion>	getVersionList() Return a list of ProjectVersion information from opened server project.
int	getXmiVersion() Return the projects XMI version.
boolean	isDirty() Return true if this project was modified after last save/load.
boolean	isRemote() Return the remote or not remote state of the project.

Methods inherited from class com.nomagic.magicreport.engine.Tool

clone, getContext, getProperties, getProperty, getProperty, notifyObservers, setContext, setProperties

Methods inherited from class java.util.Observable

addObserver, clearChanged, countObservers, deleteObserver, deleteObservers, hasChanged, notifyObservers, setChanged

Methods inherited from class java.lang.Object

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

Field Detail

CONTEXT_NAME

public static final java.lang.String CONTEXT_NAME

Contains a context name.

See Also:

Constant Field Values

Constructor Detail

ProjectTool

public ProjectTool()

Method Detail

getDiagrams

public java.util.Collection<Diagram> getDiagrams()

Return all existing diagrams stored in this Project.

Returns:

collection of Diagram instance.

getDiagrams

public java.util.Collection<Diagram> getDiagrams(java.lang.String type)

Return existing diagrams of given type stored in Project.

Parameters:

type - the given diagrams type.

Returns:

collection of Diagram instance.

getPresentationDiagrams

public java.util.Collection<DiagramPresentationElement> getPresentationDiagrams()

Return all existing presentation diagrams stored in this Project.

Returns:

collection of diagram views.

getPresentationDiagrams

public java.util.Collection<DiagramPresentationElement> getPresentationDiagrams(java.lang.String type)

Return existing presentation diagrams of given type stored in Project.

Parameters:

type - the given diagrams type.

Returns:

collection of diagram views.

getName

public java.lang.String getName()

Return project name.

Returns:

project name.

getTitle

public java.lang.String getTitle()

Return project title.

Returns:

project title

getExtension

public java.lang.String getExtension()

Return project file extension.

Returns:

project file extension.

getDirectory

public java.lang.String getDirectory()

Return project directory.

Returns:

project location directory.

getFileName

@CheckForNull
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.

isRemote

public boolean isRemote()

Return the remote or not remote state of the project.

Returns:

true if project is a remote project, false otherwise.

isDirty

public boolean isDirty()

Return true if this project was modified after last save/load.

Returns:

true if this project was modified after last save/load.

getElementByID

@CheckForNull
public BaseElement getElementByID(java.lang.String id)

Return the Element with given id.

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.

getAllElementId

public java.util.Collection<java.lang.String> getAllElementId()

Return the collection of all element id in the project.

Returns:

the collection of all element id in the project.

getXmiVersion

public int getXmiVersion()

Return the projects XMI version.

Returns:

xmi version

getModel

@Deprecated
 @CheckForNull
public Model getModel()

Deprecated. use ProjectTool#getPrimaryModel()

Returns the primary (main) model of the project (not including the ones from modules). 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). getPrimaryModel() should be used instead as needed.

Returns:

Model

getPrimaryModel

@CheckForNull
public Package getPrimaryModel()

Returns the primary (main) model of the project (not including the ones from modules).

Returns:

Model

getAllModels

public java.util.List<Package> getAllModels()

Returns a list of models in the project (the primary model of the project and all the models of the modules (attached projects)).

Returns:

models.

getVersion

public long getVersion()

Return project version number.

Returns:

project version number

getVersionList

public java.util.List<com.nomagic.magicdraw.magicreport.tools.ProjectVersion> getVersionList()

Return a list of ProjectVersion information from opened server project.

Returns:

List of ProjectVersion

getDescription

public java.lang.String getDescription()

Get project description.

Returns:

project description