Package 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.

    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>

    • 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

      • getListAggregators

        List<Aggregator<?>> getListAggregators​(Class<?> type)
        Get the list of List 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

      • getListAggregators

        List<Aggregator<?>> getListAggregators()
        Get the list of aggregators for List columns.
        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

      • getSupportedListClasses

        List<Class<?>> getSupportedListClasses()
        Get the list of classes of List for which have aggregators.
        Returns:
        the list of classes of List we're aggregating