Author: scooter
Date: 2012-04-12 16:04:10 -0700 (Thu, 12 Apr 2012)
New Revision: 28815
Removed:
core3/api/trunk/group-data-api/src/main/java/org/cytoscape/group/data/CyGroupSettings.java
Modified:
core3/api/trunk/group-api/src/main/java/org/cytoscape/group/CyGroupManager.java
Log:
Remove CyGroupSettings API. Wrong approach -- will probably add something
that provides a CyTable and a list of columns to replace it.
Modified:
core3/api/trunk/group-api/src/main/java/org/cytoscape/group/CyGroupManager.java
===================================================================
---
core3/api/trunk/group-api/src/main/java/org/cytoscape/group/CyGroupManager.java
2012-04-12 23:01:37 UTC (rev 28814)
+++
core3/api/trunk/group-api/src/main/java/org/cytoscape/group/CyGroupManager.java
2012-04-12 23:04:10 UTC (rev 28815)
@@ -68,6 +68,17 @@
public List<CyGroup> getGroupsForNode(CyNode node);
/**
+ * Return the list of {@link CyGroup}s this node is in for
+ * a particular network.
+ *
+ * @param node the {@link CyNode} we want get the groups for
+ * @param network the {@link CyNetwork} we want to restrict our search
to
+ * @return the list of {@link CyGroup}s the node is in
+ * null if it is not in any groups
+ */
+ public List<CyGroup> getGroupsForNode(CyNode node, CyNetwork network);
+
+ /**
* Test to see if this node represents a {@link CyGroup} in
* a particular {@link CyNetwork}.
*
Deleted:
core3/api/trunk/group-data-api/src/main/java/org/cytoscape/group/data/CyGroupSettings.java
===================================================================
---
core3/api/trunk/group-data-api/src/main/java/org/cytoscape/group/data/CyGroupSettings.java
2012-04-12 23:01:37 UTC (rev 28814)
+++
core3/api/trunk/group-data-api/src/main/java/org/cytoscape/group/data/CyGroupSettings.java
2012-04-12 23:04:10 UTC (rev 28815)
@@ -1,338 +0,0 @@
-/* vim: set ts=2: */
-/**
- * Copyright (c) 2012 The Regents of the University of California.
- * All rights reserved.
- *
- * Redistribution and use in source and binary forms, with or without
- * modification, are permitted provided that the following conditions
- * are met:
- * 1. Redistributions of source code must retain the above copyright
- * notice, this list of conditions, and the following disclaimer.
- * 2. Redistributions in binary form must reproduce the above
- * copyright notice, this list of conditions, and the following
- * disclaimer in the documentation and/or other materials provided
- * with the distribution.
- * 3. Redistributions must acknowledge that this software was
- * originally developed by the UCSF Computer Graphics Laboratory
- * under support by the NIH National Center for Research Resources,
- * grant P41-RR01081.
- *
- * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDER "AS IS" AND ANY
- * EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
- * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
- * PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS BE LIABLE
- * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
- * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT
- * OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR
- * BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY,
- * WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE
- * OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE,
- * EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
- *
- */
-package org.cytoscape.group.data;
-
-import org.cytoscape.group.CyGroup;
-import org.cytoscape.model.CyColumn;
-import org.cytoscape.model.CyTable;
-
-/**
- * CyGroupSettings provides interfaces to access user-requested settings
- * that influence how the {@link CyGroup} system works. There are
- * two groups of settings that influence different aspects of
- * groups: visual settings and attribute aggregation settings.
- *
- * <b>Visual Settings</b>
- * <ul><li>Double-click action: what should happen when a user double-clicks
- * on a group node or a group member. This can be either:
- * <i>None</i>, <i>ExpandContract</i>,
- * or <i>Select</i>.</li>
- * <li>Use nested networks: if this setting is set to true, then
- * when a group is collapsed a nested netwrok will be created for
- * the group</li>
- * <li>Hide group node: if this setting is set to true, then
- * when a group is expanded, the group node is hidden. There are
- * certain (limited) use cases where a user might want the group node
- * as well as all member nodes visible in the network at the same
- * time.</li>
- * </ul>
- *
- * <b>Attribute Aggregation Settings</b>
- *
- */
-
-public interface CyGroupSettings {
- enum DoubleClickAction {
- None("None"),
- ExpandContract("Expand/Contract"),
- Select("Select");
-
- private final String name;
- DoubleClickAction(String n) {this.name = n;}
- public String toString() {return name;}
- }
-
- /**
- * Get the default action to use when the user double-clicks on a
- * group node or member node. This setting has no impact if Cytoscape
- * is headless.
- *
- * @return the double-click action
- */
- public DoubleClickAction getDoubleClickAction();
-
- /**
- * Get the action to use when the user double-clicks a specific
- * group node or member node. This setting has no impact if
- * Cytoscape is headless.
- *
- * @param group the group we're interested in
- * @return the double-click action
- */
- public DoubleClickAction getDoubleClickAction(CyGroup group);
-
- /**
- * Set the default action to use when the user double-clicks on a
- * group node or member node. This setting has no impact if
- * Cytoscape is headless.
- *
- * @param action the double-click action
- */
- public void setDoubleClickAction(DoubleClickAction action);
-
- /**
- * Set the action to use when the user double-clicks on a specific
- * group node or member node. This setting has no impact if
- * Cytoscape is headless.
- *
- * @param group the group we're interested in
- * @param action the double-click action
- */
- public void setDoubleClickAction(CyGroup group, DoubleClickAction
action);
-
- /**
- * Get the setting controlling whether to visualize a collapsed
- * group as a nested network.
- *
- * @return the nested network setting
- */
- public boolean getUseNestedNetworks();
-
- /**
- * Get the setting controlling whether to visualize a specific
- * collapsed group as a nested network.
- *
- * @param group the group we're interested in
- * @return the nested network setting
- */
- public boolean getUseNestedNetworks(CyGroup group);
-
- /**
- * Set the setting controlling whether to visualize a collapsed
- * group as a nested network.
- *
- * @param useNN if true, use nested networks to visualize the
- * collapsed node.
- */
- public void setUseNestedNetworks(boolean useNN);
-
- /**
- * Set the setting controlling whether to visualize a collapsed
- * group as a nested network.
- *
- * @param group the group we're interested in
- * @param useNN if true, use nested networks to visualize the
- * collapsed node.
- */
- public void setUseNestedNetworks(CyGroup group, boolean useNN);
-
- /**
- * Get the setting controlling whether to hide the
- * group node when a group is expanded.
- *
- * @return the hide group node setting
- */
- public boolean getHideGroupNode();
-
- /**
- * Get the setting controlling whether to hide the
- * group node when a specific group is expanded.
- *
- * @param group the group we're interested in
- * @return the hide group node setting
- */
- public boolean getHideGroupNode(CyGroup group);
-
- /**
- * Set the setting controlling whether to hide the
- * group node when a group is expanded.
- *
- * @param hideGroup the hide group setting
- */
- public void setHideGroupNode(boolean hideGroup);
-
- /**
- * Set the setting controlling whether to hide the
- * group node when a group is expanded.
- *
- * @param group the group we're interested in
- * @param hideGroup the hide group setting
- */
- public void setHideGroupNode(CyGroup group, boolean hideGroup);
-
- /**
- * Get the default opacity of group nodes
- *
- * @return opacity as a percentage from 0.0-100.0
- */
- public double getGroupNodeOpacity();
-
- /**
- * Get the opacity of a particular group node
- *
- * @param group the group we're interested in
- * @return opacity as a percentage from 0.0-100.0
- */
- public double getGroupNodeOpacity(CyGroup group);
-
- /**
- * Set the default opacity of group nodes
- *
- * @param opacity opacity as a percentage from 0.0-100.0
- */
- public void setGroupNodeOpacity(double opacity);
-
- /**
- * Set the default opacity of a particular group node
- *
- * @param group the group we're interested in
- * @param opacity opacity as a percentage from 0.0-100.0
- */
- public void setGroupNodeOpacity(CyGroup group, double opacity);
-
- /**
- * Determine whether attribute aggregation (aggregating all of the
- * attributes from member nodes onto the group node).
- *
- * @return whether attribute aggregation is enabled (true) or not
(false)
- */
- public boolean getEnableAttributeAggregation();
-
- /**
- * Determine whether attribute aggregation (aggregating all of the
- * attributes from member nodes onto the group node) is enabled for
- * a specific group.
- *
- * @param group the group we're interested in
- * @return whether attribute aggregation is enabled (true) or not
(false)
- */
- public boolean getEnableAttributeAggregation(CyGroup group);
-
- /**
- * Set whether attribute aggregation (aggregating all of the
- * attributes from member nodes onto the group node).
- *
- * @param aggregateAttributes whether attribute aggregation
- * is enabled (true) or not (false)
- */
- public void setEnableAttributeAggregation(boolean aggregateAttributes);
-
- /**
- * Set whether attribute aggregation (aggregating all of the
- * attributes from member nodes onto the group node) is enabled
- * for a specific group.
- *
- * @param group the group we're interested in
- * @param aggregateAttributes whether attribute aggregation is
- * enabled (true) or not (false)
- */
- public void setEnableAttributeAggregation(CyGroup group,
- boolean aggregateAttributes);
-
- /**
- * The the {@link Aggregator} for a specific group and column
- *
- * @param group the group to get the aggregator for
- * @param column the column to get the aggregator for
- * @return the aggregator to use for this group and column
- */
- public Aggregator getAggregator(CyGroup group, CyColumn column);
-
- /**
- * Set the default aggregator to use for a specific group and class.
- *
- * @param group the group to set the aggregator for
- * @param ovClass the Class to set the aggregator for
- * @param agg the {@link Aggregator} to use
- */
- public void setDefaultAggregation(CyGroup group, Class ovClass,
- Aggregator agg);
-
- /**
- * Get the default aggregator to use for a specific group and class.
- *
- * @param group the group to get the aggregator for
- * @param ovClass the Class to get the aggregator for
- * @return the {@link Aggregator} to use
- */
- public Aggregator getDefaultAggregation(CyGroup group, Class ovClass);
-
- /**
- * Set the default aggregator to use for a class.
- *
- * @param ovClass the Class to set the aggregator for
- * @param agg the {@link Aggregator} to use
- */
- public void setDefaultAggregation(Class ovClass, Aggregator agg);
-
- /**
- * Get the default aggregator to use for a class.
- *
- * @param ovClass the Class to get the aggregator for
- * @return the {@link Aggregator} to use
- */
- public Aggregator getDefaultAggregation(Class ovClass);
-
- /**
- * Set the aggregator to use for a specific group and {@link CyColumn}.
- * An override aggregator will be use for this node and this column
- * only, reguardless of what the default aggregation is set to.
- *
- * @param group the group to set the override for
- * @param column the CyColumn to set the override for
- * @param agg the {@link Aggregator} to use
- */
- public void setOverrideAggregation(CyGroup group, CyColumn column,
- Aggregator agg);
-
- /**
- * Get the aggregator to use for a specific group and {@link CyColumn}.
- * An override aggregator will be use for this node and this column
- * only, reguardless of what the default aggregation is set to.
- *
- * @param group the group to get the override for
- * @param column the CyColumn to get the override for
- * @return the {@link Aggregator} to use
- */
- public Aggregator getOverrideAggregation(CyGroup group, CyColumn column);
-
- /**
- * Set the aggregator to use for a {@link CyColumn}.
- * An override aggregator will be use for this column
- * only, reguardless of what the default aggregation is set to.
- *
- * @param column the CyColumn to set the override for
- * @param agg the {@link Aggregator} to use
- */
- public void setOverrideAggregation(CyColumn column, Aggregator agg);
-
- /**
- * Get the aggregator to use for a specific {@link CyColumn}.
- * An override aggregator will be use for this column
- * only, reguardless of what the default aggregation is set to.
- *
- * @param column the CyColumn to get the override for
- * @return the {@link Aggregator} to use
- */
- public Aggregator getOverrideAggregation(CyColumn column);
-}
--
You received this message because you are subscribed to the Google Groups
"cytoscape-cvs" group.
To post to this group, send email to [email protected].
To unsubscribe from this group, send email to
[email protected].
For more options, visit this group at
http://groups.google.com/group/cytoscape-cvs?hl=en.
