Package org.cytoscape.group

Interface CyGroupSettingsManager

  • public interface CyGroupSettingsManager
    The CyGroupSettingsManager is responsible for providing an interface to all of the possible settings controlling CyGroups, including the default settings and group specific settings. This includes both view settings as well as the various aggregation settings.

    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 (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 Detail

      • getUseNestedNetworks

        boolean getUseNestedNetworks()
        Get the default setting for whether or not to create a nested network view on collapsed nodes.
        Returns:
        use nested network image on collapsed nodes if true

      • getUseNestedNetworks

        boolean getUseNestedNetworks​(CyGroup group)
        Get the setting for whether or not to create a nested network view on collapsed nodes for the specified CyGroup.
        Parameters:
        group - the CyGroup we want to get the nested network setting for
        Returns:
        use nested network image on collapsed nodes if true

      • setUseNestedNetworks

        void setUseNestedNetworks​(boolean useNestedNetwork)
        Set the default setting for whether or not to create a nested network view on collapsed nodes.
        Parameters:
        useNestedNetwork - if true, create a nested network image by default

      • setUseNestedNetworks

        void setUseNestedNetworks​(CyGroup group,
                          boolean useNestedNetwork)
        Set the setting for whether or not to create a nested network view on collapsed nodes for a specific CyGroup.
        Parameters:
        group - the CyGroup we're setting
        useNestedNetwork - if true, create a nested network image by default

      • getEnableAttributeAggregation

        boolean getEnableAttributeAggregation()
        Get the setting for whether or not we're enabling aggregation. If the return value is true, then the values in the member nodes will be aggregated onto the corresponding column in the group node.
        Returns:
        true if we are aggregating values, false otherwise

      • getEnableAttributeAggregation

        boolean getEnableAttributeAggregation​(CyGroup group)
        Get the setting for whether or not we're enabling aggregation for a specific group. If the return value is true, then the values in the member nodes will be aggregated onto the corresponding column in the group node.
        Parameters:
        group - the CyGroup we're interested in
        Returns:
        true if we are aggregating values, false otherwise

      • setEnableAttributeAggregation

        void setEnableAttributeAggregation​(boolean aggregate)
        Set the setting for whether or not we're aggregating values from member nodes onto the group node.
        Parameters:
        aggregate - true if we are aggregating values, false otherwise

      • setEnableAttributeAggregation

        void setEnableAttributeAggregation​(CyGroup group,
                                   boolean aggregate)
        Set the setting for whether or not we're aggregating values for member nodes onto the group node for a specific group.
        Parameters:
        group - the CyGroup we're interested in
        aggregate - true if we are aggregating values, false otherwise

      • getAggregator

        Aggregator<?> getAggregator​(CyGroup group,
                            CyColumn column)
        Get the Aggregator that will be used to aggregate the values in a specific CyColumn for all of the nodes in a group onto the corresponding column in the group node. The returned Aggregator will take into account any overrides and group-specific settings, if there are any.
        Parameters:
        group - the CyGroup to get the Aggregator for
        column - the CyColumn to get the Aggregator for
        Returns:
        the Aggregator for the specific group and column

      • getDefaultListAggregation

        Aggregator<?> getDefaultListAggregation​(Class<?> ovClass)
        Get the default Aggregator for a specific List column type as expressed as a java Class.
        Parameters:
        ovClass - the List Class to get the default Aggregator for
        Returns:
        the default Aggregator for the specific Class

      • setDefaultAggregation

        void setDefaultAggregation​(Class<?> ovClass,
                           Aggregator<?> agg)
        Set the default Aggregator for a specific column type as expressed as a java Class.
        Parameters:
        ovClass - the Class to get the default Aggregator for
        agg - the Aggregator to set as the default for the specified Class

      • setDefaultListAggregation

        void setDefaultListAggregation​(Class<?> ovClass,
                               Aggregator<?> agg)
        Set the default Aggregator for a specific List column type as expressed as a java Class.
        Parameters:
        ovClass - the List Class to set the default Aggregator for
        agg - the Aggregator to set as the default for the specified Class

      • getOverrideAggregation

        Aggregator<?> getOverrideAggregation​(CyColumn column)
        Get the override aggregation setting for a column (if any). Override aggregation provides the ability to override the Aggregator used for a specific column. For example we may not want to aggregate the "shared node" column.
        Parameters:
        column - the CyColumn to get the default override for
        Returns:
        the Aggregator for this column, or null if no override was set

      • setOverrideAggregation

        void setOverrideAggregation​(CyColumn column,
                            Aggregator<?> agg)
        set the override aggregation setting for a column (if any). Override aggregation provides the ability to override the Aggregator used for a specific column. For example we may not want to aggregate the "shared node" column.
        Parameters:
        column - the CyColumn to set the default override for
        agg - the Aggregator for this column

      • getOverrideAggregation

        Aggregator<?> getOverrideAggregation​(CyGroup group,
                                     CyColumn column)
        Get the override aggregation setting for a column (if any) in a specific group. Override aggregation provides the ability to override the Aggregator used for a specific column. For example we may not want to aggregate the "shared node" column.
        Parameters:
        group - the CyGroup to get the Aggregator for
        column - the CyColumn to get the override for
        Returns:
        the Aggregator for this column in this group, or null if no override was set

      • setOverrideAggregation

        void setOverrideAggregation​(CyGroup group,
                            CyColumn column,
                            Aggregator<?> agg)
        set the override aggregation setting for a column in a group (if any). Override aggregation provides the ability to override the Aggregator used for a specific column. For example we may not want to aggregate the "shared node" column.
        Parameters:
        group - the CyGroup to set the Aggregator for
        column - the CyColumn to set the default override for
        agg - the Aggregator for this column in this group