Package org.cytoscape.view.vizmap

Interface VisualMappingFunctionFactory

public interface VisualMappingFunctionFactory

Factory for VisualMappingFunctions. Implementation of this will be provided as an service. One mapping type should have one factory.

Module: vizmap-api

To use this in your app, include the following dependency in your POM:

<dependency>
    <groupId>org.cytoscape</groupId>
    <artifactId>vizmap-api</artifactId>
</dependency>

Cytoscape Backwards Compatibility (API Interface): We expect that this interface will be used but not implemented by developers using this interface. As such, we reserve the right to add methods to the interface as part of minor version upgrades. We will not remove methods for any changes other than major version upgrades.

Method Summary

Modifier and Type	Method	Description
<K,V> VisualMappingFunction<K,V>	createVisualMappingFunction(String attributeName, Class<K> attrValueType, VisualProperty<V> vp)	Create a new VisualMappingFunction.
Class<?>	getMappingFunctionType()	Returns the type of this VisualMappingFunctionFactory.

Method Detail

createVisualMappingFunction

<K,V> VisualMappingFunction<K,V> createVisualMappingFunction(String attributeName,
                                                                         Class<K> attrValueType,
                                                                         VisualProperty<V> vp)

Create a new VisualMappingFunction.

Type Parameters:

K - Data type of controlling attribute.

V - Data type of VisualProperty, such as Double, String, etc.

Parameters:

attributeName - Controlling attribute name. This is a name of the column in a data table.

attrValueType - Data type of controlling attribute.

vp - VisualProperty used in the new mapping

Returns:

new VisualMappingFunction.

getMappingFunctionType

Class<?> getMappingFunctionType()

Returns the type of this VisualMappingFunctionFactory.

Returns:

the type of this VisualMappingFunctionFactory.