cytoscape.visual
Class EdgeAppearanceCalculator

java.lang.Object
  cytoscape.visual.EdgeAppearanceCalculator

All Implemented Interfaces:

Cloneable

public class EdgeAppearanceCalculator
extends Object

This class calculates the appearance of an Edge. It holds a default value and a (possibly null) calculator for each visual attribute.

Constructor Summary

EdgeAppearanceCalculator()
Creates a new EdgeAppearanceCalculator object.

EdgeAppearanceCalculator(EdgeAppearanceCalculator toCopy)
Copy constructor.

EdgeAppearanceCalculator(String name, Properties eacProps, String baseKey, CalculatorCatalog catalog)
Creates a new EdgeAppearanceCalculator and immediately customizes it by calling applyProperties with the supplied arguments.

Method Summary

void	applyProperties(String name, Properties eacProps, String baseKey, CalculatorCatalog catalog) DOCUMENT ME!
void	calculateEdgeAppearance(EdgeAppearance appr, Edge edge, CyNetwork network) Using the rules defined by the default values and calculators in this object, compute an appearance for the requested Edge in the supplied CyNetwork.
EdgeAppearance	calculateEdgeAppearance(Edge edge, CyNetwork network) Using the rules defined by the default values and calculators in this object, compute an appearance for the requested Edge in the supplied CyNetwork.
Object	clone() Create deep copy of the object.
Object	clone(String vsName) Make deep copy of this object
Calculator	getCalculator(byte type) Deprecated. Will be removed 5/2008
Calculator	getCalculator(VisualPropertyType type) DOCUMENT ME!
List<Calculator>	getCalculators() DOCUMENT ME!
EdgeAppearance	getDefaultAppearance() DOCUMENT ME!
String	getDescription() DOCUMENT ME!
Properties	getProperties(String baseKey) DOCUMENT ME!
void	removeCalculator(byte type) Deprecated. Will be removed 5/2008
void	removeCalculator(VisualPropertyType type) DOCUMENT ME!
void	setCalculator(Calculator c) DOCUMENT ME!
void	setDefaultAppearance(EdgeAppearance appr) DOCUMENT ME!

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

EdgeAppearanceCalculator

public EdgeAppearanceCalculator()

Creates a new EdgeAppearanceCalculator object.

EdgeAppearanceCalculator

public EdgeAppearanceCalculator(EdgeAppearanceCalculator toCopy)

Copy constructor. Returns a default object if the argument is null.

EdgeAppearanceCalculator

public EdgeAppearanceCalculator(String name,
                                Properties eacProps,
                                String baseKey,
                                CalculatorCatalog catalog)

Creates a new EdgeAppearanceCalculator and immediately customizes it by calling applyProperties with the supplied arguments.

Method Detail

clone

public Object clone()

Create deep copy of the object.

calculateEdgeAppearance

public EdgeAppearance calculateEdgeAppearance(Edge edge,
                                              CyNetwork network)

Using the rules defined by the default values and calculators in this object, compute an appearance for the requested Edge in the supplied CyNetwork. A new EdgeApperance object will be created.

calculateEdgeAppearance

public void calculateEdgeAppearance(EdgeAppearance appr,
                                    Edge edge,
                                    CyNetwork network)

Using the rules defined by the default values and calculators in this object, compute an appearance for the requested Edge in the supplied CyNetwork. The supplied EdgeAppearance object will be changed to hold the new values.

getDefaultAppearance

public EdgeAppearance getDefaultAppearance()

DOCUMENT ME!

Returns:

DOCUMENT ME!

setDefaultAppearance

public void setDefaultAppearance(EdgeAppearance appr)

DOCUMENT ME!

Parameters:

appr - DOCUMENT ME!

getDescription

public String getDescription()

DOCUMENT ME!

Returns:

DOCUMENT ME!

applyProperties

public void applyProperties(String name,
                            Properties eacProps,
                            String baseKey,
                            CalculatorCatalog catalog)

DOCUMENT ME!

Parameters:

name - DOCUMENT ME!

eacProps - DOCUMENT ME!

baseKey - DOCUMENT ME!

catalog - DOCUMENT ME!

getProperties

public Properties getProperties(String baseKey)

DOCUMENT ME!

Parameters:

baseKey - DOCUMENT ME!

Returns:

DOCUMENT ME!

clone

public Object clone(String vsName)

Make deep copy of this object

getCalculator

@Deprecated
public Calculator getCalculator(byte type)

Deprecated. Will be removed 5/2008

Use Calculator getCalculator(final VisualPropertyType type) instead.

Parameters:

type -

Returns:

getCalculator

public Calculator getCalculator(VisualPropertyType type)

DOCUMENT ME!

Parameters:

type - DOCUMENT ME!

Returns:

DOCUMENT ME!

getCalculators

public List<Calculator> getCalculators()

DOCUMENT ME!

Returns:

DOCUMENT ME!

removeCalculator

@Deprecated
public void removeCalculator(byte type)

Deprecated. Will be removed 5/2008

Use removeCalculator(final VisualPropertyType type) instead.

Parameters:

type -

removeCalculator

public void removeCalculator(VisualPropertyType type)

DOCUMENT ME!

Parameters:

type - DOCUMENT ME!

setCalculator

public void setCalculator(Calculator c)

DOCUMENT ME!

Parameters:

c - DOCUMENT ME!