cytoscape.visual.mappings
Class ContinuousMapping

java.lang.Object
  cytoscape.visual.SubjectBase
      cytoscape.visual.mappings.AbstractMapping
          cytoscape.visual.mappings.ContinuousMapping

All Implemented Interfaces:

ObjectMapping, Cloneable

public class ContinuousMapping
extends AbstractMapping

Implements an interpolation table mapping data to values of a particular class. The data value is extracted from a bundle of attributes by using a specified data attribute name. For refactoring changes in this class, please refer to: cytoscape.visual.mappings.continuous.README.txt.

Field Summary

Fields inherited from class cytoscape.visual.mappings.AbstractMapping

acceptedClasses, controllingAttrName, rangeClass

Fields inherited from class cytoscape.visual.SubjectBase

observers

Fields inherited from interface cytoscape.visual.mappings.ObjectMapping

EDGE_MAPPING, NODE_MAPPING

Constructor Summary

ContinuousMapping(Class<?> rangeClass, String controllingAttrName)

ContinuousMapping(Object defaultObj, byte mapType)
Deprecated. Use new constructor instead. Will be removed in 10/2011. Controlling attribute name is always required, and now it's a part of constructor argument.

Method Summary

void	addPoint(double value, BoundaryRangeValues brv) Adds a New Data Point.
void	applyProperties(Properties props, String baseKey, ValueParser parser) Customizes this object by applying mapping defintions described by the supplied Properties argument.
Object	calculateRangeValue(Map<String,Object> attrBundle) Calculates the Range Value.
Object	clone() Create deep copy of the object.
List<ContinuousMappingPoint>	getAllPoints() Gets all Data Points.
Interpolator	getInterpolator() Gets the Mapping Interpolator.
JPanel	getLegend(VisualPropertyType vpt)
ContinuousMappingPoint	getPoint(int index) Gets Specified Point.
int	getPointCount() Gets Total Point Count.
Properties	getProperties(String baseKey) Returns a Properties object with entries suitable for customizing this object via the applyProperties method.
void	removePoint(int index) Removes a Point from the List.
void	setInterpolator(Interpolator interpolator) Sets the Mapping Interpolator.

Methods inherited from class cytoscape.visual.mappings.AbstractMapping

getAcceptedDataClasses, getControllingAttributeName, getRangeClass, getUI, setControllingAttributeName, setControllingAttributeName

Methods inherited from class cytoscape.visual.SubjectBase

addChangeListener, fireStateChanged, removeChangeListener

Methods inherited from class java.lang.Object

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

Methods inherited from interface cytoscape.visual.mappings.ObjectMapping

addChangeListener, removeChangeListener

Constructor Detail

ContinuousMapping

@Deprecated
public ContinuousMapping(Object defaultObj,
                                    byte mapType)
                  throws IllegalArgumentException

Deprecated. Use new constructor instead. Will be removed in 10/2011. Controlling attribute name is always required, and now it's a part of constructor argument.

Constructor.

Parameters:

defaultObj - default object to map to

mapType - Type of mapping, one of ObjectMapping.EDGE_MAPPING or ObjectMapping.NODE_MAPPING

Throws:

IllegalArgumentException

ContinuousMapping

public ContinuousMapping(Class<?> rangeClass,
                         String controllingAttrName)

Method Detail

clone

public Object clone()

Create deep copy of the object.

Specified by:

clone in interface ObjectMapping

Specified by:

clone in class AbstractMapping

Returns:

Cloned Mapping Object.

getAllPoints

public List<ContinuousMappingPoint> getAllPoints()

Gets all Data Points.

Returns:

ArrayList of ContinuousMappingPoint objects.

addPoint

public void addPoint(double value,
                     BoundaryRangeValues brv)

Adds a New Data Point.

removePoint

public void removePoint(int index)

Removes a Point from the List.

getPointCount

public int getPointCount()

Gets Total Point Count.

getPoint

public ContinuousMappingPoint getPoint(int index)

Gets Specified Point.

Parameters:

index - Index Value.

Returns:

ContinuousMappingPoint.

applyProperties

public void applyProperties(Properties props,
                            String baseKey,
                            ValueParser parser)

Customizes this object by applying mapping defintions described by the supplied Properties argument. Required by the ObjectMapping interface.

Specified by:

applyProperties in interface ObjectMapping

Specified by:

applyProperties in class AbstractMapping

Parameters:

props - Properties Object.

baseKey - Base Key for finding properties.

parser - ValueParser Object.

getProperties

public Properties getProperties(String baseKey)

Returns a Properties object with entries suitable for customizing this object via the applyProperties method. Required by the ObjectMapping interface.

Specified by:

getProperties in interface ObjectMapping

Specified by:

getProperties in class AbstractMapping

Parameters:

baseKey - Base Key for creating properties.

Returns:

Properties Object.

getInterpolator

public Interpolator getInterpolator()

Gets the Mapping Interpolator. Required by the ObjectMapping interface.

Returns:

Interpolator Object.

setInterpolator

public void setInterpolator(Interpolator interpolator)

Sets the Mapping Interpolator. Required by the ObjectMapping interface.

Parameters:

interpolator - Interpolator Object.

getLegend

public JPanel getLegend(VisualPropertyType vpt)

Specified by:

getLegend in interface ObjectMapping

Overrides:

getLegend in class AbstractMapping

calculateRangeValue

public Object calculateRangeValue(Map<String,Object> attrBundle)

Calculates the Range Value. Required by the ObjectMapping interface.

Specified by:

calculateRangeValue in interface ObjectMapping

Specified by:

calculateRangeValue in class AbstractMapping

Parameters:

attrBundle - A Bundle of Attributes.

Returns:

Mapping object.