org.cytoscape.cyni
Interface CyCyniMetricsManager

public interface CyCyniMetricsManager

This class provides access to the available Cyni Metrics.

Field Summary

static String

DEFAULT_Cyni_Metric_PROPERTY_NAME The name of the default Cyni Metric property.

Method Summary

ArrayList<CyCyniMetric>	getAllCyniMetrics() Returns a list of all available Cyni Metrics.
ArrayList<CyCyniMetric>	getAllCyniMetricsWithType(List<String> types) Returns the list of metrics that contains at least the same types that are passed as input parameter.
CyCyniMetric	getCyniMetric(String name) Returns a Cyni Metric of the specified name and null if no metric exists with that name.
CyCyniMetric	getDefaultCyniMetric() Returns the default Cyni Metric.
void	setDefaultCyniMetric(String name) Sets the default Cyni Metric.

Field Detail

DEFAULT_Cyni_Metric_PROPERTY_NAME

static final String DEFAULT_Cyni_Metric_PROPERTY_NAME

The name of the default Cyni Metric property.

See Also:

Constant Field Values

Method Detail

getCyniMetric

CyCyniMetric getCyniMetric(String name)

Returns a Cyni Metric of the specified name and null if no metric exists with that name.

Parameters:

name - The name of the metric.

Returns:

a Cyni metric of the specified name and null if no metric exists with that name.

getAllCyniMetrics

ArrayList<CyCyniMetric> getAllCyniMetrics()

Returns a list of all available Cyni Metrics.

Returns:

a list of all available Cyni Metrics.

getAllCyniMetricsWithType

ArrayList<CyCyniMetric> getAllCyniMetricsWithType(List<String> types)

Returns the list of metrics that contains at least the same types that are passed as input parameter.

Parameters:

types - The list of types that the metrics need to support

Returns:

the list of metrics.

getDefaultCyniMetric

CyCyniMetric getDefaultCyniMetric()

Returns the default Cyni Metric. The default metric name can be specified using the DEFAULT_Cyni_Metric_PROPERTY_NAME property.

Returns:

the default metric.

setDefaultCyniMetric

void setDefaultCyniMetric(String name)

Sets the default Cyni Metric. The default metric name can be specified using the DEFAULT_Cyni_Metric_PROPERTY_NAME property.

Parameters:

the - name of the metric that will be the default one.