de.ipcon.tools.graph

Interface GraphEdgeI

All Known Subinterfaces:

AttributeI, CBOAttributeI, InstrumentingAttributeI

All Known Implementing Classes:

AttributeWrapper, CBOAttribute, DefaultGraphEdge, InstrumentingAttribute, ScriptedAttribute

public interface GraphEdgeI

Represents a directed edge in a graph, connecting a source (or "from") node to a target (or "to") node.

This interface defines the fundamental contract for any object that acts as an edge in a graph structure. Implementations of this interface are expected to provide access to the two nodes that this edge connects.

Edges are essential components of graphs, defining the relationships and pathways between nodes. While this base interface only mandates access to source and target nodes, implementations or sub-interfaces might extend this to include additional properties such as edge weight, type, capacity, or other attributes relevant to specific graph algorithms or models.

See Also:

The type of nodes this edge connects., A common, immutable implementation of this interface., A sequence of connected edges forming a path.

Method Summary

Modifier and Type	Method and Description
OnlyToDirectedGraphNodeI	getFromNode() Retrieves the source node from which this directed edge originates.
OnlyToDirectedGraphNodeI	getToNode() Retrieves the target node to which this directed edge points.

Method Detail

getFromNode

OnlyToDirectedGraphNodeI getFromNode()

Retrieves the source node from which this directed edge originates.

This method is contractually obligated to return a non-null OnlyToDirectedGraphNodeI instance, as every valid edge must have a defined starting point.

Returns:

The non-null source node (also referred to as the "from-node" or "tail") of this edge.

getToNode

OnlyToDirectedGraphNodeI getToNode()

Retrieves the target node to which this directed edge points.

This method is contractually obligated to return a non-null OnlyToDirectedGraphNodeI instance, as every valid edge must have a defined ending point.

Returns:

The non-null target node (also referred to as the "to-node" or "head") of this edge.