mascoptLib.abstractGraph
Interface MascoptObjectInterface

All Known Implementing Classes:

MascoptObject

public interface MascoptObjectInterface

Controls what methods have the Mascopt Objects.

Version:

Wed Feb 20 18:37:37 2002

Author:

bbongiov@bing.inria.fr

Method Summary

boolean	deleteValue(String name) Delete the value for a category.
boolean	deleteValue(String name, mascoptLib.abstractGraph.MascoptObjectInterface o) Delete the value for a category and a specific context.
Double	getDoubleValue(String name) Returns the value for a category.
Double	getDoubleValue(String name, mascoptLib.abstractGraph.MascoptObjectInterface o) Returns the value for a category and a specific context.
String	getId() Returns the id of the MascoptObject.
Integer	getIntegerValue(String name) Returns the value for a category.
Integer	getIntegerValue(String name, mascoptLib.abstractGraph.MascoptObjectInterface o) Returns the value for a category and a specific context.
String	getName() Returns the name of the MascoptObject.
String	getValue(String name) Returns the value associated to its name.
String	getValue(String name, mascoptLib.abstractGraph.MascoptObjectInterface o) Returns the value associated to its name and a context.
Iterator	getValueContexts(String name) Returns an iterator on all contexts used for a value.
String	getValueDataType(String name) Returns the data type of the value associated to this name and context
String	getValueDataType(String name, mascoptLib.abstractGraph.MascoptObjectInterface o) Returns the data type of the value associated to this name and context
Iterator	getValueEntries() Give the name of values stored in this object.
boolean	notifyOnValueChange(boolean notify) Can be called to notify observers that the user changed the value.
boolean	setName(String name) Sets the name of the MascoptObject.
void	setValue(String name, Double value) Sets the value associated to its name.
void	setValue(String name, Integer value) Sets the value associated to its name.
void	setValue(String name, mascoptLib.abstractGraph.MascoptObjectInterface o, Double value) Sets the value associated to its name and context.
void	setValue(String name, mascoptLib.abstractGraph.MascoptObjectInterface o, Integer value) Sets the value associated to its name and context.
void	setValue(String name, mascoptLib.abstractGraph.MascoptObjectInterface o, String value) Sets the value associated to its name and context.
void	setValue(String name, String value)

Method Detail

getId

public String getId()

Returns the id of the MascoptObject.

Returns:

the id of the MascoptObject.

getName

public String getName()

Returns the name of the MascoptObject.

Returns:

the name of the MascoptObject.

setName

public boolean setName(String name)

Sets the name of the MascoptObject.

Parameters:

name - the name of the MascoptObject.

getValue

public String getValue(String name)

Returns the value associated to its name.

Parameters:

name - the name of the value to return.

Returns:

a string containing the value.

getIntegerValue

public Integer getIntegerValue(String name)

Returns the value for a category. The category is identified by a string name. It returns the value with an Integer.

Parameters:

name - the category of value to get.

Returns:

the Integer representing the value.

getDoubleValue

public Double getDoubleValue(String name)

Returns the value for a category. The category is identified by a string name. It returns the value with a Double.

Parameters:

name - the category of value to get.

Returns:

the Double representing the value.

getValueDataType

public String getValueDataType(String name)

Returns the data type of the value associated to this name and context

Parameters:

name - the name of the value we are interested in

Returns:

a string containing the data type of the value. The returned string is one of the following: "String", "Integer", "Double" or "null".

getValueDataType

public String getValueDataType(String name,
                               mascoptLib.abstractGraph.MascoptObjectInterface o)

Returns the data type of the value associated to this name and context

Parameters:

name - the name of the value we are interested in

o - the object representing the context.

Returns:

a string containing the data type of the value. The returned string is one of the following: "String", "Integer", "Double" or "null".

getValue

public String getValue(String name,
                       mascoptLib.abstractGraph.MascoptObjectInterface o)

Returns the value associated to its name and a context.

Parameters:

name - the name of the value to return.

o - the object which represents the context. It is usefull when associating a value to an object regarding to a certain context.

Returns:

a string containing the value.

getIntegerValue

public Integer getIntegerValue(String name,
                               mascoptLib.abstractGraph.MascoptObjectInterface o)

Returns the value for a category and a specific context. The category is identified by a string name. It returns the value with a double. The value is specific for the object o which is the context. This parameter is usefull for setting/getting values specific to a context (a layer, a graph, a set).

Parameters:

name - the category of value to get.

o - the object, context of the value.

Returns:

the Integer representing the value.

getDoubleValue

public Double getDoubleValue(String name,
                             mascoptLib.abstractGraph.MascoptObjectInterface o)

Returns the value for a category and a specific context. The category is identified by a string name. It returns the value with a double. The value is specific for the object o which is the context. This parameter is usefull for setting/getting values specific to a context (a layer, a graph, a set).

Parameters:

name - the category of value to get.

o - the object, context of the value.

Returns:

the Double representing the value.

setValue

public void setValue(String name,
                     String value)

setValue

public void setValue(String name,
                     Integer value)

Sets the value associated to its name.

Parameters:

name - the name of the value to get.

value - the value to store.

setValue

public void setValue(String name,
                     Double value)

Sets the value associated to its name.

Parameters:

name - the name of the value to get.

value - the value to store.

setValue

public void setValue(String name,
                     mascoptLib.abstractGraph.MascoptObjectInterface o,
                     String value)

Sets the value associated to its name and context.

Parameters:

name - the name of the value.

o - the object which represents the context. It is usefull when associating a value to an object regarding to a certain context.

value - the value to store.

setValue

public void setValue(String name,
                     mascoptLib.abstractGraph.MascoptObjectInterface o,
                     Integer value)

Sets the value associated to its name and context.

Parameters:

name - the name of the value.

o - the object which represents the context. It is usefull when associating a value to an object regarding to a certain context.

value - the value to store.

setValue

public void setValue(String name,
                     mascoptLib.abstractGraph.MascoptObjectInterface o,
                     Double value)

Sets the value associated to its name and context.

Parameters:

name - the name of the value.

o - the object which represents the context. It is usefull when associating a value to an object regarding to a certain context.

value - the value to store.

deleteValue

public boolean deleteValue(String name)

Delete the value for a category. The category is identified by a string name.

Parameters:

name - the category of value to delete.

Returns:

true if successfull

deleteValue

public boolean deleteValue(String name,
                           mascoptLib.abstractGraph.MascoptObjectInterface o)

Delete the value for a category and a specific context.

Parameters:

name - the category of value to get.

o - the object, context of the value.

Returns:

true if successfull

getValueEntries

public Iterator getValueEntries()

Give the name of values stored in this object. It returns an iterator on Strings where each String is the name of the value in this object. You can use this function when you have object with values wich you don't know the name

Returns:

an iterator on Strings

getValueContexts

public Iterator getValueContexts(String name)

Returns an iterator on all contexts used for a value. When a value with a given name is stored in an object, different contexts can be used to know to what context is attached a value. When the user doesn't know the different contexts it can ask for an iterator on these contexts (AbstractGraph in general).

Parameters:

name - the name of the value

Returns:

an iterator on the contexts

notifyOnValueChange

public boolean notifyOnValueChange(boolean notify)

Can be called to notify observers that the user changed the value. If some objects are listening this objects and can be affected by a modification of a value, the user may notify them. It's used in the graphical interface for example where value x or y change and are notifiyed to the GUI.

Parameters:

notify - true if we want to notify that a value has changed.

Returns:

the old notify boolean.