magpie.user

Class Workspace

java.lang.Object

magpie.user.Workspace

public class Workspace
extends java.lang.Object

Keeps track of variables produced by user interface. Stored as a map between a name (String) and the variable (Object)

Field Summary

Fields

Modifier and Type	Field and Description
protected java.util.Map<java.lang.String,java.lang.Object>	Variables Map of variable name to object

Constructor Summary

Constructors

Constructor and Description
Workspace() Create a Workspace with an empty variable list

Method Summary

Modifier and Type	Method and Description
void	addVariable(java.lang.String Name, java.lang.Object obj) Adds a variable to the workspace.
BaseAttributeSelector	getAttributeSelector(java.lang.String Name) Get an BaseAttributeSelector out of the Workspace
BaseClusterer	getClusterer(java.lang.String Name) Get an BaseClusterer out of the Workspace
Dataset	getDataset(java.lang.String Name) Get a dataset out of the variable list
BaseModel	getModel(java.lang.String Name) Get a model out of the workspace
java.lang.Object	getObject(java.lang.String Name) Gets an object that has been created by the user
java.util.Set<java.lang.String>	getVariableNames() Get the names of all variables stored in this class
boolean	hasVariable(java.lang.String Name) Test whether the user has created a variable
java.lang.String	printWorkspace() Prints a table containing all variables currently in Workspace.
void	removeVariable(java.lang.String Name) Removes a variable from the workspace

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

Variables

protected java.util.Map<java.lang.String,java.lang.Object> Variables

Map of variable name to object

Constructor Detail

Workspace

public Workspace()

Create a Workspace with an empty variable list

Method Detail

getVariableNames

public java.util.Set<java.lang.String> getVariableNames()

Get the names of all variables stored in this class

Returns:

Names of all variables

getDataset

public Dataset getDataset(java.lang.String Name)
                   throws java.lang.Exception

Get a dataset out of the variable list

Parameters:

Name - Name of variable to be return

Returns:

Dataset object if it is in the set

Throws:

java.lang.Exception - If Name is not in set or is not a Dataset Object

getModel

public BaseModel getModel(java.lang.String Name)
                   throws java.lang.Exception

Get a model out of the workspace

Parameters:

Name - Name of model to be returned

Returns:

BaseModel object if it is in the set

Throws:

java.lang.Exception - If Name is not in set or is not a BaseModel Object

getAttributeSelector

public BaseAttributeSelector getAttributeSelector(java.lang.String Name)
                                           throws java.lang.Exception

Get an BaseAttributeSelector out of the Workspace

Parameters:

Name - Name of BaseAttributeSelector to be returned

Returns:

BaseAttributeSelector, if in set

Throws:

java.lang.Exception - If Name is not in set, or not an BaseAttributeSelector

getClusterer

public BaseClusterer getClusterer(java.lang.String Name)
                           throws java.lang.Exception

Get an BaseClusterer out of the Workspace

Parameters:

Name - Name of BaseClusterer to be returned

Returns:

BaseAttributeSelector, if in set

Throws:

java.lang.Exception - If Name is not in set, or not an BaseClusterer

hasVariable

public boolean hasVariable(java.lang.String Name)

Test whether the user has created a variable

Parameters:

Name - Name of variable

Returns:

Whether it exists

removeVariable

public void removeVariable(java.lang.String Name)

Removes a variable from the workspace

Parameters:

Name - Variable to be removed

addVariable

public void addVariable(java.lang.String Name,
                        java.lang.Object obj)
                 throws java.lang.Exception

Adds a variable to the workspace. Throws exception if variable is not of one of the defined types Workspace.

Parameters:

Name - Name of variable

obj - Pointer to variable

Throws:

java.lang.Exception - if variable has already been assigned

getObject

public java.lang.Object getObject(java.lang.String Name)
                           throws java.lang.Exception

Gets an object that has been created by the user

Parameters:

Name - name of variable to retrieve

Returns:

hasVariable(Name) ? That object : exception;

Throws:

java.lang.Exception - if variable does not exist

printWorkspace

public java.lang.String printWorkspace()

Prints a table containing all variables currently in Workspace. Format:

Name Type About
<Variable name> <Variable type> <About variable>
...

Returns:

String formatted as specified