org.openquark.gems.client
Class ArgumentName

java.lang.Object
  org.openquark.gems.client.ArgumentName

public class ArgumentName
extends Object

A class to manage the different names of an argument: base name and composite name.

Base name is the name used in calculation of a composite name. It starts out as one of the following:

FunctionalAgentGem - the argument name in the CAL code or the default name if the argument is not named
CodeGem - the argument name used in the code panel
Other - the default name

The base name may be replaced with a name saved by a user. The composite name is the base name plus a disambiguating suffix to make it unique to the input's forest. The composite name is displayed in tooltips and the Gem Properties dialog.

Author:

Steve Norton

Constructor Summary

ArgumentName(ArgumentName copy)
ArgumentName copy constructor.

ArgumentName(String name)
ArgumentName constructor.

Method Summary

String	getBaseName()
String	getCompositeName()
String	getDisambiguatingSuffix()
boolean	isBaseNameSavedByUser()
void	loadXML(Node parentNode) Load this object's state.
void	saveXML(Node parentNode) Attached the saved form of this object as a child XML node.
void	setBaseName(String baseName) Set the base name.
void	setBaseNameSavedByUser(boolean savedByUser)
void	setDisambiguatingSuffix(String suffix)
String	toString()

Methods inherited from class java.lang.Object

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

Constructor Detail

ArgumentName

public ArgumentName(String name)

ArgumentName constructor.

Parameters:

name - the original name, a default will be used if null

ArgumentName

public ArgumentName(ArgumentName copy)

ArgumentName copy constructor.

Parameters:

copy - the InputName to copy

Method Detail

toString

public String toString()

Overrides:

toString in class Object

See Also:

Object.toString()

getBaseName

public String getBaseName()

Returns:

the base name of the InputName

setBaseName

public void setBaseName(String baseName)

Set the base name. Input names should be checked for name conflicts after using this method. CAUTION: The new base name will be considered to be user saved.

Parameters:

baseName - the new base name for the InputName

getCompositeName

public String getCompositeName()

Returns:

the composite name of this input name

setDisambiguatingSuffix

public void setDisambiguatingSuffix(String suffix)

Parameters:

suffix - the suffix to use to make the composite name

getDisambiguatingSuffix

public String getDisambiguatingSuffix()

Returns:

the suffix used to make the composite name

isBaseNameSavedByUser

public boolean isBaseNameSavedByUser()

Returns:

true if the name was saved by the user, false otherwise

setBaseNameSavedByUser

public void setBaseNameSavedByUser(boolean savedByUser)

Parameters:

savedByUser - whether the base name was saved by the user

saveXML

public void saveXML(Node parentNode)

Attached the saved form of this object as a child XML node.

Parameters:

parentNode - the node that will be the parent of the generated XML.

loadXML

public void loadXML(Node parentNode)
             throws org.openquark.util.xml.BadXMLDocumentException

Load this object's state.

Parameters:

parentNode - the node representing the structure to deserialize.

Throws:

org.openquark.util.xml.BadXMLDocumentException