edu.ucsf.groups.view
Interface GroupViewer

public interface GroupViewer

An interface for classes that handle the actual presentation of groups.

Method Summary

String	getGroupViewerName() Returns the name of this viewer.
void	viewGrouped(CyNetworkView networkView, CyNetwork groupedNetwork, CyNode group_node, List members, List internalEdges, List externalEdges) Show this group in a grouped state.
void	viewUngrouped(CyNetworkView networkView, CyNetwork groupedNetwork, CyNode group_node, List members, List internalEdges, List externalEdges) Show this group in an ungrouped state.

Method Detail

getGroupViewerName

String getGroupViewerName()

Returns the name of this viewer. This will be saved as part of the group.

Returns:

String containing the viewer name.

viewGrouped

void viewGrouped(CyNetworkView networkView,
                 CyNetwork groupedNetwork,
                 CyNode group_node,
                 List members,
                 List internalEdges,
                 List externalEdges)

Show this group in a grouped state.

Parameters:

networkView - the CyNetworkView for displaying this group

groupedNetwork - the CyNetwork containing the group members

group_node - the CyNode representing the group

members - a List of CyNodes containing the members of the group

internalEdges - a List of CyEdges containing the internal edges for this group

externalEdges - a List of CyEdges containing the external edges for this group

viewUngrouped

void viewUngrouped(CyNetworkView networkView,
                   CyNetwork groupedNetwork,
                   CyNode group_node,
                   List members,
                   List internalEdges,
                   List externalEdges)

Show this group in an ungrouped state.

Parameters:

networkView - the CyNetworkView for displaying this group

groupedNetwork - the CyNetwork containing the group members

group_node - the CyNode representing the group

members - a List of CyNodes containing the members of the group

internalEdges - a List of CyEdges containing the internal edges for this group

externalEdges - a List of CyEdges containing the external edges for this group