public class MagicDrawHelper
extends java.lang.Object
Constructor and Description |
---|
MagicDrawHelper() |
Modifier and Type | Method and Description |
---|---|
static void |
cancelSession()
Cancels an open session, causing all programmatically completed changes in the current
session to be lost and not recorded in the model.
|
static void |
clearModel()
Deletes all editable container elements in a project.
|
static void |
closeProject() |
static void |
closeSession()
Closes an open session, causing all programmatically completed changes in the current
session to be reflected in the model.
|
static com.nomagic.uml2.ext.magicdraw.classes.mdkernel.Element |
copyElementToTarget(com.nomagic.uml2.ext.magicdraw.classes.mdkernel.Element elementToCopy,
com.nomagic.uml2.ext.magicdraw.classes.mdkernel.Element copyTarget)
Copies specific elements to a location
|
static com.nomagic.uml2.ext.magicdraw.classes.mdkernel.Association |
createAssociation(com.nomagic.uml2.ext.magicdraw.classes.mdkernel.Element owner,
com.nomagic.uml2.ext.magicdraw.classes.mdkernel.Element source,
com.nomagic.uml2.ext.magicdraw.classes.mdkernel.Element target)
Element Creation Functions
|
static com.nomagic.uml2.ext.magicdraw.classes.mdkernel.Class |
createBlock(java.lang.String name,
com.nomagic.uml2.ext.magicdraw.classes.mdkernel.Element owner) |
static com.nomagic.uml2.ext.magicdraw.classes.mdkernel.Class |
createClass(java.lang.String name,
com.nomagic.uml2.ext.magicdraw.classes.mdkernel.Element owner) |
static com.nomagic.uml2.ext.magicdraw.components.mdbasiccomponents.Component |
createComponent(java.lang.String name,
com.nomagic.uml2.ext.magicdraw.classes.mdkernel.Element owner) |
static com.nomagic.uml2.ext.magicdraw.classes.mdkernel.Constraint |
createConstraint(java.lang.String name,
com.nomagic.uml2.ext.magicdraw.classes.mdkernel.Element owner,
com.nomagic.uml2.ext.magicdraw.classes.mdkernel.ValueSpecification spec) |
static com.nomagic.uml2.ext.magicdraw.classes.mddependencies.Dependency |
createDependency(java.lang.String name,
com.nomagic.uml2.ext.magicdraw.classes.mdkernel.Element owner,
com.nomagic.uml2.ext.magicdraw.classes.mdkernel.Element source,
com.nomagic.uml2.ext.magicdraw.classes.mdkernel.Element target) |
static com.nomagic.uml2.ext.magicdraw.classes.mdkernel.Association |
createDirectedComposition(com.nomagic.uml2.ext.magicdraw.classes.mdkernel.Element document,
com.nomagic.uml2.ext.magicdraw.classes.mdkernel.Element view) |
static com.nomagic.uml2.ext.magicdraw.classes.mdkernel.Class |
createDocument(java.lang.String name,
com.nomagic.uml2.ext.magicdraw.classes.mdkernel.Element owner) |
static com.nomagic.uml2.ext.magicdraw.classes.mdkernel.Generalization |
createGeneralization(java.lang.String name,
com.nomagic.uml2.ext.magicdraw.classes.mdkernel.Element owner,
com.nomagic.uml2.ext.magicdraw.classes.mdkernel.Element source,
com.nomagic.uml2.ext.magicdraw.classes.mdkernel.Element target) |
static com.nomagic.uml2.ext.magicdraw.classes.mdkernel.Package |
createPackage(java.lang.String name,
com.nomagic.uml2.ext.magicdraw.classes.mdkernel.Element owner) |
static com.nomagic.uml2.ext.magicdraw.classes.mdkernel.Property |
createPartProperty(java.lang.String name,
com.nomagic.uml2.ext.magicdraw.classes.mdkernel.Element owner) |
static com.nomagic.uml2.ext.magicdraw.classes.mdkernel.Property |
createProperty(java.lang.String name,
com.nomagic.uml2.ext.magicdraw.classes.mdkernel.Element owner,
com.nomagic.uml2.ext.magicdraw.classes.mdkernel.ValueSpecification defaultValue,
com.nomagic.uml2.ext.magicdraw.classes.mdkernel.Element typeElement,
java.lang.String aggregation,
java.lang.String multMin,
java.lang.String multMax) |
static void |
createSession()
Creates a MagicDraw Session.
|
static com.nomagic.uml2.ext.magicdraw.components.mdbasiccomponents.Component |
createSiteCharComponent(java.lang.String name,
com.nomagic.uml2.ext.magicdraw.classes.mdkernel.Element owner) |
static com.nomagic.uml2.ext.magicdraw.classes.mdkernel.ValueSpecification |
createValueSpec(java.lang.String type,
java.lang.String value)
Deprecated.
|
static com.nomagic.uml2.ext.magicdraw.classes.mdkernel.Class |
createView(java.lang.String name,
com.nomagic.uml2.ext.magicdraw.classes.mdkernel.Element owner) |
static void |
deleteEditableContainerChildren(com.nomagic.uml2.ext.magicdraw.classes.mdkernel.Element parent)
Deletes all elements in a project under the indicated parent.
|
static void |
deleteMDElement(com.nomagic.uml2.ext.magicdraw.classes.mdkernel.Element ele)
Deletes selected element from Magic Draw, including children
Convenience method for the MD API.
|
static void |
generalMessage(java.lang.String s)
Prints a message to console and MD log
|
static java.lang.String |
getElementDocumentation(com.nomagic.uml2.ext.magicdraw.classes.mdkernel.Element target)
Returns the element's documentation, stripped of HTML wrapper
|
static java.lang.String |
getPropertyValue(com.nomagic.uml2.ext.magicdraw.classes.mdkernel.Element target)
Returns the value of the passed property
|
static java.lang.String |
getSpecificationValue(com.nomagic.uml2.ext.magicdraw.classes.mdkernel.ValueSpecification vs)
Returns the value stored in a ValueSpecification
|
static com.nomagic.magicdraw.core.project.ProjectDescriptor |
openProject(java.io.File file)
Project load / close functions
|
static com.nomagic.magicdraw.core.project.ProjectDescriptor |
openProject(java.net.URI uri) |
static void |
prepareMMS(java.lang.String url,
java.lang.String site)
Deprecated.
|
static void |
saveProject(java.lang.String filename) |
static void |
setElementDocumentation(com.nomagic.uml2.ext.magicdraw.classes.mdkernel.Element target,
java.lang.String documentation)
Sets the comments of the target element, adding the necessary html
wrapper
|
static void |
setElementName(com.nomagic.uml2.ext.magicdraw.classes.mdkernel.NamedElement target,
java.lang.String newName)
Sets the name of the passed NamedElement.
|
public static com.nomagic.magicdraw.core.project.ProjectDescriptor openProject(java.io.File file) throws java.io.IOException
java.io.IOException
public static com.nomagic.magicdraw.core.project.ProjectDescriptor openProject(java.net.URI uri) throws java.io.IOException
java.io.IOException
public static void saveProject(java.lang.String filename)
public static void closeProject()
public static void createSession() throws java.lang.IllegalStateException
java.lang.IllegalStateException
public static void closeSession() throws java.lang.IllegalStateException
java.lang.IllegalStateException
public static void cancelSession() throws java.lang.IllegalStateException
java.lang.IllegalStateException
public static void generalMessage(java.lang.String s)
public static com.nomagic.uml2.ext.magicdraw.classes.mdkernel.Element copyElementToTarget(com.nomagic.uml2.ext.magicdraw.classes.mdkernel.Element elementToCopy, com.nomagic.uml2.ext.magicdraw.classes.mdkernel.Element copyTarget)
elementToCopy
- copyTarget
- public static void deleteEditableContainerChildren(com.nomagic.uml2.ext.magicdraw.classes.mdkernel.Element parent) throws com.nomagic.magicdraw.openapi.uml.ReadOnlyElementException
parent
- Parent element under which you want to delete elements.com.nomagic.magicdraw.openapi.uml.ReadOnlyElementException
public static void clearModel() throws com.nomagic.magicdraw.openapi.uml.ReadOnlyElementException
com.nomagic.magicdraw.openapi.uml.ReadOnlyElementException
public static void deleteMDElement(com.nomagic.uml2.ext.magicdraw.classes.mdkernel.Element ele) throws com.nomagic.magicdraw.openapi.uml.ReadOnlyElementException
ele
- selected element to be deleted.com.nomagic.magicdraw.openapi.uml.ReadOnlyElementException
public static java.lang.String getElementDocumentation(com.nomagic.uml2.ext.magicdraw.classes.mdkernel.Element target)
target
- The level element whose comment you want to returnpublic static java.lang.String getPropertyValue(com.nomagic.uml2.ext.magicdraw.classes.mdkernel.Element target)
target
- The property whose value you wish to inspectpublic static java.lang.String getSpecificationValue(com.nomagic.uml2.ext.magicdraw.classes.mdkernel.ValueSpecification vs)
vs
- The ValueSpecification to extract a value frompublic static void setElementDocumentation(com.nomagic.uml2.ext.magicdraw.classes.mdkernel.Element target, java.lang.String documentation)
target
- The level element whose comment you want to changedocumentation
- The new comments for the target elementpublic static void setElementName(com.nomagic.uml2.ext.magicdraw.classes.mdkernel.NamedElement target, java.lang.String newName)
target
- The NamedElement to renamenewName
- The new name for the element@Deprecated public static void prepareMMS(java.lang.String url, java.lang.String site)
public static com.nomagic.uml2.ext.magicdraw.classes.mdkernel.Association createAssociation(com.nomagic.uml2.ext.magicdraw.classes.mdkernel.Element owner, com.nomagic.uml2.ext.magicdraw.classes.mdkernel.Element source, com.nomagic.uml2.ext.magicdraw.classes.mdkernel.Element target)
public static com.nomagic.uml2.ext.magicdraw.classes.mdkernel.Class createBlock(java.lang.String name, com.nomagic.uml2.ext.magicdraw.classes.mdkernel.Element owner)
public static com.nomagic.uml2.ext.magicdraw.classes.mdkernel.Class createClass(java.lang.String name, com.nomagic.uml2.ext.magicdraw.classes.mdkernel.Element owner)
public static com.nomagic.uml2.ext.magicdraw.components.mdbasiccomponents.Component createComponent(java.lang.String name, com.nomagic.uml2.ext.magicdraw.classes.mdkernel.Element owner)
public static com.nomagic.uml2.ext.magicdraw.classes.mdkernel.Constraint createConstraint(java.lang.String name, com.nomagic.uml2.ext.magicdraw.classes.mdkernel.Element owner, com.nomagic.uml2.ext.magicdraw.classes.mdkernel.ValueSpecification spec)
public static com.nomagic.uml2.ext.magicdraw.classes.mdkernel.Association createDirectedComposition(com.nomagic.uml2.ext.magicdraw.classes.mdkernel.Element document, com.nomagic.uml2.ext.magicdraw.classes.mdkernel.Element view)
public static com.nomagic.uml2.ext.magicdraw.classes.mddependencies.Dependency createDependency(java.lang.String name, com.nomagic.uml2.ext.magicdraw.classes.mdkernel.Element owner, com.nomagic.uml2.ext.magicdraw.classes.mdkernel.Element source, com.nomagic.uml2.ext.magicdraw.classes.mdkernel.Element target)
public static com.nomagic.uml2.ext.magicdraw.classes.mdkernel.Class createDocument(java.lang.String name, com.nomagic.uml2.ext.magicdraw.classes.mdkernel.Element owner)
public static com.nomagic.uml2.ext.magicdraw.classes.mdkernel.Generalization createGeneralization(java.lang.String name, com.nomagic.uml2.ext.magicdraw.classes.mdkernel.Element owner, com.nomagic.uml2.ext.magicdraw.classes.mdkernel.Element source, com.nomagic.uml2.ext.magicdraw.classes.mdkernel.Element target)
public static com.nomagic.uml2.ext.magicdraw.classes.mdkernel.Package createPackage(java.lang.String name, com.nomagic.uml2.ext.magicdraw.classes.mdkernel.Element owner)
public static com.nomagic.uml2.ext.magicdraw.classes.mdkernel.Property createPartProperty(java.lang.String name, com.nomagic.uml2.ext.magicdraw.classes.mdkernel.Element owner)
public static com.nomagic.uml2.ext.magicdraw.classes.mdkernel.Property createProperty(java.lang.String name, com.nomagic.uml2.ext.magicdraw.classes.mdkernel.Element owner, com.nomagic.uml2.ext.magicdraw.classes.mdkernel.ValueSpecification defaultValue, com.nomagic.uml2.ext.magicdraw.classes.mdkernel.Element typeElement, java.lang.String aggregation, java.lang.String multMin, java.lang.String multMax)
public static com.nomagic.uml2.ext.magicdraw.components.mdbasiccomponents.Component createSiteCharComponent(java.lang.String name, com.nomagic.uml2.ext.magicdraw.classes.mdkernel.Element owner)
@Deprecated public static com.nomagic.uml2.ext.magicdraw.classes.mdkernel.ValueSpecification createValueSpec(java.lang.String type, java.lang.String value) throws ReferenceException
ReferenceException
public static com.nomagic.uml2.ext.magicdraw.classes.mdkernel.Class createView(java.lang.String name, com.nomagic.uml2.ext.magicdraw.classes.mdkernel.Element owner)