org.argouml.notation
Interface NotationProvider4

All Known Implementing Classes:
ValueHandler

public interface NotationProvider4

A class that implements this interface manages a text shown on a diagram. This means it is able to generate text that represents one or more UML objects. And when the user has edited this text, the model may be adapted by parsing the text. Additionally, a help text for the parsing is provided, so that the user knows the syntax.


Method Summary
 String getParsingHelp()
           
 Object getValue(String key)
          Gets the Object associated with the specified key.
 boolean isValue(String key)
          Gets the boolean associated with the specified key.
 String parse(String text)
           
 void putValue(String key, boolean newValue)
          Sets the Value associated with the specified key.
 void putValue(String key, Object newValue)
          Sets the Value associated with the specified key.
 String toString()
           
 

Method Detail

parse

public String parse(String text)
Parameters:
text - the text given by the user to be parsed to adapt the model
Returns:
after parsing, the modelelement is generated again, to normalize the given text

toString

public String toString()
Returns:
the string written in the correct notation

getParsingHelp

public String getParsingHelp()
Returns:
a i18 key that represents a help string giving an explanation to the user of the syntax

putValue

public void putValue(String key,
                     Object newValue)
Sets the Value associated with the specified key.

Parameters:
key - the String that identifies the stored object
newValue - the Object to store using this key

putValue

public void putValue(String key,
                     boolean newValue)
Sets the Value associated with the specified key.

Parameters:
key - the String that identifies the stored object
newValue - the Object to store using this key

getValue

public Object getValue(String key)
Gets the Object associated with the specified key.

Parameters:
key - a string containing the specified key
Returns:
the binding Object stored with this key; if this key is not present, it will return null

isValue

public boolean isValue(String key)
Gets the boolean associated with the specified key.

Parameters:
key - a string containing the specified key
Returns:
the binding boolean stored with this key; if this key is not present, it will return false


ArgoUML © 1996-2006ArgoUML HomepageArgoUML Developers' pageArgoUML Cookbook