|
| |
|
| java.lang.Object
 org.cougaar.tools.csmart.core.property.ConfigurableComponent
org.cougaar.tools.csmart.core.property.ModifiableConfigurableComponent
org.cougaar.tools.csmart.society.SocietyBase
All known Subclasses: org.cougaar.tools.csmart.society.file.SocietyFileComponent, org.cougaar.tools.csmart.society.db.SocietyDBComponent, org.cougaar.tools.csmart.society.cdata.SocietyCDataComponent, org.cougaar.tools.csmart.society.ui.SocietyUIComponent,
| Constructor Summary | |
| public | SocietyBase(String name)
Constructs a SocietyBase object
with the given name. |
| BACKUP_DESCRIPTION | | final protected static String BACKUP_DESCRIPTION(Code) | | |
| DESCRIPTION_RESOURCE_NAME | | final protected static String DESCRIPTION_RESOURCE_NAME(Code) | | |
| SOCIETY_SAVED | | final public static int SOCIETY_SAVED(Code) | | |
| isRunning | | protected transient boolean isRunning(Code) | | |
| isSelfTerminating | | protected boolean isSelfTerminating(Code) | | |
| modified | | protected boolean modified(Code) | | |
| SocietyBase | | public SocietyBase(String name)(Code) | | Constructs a SocietyBase object
with the given name.
Parameters:
name - Name for this component |
| addComponentData | | public ComponentData addComponentData(ComponentData data)(Code) | | Adds any relevent ComponentData for this component.
This method does not modify any existing ComponentData
See Also: ComponentData
Parameters:
data - Pointer to the global ComponentData an updated ComponentData object |
| copy | | public ModifiableComponent copy(String name)(Code) | | Copy the given society, including the modified status.
The copy will store the original AssemblyId in the oldAssemblyId slot.
Parameters:
name - a String new society name a ModifiableComponent society copy |
| copyAndSave | | public ModifiableComponent copyAndSave(String name)(Code) | | Copy this Society and save the copy to the database, under
the given new name. If the save fails, the new society
will be marked modified when this method returns
Parameters:
name - a String new society name a ModifiableComponent new society |
| fireModification | | public void fireModification()(Code) | | |
| getAgents | | public AgentComponent[] getAgents()(Code) | | Returns the agents in this Society
an array of AgentComponent objects |
| getAssemblyId | | public String getAssemblyId()(Code) | | Get the assembly id for this Society.
a String which is the assembly id for this Society |
| getCleanupFileFilter | | public FileFilter getCleanupFileFilter()(Code) | | Return a file filter which can be used to delete
the files generated by this experiment.
FileFilter for cleanup |
| getDescription | | public URL getDescription()(Code) | | Returns the description of this society
an URL value |
| getResultFileFilter | | public FileFilter getResultFileFilter()(Code) | | Return a file filter which can be used to fetch
the metrics files for this experiment.
FileFilter to get metrics files for this experiment |
| getSocietyName | | public String getSocietyName()(Code) | | Returns the name of this Society
Society Name |
| isModified | | public boolean isModified()(Code) | | Has this society been modified, such that a save would do something.
a boolean, false if no save necessary |
| isRunning | | public boolean isRunning()(Code) | | Returns whether or not the society is running,
i.e. can be dynamically monitored.
Running societies are not editable, but they can be copied,
and the copy can be edited.
true if society is running and false otherwise |
| isSelfTerminating | | public boolean isSelfTerminating()(Code) | | Returns whether the society is self terminating or must
be manually terminated.
Self terminating nodes cause the app-server to send back
a "process-destroyed" message when the node terminates.
true if society is self terminating |
| modifyComponentData | | public ComponentData modifyComponentData(ComponentData data)(Code) | | Modifies any part of the ComponentData Structure.
Parameters:
data - Completed ComponentData structure for the society a ComponentData value |
| saveToDatabase | | public boolean saveToDatabase()(Code) | | Save this society to the database. Only to be used
after creating a new society. Not to be used from DB societies
which are already in the database.
a boolean, false on error |
| setRunning | | public void setRunning(boolean isRunning)(Code) | | Set by the experiment controller to indicate that the
society is running.
The society is running from the moment that any node
is successfully created
(via the app-server's "create" method)
until all nodes are terminated (aborted, self terminated, or
manually terminated).
Parameters:
isRunning - flag indicating whether or not the society is running |
| setSelfTerminating | | protected void setSelfTerminating(boolean isSelfTerminating)(Code) | | Sets if the society is self terminating or not.
Self terminating nodes cause the app-server to send back
a "process-destroyed" message when the node terminates.
Parameters:
isSelfTerminating - true if society is self terminating |
| Fields inherited from org.cougaar.tools.csmart.core.property.ModifiableConfigurableComponent | protected transient boolean editable(Code)(Java Doc)
|
| Fields inherited from org.cougaar.tools.csmart.core.property.ConfigurableComponent | protected transient Logger log(Code)(Java Doc)
|
| Methods inherited from org.cougaar.tools.csmart.core.property.ConfigurableComponent | public int addChild(ComposableComponent c)(Code)(Java Doc)
public void addChildConfigurationListener(ChildConfigurationListener l)(Code)(Java Doc)
public ComponentData addComponentData(ComponentData data)(Code)(Java Doc)
public Property addInvisibleProperty(String name, Object value)(Code)(Java Doc)
public Property addInvisibleProperty(String name, Object value, Class cls)(Code)(Java Doc)
public Property addInvisibleProperty(Property p)(Code)(Java Doc)
public void addPropertiesListener(PropertiesListener l)(Code)(Java Doc)
public Property addProperty(String name, Object value)(Code)(Java Doc)
public Property addProperty(String name, Object value, Class cls)(Code)(Java Doc)
public Property addProperty(Property p)(Code)(Java Doc)
public Property addProperty(String name, Object value, PropertyListener l)(Code)(Java Doc)
public boolean componentWasRemoved()(Code)(Java Doc)
public BaseComponent copy(BaseComponent result)(Code)(Java Doc)
public void finishNameChange()(Code)(Java Doc)
protected void fireChildConfigurationChanged()(Code)(Java Doc)
protected void firePropertyAdded(PropertyEvent ev)(Code)(Java Doc)
public Iterator getAllProperties()(Code)(Java Doc)
protected ComposableComponent getAncestorOfClass(Class cls)(Code)(Java Doc)
public ComposableComponent getChild(int n)(Code)(Java Doc)
public ComposableComponent getChild(CompositeName childName)(Code)(Java Doc)
public int getChildCount()(Code)(Java Doc)
public Collection getDescendentsOfClass(Class cls, Collection c)(Code)(Java Doc)
public Collection getDescendentsOfClass(Class cls)(Code)(Java Doc)
public URL getDescription()(Code)(Java Doc)
protected EventListenerList getEventListenerList()(Code)(Java Doc)
public CompositeName getFullName()(Code)(Java Doc)
public Property getInvisibleProperty(CompositeName name)(Code)(Java Doc)
public Property getInvisibleProperty(String localName)(Code)(Java Doc)
public Iterator getLocalProperties()(Code)(Java Doc)
public Iterator getLocalPropertyNames()(Code)(Java Doc)
protected Map getMyProperties()(Code)(Java Doc)
public ComposableComponent getParent()(Code)(Java Doc)
public Iterator getProperties()(Code)(Java Doc)
public Property getProperty(CompositeName name)(Code)(Java Doc)
public Property getProperty(String localName)(Code)(Java Doc)
public Iterator getPropertyNames()(Code)(Java Doc)
public List getPropertyNamesList()(Code)(Java Doc)
protected Property getPropertyWorker(CompositeName name, boolean all, boolean visible)(Code)(Java Doc)
public String getShortName()(Code)(Java Doc)
public Iterator getSortedLocalPropertyNames()(Code)(Java Doc)
public Property getVisibleProperty(CompositeName name)(Code)(Java Doc)
public Property getVisibleProperty(String localName)(Code)(Java Doc)
public boolean hasUnboundProperties()(Code)(Java Doc)
abstract public void initProperties()(Code)(Java Doc)
public boolean isPropertyVisible(Property prop)(Code)(Java Doc)
public ComponentData modifyComponentData(ComponentData data)(Code)(Java Doc)
public ComponentData modifyComponentData(ComponentData data, PopulateDb pdb)(Code)(Java Doc)
public void printAllProperties(PrintStream out)(Code)(Java Doc)
public void printAllProperties(PrintStream out, String indent)(Code)(Java Doc)
public void printLocalProperties(PrintStream out)(Code)(Java Doc)
public void printLocalProperties(PrintStream out, String indent)(Code)(Java Doc)
public void removeAllChildren()(Code)(Java Doc)
public void removeChild(int childIndex)(Code)(Java Doc)
public void removeChild(ComposableComponent c)(Code)(Java Doc)
public void removeChildConfigurationListener(ChildConfigurationListener l)(Code)(Java Doc)
public void removePropertiesListener(PropertiesListener l)(Code)(Java Doc)
public void removeProperty(Property prop)(Code)(Java Doc)
public void setName(String newName)(Code)(Java Doc)
public void setParent(ComposableComponent newParent)(Code)(Java Doc)
public void setProperties(Map props)(Code)(Java Doc)
public void setPropertyVisible(Property prop, boolean newVisible)(Code)(Java Doc)
public void startNameChange()(Code)(Java Doc)
public String toString()(Code)(Java Doc)
|
|
|
|