org.cytoscape.group.data

Interface Aggregator<T>

public interface Aggregator<T>

The Aggregator interface acts as a service interface for different methods of aggregating attribute data for the nodes in a CyGroup. Aggregators are used to combine the attribute values of the nodes contained within a Group into a representative attribute value for the Group itself.

Module: group-api

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

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

Cytoscape Backwards Compatibility (SPI Interface): We expect that this interface will be implemented. Therefore to maintain backwards compatibility this interface will only be modified for major version updates.

Method Summary

Modifier and Type	Method and Description
<T> T	aggregate(CyTable table, CyGroup group, CyColumn column) Aggregate the column for the members of the specified group into the group.
default Class	getSupportedListType() Return the base Class of the List, if this is a list type.
Class	getSupportedType() Return the Class this aggregator supports
String	toString() This gets the name of the handling type supported by this aggregator, suitable for use in a menu.

Method Detail

getSupportedType

Class getSupportedType()

Return the Class this aggregator supports

Returns:

the Class supported

getSupportedListType

default Class getSupportedListType()

Return the base Class of the List, if this is a list type.

Returns:

the Class supported by this List

toString

String toString()

This gets the name of the handling type supported by this aggregator, suitable for use in a menu.

Overrides:

toString in class Object

Returns:

a name for the handling type

aggregate

<T> T aggregate(CyTable table,
                CyGroup group,
                CyColumn column)

Aggregate the column for the members of the specified group into the group.

Parameters:

table - the CyTable for this group

group - the group

column - the column we're aggregating

Returns:

the aggregated value