Class OptDirectedEdge

Object
OptGraphable
OptDirectedEdge
All Implemented Interfaces:
Serializable, DirectedEdge, DirectedGraphable, Edge, Graphable

public class OptDirectedEdge extends OptGraphable implements DirectedEdge
Optimized implementation of DirectedEdge.
Author:
Justin Deoliveira, Refractions Research Inc, jdeolive@refractions.net
See Also:
  • Constructor Details

    • OptDirectedEdge

      public OptDirectedEdge(OptDirectedNode in, OptDirectedNode out)
      Constructs a new OptDirectedEdge.
      Parameters:
      in - Optimized in node.
      out - Optimized out node.
  • Method Details

    • getInNode

      public DirectedNode getInNode()
      Description copied from interface: DirectedEdge
      Returns the originating (in) node of the edge.
      Specified by:
      getInNode in interface DirectedEdge
      Returns:
      The directed node at the source of the edge.
      See Also:
    • getOutNode

      public DirectedNode getOutNode()
      Description copied from interface: DirectedEdge
      Returns the terminating (out) node of the edge.
      Specified by:
      getOutNode in interface DirectedEdge
      Returns:
      The directed node at the destination of the edge.
      See Also:
    • getNodeA

      public Node getNodeA()
      Description copied from interface: Edge
      Returns the A node of the edge.
      Specified by:
      getNodeA in interface Edge
      Returns:
      The A node.
      See Also:
    • getNodeB

      public Node getNodeB()
      Description copied from interface: Edge
      Returns the B node of the edge.
      Specified by:
      getNodeB in interface Edge
      Returns:
      The B node.
      See Also:
    • getOtherNode

      public Node getOtherNode(Node node)
      Description copied from interface: Edge
      Returns one of the two nodes of an edge. If the specified node is node A, then node B is returned, and vice versa.
      Specified by:
      getOtherNode in interface Edge
      Parameters:
      node - The node opposite of the node to return.
      Returns:
      Node A if node B is specified, node B if node A is specified.
      See Also:
    • reverse

      public void reverse()
      Unsupported Operation.
      Specified by:
      reverse in interface Edge
    • compareNodes

      public int compareNodes(Edge other)
      Description copied from interface: Edge
      Compares the node orientation of the edge with another edge.
      Specified by:
      compareNodes in interface Edge
      Returns:
      EQUAL_NODE_ORIENTATION : both nodes are equal in the correct order. UNEQUAL_NODE_ORIENTATION: both nodes are not equal OPPOSITE_NODE_ORIENTATION : both nodes are equal in opposite order.
      See Also:
    • getRelated

      public Iterator<? extends Graphable> getRelated()
      Description copied from interface: Graphable
      Returns an iterator over any related components. A graph component is related to other components of the graph of similary type through some relationship.
      Specified by:
      getRelated in interface Graphable
      Returns:
      Iterator An iterator over other components of the graph that are related to the component.
      See Also:
    • getInRelated

      public Iterator<? extends Graphable> getInRelated()
      Description copied from interface: DirectedGraphable
      Returns other components related through an in relationship.
      Specified by:
      getInRelated in interface DirectedGraphable
      Returns:
      An iterator over the other directed components related through an in relationship.
      See Also:
    • getOutRelated

      public Iterator<? extends Graphable> getOutRelated()
      Description copied from interface: DirectedGraphable
      Returns other components related through an out relationship.
      Specified by:
      getOutRelated in interface DirectedGraphable
      Returns:
      An iterator over the other directed components related through an out relationship.
      See Also: