Graph (Tensegrity API)

Overview

Package

Class

Use

Tree

Deprecated

Index

Help

PREV CLASS NEXT CLASS

FRAMES NO FRAMES

SUMMARY: NESTED | FIELD | CONSTR | METHOD

DETAIL: FIELD | CONSTR | METHOD

com.tensegrity.graph.model
Interface Graph

All Superinterfaces:: Attributable, AttributableOnSet, GraphObjectContainer

public interface Graph
extends GraphObjectContainer, AttributableOnSet

This interface defines an abstract Graph without any notion of a visualization. This class can be used on its own for applying graph algorithms and for deriving specialized graph classes.
Both directed and undirected graphs are supported.
A Graph consists of Node and Edge objects. These are the parts of the graph model that can be accessed through the Graph interface and whose abstraction is commonly defined in the base interface GraphObject. This component interface defines the functionality common to both nodes and edges, as illustrated in the following class diagram.

Constructing a Graph and its related objects is done by means of a GraphModelFactory, which will hide the particular implementation classes from client code.

Upon adding, the ID of any GraphObject is automatically assigned. Before adding, however, the ID should be set to -1.
Each GraphObject may only be added to at most one Graph instance. Adding it to a Graph instance while still managed by another will produce an exception.
Removing a GraphObject will reset its ID to -1.

Graph objects that are dereferenced will be garbage collected.

Two types of event listeners are available for notification. Instances of GraphListener listen to events coming from one Graph object, while GraphEventMediator instances listen to events coming from an entire Graph tree. Any number of event listeners may be added to a Graph.

Additionally, there are corresponding vetoable listeners and mediators defined in the event package of the API. These listeners and mediators contain methods that are invoked prior to a specific event. By throwing an exception, code can indicate that it would like to prevent a specific event from happening, thereby sending a veto for the event. These special listeners are VetoableGraphListener and VetoableGraphEventMediatorListener.

A Graph contains and manages objects of type Node and Edge. Instances of these classes may be added to and removed from a Graph. Both types are derived from the superclass GraphObject.

Many methods in this interface specification may be found in the the parent interface GraphObjectContainer, which allows generic handling of both Graph and Subgraph instances.

Version:: $Id: Graph.java,v 1.71 2006/04/25 07:10:27 MichaelKegel Exp $
Author:: Stepan Rutz
See Also:: Node, Edge, Subgraph, Port, GraphObject

Field Summary
`static int`	`EVENT_MASK_CASCADE_NODE_DELETE` Enumeration for setting event masks for the different type of events.
`static int`	`EVENT_MASK_EDGE_ADDED` Enumeration for setting event masks for the different type of events.
`static int`	`EVENT_MASK_EDGE_ATTACH_REJECTED` Enumeration for setting event masks for the different type of events.
`static int`	`EVENT_MASK_EDGE_PRE_ADD` Enumeration for setting event masks for the different type of events.
`static int`	`EVENT_MASK_EDGE_PRE_REMOVE` Enumeration for setting event masks for the different type of events.
`static int`	`EVENT_MASK_EDGE_PRE_SPLIT` Enumeration for setting event masks for the different type of events.
`static int`	`EVENT_MASK_EDGE_REMOVED` Enumeration for setting event masks for the different type of events.
`static int`	`EVENT_MASK_EDGE_SPLIT` Enumeration for setting event masks for the different type of events.
`static int`	`EVENT_MASK_NODE_ADDED` Enumeration for setting event masks for the different type of events.
`static int`	`EVENT_MASK_NODE_PRE_ADD` Enumeration for setting event masks for the different type of events.
`static int`	`EVENT_MASK_NODE_PRE_REMOVE` Enumeration for setting event masks for the different type of events.
`static int`	`EVENT_MASK_NODE_REMOVED` Enumeration for setting event masks for the different type of events.
`static int`	`EVENT_MASK_PRE_CASCADE_NODE_DELETE` Enumeration for setting event masks for the different type of events.

Fields inherited from interface com.tensegrity.generic.attribute.AttributableOnSet

TREE_SUBSET_POSTFIX

Method Summary
`void`	`addCustomAttribute(Attribute attribute)` Adds the `Attribute` given by `attribute` to the custom attributes of the `Graph`.
`void`	`addEventMediatorListener(GraphEventMediatorListener listener)` Adds the `GraphEventMediatorListener` given by `listener` to the list of GraphEventMediatorListeners that will be informed of all events related to graph objects that occur.
`void`	`addEventMediatorListenerInternal(GraphEventMediatorListener listenerInternal)` Adds the `GraphEventMediatorListener` given by `listener` to the list of GraphEventMediatorListeners that will be informed of all events related to graph objects that occur.
`void`	`addGraphListener(GraphListener listener)` Adds a graph listener to the graphs internal structure.
`void`	`addVetoableEventMediatorListener(VetoableGraphEventMediatorListener listener)` Adds the `VetoableGraphEventMediatorListener` given by `listener` to the list of VetoableGraphEventMediatorListeners that will be informed of all vetoable events related to graph objects that occur.
`void`	`addVetoableGraphListener(VetoableGraphListener listener)` Adds a graph listener to the graph's internal structure.
`Graph`	`deepCopy()` Returns a deep independent copy of the `Graph`.
`Graph`	`deepCopyWithoutEdges()` Copies this `Graph` and its type to a new empty `Graph` and omitting the edges.
`Graph`	`deepCopyWithoutNodesAndEdges()` Copies this `Graph` and its type to a new empty `Graph` and omitting the nodes and edges.
`void`	`disableVerify()` Disables internal invariant verifications.
`void`	`enableVerify()` Enables internal invariant verifications.
`void`	`enableVetosFromStack()` This method is API internal and should not be invoked by clients.
`void`	`enableVetosWithStack(boolean enable)` This method is API internal and should not be invoked by clients.
`AttributeSet`	`getCustomAttributes()` Returns an `AttributeSet` that contains all custom attributes currently assigned to the `Graph` or `null` if no custom attribute is assigned to the `Graph`.
`Subgraph`	`getSubgraph()` Returns a reference to the `Subgraph` this `Graph` is a part of.
`int`	`getVersionID()` Gets the version-id of the `Graph`.
`void`	`removeCustomAttribute(java.lang.String attributename)` Removes the custom `Attribute` with the name given by `attributename` from the `Graph`s custom attributes.
`void`	`removeEventMediatorListener(GraphEventMediatorListener listener)` Removes the `GraphEventMediatorListener` given by `listener` from the list of `GraphEventMediatorListener`s so that he will no longer be informed about events related to graph objects.
`void`	`removeEventMediatorListenerInternal(GraphEventMediatorListener listenerInternal)` Removes the `GraphEventMediatorListener` given by `listener` from the list of `GraphEventMediatorListener`s so that he will no longer be informed about events related to graph objects.
`void`	`removeGraphListener(GraphListener listener)` Removes a graph listener.
`void`	`removeVetoableEventMediatorListener(VetoableGraphEventMediatorListener listener)` Removes the `VetoableGraphEventMediatorListener` given by `listener` from the list of `VetoableGraphEventMediatorListener`s so that he will no longer be informed about events related to graph objects.
`void`	`removeVetoableGraphListener(VetoableGraphListener listener)` Removes a graph listener.
`void`	`setCustomAttributes(AttributeSet customAttributes)` Sets the `Attribute`s within the `AttributeSet` given by `customAttributes` to the custom attributes currently added to the `Graph`.
`void`	`visitSubgraphs(GraphVisitor visitor)` Traverse the sub graphs of this graph by means of the given `GraphVisitor`.

Methods inherited from interface com.tensegrity.graph.model.GraphObjectContainer

addEdge, addEdges, addNode, addNodes, buildAdjacencyMatrix, disableGraphEvents, disableGraphEventsInternal, enableGraphEvents, enableGraphEventsInternal, findMultiEdge, fireCascadeNodeDeleteInternal, fireEdgeSplitInternal, fireNodePreRemove, fireNodeRemoved, firePreCascadeNodeDeleteInternal, firePreEdgeSplitInternal, getEdgeArray, getEdgeByID, getEdgeCount, getEdges, getEventmask, getEventmaskInternal, getNodeArray, getNodeByID, getNodeCount, getNodes, getObjectByID, getParentContainer, getRootContainer, isDirected, isMultiEdge, isMultiGraph, removeEdge, removeNode, setDirected, setMultiGraph

Methods inherited from interface com.tensegrity.generic.attribute.AttributableOnSet

addAttributableOnSetListener, areAttributableEventsEnabled, disableAttributableEvents, enableAttributableEvents, getAttributes, getAttributesTree, removeAttributableOnSetListener, setAttributes, setAttributesTree

Methods inherited from interface com.tensegrity.generic.attribute.Attributable

getAttribute, getAttributeType, getAttributeValue, setAttribute, setAttributeValue

Field Detail