|
|||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectorg.argouml.kernel.Project
A datastructure that represents the designer's current project. A Project consists of diagrams and UML models.
Field Summary | |
private ArgoDiagram |
_activeDiagram
The active diagram, pointer to a diagram in the list with diagrams. |
private java.lang.String |
_authorname
|
private GenerationPreferences |
_cgPrefs
|
protected java.lang.Object |
_currentNamespace
|
protected java.lang.Object |
_defaultModel
|
private java.util.HashMap |
_defaultModelCache
Cache for the default model. |
private java.lang.String |
_description
|
private java.util.Vector |
_diagrams
Instances of the uml diagrams. |
private java.lang.String |
_historyFile
|
private java.util.Vector |
_members
|
private java.util.Vector |
_models
Instances of the uml model. |
private boolean |
_needsSave
|
private java.lang.Object |
_root
The root of the modeltree the user is working on. |
protected ChangeRegistry |
_saveRegistry
|
private java.util.Vector |
_searchpath
|
private java.net.URL |
_url
TODO: should just be the directory to write |
private java.util.HashMap |
_UUIDRefs
|
private java.lang.String |
_version
|
private java.beans.VetoableChangeSupport |
_vetoSupport
|
static java.lang.String |
ARGO_TEE
|
private static org.apache.log4j.Logger |
cat
logger |
protected static org.tigris.gef.ocl.OCLExpander |
expander
This is used in the save process for PGML. |
(package private) static long |
serialVersionUID
|
static java.lang.String |
TEMPLATES
|
static java.lang.String |
UNTITLED_FILE
|
Constructor Summary | |
Project()
|
|
Project(java.io.File file)
|
|
Project(java.lang.Object model)
|
|
Project(java.net.URL url)
|
Method Summary | |
void |
addDiagram(ArgoDiagram d)
|
void |
addMember(ArgoDiagram d)
|
void |
addMember(java.lang.Object m)
|
void |
addMember(ProjectMemberTodoList pm)
|
void |
addMember(java.lang.String name,
java.lang.String type)
|
void |
addModel(java.lang.Object m)
|
void |
addSearchPath(java.lang.String searchpath)
|
static void |
addStat(java.util.Vector stats,
java.lang.String name,
int value)
Deprecated. since 0.15.1. |
private java.io.File |
copyFile(java.io.File dest,
java.io.File src)
copies one file src to another, raising file exceptions if there are some problems |
java.util.Collection |
findFigsForMember(java.lang.Object member)
Finds all figs on the diagrams for some project member, including the figs containing the member (so for some operation, the containing figclass is returned). |
ProjectMember |
findMemberByName(java.lang.String name)
|
java.net.URL |
findMemberURLInSearchPath(java.lang.String name)
|
java.lang.Object |
findType(java.lang.String s)
Searches for a type/classifier with name s. |
java.lang.Object |
findType(java.lang.String s,
boolean defineNew)
Searches for a type/classifier with name s. |
java.lang.Object |
findTypeInDefaultModel(java.lang.String name)
Find a type by name in the default model. |
java.lang.Object |
findTypeInModel(java.lang.String s,
java.lang.Object ns)
Will only return first classifier with the matching name |
ArgoDiagram |
getActiveDiagram()
Get the current viewed diagram |
java.lang.String |
getAuthorname()
|
java.lang.String |
getBaseName()
Added Eugenio's patches to load 0.8.1 projects. |
GenerationPreferences |
getCgPrefs()
Returns the cgPrefs. |
java.lang.Object |
getCurrentNamespace()
|
java.lang.Object |
getDefaultModel()
|
java.lang.String |
getDescription()
|
ArgoDiagram |
getDiagram(java.lang.String name)
Finds a diagram with a specific name or UID. |
java.util.Vector |
getDiagrams()
|
GenerationPreferences |
getGenerationPrefs()
|
java.lang.String |
getHistoryFile()
|
java.lang.Object |
getInitialTarget()
|
java.util.Vector |
getMembers()
|
java.lang.Object |
getModel()
|
java.util.Collection |
getModels()
Returns all models, including the default model (default.xmi). |
java.lang.String |
getName()
|
int |
getPresentationCountFor(java.lang.Object me)
|
java.lang.Object |
getRoot()
Returns the root. |
ChangeRegistry |
getSaveRegistry()
Returns the saveRegistry. |
java.util.Vector |
getSearchpath()
Returns the searchpath. |
java.util.Vector |
getSearchPath()
|
static java.util.Vector |
getStats()
Deprecated. since 0.15.1. |
java.net.URL |
getUrl()
Returns the url. |
java.net.URL |
getURL()
|
java.util.Vector |
getUserDefinedModels()
Returns all models defined by the user. |
java.util.HashMap |
getUUIDRefs()
Returns the uUIDRefs. |
java.lang.String |
getVersion()
|
java.beans.VetoableChangeSupport |
getVetoSupport()
|
boolean |
isInTrash(java.lang.Object dm)
|
boolean |
isNeedsSave()
Returns the needsSave. |
boolean |
isValidDiagramName(java.lang.String name)
Returns true if the given name is a valid name for a diagram. |
void |
loadAllMembers()
|
void |
loadMembersOfType(java.lang.String type)
|
protected java.lang.Object |
loadModelFromXMI(java.net.URL url)
Deprecated. As of ArgoUml version 0.15.3, TODO: What is this replaced by? |
protected void |
loadZippedProjectMembers(java.net.URL url)
Loads all the members from a zipped input stream. |
protected void |
makeUntitledProject()
Makes a just created project to an untitled project with a class diagram and a usecase diagram and an untitled model. |
void |
moveFromTrash(java.lang.Object obj)
|
void |
moveToTrash(java.lang.Object obj)
Moves some object to trash. |
boolean |
needsSave()
|
void |
postLoad()
Deprecated. As of 28 Apr 2003 (ArgoUml version 0.13.5). Will be protected in future. TODO: Replace by? |
private void |
postSave()
|
private void |
preSave()
|
void |
remove()
prepare project for gc. |
protected void |
removeDiagram(ArgoDiagram d)
Removes a diagram from the list with diagrams. |
protected void |
removeProjectMemberDiagram(ArgoDiagram d)
Removes a project member diagram completely from the project. |
static void |
resetStats()
Deprecated. since 0.15.1. |
void |
save(boolean overwrite,
java.io.File file)
There are known issues with saving, particularly losing the xmi at save time. |
void |
setActiveDiagram(ArgoDiagram diagram)
|
void |
setAuthorname(java.lang.String s)
|
void |
setCgPrefs(GenerationPreferences cgPrefs)
Sets the cgPrefs. |
void |
setCurrentNamespace(java.lang.Object m)
|
void |
setDefaultModel(java.lang.Object defaultModel)
|
void |
setDescription(java.lang.String s)
|
void |
setDiagrams(java.util.Vector diagrams)
Sets the diagrams. |
void |
setFile(java.io.File file)
|
void |
setGenerationPrefs(GenerationPreferences cgp)
|
void |
setHistoryFile(java.lang.String s)
|
void |
setMembers(java.util.Vector members)
Sets the members. |
void |
setModels(java.util.Vector models)
Sets the models. |
void |
setName(java.lang.String n)
|
void |
setNeedsSave(boolean newValue)
|
void |
setRoot(java.lang.Object root)
Sets the root. |
void |
setSaveRegistry(ChangeRegistry saveRegistry)
Sets the saveRegistry. |
void |
setSearchpath(java.util.Vector searchpath)
Sets the searchpath. |
static void |
setStat(java.lang.String n,
int v)
Deprecated. since 0.15.1. |
private void |
setTarget(java.lang.Object target)
Called to update the current namespace and active diagram after the target has changed. |
void |
setUrl(java.net.URL url)
Sets the url. |
void |
setURL(java.net.URL url)
|
void |
setUUIDRefs(java.util.HashMap uUIDRefs)
Sets the uUIDRefs. |
void |
setVersion(java.lang.String s)
|
void |
setVetoSupport(java.beans.VetoableChangeSupport vetoSupport)
Sets the vetoSupport. |
void |
targetAdded(TargetEvent e)
Fired when a target is added to the list of targets. |
void |
targetRemoved(TargetEvent e)
Fired when a target is removed from the list of targets |
void |
targetSet(TargetEvent e)
Fired when a total new set of targets is set |
protected void |
trashInternal(java.lang.Object obj)
Removes some object from the project. |
Methods inherited from class java.lang.Object |
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Field Detail |
private static org.apache.log4j.Logger cat
public static final java.lang.String TEMPLATES
public static java.lang.String ARGO_TEE
public static final java.lang.String UNTITLED_FILE
protected static org.tigris.gef.ocl.OCLExpander expander
static final long serialVersionUID
private java.net.URL _url
protected ChangeRegistry _saveRegistry
private java.lang.String _authorname
private java.lang.String _description
private java.lang.String _version
private java.util.Vector _searchpath
private java.util.Vector _members
private java.lang.String _historyFile
private java.util.Vector _models
private java.util.Vector _diagrams
protected java.lang.Object _defaultModel
private boolean _needsSave
protected java.lang.Object _currentNamespace
private java.util.HashMap _UUIDRefs
private GenerationPreferences _cgPrefs
private transient java.beans.VetoableChangeSupport _vetoSupport
private java.lang.Object _root
private ArgoDiagram _activeDiagram
private java.util.HashMap _defaultModelCache
Constructor Detail |
public Project(java.io.File file) throws java.net.MalformedURLException, java.io.IOException
public Project(java.net.URL url)
public Project()
public Project(java.lang.Object model)
Method Detail |
protected void makeUntitledProject()
protected java.lang.Object loadModelFromXMI(java.net.URL url) throws java.io.IOException, org.xml.sax.SAXException, javax.xml.parsers.ParserConfigurationException
url
- The url with the .zargo file
java.io.IOException
- Thrown if the model or the .zargo file is corrupted.
org.xml.sax.SAXException
javax.xml.parsers.ParserConfigurationException
protected void loadZippedProjectMembers(java.net.URL url) throws java.io.IOException, javax.xml.parsers.ParserConfigurationException, org.xml.sax.SAXException
java.io.IOException
- if there is something wrong with the zipped archive
or with the model.
javax.xml.parsers.ParserConfigurationException
org.xml.sax.SAXException
public java.lang.String getBaseName()
public java.lang.String getName()
public void setName(java.lang.String n) throws java.beans.PropertyVetoException, java.net.MalformedURLException
java.beans.PropertyVetoException
java.net.MalformedURLException
public java.net.URL getURL()
public void setURL(java.net.URL url)
public void setFile(java.io.File file)
public java.util.Vector getSearchPath()
public void addSearchPath(java.lang.String searchpath)
public java.net.URL findMemberURLInSearchPath(java.lang.String name)
public java.util.Vector getMembers()
public void addMember(java.lang.String name, java.lang.String type)
public void addMember(ArgoDiagram d)
public void addMember(ProjectMemberTodoList pm)
public void addMember(java.lang.Object m)
public void addModel(java.lang.Object m)
m
- a namespaceprotected void removeProjectMemberDiagram(ArgoDiagram d)
d
- public ProjectMember findMemberByName(java.lang.String name)
public void loadMembersOfType(java.lang.String type)
public void loadAllMembers()
private java.io.File copyFile(java.io.File dest, java.io.File src) throws java.io.FileNotFoundException, java.io.IOException
java.io.FileNotFoundException
java.io.IOException
public void save(boolean overwrite, java.io.File file) throws java.io.IOException, java.lang.Exception
java.io.IOException
java.lang.Exception
public java.lang.String getAuthorname()
public void setAuthorname(java.lang.String s)
public java.lang.String getVersion()
public void setVersion(java.lang.String s)
public java.lang.String getDescription()
public void setDescription(java.lang.String s)
public java.lang.String getHistoryFile()
public void setHistoryFile(java.lang.String s)
public void setNeedsSave(boolean newValue)
public boolean needsSave()
public java.util.Vector getUserDefinedModels()
public java.util.Collection getModels()
public java.lang.Object getModel()
public java.lang.Object findType(java.lang.String s)
s
-
public java.lang.Object findType(java.lang.String s, boolean defineNew)
s
- defineNew
-
public java.util.Collection findFigsForMember(java.lang.Object member)
member
- The member we are looking for.
This can be a NSUML object but also another object.
public java.lang.Object findTypeInModel(java.lang.String s, java.lang.Object ns)
s
- is short namepublic void setCurrentNamespace(java.lang.Object m)
public java.lang.Object getCurrentNamespace()
public java.util.Vector getDiagrams()
public ArgoDiagram getDiagram(java.lang.String name)
name
- is the name to search for.
public void addDiagram(ArgoDiagram d)
protected void removeDiagram(ArgoDiagram d)
d
- public int getPresentationCountFor(java.lang.Object me)
public java.lang.Object getInitialTarget()
public void setGenerationPrefs(GenerationPreferences cgp)
public GenerationPreferences getGenerationPrefs()
public java.beans.VetoableChangeSupport getVetoSupport()
private void preSave()
private void postSave()
public void postLoad()
public void moveToTrash(java.lang.Object obj)
obj
- The object to be deletedtrashInternal(java.lang.Object)
protected void trashInternal(java.lang.Object obj)
obj
- Attention: whole Trash mechanism should be rethought concerning nsuml
Note that at present these are all if, not else-if. Rather than make a big change, I've just explicitly dealt with the case where we have a use case that is not classifier.
public void moveFromTrash(java.lang.Object obj)
public boolean isInTrash(java.lang.Object dm)
public static void resetStats()
public static void setStat(java.lang.String n, int v)
public static java.util.Vector getStats()
public static void addStat(java.util.Vector stats, java.lang.String name, int value)
public void setDefaultModel(java.lang.Object defaultModel)
defaultModel
- a uml modelpublic java.lang.Object getDefaultModel()
public java.lang.Object findTypeInDefaultModel(java.lang.String name)
name
- the name.
public java.lang.Object getRoot()
public void setRoot(java.lang.Object root)
root
- The root to set, a uml modelpublic boolean isValidDiagramName(java.lang.String name)
name
- The name to test
public GenerationPreferences getCgPrefs()
public boolean isNeedsSave()
public ChangeRegistry getSaveRegistry()
public java.util.Vector getSearchpath()
public java.net.URL getUrl()
public java.util.HashMap getUUIDRefs()
public void setCgPrefs(GenerationPreferences cgPrefs)
cgPrefs
- The cgPrefs to setpublic void setDiagrams(java.util.Vector diagrams)
diagrams
- The diagrams to setpublic void setMembers(java.util.Vector members)
members
- The members to setpublic void setModels(java.util.Vector models)
models
- The models to setpublic void setSaveRegistry(ChangeRegistry saveRegistry)
saveRegistry
- The saveRegistry to setpublic void setSearchpath(java.util.Vector searchpath)
searchpath
- The searchpath to setpublic void setUrl(java.net.URL url)
url
- The url to setpublic void setUUIDRefs(java.util.HashMap uUIDRefs)
uUIDRefs
- The uUIDRefs to setpublic void setVetoSupport(java.beans.VetoableChangeSupport vetoSupport)
vetoSupport
- The vetoSupport to setpublic ArgoDiagram getActiveDiagram()
public void setActiveDiagram(ArgoDiagram diagram)
diagram
- public void targetAdded(TargetEvent e)
TargetListener
targetAdded
in interface TargetListener
e
- The targetevent, name will be TARGET_ADDEDTargetListener.targetAdded(TargetEvent)
public void targetRemoved(TargetEvent e)
TargetListener
targetRemoved
in interface TargetListener
e
- The targetevent, name will be TARGET_REMOVEDTargetListener.targetRemoved(TargetEvent)
public void targetSet(TargetEvent e)
TargetListener
targetSet
in interface TargetListener
e
- The targetevent, name will be TARGET_SETTargetListener.targetSet(TargetEvent)
private void setTarget(java.lang.Object target)
target
- public void remove()
|
|||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
ArgoUML © 1996-2004 (20040316) | ArgoUML Homepage | ArgoUML Developers' page | ArgoUML Cookbook |