Java Doc for Experiment.java in » Science » Cougaar12_4 » org » cougaar » tools » csmart » experiment » Java Source Code / Java DocumentationJava Source Code and Java Documentation

Java Source Code / Java Documentation

1.	6.0 JDK Core
2.	6.0 JDK Modules
3.	6.0 JDK Modules com.sun
4.	6.0 JDK Modules com.sun.java
5.	6.0 JDK Modules sun
6.	6.0 JDK Platform
7.	Ajax
8.	Apache Harmony Java SE
9.	Aspect oriented
10.	Authentication Authorization
11.	Blogger System
12.	Build
13.	Byte Code
14.	Cache
15.	Chart
16.	Chat
17.	Code Analyzer
18.	Collaboration
19.	Content Management System
20.	Database Client
21.	Database DBMS
22.	Database JDBC Connection Pool
23.	Database ORM
24.	Development
25.	EJB Server geronimo
26.	EJB Server GlassFish
27.	EJB Server JBoss 4.2.1
28.	EJB Server resin 3.1.5
29.	ERP CRM Financial
30.	ESB
31.	Forum
32.	GIS
33.	Graphic Library
34.	Groupware
35.	HTML Parser
36.	IDE
37.	IDE Eclipse
38.	IDE Netbeans
39.	Installer
40.	Internationalization Localization
41.	Inversion of Control
42.	Issue Tracking
43.	J2EE
44.	JBoss
45.	JMS
46.	JMX
47.	Library
48.	Mail Clients
49.	Net
50.	Parser
51.	PDF
52.	Portal
53.	Profiler
54.	Project Management
55.	Report
56.	RSS RDF
57.	Rule Engine
58.	Science
59.	Scripting
60.	Search Engine
61.	Security
62.	Sevlet Container
63.	Source Control
64.	Swing Library
65.	Template Engine
66.	Test Coverage
67.	Testing
68.	UML
69.	Web Crawler
70.	Web Framework
71.	Web Mail
72.	Web Server
73.	Web Services
74.	Web Services apache cxf 2.0.1
75.	Web Services AXIS2
76.	Wiki Engine
77.	Workflow Engines
78.	XML
79.	XML UI

Java

Java Tutorial

Illustrator Tutorials

GIMP Tutorials

C# / C Sharp

C# / CSharp Tutorial

C# / CSharp Open Source

SQL Server / T-SQL Tutorial

Oracle PL / SQL

Oracle PL/SQL Tutorial

Flash / Flex / ActionScript

VBA / Excel / Access / Word

XML

XML Tutorial

Microsoft Office PowerPoint 2007 Tutorial

Microsoft Office Excel 2007 Tutorial

Microsoft Office Word 2007 Tutorial

Java Source Code / Java Documentation » Science » Cougaar12_4 » org.cougaar.tools.csmart.experiment

Source Cross Reference Class Diagram Java Document (Java Doc)

org.cougaar.tools.csmart.experiment .Experiment

All known Subclasses:   org.cougaar.tools.csmart.experiment .ExperimentBase,
Experiment
public interface Experiment extends ModifiableComponent(Code)
An Experiment, is a complete Host, Node, Agent, Component mapping containing all required runtime variables and components. A completed Experiment can be handed off to a COUGAAR node and run, with no additional parameters required.

Field Summary
String AGENT_STARTTIME

String AGENT_STARTTIME_DFLT

int APP_SERVER_DEFAULT_PORT

String AS_SWALLOW_ERRORS

String AS_SWALLOW_ERRORS_DFLT

String BOOTSTRAP_CLASS

String COMPLAININGLP_LEVEL

String COMPLAININGLP_LEVEL_DFLT

String CONTROL_PORT

String DEFAULT_BOOTSTRAP_CLASS

String DEFAULT_NODE_CLASS

String ENV_DISPLAY

String EXPERIMENT_ID

String INITIALIZER_PROP
     Which initialization method should we use.
String NAME_SERVER

String NAME_SERVER_PORTS

String NODE_NAME

String PERSISTENCE_DFLT

String PERSISTENCE_ENABLE

String PERSIST_CLEAR

String PERSIST_CLEAR_DFLT

String PROP_PREFIX

String TIMEZONE

String TIMEZONE_DFLT


Method Summary
void addComponent(ModifiableComponent comp)
     Adds a component to the experiment.
HostComponent addHost(String name)
     Adds a new host to this experiment.
NodeComponent addNode(String name)
     Adds a node to the experiment.
void addRecipeComponent(RecipeComponent recipe)
     Adds a specific recipe component to this experiment.
void addSocietyComponent(SocietyComponent sc)
     Adds a society, as a SocietyComponent to the experiment.
boolean agentNameUnique(String name)
     Determines if the given agent name is unique within this experiment.
ModifiableComponent copy(String uniqueName)
     Copies this component, and returns a copy with the name specified.
Parameters:
  uniqueName - name of the new Component.
void createDefaultConfiguration()

void dumpHNA()
     Dumps an HNA mapping.
void dumpINIFiles()
     Dumps INI files for the current experiment.
void experimentStopped()
     Stops the currently running experiment.
AgentComponent[] getAgents()
     Gets an AgentComponent array of all agents in this experiment.
List getAgentsList()
     Returns a List of all the agents in this experiment.
public String getCommAsbID()

int getComponentCount()
     Returns a count of all components in the experiment.
List getComponents()
     Returns a List of all components in the experiment.
ModifiableComponent[] getComponentsAsArray()
     Returns all components on the experiment as a ModifiableComponent array.
Properties getDefaultNodeArguments()
     Gets all default node arguments.
URL getDescription()
     Gets the URL location of the description of this component.
public String getExperimentID()
     Experiment ID is used by database societies only.
String getExperimentName()
     Gets the current experiment name.
HostComponent[] getHostComponents()
     Returns an array of HostComponents that are part of this experiment.
HostComponent[] getHostComponentsNoReconcile()

NodeComponent[] getNodeComponents()
     Gets an NodeComponent array of all nodes in this experiment.
RecipeComponent getRecipeComponent(int i)
     Gets a specific RecipeComponent specified by the index it was stored.
Parameters:
  i - - index of the recipe to retrieve.
int getRecipeComponentCount()
     Returns a count of the number of recipe components within this experiment.
RecipeComponent[] getRecipeComponents()
     Gets an array of all RecipeComponents in this experiment.
File getResultDirectory()
     Returns the results directory used by this experiment to store all collected results.
SocietyComponent getSocietyComponent()
     Gets the society component as a SocietyCompoent for this experiment. society component from this experiment.
int getSocietyComponentCount()
     Returns a count of all societies in the experiment.
ComponentData getSocietyComponentData()
     Gets the complete society component data specified as a ComponentData object.
public String getTrialID()
     Gets the trial id for this experiment, if one exists.
boolean hasConfiguration()

public void importHNA(Component parent)
     Imports an HNA mapping into the experiment.
void initProperties()
     Initializes the properties of this component.
boolean isEditInProgress()
     Indicates if the experiment is currently being edited.
boolean isModified()
     Indicates if the current experiment has been modified.
boolean isRunInProgress()
     Indicates if the current experiment is running.
boolean isRunnable()
     Indicates that this experiment contains everything it needs to run.
void removeComponent(ModifiableComponent comp)
     Removes a specific component, specified as a ModifiableComponent.
void removeHost(HostComponent hostComponent)
     Removes the specified host from the experiment.
void removeNode(NodeComponent nc)
     Removes the specified node from the experiment.
void removeRecipeComponent(RecipeComponent recipe)
     Removed a specific recipe from the experiment.
void removeSocietyComponent()
     Removes the society component from the experiment.
void renameHost(HostComponent hostComponent, String name)

void renameNode(NodeComponent nc, String name)

void resetModified()
     Resets the modified flag.
public void save(DBConflictHandler handler)
     Saves the current Experiment.
public void setCommAsbID(String id)

void setEditInProgress(boolean newEditInProgress)
     Set the experiment currently being edited flag.
public void setExperimentID(String expID)
     Sets the Experiment Id for this experiment.
void setName(String name)
     Sets the name of this Experiment.
void setRecipeComponents(RecipeComponent[] newRecipes)
     Sets the recipe components for this experiment.
void setResultDirectory(File resultDirectory)
     Sets the directory to store all experiment results.
void setRunInProgress(boolean newRunInProgress)
     Set the experiment running flag to true.
void stop()
     Stops the currently running experiment.
String toString()

void updateNameServerHostName()


Field Detail
AGENT_STARTTIME
String AGENT_STARTTIME(Code)

AGENT_STARTTIME_DFLT
String AGENT_STARTTIME_DFLT(Code)

APP_SERVER_DEFAULT_PORT
int APP_SERVER_DEFAULT_PORT(Code)
org.cougaar.control.port; port for contacting applications server *

AS_SWALLOW_ERRORS
String AS_SWALLOW_ERRORS(Code)
When true, if CSMART dies, the society does not die *

AS_SWALLOW_ERRORS_DFLT
String AS_SWALLOW_ERRORS_DFLT(Code)

BOOTSTRAP_CLASS
String BOOTSTRAP_CLASS(Code)

COMPLAININGLP_LEVEL
String COMPLAININGLP_LEVEL(Code)

COMPLAININGLP_LEVEL_DFLT
String COMPLAININGLP_LEVEL_DFLT(Code)

CONTROL_PORT
String CONTROL_PORT(Code)

DEFAULT_BOOTSTRAP_CLASS
String DEFAULT_BOOTSTRAP_CLASS(Code)

DEFAULT_NODE_CLASS
String DEFAULT_NODE_CLASS(Code)

ENV_DISPLAY
String ENV_DISPLAY(Code)

EXPERIMENT_ID
String EXPERIMENT_ID(Code)

INITIALIZER_PROP
String INITIALIZER_PROP(Code)
Which initialization method should we use. DB means the CSMART DB *

NAME_SERVER
String NAME_SERVER(Code)

NAME_SERVER_PORTS
String NAME_SERVER_PORTS(Code)

NODE_NAME
String NODE_NAME(Code)

PERSISTENCE_DFLT
String PERSISTENCE_DFLT(Code)

PERSISTENCE_ENABLE
String PERSISTENCE_ENABLE(Code)

PERSIST_CLEAR
String PERSIST_CLEAR(Code)

PERSIST_CLEAR_DFLT
String PERSIST_CLEAR_DFLT(Code)

PROP_PREFIX
String PROP_PREFIX(Code)

TIMEZONE
String TIMEZONE(Code)

TIMEZONE_DFLT
String TIMEZONE_DFLT(Code)

Method Detail
addComponent
void addComponent(ModifiableComponent comp) throws IllegalArgumentException(Code)
Adds a component to the experiment. If the component is a society, and the experiment already contains a society, an exception is thrown. If the component is not a SocietyComponent or a RecipeComponent an exception is thrown.
Parameters:
  comp - Component to add to the experiment.
throws:
  IllegalArgumentException - Expception if component known, or already exists.

addHost
HostComponent addHost(String name) throws IllegalArgumentException(Code)
Adds a new host to this experiment. An exception is thrown if the experiment already contains a host of the same name.
Parameters:
  name - Name of the new host. HostComponent of the new host.
throws:
  IllegalArgumentException - Exception if the host is already defined in the experiment.

addNode
NodeComponent addNode(String name) throws IllegalArgumentException(Code)
Adds a node to the experiment. If the experiment already contains a node of the same name, an exception is thrown.
Parameters:
  name - Name of the new node. NodeComponent for the new node.
throws:
  IllegalArgumentException - Exception if the experiment already contains the node.

addRecipeComponent
void addRecipeComponent(RecipeComponent recipe) throws IllegalArgumentException(Code)
Adds a specific recipe component to this experiment. If the recipe already exists in the experiment, an exception is thrown
Parameters:
  recipe - New recipe component to add to the experiment.
throws:
  IllegalArgumentException - Exception is thrown if the experiment already contains this recipe.

addSocietyComponent
void addSocietyComponent(SocietyComponent sc) throws IllegalArgumentException(Code)
Adds a society, as a SocietyComponent to the experiment. A society contains a complete Node/Agent/Component mapping. Each experiment can only contain one Society. If a society already exists, an exception is thrown.
Parameters:
  sc - The new society
throws:
  IllegalArgumentException - Exception is thrown if the experiment already contains a society.

agentNameUnique
boolean agentNameUnique(String name)(Code)
Determines if the given agent name is unique within this experiment.
Parameters:
  name - Name of agent to check for uniqueness true if the agent is unique, else false.

copy
ModifiableComponent copy(String uniqueName)(Code)
Copies this component, and returns a copy with the name specified.
Parameters:
  uniqueName - name of the new Component. new ModifiableComponent copy of this component.

createDefaultConfiguration
void createDefaultConfiguration()(Code)

dumpHNA
void dumpHNA()(Code)
Dumps an HNA mapping.

dumpINIFiles
void dumpINIFiles()(Code)
Dumps INI files for the current experiment.

experimentStopped
void experimentStopped()(Code)
Stops the currently running experiment.

getAgents
AgentComponent[] getAgents()(Code)
Gets an AgentComponent array of all agents in this experiment. An array of all agents in the experiment.

getAgentsList
List getAgentsList()(Code)
Returns a List of all the agents in this experiment. a List of all agents

getCommAsbID
public String getCommAsbID()(Code)
get the local variable idea of the community assembly for this experiment, possibly null assembly ID for community data, possibly null

getComponentCount
int getComponentCount()(Code)
Returns a count of all components in the experiment. count of all components.

getComponents
List getComponents()(Code)
Returns a List of all components in the experiment. All components

getComponentsAsArray
ModifiableComponent[] getComponentsAsArray()(Code)
Returns all components on the experiment as a ModifiableComponent array. array of all components.

getDefaultNodeArguments
Properties getDefaultNodeArguments()(Code)
Gets all default node arguments. Properties of all default node arguments.

getDescription
URL getDescription()(Code)
Gets the URL location of the description of this component. URL of description file.

getExperimentID
public String getExperimentID()(Code)
Experiment ID is used by database societies only. The ExperimentID, if one exists, else null.

getExperimentName
String getExperimentName()(Code)
Gets the current experiment name. Experiment name as a String

getHostComponents
HostComponent[] getHostComponents()(Code)
Returns an array of HostComponents that are part of this experiment. Array of all hosts.

getHostComponentsNoReconcile
HostComponent[] getHostComponentsNoReconcile()(Code)

getNodeComponents
NodeComponent[] getNodeComponents()(Code)
Gets an NodeComponent array of all nodes in this experiment. An array of all nodes in the experiment.

getRecipeComponent
RecipeComponent getRecipeComponent(int i) throws IndexOutOfBoundsException(Code)
Gets a specific RecipeComponent specified by the index it was stored.
Parameters:
  i - - index of the recipe to retrieve. A RecipeComponent of the recipe found at the specified index.
throws:
  IndexOutOfBoundsException - Exception thrown if index out of bounds occurs.

getRecipeComponentCount
int getRecipeComponentCount()(Code)
Returns a count of the number of recipe components within this experiment. count of all recipe components.

getRecipeComponents
RecipeComponent[] getRecipeComponents()(Code)
Gets an array of all RecipeComponents in this experiment. array of all recipe components.

getResultDirectory
File getResultDirectory()(Code)
Returns the results directory used by this experiment to store all collected results. File location to store results.

getSocietyComponent
SocietyComponent getSocietyComponent()(Code)
Gets the society component as a SocietyCompoent for this experiment. society component from this experiment. Or null, if one does not exist.

getSocietyComponentCount
int getSocietyComponentCount()(Code)
Returns a count of all societies in the experiment. Currently, the experiment can only have 1 society. count of societies within the experiment.

getSocietyComponentData
ComponentData getSocietyComponentData()(Code)
Gets the complete society component data specified as a ComponentData object. ComponentData of the complete society.

getTrialID
public String getTrialID()(Code)
Gets the trial id for this experiment, if one exists. current trial Id, or null if one doesn't exist.

hasConfiguration
boolean hasConfiguration()(Code)

importHNA
public void importHNA(Component parent)(Code)
Imports an HNA mapping into the experiment. This method is only relevant for database experiments. Experiments from XML already contain their own HNA mapping.
Parameters:
  parent - Component containing the HNA mapping.

initProperties
void initProperties()(Code)
Initializes the properties of this component.

isEditInProgress
boolean isEditInProgress()(Code)
Indicates if the experiment is currently being edited. true if the experiment is being edited, else false

isModified
boolean isModified()(Code)
Indicates if the current experiment has been modified. true if the current experiment has been modified, else false

isRunInProgress
boolean isRunInProgress()(Code)
Indicates if the current experiment is running. true if the current experiment is running, else false.

isRunnable
boolean isRunnable()(Code)
Indicates that this experiment contains everything it needs to run. true if the experiment is ready to run, else false

removeComponent
void removeComponent(ModifiableComponent comp) throws IllegalArgumentException(Code)
Removes a specific component, specified as a ModifiableComponent. An exception is thrown if the Component to be removed is not a SocietyComponent or a RecipeComponent
Parameters:
  comp - Component to remove from the experiment.
throws:
  IllegalArgumentException - Exception if the component is of unknown type.

removeHost
void removeHost(HostComponent hostComponent)(Code)
Removes the specified host from the experiment.
Parameters:
  hostComponent - Host to remove from the experiment.

removeNode
void removeNode(NodeComponent nc)(Code)
Removes the specified node from the experiment.
Parameters:
  nc - Node to remove from the experiment.

removeRecipeComponent
void removeRecipeComponent(RecipeComponent recipe)(Code)
Removed a specific recipe from the experiment.
Parameters:
  recipe - The recipe to remove from the experiment.

removeSocietyComponent
void removeSocietyComponent()(Code)
Removes the society component from the experiment.

renameHost
void renameHost(HostComponent hostComponent, String name) throws IllegalArgumentException(Code)

renameNode
void renameNode(NodeComponent nc, String name) throws IllegalArgumentException(Code)
Renames a node, in the NodeComponent to the new given name
Parameters:
  nc - NodeComponent to be renamed.
Parameters:
  name - New name of the node.
throws:
  IllegalArgumentException -

resetModified
void resetModified()(Code)
Resets the modified flag.

save
public void save(DBConflictHandler handler)(Code)
Saves the current Experiment. If the Experiment Instance is a database instance DBExperiment. The experiment is saved to the database. Currently, Saving of an XMLExperiment is not implemented.
Parameters:
  handler - Database conflict handler. This handler is onlyused for DBExperiment instances. All othersignore it.

setCommAsbID
public void setCommAsbID(String id)(Code)
(Re) set the local variables idea of the community assembly for this experiment, possibly to null

setEditInProgress
void setEditInProgress(boolean newEditInProgress)(Code)
Set the experiment currently being edited flag.
Parameters:
  newEditInProgress - true if the experiment is currently being edited, else false

setExperimentID
public void setExperimentID(String expID)(Code)
Sets the Experiment Id for this experiment.
Parameters:
  expID - current experiment id

setName
void setName(String name)(Code)
Sets the name of this Experiment.
Parameters:
  name - Name of this experiment

setRecipeComponents
void setRecipeComponents(RecipeComponent[] newRecipes)(Code)
Sets the recipe components for this experiment.
Parameters:
  newRecipes - array of RecipeComponents to apply to this experiment.

setResultDirectory
void setResultDirectory(File resultDirectory)(Code)
Sets the directory to store all experiment results.
Parameters:
  resultDirectory - File location to store results.

setRunInProgress
void setRunInProgress(boolean newRunInProgress)(Code)
Set the experiment running flag to true.
Parameters:
  newRunInProgress - true if experiment is currently running, else false

stop
void stop()(Code)
Stops the currently running experiment.

toString
String toString()(Code)

updateNameServerHostName
void updateNameServerHostName()(Code)

www.java2java.com | Contact Us

All other trademarks are property of their respective owners.