org.cytoscape.cyni
Class AbstractCyniMetric

java.lang.Object
  org.cytoscape.cyni.AbstractCyniMetric

All Implemented Interfaces:

CyCyniMetric

public abstract class AbstractCyniMetric
extends Object
implements CyCyniMetric

The AbstractCyniMetrics provides a basic implementation of a cyni metric TaskFactory.

Constructor Summary

AbstractCyniMetric(String computerName, String humanName)
The Constructor.

Method Summary

protected void	addType(String type) It adds a type to the list of supported types for that metric
String	getName() A computer readable name used to to differentiate the metrics.
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
String	toString() Used to get the user-visible name of the cyni Metric.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface org.cytoscape.cyni.CyCyniMetric

getMetric

Constructor Detail

AbstractCyniMetric

public AbstractCyniMetric(String computerName,
                          String humanName)

The Constructor.

Parameters:

computerName - a computer readable name used to differentiate the metrics.

humanName - a user visible name of the metric.

types - list of types that this metric supports.

Method Detail

getName

public String getName()

A computer readable name used to to differentiate the metrics.

Specified by:

getName in interface CyCyniMetric

Returns:

a computer readable name used to differentiate the metrics.

toString

public String toString()

Used to get the user-visible name of the cyni Metric.

Overrides:

toString in class Object

Returns:

the user-visible name of the cyni Metric.

addType

protected void addType(String type)

It adds a type to the list of supported types for that metric

getTypesList

public List<String> getTypesList()

The list of types of this metric

Specified by:

getTypesList in interface CyCyniMetric

Returns:

the list of types

resetParameters

public void resetParameters()

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

Specified by:

resetParameters in interface CyCyniMetric

setParameters

public void setParameters(Map<String,Object> params)

It sets the metric's parameters

Specified by:

setParameters in interface CyCyniMetric

Parameters:

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