org.cytoscape.cyni
Interface CyCyniMetric

All Known Implementing Classes:

AbstractCyniMetric

public interface CyCyniMetric

An interface specific to Cyni metrics.

Method Summary

Double	getMetric(CyniTable table1, CyniTable table2, int indexBase, List<Integer> indexToCompare) The implementation of the metric
String	getName() Returns the computer-readable name of the Cyni Metric.
List<String>	getTypesList() The list of types of this metric
void	resetParameters() It resets the metric and leaves the default metric's parameters
void	setParameters(Map<String,Object> params) It sets the metric's parameters

Method Detail

getMetric

Double getMetric(CyniTable table1,
                 CyniTable table2,
                 int indexBase,
                 List<Integer> indexToCompare)

The implementation of the metric

Parameters:

table1 - The cyniTable where there is the first element to compare.

table2 - The cyniTable where there is the second element to compare.

indexBase - The index of the element in the first CyniTable that will be compared.

indexToCompare - The list of indexes of the elements in the second CyniTable that will compared

Returns:

the result of the measurement

getName

String getName()

Returns the computer-readable name of the Cyni Metric. To get a human readable name, use toString().

Returns:

The computer-readable name of the metric.

getTypesList

List<String> getTypesList()

The list of types of this metric

Returns:

the list of types

resetParameters

void resetParameters()

It resets the metric and leaves the default metric's parameters

setParameters

void setParameters(Map<String,Object> params)

It sets the metric's parameters

Parameters:

params - The map that maps the name of the parameter with the actual variable