cytoscape.visual.mappings
Class DiscreteMapping

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

All Implemented Interfaces:

ObjectMapping, Cloneable

public class DiscreteMapping
extends AbstractMapping

Implements a lookup 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.

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

DiscreteMapping(Class<?> rangeClass, String controllingAttrName)
Constructor for Discrete mapping.

DiscreteMapping(Object defObj, 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.

DiscreteMapping(Object defObj, String attrName, 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	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() Clones the Object.
Map	getAll() gets all map values
Object	getLastKeyModified() Gets the Last Modified Key.
JPanel	getLegend(VisualPropertyType vpt) DOCUMENT ME!
Object	getMapValue(Object key) Gets Value for Specified Key.
Properties	getProperties(String baseKey) Returns a Properties object with entries suitable for customizing this object via the applyProperties method.
void	putAll(Map map) Adds All Members of Specified Map.
void	putMapValue(Object key, Object value) Puts New Key/Value in Map.

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

DiscreteMapping

@Deprecated
public DiscreteMapping(Object defObj,
                                  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.

Constructor.

Parameters:

defObj - Default Object.

mapType - Map Type, ObjectMapping.EDGE_MAPPING or ObjectMapping.NODE_MAPPING.

DiscreteMapping

@Deprecated
public DiscreteMapping(Object defObj,
                                  String attrName,
                                  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.

Constructor.

Parameters:

defObj - Default Object.

attrName - Controlling Attribute Name.

mapType - Map Type, ObjectMapping.EDGE_MAPPING or ObjectMapping.NODE_MAPPING.

DiscreteMapping

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

Constructor for Discrete mapping.

Parameters:

rangeClass - Mapped value type.

controllingAttrName - attribute name used in this mapping.

Method Detail

clone

public Object clone()

Clones the Object.

Specified by:

clone in interface ObjectMapping

Specified by:

clone in class AbstractMapping

Returns:

DiscreteMapping Object.

getMapValue

public Object getMapValue(Object key)

Gets Value for Specified Key.

Parameters:

key - String Key.

Returns:

Object.

putMapValue

public void putMapValue(Object key,
                        Object value)

Puts New Key/Value in Map.

Parameters:

key - Key Object.

value - Value Object.

getLastKeyModified

public Object getLastKeyModified()

Gets the Last Modified Key.

Returns:

Key Object.

putAll

public void putAll(Map map)

Adds All Members of Specified Map.

Parameters:

map - Map.

getAll

public Map getAll()

gets all map values

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.

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.

getLegend

public JPanel getLegend(VisualPropertyType vpt)

DOCUMENT ME!

Specified by:

getLegend in interface ObjectMapping

Overrides:

getLegend in class AbstractMapping

Parameters:

vpt - DOCUMENT ME!

Returns:

DOCUMENT ME!