Package y.base

Provides the yFiles library's most fundamental classes and interfaces that model an efficient graph data type (class Graph), its nodes and edges (classes Node and Edge), and related container structures and iteration mechanisms (class YList and interface YCursor).

See:
Description

Interface Summary

Command	General command pattern interface that supports the execution and the undoability of some code.
DataAcceptor	A general interface for setting data.
DataMap	Interface that combines the DataProvider and DataAcceptor interfaces.
DataProvider	A general interface for data provision.
EdgeCursor	A cursor interface for iterating over edges.
EdgeMap	Provides access to data associated with an edge.
GraphFactory	Implementations of this interface provide a factory for graphs and elements within that graph.
GraphInterface	An interface that describes the structural information of a graph and the data that is associated with its nodes and edges.
GraphListener	The listener interface for receiving graph events.
NodeCursor	A cursor interface for iterating over nodes.
NodeMap	Provides access to data associated with a node.
YCursor	A general interface for iterating over a collection of objects.

Class Summary

CommandStream	Represents a stream of commands.
Edge	Represents an edge, i.e., a directed connection between two nodes (represented by instances of class Node) in the directed graph data type Graph.
EdgeList	Specialized list implementation for instances of type Edge.
Graph	This class implements a directed graph structure.
GraphCopyFactory	Very simple default implementation of a Copy Factory that creates Graph instances and simply delegates to the Graph.createNode() and Graph.createEdge(Node, Node) method.
GraphEvent	An event which indicates that a graph structure change occurred.
ListCell	Represents a so-called "cell" or "link" of the doubly linked list implementation YList.
Node	Represents a so-called node in the directed graph data type Graph.
NodeList	Specialized list implementation for instances of type Node.
YList	An implementation of a doubly linked list that provides direct access to the cells that store the elements.

Exception Summary

WrongGraphStructure

Exception thrown when a graph-structural precondition is violated.

Package y.base Description

Provides the yFiles library's most fundamental classes and interfaces that model an efficient graph data type (class Graph), its nodes and edges (classes Node and Edge), and related container structures and iteration mechanisms (class YList and interface YCursor).

Furthermore, this package also defines the infrastructure for association of additional data with graph elements, namely "data accessors," i.e., interfaces DataAcceptor, DataProvider, and DataMap.

Related Documentation

See the yFiles Developer's Guide chapter Working With the Graph Structure for detailed discussions of using the graph data type and its functionality.
The section on Binding Data to Graph Elements explains the concept of data accessors.