|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object | +--org.argouml.kernel.Project
A datastructure that represents the designer's current project. A Project consists of diagrams and UML models.
Field Summary | |
java.lang.String |
_authorname
|
GenerationPreferences |
_cgPrefs
|
protected ru.novosoft.uml.foundation.core.MNamespace |
_currentNamespace
|
protected ru.novosoft.uml.model_management.MModel |
_defaultModel
|
java.lang.String |
_description
|
java.util.Vector |
_diagrams
|
java.lang.String |
_historyFile
|
java.util.Vector |
_members
|
java.util.Vector |
_models
|
boolean |
_needsSave
|
protected ChangeRegistry |
_saveRegistry
|
java.util.Vector |
_searchpath
|
java.util.HashMap |
_UUIDRefs
|
java.lang.String |
_version
|
java.beans.VetoableChangeSupport |
_vetoSupport
|
static java.lang.String |
ARGO_TEE
|
protected static org.apache.log4j.Category |
cat
|
static java.lang.String |
COMPRESSED_FILE_EXT
|
protected static org.tigris.gef.ocl.OCLExpander |
expander
|
static java.lang.String |
PROJECT_FILE_EXT
|
static java.lang.String |
SEPARATOR
|
static java.lang.String |
TEMPLATES
|
static java.lang.String |
UNCOMPRESSED_FILE_EXT
|
static java.lang.String |
UNTITLED_FILE
|
Constructor Summary | |
Project()
|
|
Project(java.io.File file)
|
|
Project(ru.novosoft.uml.model_management.MModel model)
|
|
Project(java.net.URL url)
|
Method Summary | |
void |
addDiagram(ArgoDiagram d)
|
void |
addMember(ArgoDiagram d)
|
void |
addMember(ru.novosoft.uml.model_management.MModel m)
|
void |
addMember(ProjectMemberTodoList pm)
|
void |
addMember(java.lang.String name,
java.lang.String type)
|
void |
addModel(ru.novosoft.uml.foundation.core.MNamespace m)
|
void |
addSearchPath(java.lang.String searchpath)
|
static void |
addStat(java.util.Vector stats,
java.lang.String name,
int value)
|
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)
|
ru.novosoft.uml.foundation.core.MClassifier |
findType(java.lang.String s)
Searches for a type/classifier with name s. |
ru.novosoft.uml.foundation.core.MClassifier |
findType(java.lang.String s,
boolean defineNew)
Searches for a type/classifier with name s. |
ru.novosoft.uml.foundation.core.MClassifier |
findTypeInModel(java.lang.String s,
ru.novosoft.uml.foundation.core.MNamespace ns)
Will only return first classifier with the matching name |
java.lang.String |
getAuthorname()
|
java.lang.String |
getBaseName()
Added Eugenio's patches to load 0.8.1 projects. |
ru.novosoft.uml.foundation.core.MNamespace |
getCurrentNamespace()
|
ru.novosoft.uml.model_management.MModel |
getDefaultModel()
|
java.lang.String |
getDescription()
|
java.util.Vector |
getDiagrams()
|
GenerationPreferences |
getGenerationPrefs()
|
java.lang.String |
getHistoryFile()
|
java.lang.Object |
getInitialTarget()
|
java.util.Vector |
getMembers()
|
ru.novosoft.uml.foundation.core.MNamespace |
getModel()
|
java.util.Collection |
getModels()
Returns all models, including the default model (default.xmi). |
java.lang.String |
getName()
|
int |
getPresentationCountFor(ru.novosoft.uml.foundation.core.MModelElement me)
|
ru.novosoft.uml.model_management.MModel |
getRoot()
Returns the root. |
java.util.Vector |
getSearchPath()
|
static java.util.Vector |
getStats()
|
java.net.URL |
getURL()
|
java.util.Vector |
getUserDefinedModels()
Returns all models defined by the user. |
java.lang.String |
getVersion()
|
java.beans.VetoableChangeSupport |
getVetoSupport()
|
boolean |
isInTrash(java.lang.Object dm)
|
boolean |
isValidDiagramName(java.lang.String name)
Returns true if the given name is a valid name for a diagram. |
static Project |
load(java.net.URL url)
|
void |
loadAllMembers()
|
void |
loadMembersOfType(java.lang.String type)
|
ru.novosoft.uml.model_management.MModel |
loadModelFromXMI(java.net.URL url)
Loads a model (XMI only) from a .zargo file. |
static Project |
loadProject(java.net.URL url)
This method creates a project from the specified URL Unlike the constructor which forces an .argo extension This method will attempt to load a raw XMI file This method can fail in several different ways. |
void |
loadZippedProjectMembers(java.net.URL url)
Loads all the members from a zipped input stream. |
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()
|
void |
postSave()
|
void |
preSave()
|
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()
|
void |
save(boolean overwrite,
java.io.File file)
There are known issues with saving, particularly losing the xmi at save time. see issue http://argouml.tigris.org/issues/show_bug.cgi? |
void |
setAuthorname(java.lang.String s)
|
void |
setCurrentNamespace(ru.novosoft.uml.foundation.core.MNamespace m)
|
static void |
setCurrentProject(Project currentProject)
Sets the currentProject. |
void |
setDefaultModel(ru.novosoft.uml.model_management.MModel defaultModel)
|
void |
setDescription(java.lang.String s)
|
void |
setFile(java.io.File file)
|
void |
setGenerationPrefs(GenerationPreferences cgp)
|
void |
setHistoryFile(java.lang.String s)
|
void |
setName(java.lang.String n)
|
void |
setNeedsSave(boolean newValue)
|
void |
setRoot(ru.novosoft.uml.model_management.MModel root)
Sets the root. |
static void |
setStat(java.lang.String n,
int v)
|
void |
setURL(java.net.URL url)
|
void |
setVersion(java.lang.String s)
|
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 |
public static final java.lang.String SEPARATOR
public static final java.lang.String COMPRESSED_FILE_EXT
public static final java.lang.String UNCOMPRESSED_FILE_EXT
public static final java.lang.String PROJECT_FILE_EXT
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
protected ChangeRegistry _saveRegistry
public java.lang.String _authorname
public java.lang.String _description
public java.lang.String _version
public java.util.Vector _searchpath
public java.util.Vector _members
public java.lang.String _historyFile
public java.util.Vector _models
public java.util.Vector _diagrams
protected ru.novosoft.uml.model_management.MModel _defaultModel
public boolean _needsSave
protected ru.novosoft.uml.foundation.core.MNamespace _currentNamespace
public java.util.HashMap _UUIDRefs
public GenerationPreferences _cgPrefs
public transient java.beans.VetoableChangeSupport _vetoSupport
protected static org.apache.log4j.Category cat
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(ru.novosoft.uml.model_management.MModel model)
Method Detail |
public void makeUntitledProject()
public static Project loadProject(java.net.URL url) throws java.io.IOException, java.lang.Exception
This method can fail in several different ways. Either by throwing an exception or by having the ArgoParser.SINGLETON.getLastLoadStatus() set to not true.
TODO: This method NEEDS a refactoring.
public ru.novosoft.uml.model_management.MModel loadModelFromXMI(java.net.URL url) throws java.io.IOException
If there is a problem with the xmi file, an error is set in the ArgoParser.SINGLETON.getLastLoadStatus() field. This needs to be examined by the calling function.
url
- The url with the .zargo filejava.io.IOException
- Thrown if the model or the .zargo file itself is corrupted in any way.public void loadZippedProjectMembers(java.net.URL url) throws java.io.IOException, java.beans.PropertyVetoException
java.io.IOException
- if there is something wrong with the zipped archive
or with the model.java.beans.PropertyVetoException
- if the adding of a diagram is vetoed.public java.lang.String getBaseName()
public java.lang.String getName()
public void setName(java.lang.String n) throws 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(ru.novosoft.uml.model_management.MModel m)
public void addModel(ru.novosoft.uml.foundation.core.MNamespace m)
protected void removeProjectMemberDiagram(ArgoDiagram d)
d
- public ProjectMember findMemberByName(java.lang.String name)
public static Project load(java.net.URL url) throws java.io.IOException, org.xml.sax.SAXException
public void loadMembersOfType(java.lang.String type)
public void loadAllMembers()
public void save(boolean overwrite, java.io.File file) throws 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 ru.novosoft.uml.foundation.core.MNamespace getModel()
public ru.novosoft.uml.foundation.core.MClassifier findType(java.lang.String s)
s
- public ru.novosoft.uml.foundation.core.MClassifier 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 ru.novosoft.uml.foundation.core.MClassifier findTypeInModel(java.lang.String s, ru.novosoft.uml.foundation.core.MNamespace ns)
s
- is short namepublic void setCurrentNamespace(ru.novosoft.uml.foundation.core.MNamespace m)
public ru.novosoft.uml.foundation.core.MNamespace getCurrentNamespace()
public java.util.Vector getDiagrams()
public void addDiagram(ArgoDiagram d)
protected void removeDiagram(ArgoDiagram d)
d
- public int getPresentationCountFor(ru.novosoft.uml.foundation.core.MModelElement me)
public java.lang.Object getInitialTarget()
public void setGenerationPrefs(GenerationPreferences cgp)
public GenerationPreferences getGenerationPrefs()
public java.beans.VetoableChangeSupport getVetoSupport()
public void preSave()
public 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
- 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(ru.novosoft.uml.model_management.MModel defaultModel)
public ru.novosoft.uml.model_management.MModel getDefaultModel()
public static void setCurrentProject(Project currentProject)
currentProject
- The currentProject to setpublic ru.novosoft.uml.model_management.MModel getRoot()
public void setRoot(ru.novosoft.uml.model_management.MModel root)
root
- The root to setpublic boolean isValidDiagramName(java.lang.String name)
name
- The name to test
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
ArgoUML (c) 1996-2002 |