|
IBM Rational Software Modeler Release 6.0 |
||||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | ||||||||||
java.lang.Objectcom.ibm.xtools.modeler.UMLModeler
A utility class that exposes model and profile lifecycle operations and provides access to the modeling platform.
API clients should not instantiate this class.
| Method Summary | |
static void |
closeModel(Model model)
Closes the model specified by model |
static void |
closeProfile(Profile profile)
Closes the profile specified by profile |
static Model |
createModel(String file)
Creates a UML model given a file path |
static Model |
createModel(URI uri)
Creates a UML model given a URI |
static Profile |
createProfile(String file)
Creates a UML profile given a file path |
static Profile |
createProfile(URI uri)
Creates a UML profile given a URI |
static EditingDomain |
getEditingDomain()
Returns the UMLModeler's EditingDomain. |
static IEObjectHelper |
getEObjectHelper()
Returns a helper to work with classes implementing EObject |
static IOclQueryHelper |
getOclQueryHelper()
Returns a helper to perform OCL queries over models |
static Collection |
getOpenedModels()
Returns all opened UML models. |
static IQueryHelper |
getQueryHelper()
Returns a helper to perform queries over models |
static IUMLDiagramHelper |
getUMLDiagramHelper()
Returns a user helper to work with classes implementing View |
static IUMLHelper |
getUMLHelper()
Returns a helper to work with classes implementing Element |
static IUMLUIHelper |
getUMLUIHelper()
Returns a user interface helper to work with classes implementing Element |
static Model |
openModel(String file)
Opens the UML model whose filename is described by file.
|
static Model |
openModel(URI uri)
Opens the UML model whose filename is described by uri.
|
static Profile |
openProfile(String file)
Opens the UML profile whose filename is described by file.
|
static Profile |
openProfile(URI uri)
Opens the UML profile whose URI is described by uri.
|
static void |
saveModel(Model model)
Saves the UML model specified by model. |
static void |
saveModelAs(Model model,
String file)
Saves the model specified by model to the location
specified by file |
static void |
saveModelAs(Model model,
URI uri)
Saves the model specified by model to the location
specified by uri |
static void |
saveProfile(Profile profile)
Saves the UML profile specified by profile. |
static void |
saveProfileAs(Profile profile,
String file)
Saves the profile specified by profile to the location
specified by file |
static void |
saveProfileAs(Profile profile,
URI uri)
Saves the profile specified by profile 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 |
public static IEObjectHelper getEObjectHelper()
EObject
IEObjectHelperpublic static IUMLHelper getUMLHelper()
Element
IUMLHelperpublic static IUMLUIHelper getUMLUIHelper()
Element
IUMLUIHelperpublic static IUMLDiagramHelper getUMLDiagramHelper()
View
IUMLDiagramHelperpublic static IQueryHelper getQueryHelper()
IQueryHelperpublic static IOclQueryHelper getOclQueryHelper()
IOclQueryHelperpublic static EditingDomain getEditingDomain()
EditingDomainpublic static Collection getOpenedModels()
public static Model createModel(String file)
file - The model file to create
IllegalArgumentException - file is an empty string
NullPointerException - file is nullpublic static Model createModel(URI uri)
uri - The URI of the model to create
IllegalArgumentException - file is an empty string
NullPointerException - file is null
public static Model openModel(String file)
throws IOException
file.
Supported extensions are:
.emx
.uml2
file - The model file to open
IllegalArgumentException - file is an empty string
IOException - The file specified by file could not be found
or the file is corrupted or could not be opened
NullPointerException - file is null
ClassCastException - file does not point to a Model
public static Model openModel(URI uri)
throws IOException
uri.
Supported extensions are:
.emx
.uml2
uri - The URI of the model to open
IllegalArgumentException - file is an empty string
IOException - The file specified by file could not be found
or the file is corrupted or could not be opened
NullPointerException - file is null
ClassCastException - file does not point to a Model
public static void saveModel(Model model)
throws IOException
model.
model - The UML model to save
IOException - The location specified by the root path of model
cannot be used to save the model
IllegalArgumentException - model has no associated resource (
public static void saveModelAs(Model model,
String file)
throws IOException
model to the location
specified by file
model - The UML2 model to savefile - The location to save the UML2 model
IOException - The location specified by file cannot be used
to save the model
IllegalArgumentException - model has no associated Model (
model.getMode() is null or
file is empty
public static void saveModelAs(Model model,
URI uri)
throws IOException
model to the location
specified by uri
model - The UML2 model to saveuri - The URI location to save the UML2 model
IOException - The location specified by uri cannot be used
to save the model
IllegalArgumentException - model has no associated Model (
model.getMode() is null or
file is emptypublic static void closeModel(Model model)
model
model - The UML2 model to close
IllegalArgumentException - model has no associated Model (
model.getMode() is nullpublic static Profile createProfile(String file)
file - The profile file to create
IllegalArgumentException - file is an empty string
NullPointerException - file is nullpublic static Profile createProfile(URI uri)
uri - The URI of the profile to create
IllegalArgumentException - file is an empty string
NullPointerException - file is null
public static Profile openProfile(String file)
throws IOException
file.
Supported extensions are:
.prx
.uml2
file - The profile file to open
IllegalArgumentException - file is an empty string
IOException - The file specified by file could not be found
or the file is corrupted or could not be opened
NullPointerException - file is null
ClassCastException - file does not point to a Profile
public static Profile openProfile(URI uri)
throws IOException
uri.
Supported extensions are:
.prx
.uml2
uri - The URI of the profile to open
IllegalArgumentException - file is an empty string
IOException - The file specified by file could not be found
or the file is corrupted or could not be opened
NullPointerException - file is null
ClassCastException - file does not point to a Profile
public static void saveProfile(Profile profile)
throws IOException
profile.
profile - The UML profile to save
IOException - The location specified by the root path of
profile cannot be used to save the profile
IllegalArgumentException - profile has no associated resource (
public static void saveProfileAs(Profile profile,
String file)
throws IOException
profile to the location
specified by file
profile - The UML2 profile to savefile - The location to save the UML2 profile
IOException - The location specified by file cannot be used
to save the profile
IllegalArgumentException - profile has no associated Profile (
profile.getMode() is null or
file is empty
public static void saveProfileAs(Profile profile,
URI uri)
throws IOException
profile to the location
specified by uri
profile - The UML2 profile to saveuri - The location to save the UML2 profile
IOException - The location specified by file cannot be used
to save the profile
IllegalArgumentException - profile has no associated Profile (
profile.getMode() is null or
file is emptypublic static void closeProfile(Profile profile)
profile
profile - The UML2 profile to close
IllegalArgumentException - profile has no associated Profile (
profile.getMode() is null
|
IBM Rational Software Modeler Release 6.0 |
||||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | ||||||||||
Guidelines for using Eclipse APIs.
Copyright (c) IBM Corp. and others 2004. All rights reserved.