Class BasicEdge

    • Constructor Detail

      • BasicEdge

        public BasicEdge​(Node nodeA,
                         Node nodeB)
        Constructs a new edge.
        Parameters:
        nodeA - A node of edge.
        nodeB - B node of edge.
    • Method Detail

      • 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:
        Edge.getNodeA()
      • 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:
        Edge.getNodeB()
      • getOtherNode

        public Node getOtherNode​(Node node)
        Returns null if the specified node is neither the A node or the B node.
        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:
        Edge.getOtherNode(Node)
      • getRelated

        public Iterator<Edge> getRelated()
        Returns all edges that are adjacent to both the A and B nodes. This iterator is generated by calculating an underlying collection upon each method call.
        Specified by:
        getRelated in interface Graphable
        Returns:
        Iterator An iterator over other components of the graph that are related to the component.
        See Also:
        Graphable.getRelated()
      • reverse

        public void reverse()
        Description copied from interface: Edge
        Reverses the node orientation of the edge.
        Specified by:
        reverse in interface Edge
        See Also:
        Edge.reverse()
      • 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:
        Edge.compareNodes(Edge)