org.eclipse.gef4.graph

Class Graph

java.lang.Object

org.eclipse.gef4.graph.Graph

All Implemented Interfaces:

org.eclipse.gef4.common.properties.IPropertyChangeNotifier

public final class Graph
extends java.lang.Object
implements org.eclipse.gef4.common.properties.IPropertyChangeNotifier

A Graph is a container for Nodes and Edges between those Nodes.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	Graph.Builder The Graph.Builder can be used to construct a new Graph little by little.

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	ATTRIBUTES_PROPERTY The property name that is used to notify change listeners about changes made to the attributes of this Graph.
static java.lang.String	EDGES_PROPERTY The property name that is used to notify change listeners about added/removed edges.
static java.lang.String	NODES_PROPERTY The property name that is used to notify change listeners about added/removed nodes.

Constructor Summary

Constructors

Constructor and Description
Graph() Default constructor, using empty collections for attributes, nodes, and edges.
Graph(java.util.Map<java.lang.String,java.lang.Object> attrs, java.util.Collection<? extends Node> nodes, java.util.Collection<? extends Edge> edges) Constructs a new Graph from the given attributes, nodes, and edges.

Method Summary

Modifier and Type	Method and Description
void	addPropertyChangeListener(java.beans.PropertyChangeListener listener)
boolean	equals(java.lang.Object other)
java.util.Map<java.lang.String,java.lang.Object>	getAttrs() Returns the map of attributes of this Graph by reference.
java.util.List<Edge>	getEdges() Returns the list of Edges of this Graph by reference.
Node	getNestingNode() Returns the Node in which this Graph is nested.
java.util.List<Node>	getNodes() Returns the list of Nodes of this Graph by reference.
int	hashCode()
void	removePropertyChangeListener(java.beans.PropertyChangeListener listener)
void	setNestingNode(Node nestingNode) Sets the nesting Node of this Graph.
java.lang.String	toString()

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Detail

ATTRIBUTES_PROPERTY

public static final java.lang.String ATTRIBUTES_PROPERTY

The property name that is used to notify change listeners about changes made to the attributes of this Graph. A property change event for this property will have its old value set to a Map<String, Object> holding the old attributes and its new value set to a Map<String, Object> holding the new attributes.

See Also:

Constant Field Values

NODES_PROPERTY

public static final java.lang.String NODES_PROPERTY

The property name that is used to notify change listeners about added/removed nodes. A property change event for this property will have its old value set to a List<Node> holding the old nodes and its new value set to a List<Node> holding the new nodes.

See Also:

Constant Field Values

EDGES_PROPERTY

public static final java.lang.String EDGES_PROPERTY

The property name that is used to notify change listeners about added/removed edges. A property change event for this property will have its old value set to a List<Edge> holding the old edges and its new value set to a List<Edge> holding the new edges.

See Also:

Constant Field Values

Constructor Detail

Graph

public Graph()

Default constructor, using empty collections for attributes, nodes, and edges.

Graph

public Graph(java.util.Map<java.lang.String,java.lang.Object> attrs,
             java.util.Collection<? extends Node> nodes,
             java.util.Collection<? extends Edge> edges)

Constructs a new Graph from the given attributes, nodes, and edges. Associates all nodes and edges with this Graph.

Parameters:

attrs - Map of graph attributes.

nodes - List of Nodes.

edges - List of Edges.

Method Detail

addPropertyChangeListener

public void addPropertyChangeListener(java.beans.PropertyChangeListener listener)

Specified by:

addPropertyChangeListener in interface org.eclipse.gef4.common.properties.IPropertyChangeNotifier

equals

public boolean equals(java.lang.Object other)

Overrides:

equals in class java.lang.Object

getAttrs

public java.util.Map<java.lang.String,java.lang.Object> getAttrs()

Returns the map of attributes of this Graph by reference.

Returns:

The map of attributes of this Graph by reference.

getEdges

public java.util.List<Edge> getEdges()

Returns the list of Edges of this Graph by reference.

Returns:

The list of Edges of this Graph by reference.

getNestingNode

public Node getNestingNode()

Returns the Node in which this Graph is nested. Returns null when this Graph is not nested.

Returns:

The Node in which this Graph is nested, or null.

getNodes

public java.util.List<Node> getNodes()

Returns the list of Nodes of this Graph by reference.

Returns:

The list of Nodes of this Graph by reference.

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object

removePropertyChangeListener

public void removePropertyChangeListener(java.beans.PropertyChangeListener listener)

Specified by:

removePropertyChangeListener in interface org.eclipse.gef4.common.properties.IPropertyChangeNotifier

setNestingNode

public void setNestingNode(Node nestingNode)

Sets the nesting Node of this Graph.

Parameters:

nestingNode - The new Node in which this Graph is nested.

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object