cytoscape.util
Interface ModuleProperties

All Known Implementing Classes:

LayoutProperties, ModulePropertiesImpl

public interface ModuleProperties

Method Summary

void	add(Tunable tunable) This method is used to add a new Tunable to the LayoutProperties list.
Tunable	get(String name) This method is used to get the Tunable named name from this LayoutProperties.
HashMap	getProperties() getProperties is used to extract properties from the Cytoscape properties file.
List<String>	getTunableList() This method is used to get the list of available Tunables for this algorithm.
List<Tunable>	getTunables() This method returns list of tunables.
String	getValue(String name) This method is used to get the value from the Tunable named name from this LayoutProperties.
void	initializeProperties() This method is used to read the properties from the Cytoscape properties file and set the values for that property in the appropriate Tunable.
void	revertProperties() revertProperties is used primarily by the settings dialog mechanism when the user does a "Cancel".
void	saveProperties() saveProperties is used to add modified properties to the Cytoscape properties so they can be saved in the properties file.
void	setProperty(String property, String value) DOCUMENT ME!
void	setSavedProperty(String property, String value) DOCUMENT ME!
void	updateValues() This method calls the updateValues method of each Tunable that is part of this LayoutProperty.

Method Detail

add

void add(Tunable tunable)

This method is used to add a new Tunable to the LayoutProperties list. The Tunable can later be retrieved by name using the get method.

Parameters:

tunable - The Tunable to add to this LayoutProperties

get

Tunable get(String name)

This method is used to get the Tunable named name from this LayoutProperties. In general, the name of a Tunable should correspond to the last component of the property that it is associated with.

Parameters:

name - The name of the Tunable to retrieve.

Returns:

Tunable associated with name or null if there is no Tunable with that name.

getTunableList

List<String> getTunableList()

This method is used to get the list of available Tunables for this algorithm.

Returns:

the list of the names of Tunables for this algorithm

getValue

String getValue(String name)

This method is used to get the value from the Tunable named name from this LayoutProperties. The value is always returned as a String.

Parameters:

name - The name of the Tunable whose value you want to retrieve.

Returns:

String value from the Tunable or null if there is no Tunable with that name.

updateValues

void updateValues()

This method calls the updateValues method of each Tunable that is part of this LayoutProperty.

getProperties

HashMap getProperties()

getProperties is used to extract properties from the Cytoscape properties file. getProperties should always be called first to initialize the property maps.

Returns:

HashMap containing the resulting properties

saveProperties

void saveProperties()

saveProperties is used to add modified properties to the Cytoscape properties so they can be saved in the properties file.

setProperty

void setProperty(String property,
                 String value)

DOCUMENT ME!

Parameters:

property - DOCUMENT ME!

value - DOCUMENT ME!

setSavedProperty

void setSavedProperty(String property,
                      String value)

DOCUMENT ME!

Parameters:

property - DOCUMENT ME!

value - DOCUMENT ME!

revertProperties

void revertProperties()

revertProperties is used primarily by the settings dialog mechanism when the user does a "Cancel".

initializeProperties

void initializeProperties()

This method is used to read the properties from the Cytoscape properties file and set the values for that property in the appropriate Tunable. If there is no value for the property, then the default value in the Tunable is used to initialize the property.

getTunables

List<Tunable> getTunables()

This method returns list of tunables.

Returns:

JPanel that contains all of the Tunable widgets