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.uml

Class PoseidonUmlConnector

com.gentleware.poseidon.openapi.uml.PoseidonUmlConnector

public class PoseidonUmlConnector


The public API to UML-related issues in Poseidon.
Since:
2.0


 Association Summary
private AutolayoutStrategy  _autolayoutStrategy
Let's hope that the strategies do not produce memory leaks. 
arrow_up
 

 Method Summary
public static boolean   addHiddenStereotypeName(String name)
Adds a stereotype name to the set of names that should never be shown to the user. 
public static boolean   addHiddenTagDefinition(String regex)
Specifies that all tag definition tag types (names) that match the regular expression should not be shown to the user (but have meaning to Poseidon (plug-ins) only). 
public static void   deregisterLayoutStrategy()
Used to deregister a strategy for auto-layouting diagrams that were generated automatically. 
public static void   deregisterProfile(String key)
Inverse of registerProfile. 
public static Uml1SmCommandFactory   getCommandSmFactory()
 
public static AutolayoutStrategy   getLayoutStrategy()
 
public static void   loadProfile(String key)
Load a previously registered profile, so that its contents are available in the combo boxes. 
public static void   registerLayoutStrategy(AutolayoutStrategy strategy)
Used to register for auto-layouting diagrams that were generated automatically, eg after reverse engineering (aka source import). 
public static void   registerProfile(ResourceId profileResourceId, String key, String pathToProfile, ClassLoader loader)
Register a profile in the system. 
public static void   registerProfile(ResourceId profileResourceId, String key, String pathToProfile, ClassLoader loader, String moduleName)
Register a profile in the system. 
public static void   registerProfile(ResourceId profileResourceId, String key, String pathToProfile, ClassLoader loader, String moduleName, String language)
Register a profile in the system. 
public static boolean   removeHiddenStereotypeName(String name)
Remove a stereotype name from the set of names that should be hidden from the user. 
public static boolean   removeHiddenTagDefinition(String name)
Removes a pattern from the list that specifies tag definition tag types (names) that should be hidden from the user. 
public static void   unloadProfile(String key)
Inverse of loadProfile. 
arrow_up
 

Tagged Values
static false
gentleware-imported-line-number 23
gentleware-imported-package-statement-line-number 5
 

 Association Detail

_autolayoutStrategy

private AutolayoutStrategy _autolayoutStrategy

Let's hope that the strategies do not produce memory leaks.  
arrow_up
 Method Detail

addHiddenStereotypeName

public static boolean addHiddenStereotypeName(String name)


Adds a stereotype name to the set of names that should never be shown to the user. Use this if you have stereotypes that are for internal use only.  
Parameters:
name - name of a stereotype that should be hidden
Returns:
true iff the name was not previously hidden
arrow_up


addHiddenTagDefinition

public static boolean addHiddenTagDefinition(String regex)


Specifies that all tag definition tag types (names) that match the regular expression should not be shown to the user (but have meaning to Poseidon (plug-ins) only). A plug-in will have to call this on install if it uses tag definitions internally.  
Parameters:
regex - a regular expression describing tag types of a tag definitions that should not be displayed to the user
Returns:
true if the pattern was not already included in the list of patterns to hide
See also:
java.util.regex.Pattern
arrow_up


deregisterLayoutStrategy

public static void deregisterLayoutStrategy()


Used to deregister a strategy for auto-layouting diagrams that were generated automatically.  
Since:
2.2
arrow_up


deregisterProfile

public static void deregisterProfile(String key)


Inverse of registerProfile. It includes unlading of the profile.  
Parameters:
key -
arrow_up


getCommandSmFactory

public static Uml1SmCommandFactory getCommandSmFactory()

Returns:
The factory that creates UML (Semantic, short: SM) commands.
arrow_up


getLayoutStrategy

public static AutolayoutStrategy getLayoutStrategy()

Returns:
the strategy or null.
arrow_up


loadProfile

public static void loadProfile(String key)


Load a previously registered profile, so that its contents are available in the combo boxes.  
Parameters:
key - The key under which the profiel was registered.
arrow_up


registerLayoutStrategy

public static void registerLayoutStrategy(AutolayoutStrategy strategy)


Used to register for auto-layouting diagrams that were generated automatically, eg after reverse engineering (aka source import).  
Parameters:
strategy -
Since:
2.2
arrow_up


registerProfile

public static void registerProfile(ResourceId profileResourceId, String key, String pathToProfile, ClassLoader loader)


Register a profile in the system. This does not mean that it is available yet! It has to be loaded by a call to loadProfile(key). You should preferrably use the method that also takes a module name and language as parameters.  
Parameters:
profileResourceId -
key - The key under which you want to address the profile.
pathToProfile - The path within the JAR or the file system.
loader - The class loader that has to be used to find the profile. If you are a plugin, this would be the class loader of a class in the plugin.
arrow_up


registerProfile

public static void registerProfile(ResourceId profileResourceId, String key, String pathToProfile, ClassLoader loader, String moduleName)


Register a profile in the system. This does not mean that it is available yet! It has to be loaded by a call to loadProfile(key). You should preferrably use the method that also takes a language as parameter.  
Parameters:
profileResourceId -
key - The key under which you want to address the profile.
pathToProfile - The path within the JAR or the file system.
loader - The class loader that has to be used to find the profile. If you are a plugin, this would be the class loader of a class in the plugin.
moduleName - The display name of the plugin that provides this profile. Needed for the profile dialog.
arrow_up


registerProfile

public static void registerProfile(ResourceId profileResourceId, String key, String pathToProfile, ClassLoader loader, String moduleName, String language)


Register a profile in the system. This does not mean that it is available yet! It has to be loaded by a call to loadProfile(key).  
Parameters:
profileResourceId -
key - The key under which you want to address the profile.
pathToProfile - The path within the JAR or the file system.
loader - The class loader that has to be used to find the profile. If you are a plugin, this would be the class loader of a class in the plugin.
moduleName - The display name of the plugin that provides this profile. Needed for the profile dialog.
language -
arrow_up


removeHiddenStereotypeName

public static boolean removeHiddenStereotypeName(String name)


Remove a stereotype name from the set of names that should be hidden from the user. Use this when a plugin is deinstalled.  
Parameters:
name - name of a stereotype that should no longer be hidden
Returns:
true iff the stereotype was previously hidden
arrow_up


removeHiddenTagDefinition

public static boolean removeHiddenTagDefinition(String name)


Removes a pattern from the list that specifies tag definition tag types (names) that should be hidden from the user. A plug-in will have to call this on uninstall if it uses tag definitions internally.  
Parameters:
name - a regular expression that probably was previously added with addHiddenTagDefinition
Returns:
true if the pattern was previously included in the list of tag definition tag types to hide
arrow_up


unloadProfile

public static void unloadProfile(String key)


Inverse of loadProfile.  
Parameters:
key -
arrow_up
Created  2004 - 12 - 1

    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.