org.argouml.uml.ui
Interface SourcePathController

All Known Implementing Classes:
SourcePathControllerImpl

public interface SourcePathController

Since:
0.17.1

Method Summary
 void deleteSourcePath(java.lang.Object modelElement)
          Delete the source path settings of the model element.
 java.util.Collection getAllModelElementsWithSourcePath()
          Retrieve a collection of all model elements that have source path settings.
 java.io.File getSourcePath(java.lang.Object modelElement)
          From a model element retrieve its source path or null if it does not have a direct one (if that happens, you must use recursively its parent or the parent's parent).
 org.argouml.uml.ui.SourcePathTableModel getSourcePathSettings()
          Provide the complete list of existing source path settings for a model on request.
 void setSourcePath(java.lang.Object modelElement, java.io.File sourcePath)
          Set the source path for a specific model element (package or classifier) based on a given File object.
 void setSourcePath(org.argouml.uml.ui.SourcePathTableModel srcPaths)
          Set the source path of the model from the specified settings.
 

Method Detail

getSourcePath

java.io.File getSourcePath(java.lang.Object modelElement)
From a model element retrieve its source path or null if it does not have a direct one (if that happens, you must use recursively its parent or the parent's parent).

Parameters:
modelElement - model element
Returns:
The file reference that represents the source file.

getSourcePathSettings

org.argouml.uml.ui.SourcePathTableModel getSourcePathSettings()
Provide the complete list of existing source path settings for a model on request.

Returns:
The source path settings table - @see SourcePathTableModel.

setSourcePath

void setSourcePath(java.lang.Object modelElement,
                   java.io.File sourcePath)
Set the source path for a specific model element (package or classifier) based on a given File object.

Parameters:
modelElement - the model element
sourcePath - its source path

setSourcePath

void setSourcePath(org.argouml.uml.ui.SourcePathTableModel srcPaths)
Set the source path of the model from the specified settings.

Parameters:
srcPaths - the source path settings to be set in the model. Note, these are used in a resetting way, use the object retrieved with.
See Also:
getSourcePathSettings()

deleteSourcePath

void deleteSourcePath(java.lang.Object modelElement)
Delete the source path settings of the model element.

Parameters:
modelElement - the model element for which the source path settings are going to be removed

getAllModelElementsWithSourcePath

java.util.Collection getAllModelElementsWithSourcePath()
Retrieve a collection of all model elements that have source path settings.

Returns:
the collection


ArgoUML © 1996-2006ArgoUML HomepageArgoUML Developers' pageArgoUML Cookbook