Package org.cytoscape.group
Interface CyGroupFactory
-
public interface CyGroupFactory
An interface describing a factory used for creatingCyGroup
objects. This factory will be provided as a service through Spring/OSGi.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 Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method Description CyGroup
createGroup(CyNetwork network, boolean register)
Creates a CyGroup object in the referenced network.CyGroup
createGroup(CyNetwork network, List<CyNode> nodes, List<CyEdge> edges, boolean register)
Creates a CyGroup object in the referenced network initially populated with the supplied nodes.CyGroup
createGroup(CyNetwork network, CyNode node, boolean register)
Creates a CyGroup object in the referenced network from an existingCyNode
.CyGroup
createGroup(CyNetwork network, CyNode node, List<CyNode> nodes, List<CyEdge> edges, boolean register)
Creates a CyGroup object in the referenced network from an existingCyNode
.
-
-
-
Method Detail
-
createGroup
CyGroup createGroup(CyNetwork network, boolean register)
Creates a CyGroup object in the referenced network.
-
createGroup
CyGroup createGroup(CyNetwork network, List<CyNode> nodes, List<CyEdge> edges, boolean register)
Creates a CyGroup object in the referenced network initially populated with the supplied nodes.- Parameters:
network
- theCyNetwork
this group is part ofnodes
- theCyNode
s that are part of this group.edges
- theCyEdge
s that are part of this group. If this is null, the edges are determined based on the node connectivityregister
- if true, register theCyGroup
- Returns:
- A new
CyGroup
as part of the designated network.
-
createGroup
CyGroup createGroup(CyNetwork network, CyNode node, List<CyNode> nodes, List<CyEdge> edges, boolean register)
Creates a CyGroup object in the referenced network from an existingCyNode
.- Parameters:
network
- theCyNetwork
this group is part ofnode
- theCyNode
to convert into a groupnodes
- theCyNode
s that are part of this group.edges
- theCyEdge
s that are part of this group. If this is null, the edges are determined based on the node connectivityregister
- if true, register theCyGroup
- Returns:
- A new
CyGroup
as part of the designated network.
-
-