com.ibm.xtools.umlviz.ui

Class UMLDiagramResourceUtil

java.lang.Object

com.ibm.xtools.umlviz.ui.UMLDiagramResourceUtil

public final class UMLDiagramResourceUtil
extends java.lang.Object

A utility class that exposes UML diagram resource lifecycle operations and provides access to the modeling platform.

API clients should not instantiate this class.

Method Summary

Modifier and Type	Method and Description
static void	closeDiagram(org.eclipse.gmf.runtime.notation.Diagram diagram) Closes the diagram specified by diagram
static org.eclipse.gmf.runtime.notation.Diagram	createDiagram(java.lang.String file, UMLDiagramKind umlDiagramKind) Creates a visualization diagram given a file path
static org.eclipse.gmf.runtime.notation.Diagram	createDiagram(org.eclipse.emf.common.util.URI uri, UMLDiagramKind umlDiagramKind) Creates a visualization diagram given a URI
static com.ibm.xtools.emf.msl.EditingDomain	getCompatibilityEditingDomain() Deprecated. use the getEditingDomain() method, instead
static org.eclipse.emf.transaction.TransactionalEditingDomain	getEditingDomain() Returns the UMLModeler's EditingDomain.
static com.ibm.xtools.emf.msl.IEObjectHelper	getEObjectHelper() Deprecated. IEObjectHelper is mostly obsoleted by the EMFCoreUtil API. See IEObjectHelper's individual method documentation for details.
static IUMLDiagramHelper	getUMLDiagramHelper() Returns a user helper to work with classes implementing View
static IUMLUIHelper	getUMLUIHelper() Returns a user interface helper to work with classes implementing Element
static org.eclipse.gmf.runtime.notation.Diagram	openDiagram(java.lang.String file) Opens the visualization diagram whose filename is described by file.
static org.eclipse.gmf.runtime.notation.Diagram	openDiagram(org.eclipse.emf.common.util.URI uri) Opens the visualization diagram whose URI is described by uri.
static void	saveDiagram(org.eclipse.gmf.runtime.notation.Diagram diagram) Saves the visualization diagram specified by diagram.
static void	saveDiagramAs(org.eclipse.gmf.runtime.notation.Diagram diagram, java.lang.String file) Saves the diagram specified by diagram to the location specified by file
static void	saveDiagramAs(org.eclipse.gmf.runtime.notation.Diagram diagram, org.eclipse.emf.common.util.URI uri) Saves the diagram specified by diagram to the location specified by uri

Methods inherited from class java.lang.Object

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

Method Detail

getEObjectHelper

public static com.ibm.xtools.emf.msl.IEObjectHelper getEObjectHelper()

Deprecated. IEObjectHelper is mostly obsoleted by the EMFCoreUtil API. See IEObjectHelper's individual method documentation for details.

Returns a helper to work with classes implementing EObject

Returns:

The UMLDiagramResourceUtil IEObjectHelper

getUMLUIHelper

public static IUMLUIHelper getUMLUIHelper()

Returns a user interface helper to work with classes implementing Element

Returns:

The UMLDiagramResourceUtil IUMLUIHelper

getUMLDiagramHelper

public static IUMLDiagramHelper getUMLDiagramHelper()

Returns a user helper to work with classes implementing View

Returns:

The UMLDiagramResourceUtil IUMLDiagramHelper

getEditingDomain

public static org.eclipse.emf.transaction.TransactionalEditingDomain getEditingDomain()

Returns the UMLModeler's EditingDomain. The latter is used to perform operations on the models managed by the tool. It also provides batched notification support.

Returns:

The UMLModeler EditingDomain

getCompatibilityEditingDomain

public static com.ibm.xtools.emf.msl.EditingDomain getCompatibilityEditingDomain()

Deprecated. use the getEditingDomain() method, instead

Returns the UMLModeler's EditingDomain. The latter is used to perform operations on the models managed by the tool. It also provides batched notification support.

Returns:

The UMLModeler EditingDomain

createDiagram

public static org.eclipse.gmf.runtime.notation.Diagram createDiagram(java.lang.String file,
                                                                     UMLDiagramKind umlDiagramKind)

Creates a visualization diagram given a file path

Parameters:

file - The diagram file to create, an extension will be added if not provided

umlDiagramKind - The kind of diagram to create, the only currently supported type is CLASS_LITERAL

Returns:

The created visualization diagram

Throws:

java.lang.IllegalArgumentException - file is an empty string file specifies a filename with an invalid extension umlDiagramKind is unsupported

java.lang.NullPointerException - file or umlDiagramKind is null

createDiagram

public static org.eclipse.gmf.runtime.notation.Diagram createDiagram(org.eclipse.emf.common.util.URI uri,
                                                                     UMLDiagramKind umlDiagramKind)

Creates a visualization diagram given a URI

Parameters:

uri - The URI of the diagram to create, an extension will be added if not provided

umlDiagramKind - The kind of diagram to create, the only currently supported type is CLASS_LITERAL

Returns:

The created visualization diagram

Throws:

java.lang.IllegalArgumentException - uri specifies a filename with an invalid extension umlDiagramKind is unsupported

java.lang.NullPointerException - uri or umlDiagramKind is null

openDiagram

public static org.eclipse.gmf.runtime.notation.Diagram openDiagram(java.lang.String file)
                                                            throws java.io.IOException

Opens the visualization diagram whose filename is described by file.

Parameters:

file - The diagram file to open

Returns:

The opened visualization diagram

Throws:

java.io.IOException - The file specified by file could not be found or the file is corrupted or could not be opened

java.lang.IllegalArgumentException - file is an empty string

java.lang.NullPointerException - file is null

openDiagram

public static org.eclipse.gmf.runtime.notation.Diagram openDiagram(org.eclipse.emf.common.util.URI uri)
                                                            throws java.io.IOException

Opens the visualization diagram whose URI is described by uri.

Parameters:

uri - The URI of the diagram to open

Returns:

The opened visualization diagram

Throws:

java.io.IOException - The file specified by URI could not be found or the file is corrupted or could not be opened

java.lang.NullPointerException - uri is null

saveDiagram

public static void saveDiagram(org.eclipse.gmf.runtime.notation.Diagram diagram)
                        throws java.io.IOException

Saves the visualization diagram specified by diagram.

Parameters:

diagram - The visualization diagram to save

Throws:

java.io.IOException - The location specified by the root path of diagram cannot be used to save the diagram

java.lang.IllegalArgumentException - diagram has no associated resource (

saveDiagramAs

public static void saveDiagramAs(org.eclipse.gmf.runtime.notation.Diagram diagram,
                                 java.lang.String file)
                          throws java.io.IOException

Saves the diagram specified by diagram to the location specified by file

Parameters:

diagram - The diagram to save

file - The location to save the diagram

Throws:

java.io.IOException - The location specified by file cannot be used to save the diagram

java.lang.IllegalArgumentException - diagram has no associated resource ( file is empty

saveDiagramAs

public static void saveDiagramAs(org.eclipse.gmf.runtime.notation.Diagram diagram,
                                 org.eclipse.emf.common.util.URI uri)
                          throws java.io.IOException

Saves the diagram specified by diagram to the location specified by uri

Parameters:

diagram - The diagram to save

uri - The URI location to save the diagram

Throws:

java.io.IOException - The location specified by uri cannot be used to save the diagram

java.lang.IllegalArgumentException - diagram has no associated resource

closeDiagram

public static void closeDiagram(org.eclipse.gmf.runtime.notation.Diagram diagram)

Closes the diagram specified by diagram

Parameters:

diagram - The diagram to close

Throws:

java.lang.IllegalArgumentException - diagram has no associated resource (