Poseidon for UMLTM
  UMLdoc
 PREV  CLASSIFIER    NEXT  CLASSIFIER     FRAMES    NO FRAMES      
SUMMARY:   INNER | ATTR | ASSOC | CONSTR | METHOD     DETAIL:   INNER | ATTR | ASSOC | CONSTR | METHOD     DIAGRAMS:   COLLAB | SEQ | STATE | ACTIV

com.gentleware.poseidon.openapi

Class PoseidonProjectConnector

com.gentleware.poseidon.openapi.PoseidonProjectConnector

public final class PoseidonProjectConnector


Facade to projects. One project maps to one file. A project contains the model information, the graphical diagram information, and some other information relating to one file. Currently, the only kind of supported project is one containing UML-style information.

A UML project contains one or more (currently, in version 1.x, only one) models.

The documentation for the UML model can be found on">http://www.gentleware.com/support">on the Gentleware website for download and online reading.

Authors:
JvV


 Constructor Summary
private   PoseidonProjectConnector()
 
arrow_up
 

 Method Summary
public static void   addMDRListener(RefObject observed, MDRChangeListener listener)
Adds a listener to the given MDR element, such as a metaclass, a model element, or a DI element. 
public static void   exportXmi()
Exports the current project as XMI. 
public static DiCommandFactory   getCommandDiFactory()
 
public static PoseidonProject   getCurrentProject()
 
public static Collection   getDiagrams()
Returns all diagrams in the project. 
public static URL   getFile()
Gets the URL of the current project file. 
public static String   getFilename()
 
public static RefObject   getModel()
Returns the first (currently, the only) UML model of the current project. 
public static Collection   getModels()
Returns all UML models of the current project. 
public static boolean   getNeedsSave()
Gets the saved status of the current project. 
public static Project   makeEmptyProject()
Replaces the current project with a blank project, asks when changes need to be saved. 
public static void   openProject(String filename)
Opens the project with the given name, asks when changes need to be saved. 
public static void   openProject(String filename, boolean addToRecentProjectFiles)
Opens the project with the given name, asks when changes need to be saved  
public static void   removeMDRListener(RefObject observed, MDRChangeListener listener)
Removes a listener from the given MDR element, such as a metaclass, a model element, or a DI element. 
public static void   saveProject(String filename)
Saves the current project to a .zuml file. 
arrow_up
 

Tagged Values
static false
 

 Constructor Detail

PoseidonProjectConnector

private PoseidonProjectConnector PoseidonProjectConnector()

Returns:
arrow_up
 Method Detail

addMDRListener

public static void addMDRListener(RefObject observed, MDRChangeListener listener)


Adds a listener to the given MDR element, such as a metaclass, a model element, or a DI element.  
Parameters:
observed - The observed element.
listener - The MDR listener; may be a PreChange- or a ChangeListener.
arrow_up


exportXmi

public static void exportXmi()


Exports the current project as XMI. Currently, it is not possible to set the filename - it will be the project's name or 'untitled'.  
Since:
2.3.1
arrow_up


getCommandDiFactory

public static DiCommandFactory getCommandDiFactory()

Returns:
arrow_up


getCurrentProject

public static PoseidonProject getCurrentProject()

Returns:
The currently opened project.
arrow_up


getDiagrams

public static Collection getDiagrams()


Returns all diagrams in the project.

Poseidon enforces this list to have at least one element.  

Returns:
arrow_up


getFile

public static URL getFile()


Gets the URL of the current project file. If the file was never saved, it returns null.  
Returns:
arrow_up


getFilename

public static String getFilename()

Returns:
the filename of the current project including the suffix
arrow_up


getModel

public static RefObject getModel()


Returns the first (currently, the only) UML model of the current project.  
Returns:
A UML model.
arrow_up


getModels

public static Collection getModels()


Returns all UML models of the current project. Currently, this list contains only one member.  
Returns:
arrow_up


getNeedsSave

public static boolean getNeedsSave()


Gets the saved status of the current project.  
Returns:
arrow_up


makeEmptyProject

public static Project makeEmptyProject()


Replaces the current project with a blank project, asks when changes need to be saved. if the uses chooses to cancel, null is returned  
Returns:
Since:
1.5
arrow_up


openProject

public static void openProject(String filename)


Opens the project with the given name, asks when changes need to be saved.  
Parameters:
filename -
Since:
1.5
arrow_up


openProject

public static void openProject(String filename, boolean addToRecentProjectFiles)


Opens the project with the given name, asks when changes need to be saved  
Parameters:
filename -
addToRecentProjectFiles - if set to false, the project will not appear in the filemenu list of recent files
Since:
2.1.4
arrow_up


removeMDRListener

public static void removeMDRListener(RefObject observed, MDRChangeListener listener)


Removes a listener from the given MDR element, such as a metaclass, a model element, or a DI element. WARNING: Currently, this method has the same behavior as removeMDRListener(MDRChangeListener), ie, the listener is detached from all objects that it observed.  
Parameters:
observed - The observed element.
listener - The MDR listener; may be a PreChange- or a ChangeListener.
arrow_up


saveProject

public static void saveProject(String filename)


Saves the current project to a .zuml file.  
Parameters:
filename - The name of the file.
arrow_up
Created  2004 - 10 - 21

    Poseidon for UMLTM
  UMLdoc
 PREV  CLASSIFIER    NEXT  CLASSIFIER     FRAMES    NO FRAMES      
SUMMARY:   INNER | ATTR | ASSOC | CONSTR | METHOD     DETAIL:   INNER | ATTR | ASSOC | CONSTR | METHOD     DIAGRAMS:   COLLAB | SEQ | STATE | ACTIV

Generated with Poseidon for UMLTM.
Poseidon is a registered trademark of Gentleware AG in Germany, USA and other countries. Copyright 2003-2004 Gentleware AG, Schanzenstr. 70, 20357 Hamburg, Germany. All Rights Reserved.

UML is a trademark or registered trademark of Object Management Group, Inc. in the U.S. and other countries.