Cytoscape 3.0.1 API

org.cytoscape.group.data
Interface CyGroupAggregationManager


public interface CyGroupAggregationManager

The CyGroupAggregationManager provides a mechanism to add new Aggregators to the group aggregation mechanism. It is meant to be used by apps that want to extend the aggregation mechanism for types not supported by the built-in aggregators.


Method Summary
 void addAggregator(Aggregator aggregator)
          Add a new aggregator to the available aggregators.
 List<Aggregator> getAggregators()
          Get the list of aggregators.
 List<Aggregator> getAggregators(Class type)
          Get the list of aggregators for a particular Class.
 List<Class> getSupportedClasses()
          Get the list of classes for which have aggregators.
 void removeAggregator(Aggregator aggregator)
          Remove an aggregator from the available aggregators.
 

Method Detail

addAggregator

void addAggregator(Aggregator aggregator)
Add a new aggregator to the available aggregators. Aggregators provide a specific aggregation algorithm for a specific CyColumn type.

Parameters:
aggregator - the Aggregator

removeAggregator

void removeAggregator(Aggregator aggregator)
Remove an aggregator from the available aggregators.

Parameters:
aggregator - the Aggregator to remove

getAggregators

List<Aggregator> getAggregators(Class type)
Get the list of aggregators for a particular Class.

Parameters:
type - the Class to get aggregators for
Returns:
the list of aggregators

getAggregators

List<Aggregator> getAggregators()
Get the list of aggregators.

Returns:
the list of aggregators

getSupportedClasses

List<Class> getSupportedClasses()
Get the list of classes for which have aggregators.

Returns:
the list of classes we're aggregating

Cytoscape 3.0.1 API

Copyright 2011 Cytoscape Consortium. All rights reserved.