Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Content layer
id1776059845
Content column
id1776059851
Content block
id1776059842

On this page

Table of Contents

Content block
id1776059849

$project is a project reference enabling a template to return the project information.

$project.getName()

Returns a project name.


NameTypeDescription
Parameter(s)---
Return-java.lang.StringA project name.

$project.getTitle()

Gets a project title.


NameTypeDescription
Parameter(s)---
Return-java.lang.StringA project title.

$project.getFileName()

Gets a project filename.


NameTypeDescription
Parameter(s)---
Return-java.lang.StringA project filename.

$project.getExtension()

Gets a project filename extension.

Note
titleNote

This function is only for local projects.


NameTypeDescription
Parameter(s)---
Return-java.lang.StringA project filename extension.

$project.getDirectory()

Get a project directory name.

Note
titleNote

This function is only for local projects.


NameTypeDescription
Parameter(s)---
Return-java.lang.StringA project directory name.

$project.getVersionList()

Returns a list of version information from an open Server project.


NameTypeDescription
Return-java.util.List<ProjectVersion>A list of com.nomagic.magicdraw.magicreport.tools.ProjectsVersion.

$project.getDiagrams()

Returns all existing diagrams stored in a particular project.


NameTypeDescription
Return-java.util.CollectionA collection of diagram instances.

$project.getDiagrams(type)

Returns existing diagrams of a given type stored in a particular project.


NameTypeDescription
Parameter(s)typejava.lang.StringA diagram type.
Return-java.util.CollectionA collection of diagram instances.
Code Block
languagetext
titleSample code
#set($classDiagram = $project.getDiagrams("Class Diagram"))
#foreach($cl in $classDiagram)
$cl.name
#end
  • “Class Diagram” is a diagram type.

$project.getPresentationDiagrams()

Returns all existing presentation diagrams stored in a particular project.


NameTypeDescription
Return

-

java.util.CollectionA collection of diagram views.


$project.getPresentationDiagrams(type)

Returns all existing presentation diagrams of a given type stored in a particular project.


NameTypeDescription
Parameter(s)typejava.lang.StringA diagram type.
Return-java.util.CollectionA collection of diagram views.
Code Block
languagetext
titleSample code
#set($classDiagram = $project.getPresentationDiagrams("Class Diagram"))
#foreach($cl in $classDiagram)
$cl.name
#end


  • “Class Diagram” is a diagram type.

$project.isRemote()

Returns the remote or non-remote state of a project.


NameTypeDescription
Return-java.lang.BooleanReturn true if a
project is a remote
project, otherwise false.

$project.isDirty()

Returns true if that particular project was modified after it had been saved or loaded.


NameTypeDescription
Return

-

java.lang.BooleanReturn true if a
project was modified
after it had been
saved/loaded,
otherwise false.

$project.getElementByID(id)

Returns an element with a given ID.

 NameTypeDescription
Parameter(s)IDjava.lang.StringAn element ID.
Return-com.nomagic.magicdraw.uml.BaseElementAn element with a given ID or null
if the element with such ID is not
registered in the project.
Code Block
languagetext
titleSample code
#set($ele = $project.getElementByID("_9_0_62a020a_1105704887361_983947_8206"))
$ele.name
$ele.humanType


  • “_9_0_62a020a_1105704887361_983947_8206” is the element’s ID number.

$project.getAllElementId()

Returns a collection of all element IDs in a project.


NameTypeDescription
Return-java.util.CollectionA collection of all element IDs in a project.

$project.getXmiVersion()

Returns the XMI version of a project.


NameTypeDescription
Return-intAn XMI version.

$project.getVersion()

Return a project version number.


NameTypeDescription
Return-longA project version number.

$project.getModel()

Returns a model (the root container of all model structures).


NameTypeDescription
Return-com.nomagic.uml2.ext.magicdraw.auxiliaryconstructs.mdmodels.ModelA model.
Warning

$project.getModel() is deprecated since MagicDraw 18.2, please use $project.getPrimaryModel() instead

$project.getPrimaryModel()

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


NameTypeDescription
Return-com.nomagic.uml2.ext.magicdraw.classes.mdkernel.PackageThe primary model
of the project.

$project.getAllModels()

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


NameTypeDescription
Return-Java.util.ListA list of
models.

-------

$project.getModuleList()

Returns a list of used server and local modules from a current project.


NameTypeDescription
Return-java.util.CollectionA collection of com.nomagic.magicdraw.magicreport.tools.ProjectModule.

$project.getModuleList(includeAuxiliary)

Returns a list of used server and local modules as well as auxiliary resources from a current project.


NameTypeDescription
Parameter(s)includeAuxiliarybooleanReturns
module
modules including auxiliary resources
when
if this value is
True. Default is false
true (false by default).
Return-java.util.CollectionA collection of com.nomagic.magicdraw.magicreport.tools.ProjectModule.

$project.getSharedModule()

Returns a list of shared modules from a current project.


NameTypeDescription
Return-java.util.CollectionA collection of com.nomagic.magicdraw.magicreport.tools.ProjectModule.

$project.getSharedModule(projectModule)

Returns a list of shared modules from a specified project module.


NameTypeDescription
Parameter(s)projectModulecom.nomagic.magicdraw.magicreport.tools.ProjectModuleA project module.
Return-java.util.CollectionA collection of com.nomagic.magicdraw.magicreport.tools.ProjectModule.

$project.getServerModule()

This function returns the Returns a list of used server modules.


NameTypeDescription
Return-java.util.CollectionA collection of com.nomagic.magicdraw.magicreport.tools.ProjectModule.

$project.getServerModule(includeAuxiliary)

This function returns the Returns a list of used server modules as well as auxiliary resources.


NameTypeDescription
Parameter(s)includeAuxiliarybooleanReturns server modules including auxiliary resources
when
if this value is
True. Default is false
true (false by default).
Return-java.util.CollectionA collection of com.nomagic.magicdraw.magicreport.tools.ProjectModule.

$project.getLocalModule()

This function returns the Returns a list of used local modules.


NameTypeDescription
Return-java.util.CollectionA collection of com.nomagic.magicdraw.magicreport.tools.ProjectModule.

$project.getLocalModule(includeAuxiliary)

This function returns the Returns a list of used local modules as well as auxiliary resources.


NameTypeDescription
Parameter(s)includeAuxiliarybooleanReturns local modules including auxiliary resources
when
if this value is
True. Default is false
true (false by default).
Return-java.util.CollectionA collection of com.nomagic.magicdraw.magicreport.tools.ProjectModule.

$project.getAuxiliaryResource()

This function returns Returns a list of auxiliary resources.


NameTypeDescription
Return-java.util.CollectionA collection of com.nomagic.magicdraw.magicreport.tools.ProjectModule.


ProjectVersionProject Version

Full The full class name is com.nomagic.magicdraw.magicreport.tools.ProjectVersion.
ProjectVersion is a class that represents some version of the project or module. It contains date, user, and number, etc.
ProjectVersion contains the following properties:

PropertyReturn
Type
typeDescription
commentjava.lang.String
Return
Returns a version committed comment.
datejava.util.Date
Return
Returns a committed date.
dateAsStringjava.lang.String
Return
Returns a committed date as text.
numberlong
Return
Returns a committed version.
numberAsStringjava.lang.String
Return
Returns a committed version as text.
userjava.lang.String
Return
Returns a committer’s name.
versionjava.lang.Object
Return
Returns a version object that can be com.nomagic.teamwork.common.projects.Version for a Teamwork project or com.nomagic.magicdraw.esi.project.project.IEsiVersionDescriptor for a Teamwork Cloud project.
tagsjava.util.List<java.lang.String>
Return
Returns all tags
Sample code
.
Code Block
languagetext
titleSample code
Current version : $project.version
All version:
#foreach ($version in $project.getVersionList())
	Date : 				$version.date
	Number : 			$version.number
	Number As String : 	$version.numberAsString
	User : 				$version.user
	Comment : 			$version.comment
	Tags: 	
#foreach($tag in $version.tags) 
						- tag
			#end
---
#end

ProjectModuleProject Module

Full The full class name is com.nomagic.magicdraw.magicreport.tools.ProjectModule.
ProjectModule is a wrapper Class of an attached project (com.nomagic.ci.persistence.IAttachedProject) that represents a special kind of the project that is used as a component in the current project.
Example The following are some properties and methods of ProjectModule:

Property / MethodReturn
Type
typeDescription
representationStringjava.lang.String
Return
Returns user-friendly representation string about the module.
descriptionjava.lang.String
Return
Returns project description of the module.
versionlong
Return
Returns a version number of the module.
requiredVersionjava.lang.String
Return
Returns a required version of the module. This property works for Teamwork Server
project
projects. It will return -1 when the module is the latest version, and the required version is not set.
remoteIDjava.lang.String
Return
Returns a remote
id
ID for the module.
URIjava.net.URI
Convert
Converts EMF
uri
URI to java.net.URI.
versionListjava.util.List<com.nomagic.magicdraw.magicreport.tools.ProjectVersion
Return
Returns a list of version descriptors of the module.
isRemote()boolean
Check
Checks if the module is remote - from Teamwork server or
TW
Teamwork Cloud.
Sample code
Code Block
languagetext
titleSample code
#foreach($module in $project.getModuleList())
	Name : $module.representationString
	Description : $module.description
	Version : $module.version
	RemoteID : $module.remoteID
	URI : $module.URI 
#if($module.isRemote())
#set($version = $module.projectVersion)
	Current module version :
		date : $version.date
		number : $version.number 
		numberAsString : $version.numberAsString
		user : $version.user
		comment : $version.comment
		tags: 
#foreach($tag in $version.tags) 
- $tag 
#end
	All All
module versions : 
#foreach($version in $module.versionList)
		date : $version.date
		number : $version.number
		numberAsString : $version.numberAsString
		user : $version.usercomment : $version.comment 
		tags: 
#foreach($tag in $version.tags) 
- $tag 
#end 
---------- 
#end 
#end 
	Shared module: 
#foreach ($child in $project.getSharedModule($module)) 
		- 
$child.representationString
#end
#end