Package org.cytoscape.model

Interface CyEdge

  • All Superinterfaces:
    CyIdentifiable
    public interface CyEdge
extends CyIdentifiable
    An object that represents an edge within a network of nodes (vertices) and edges.

    Module: model-api

    To use this in your app, include the following dependency in your POM:

    <dependency>
    <groupId>org.cytoscape</groupId>
    <artifactId>model-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 Classes 
      Modifier and Type Interface Description
      static class  CyEdge.Type
      The Type enum is used by methods in CyNetwork to restrict the edges that match a query.

    • Field Summary

      Fields 
      Modifier and Type Field Description
      static String INTERACTION
      A String column created by default for every CyEdge that holds the interaction description of the edge.

    • Field Detail

      • INTERACTION

        static final String INTERACTION
        A String column created by default for every CyEdge that holds the interaction description of the edge.
        See Also:
        Constant Field Values

    • Method Detail

      • getSource

        CyNode getSource()
        Returns the source node determining this edge. It will never be null. For undirected networks this method will consistently return the same node.
        Returns:
        The source node of this edge.

      • getTarget

        CyNode getTarget()
        Returns the target node determining this edge. It will never be null. For undirected networks this method will consistently return the same node.
        Returns:
        The target node of this edge.

      • isDirected

        boolean isDirected()
        This will return true if the edge is directed and false if the node is undirected.
        Returns:
        Returns true if this edge is directed and false if the node is undirected.