Package org.cytoscape.group
Interface CyGroupSettingsManager
public interface CyGroupSettingsManager
The CyGroupSettingsManager is responsible for providing an interface
to all of the possible settings controlling
CyGroup
s, 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.
-
Nested Class Summary
Nested ClassesModifier and TypeInterfaceDescriptionstatic enum
TheDoubleClickAciton
enum provides the options for what to do when the user double-clicks on either a group node or a node that's a member of a group.static enum
TheCyGroupSettingsManager.GroupViewType
enum provides the options for how to visualize a group. -
Method Summary
Modifier and TypeMethodDescriptionAggregator<?>
getAggregator
(CyGroup group, CyColumn column) Get theAggregator
that will be used to aggregate the values in a specificCyColumn
for all of the nodes in a group onto the corresponding column in the group node.Aggregator<?>
getDefaultAggregation
(Class<?> ovClass) Get the defaultAggregator
for a specific column type as expressed as a javaClass
.Aggregator<?>
getDefaultAggregation
(CyGroup group, Class<?> ovClass) Get theAggregator
for a specific column type as expressed as a javaClass
that will be used in the specifiedCyGroup
.Aggregator<?>
getDefaultListAggregation
(Class<?> ovClass) Get the defaultAggregator
for a specific List column type as expressed as a javaClass
.Aggregator<?>
getDefaultListAggregation
(CyGroup group, Class<?> ovClass) Get theAggregator
for a specific List column type as expressed as a javaClass
that will be used in the specifiedCyGroup
.Get the current defaultCyGroupSettingsManager.DoubleClickAction
.getDoubleClickAction
(CyGroup group) Get the currentCyGroupSettingsManager.DoubleClickAction
for the specified group.boolean
Get the setting for whether or not we're enabling aggregation.boolean
Get the setting for whether or not we're enabling aggregation for a specific group.Get the current defaultCyGroupSettingsManager.GroupViewType
.getGroupViewType
(CyGroup group) Get the currentCyGroupSettingsManager.GroupViewType
for the specified group.Aggregator<?>
getOverrideAggregation
(CyGroup group, CyColumn column) Get the override aggregation setting for a column (if any) in a specific group.Aggregator<?>
getOverrideAggregation
(CyColumn column) Get the override aggregation setting for a column (if any).boolean
Get the default setting for whether or not to create a nested network view on collapsed nodes.boolean
getUseNestedNetworks
(CyGroup group) Get the setting for whether or not to create a nested network view on collapsed nodes for the specifiedCyGroup
.void
setDefaultAggregation
(Class<?> ovClass, Aggregator<?> agg) Set the defaultAggregator
for a specific column type as expressed as a javaClass
.void
setDefaultAggregation
(CyGroup group, Class<?> ovClass, String aggName) Set theAggregator
for a specific column type as expressed as a javaClass
that will be used in the specifiedCyGroup
.void
setDefaultAggregation
(CyGroup group, Class<?> ovClass, Aggregator<?> agg) Set theAggregator
for a specific column type as expressed as a javaClass
that will be used in the specifiedCyGroup
.void
setDefaultListAggregation
(Class<?> ovClass, Aggregator<?> agg) Set the defaultAggregator
for a specific List column type as expressed as a javaClass
.void
setDefaultListAggregation
(CyGroup group, Class<?> ovClass, String aggName) Set theAggregator
for a specific List column type as expressed as a javaClass
that will be used in the specifiedCyGroup
.void
setDefaultListAggregation
(CyGroup group, Class<?> ovClass, Aggregator<?> agg) Set theAggregator
for a specific List column type as expressed as a javaClass
that will be used in the specifiedCyGroup
.void
setDoubleClickAction
(CyGroup group, CyGroupSettingsManager.DoubleClickAction action) Set theCyGroupSettingsManager.DoubleClickAction
for a specific group.void
Set the current defaultCyGroupSettingsManager.DoubleClickAction
.void
setEnableAttributeAggregation
(boolean aggregate) Set the setting for whether or not we're aggregating values from member nodes onto the group node.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.void
setGroupViewType
(CyGroup group, CyGroupSettingsManager.GroupViewType action) Set theCyGroupSettingsManager.GroupViewType
for a specific group.void
Set the current defaultCyGroupSettingsManager.GroupViewType
.void
setOverrideAggregation
(CyGroup group, CyColumn column, Aggregator<?> agg) set the override aggregation setting for a column in a group (if any).void
setOverrideAggregation
(CyColumn column, Aggregator<?> agg) set the override aggregation setting for a column (if any).void
setUseNestedNetworks
(boolean useNestedNetwork) Set the default setting for whether or not to create a nested network view on collapsed nodes.void
setUseNestedNetworks
(CyGroup group, boolean useNestedNetwork) Set the setting for whether or not to create a nested network view on collapsed nodes for a specificCyGroup
.
-
Method Details
-
getDoubleClickAction
CyGroupSettingsManager.DoubleClickAction getDoubleClickAction()Get the current defaultCyGroupSettingsManager.DoubleClickAction
. All new groups will utilize this action unless changed by a group-specific set.- Returns:
- the current default DoubleClickAction
-
getDoubleClickAction
Get the currentCyGroupSettingsManager.DoubleClickAction
for the specified group.- Parameters:
group
- theCyGroup
we're interested in- Returns:
- the current DoubleClickAction for this group
-
setDoubleClickAction
Set the current defaultCyGroupSettingsManager.DoubleClickAction
. All new groups will utilize this action unless changed by a group-specific set.- Parameters:
action
- theCyGroupSettingsManager.DoubleClickAction
to set as the default
-
setDoubleClickAction
Set theCyGroupSettingsManager.DoubleClickAction
for a specific group.- Parameters:
group
- theCyGroup
to set the value foraction
- theCyGroupSettingsManager.DoubleClickAction
to set for this group
-
getGroupViewType
CyGroupSettingsManager.GroupViewType getGroupViewType()Get the current defaultCyGroupSettingsManager.GroupViewType
. All new groups will utilize this visualization unless overridden by a specific setting- Returns:
- the current default
CyGroupSettingsManager.GroupViewType
to set
-
getGroupViewType
Get the currentCyGroupSettingsManager.GroupViewType
for the specified group.- Parameters:
group
- theCyGroup
we're interested in- Returns:
- the current
CyGroupSettingsManager.GroupViewType
for this group
-
setGroupViewType
Set the current defaultCyGroupSettingsManager.GroupViewType
. All new groups will utilize this visualization unless changed by a group-specific set.- Parameters:
action
- theCyGroupSettingsManager.GroupViewType
to set as the default
-
setGroupViewType
Set theCyGroupSettingsManager.GroupViewType
for a specific group.- Parameters:
group
- theCyGroup
to set the value foraction
- theCyGroupSettingsManager.GroupViewType
to set for this group
-
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
Get the setting for whether or not to create a nested network view on collapsed nodes for the specifiedCyGroup
.- Parameters:
group
- theCyGroup
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
Set the setting for whether or not to create a nested network view on collapsed nodes for a specificCyGroup
.- Parameters:
group
- theCyGroup
we're settinguseNestedNetwork
- 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
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
- theCyGroup
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
Set the setting for whether or not we're aggregating values for member nodes onto the group node for a specific group.- Parameters:
group
- theCyGroup
we're interested inaggregate
- true if we are aggregating values, false otherwise
-
getAggregator
Get theAggregator
that will be used to aggregate the values in a specificCyColumn
for all of the nodes in a group onto the corresponding column in the group node. The returnedAggregator
will take into account any overrides and group-specific settings, if there are any.- Parameters:
group
- theCyGroup
to get theAggregator
forcolumn
- theCyColumn
to get theAggregator
for- Returns:
- the
Aggregator
for the specific group and column
-
getDefaultAggregation
Get the defaultAggregator
for a specific column type as expressed as a javaClass
.- Parameters:
ovClass
- theClass
to get the defaultAggregator
for- Returns:
- the default
Aggregator
for the specificClass
-
getDefaultListAggregation
Get the defaultAggregator
for a specific List column type as expressed as a javaClass
.- Parameters:
ovClass
- the ListClass
to get the defaultAggregator
for- Returns:
- the default
Aggregator
for the specificClass
-
setDefaultAggregation
Set the defaultAggregator
for a specific column type as expressed as a javaClass
.- Parameters:
ovClass
- theClass
to get the defaultAggregator
foragg
- theAggregator
to set as the default for the specifiedClass
-
setDefaultListAggregation
Set the defaultAggregator
for a specific List column type as expressed as a javaClass
.- Parameters:
ovClass
- the ListClass
to set the defaultAggregator
foragg
- theAggregator
to set as the default for the specifiedClass
-
getDefaultAggregation
Get theAggregator
for a specific column type as expressed as a javaClass
that will be used in the specifiedCyGroup
.- Parameters:
group
- theCyGroup
to get theAggregator
forovClass
- theClass
to get theAggregator
for- Returns:
- the
Aggregator
for the specificClass
in thisCyGroup
-
getDefaultListAggregation
Get theAggregator
for a specific List column type as expressed as a javaClass
that will be used in the specifiedCyGroup
.- Parameters:
group
- theCyGroup
to get theAggregator
forovClass
- theClass
to get theAggregator
for- Returns:
- the
Aggregator
for the specificClass
in thisCyGroup
-
setDefaultAggregation
Set theAggregator
for a specific column type as expressed as a javaClass
that will be used in the specifiedCyGroup
.- Parameters:
group
- theCyGroup
to get theAggregator
forovClass
- theClass
to get theAggregator
foragg
- theAggregator
to use for the specifiedClass
in thisCyGroup
-
setDefaultListAggregation
Set theAggregator
for a specific List column type as expressed as a javaClass
that will be used in the specifiedCyGroup
.- Parameters:
group
- theCyGroup
to set theAggregator
toovClass
- theClass
to set theAggregator
toagg
- theAggregator
to use for the specifiedClass
in thisCyGroup
-
setDefaultAggregation
Set theAggregator
for a specific column type as expressed as a javaClass
that will be used in the specifiedCyGroup
.- Parameters:
group
- theCyGroup
to set theAggregator
toovClass
- theClass
to et theAggregator
toaggName
- the name of theAggregator
to use for the specifiedClass
in thisCyGroup
-
setDefaultListAggregation
Set theAggregator
for a specific List column type as expressed as a javaClass
that will be used in the specifiedCyGroup
.- Parameters:
group
- theCyGroup
to set theAggregator
toovClass
- the ListClass
to set theAggregator
toaggName
- the name of theAggregator
to use for the specifiedClass
in thisCyGroup
-
getOverrideAggregation
Get the override aggregation setting for a column (if any). Override aggregation provides the ability to override theAggregator
used for a specific column. For example we may not want to aggregate the "shared node" column.- Parameters:
column
- theCyColumn
to get the default override for- Returns:
- the
Aggregator
for this column, or null if no override was set
-
setOverrideAggregation
set the override aggregation setting for a column (if any). Override aggregation provides the ability to override theAggregator
used for a specific column. For example we may not want to aggregate the "shared node" column.- Parameters:
column
- theCyColumn
to set the default override foragg
- theAggregator
for this column
-
getOverrideAggregation
Get the override aggregation setting for a column (if any) in a specific group. Override aggregation provides the ability to override theAggregator
used for a specific column. For example we may not want to aggregate the "shared node" column.- Parameters:
group
- theCyGroup
to get theAggregator
forcolumn
- theCyColumn
to get the override for- Returns:
- the
Aggregator
for this column in this group, or null if no override was set
-
setOverrideAggregation
set the override aggregation setting for a column in a group (if any). Override aggregation provides the ability to override theAggregator
used for a specific column. For example we may not want to aggregate the "shared node" column.- Parameters:
group
- theCyGroup
to set theAggregator
forcolumn
- theCyColumn
to set the default override foragg
- theAggregator
for this column in this group
-