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 enum 
    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 final String
    INTERACTION
    A String column created by default for every CyEdge that holds the interaction description of the edge.

    Fields inherited from interface org.cytoscape.model.CyIdentifiable

    SUID

  • Method Summary

    Modifier and Type
    Method
    Description
    CyNode
    getSource()
    Returns the source node determining this edge.
    CyNode
    getTarget()
    Returns the target node determining this edge.
    boolean
    isDirected()
    This will return true if the edge is directed and false if the node is undirected.

    Methods inherited from interface org.cytoscape.model.CyIdentifiable

    getSUID

  • Field Details

    • INTERACTION

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

  • Method Details

    • 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.