Topology

The Topology OSID provides defines a service to manage and connect nodes.

Edges

Nodes are connected to each other using Edges that allow for the storage of routing data. An Edge represents a single connection between two Nodes, and may have an optional direction assigned. The Edge defines cost and distance metrics that aid in the display and/or routing within the topology.

Topology Traversal

The traversal and routing sessions offers a different view of the topology than the typical node and edge lookup sessions. Methods exist to query neighboring nodes, inbound and outbound edges, as well as determine the shortest or least expensive route between any two nodes in a topology.

Graph Cataloging

Topologies are organized into Graphs which may also be hierarchical. Federated graphs may serve to link multiple topologies together, and offers a means of defining a set of layers among different node or edge types. The ability to assign nodes and edges to different Graphs offers a lot of flexibility, although a provider may or may not require an Edge to be defined in the same Graph as the connected Nodes.

Sub Packages

The Topology OSID includes a Topology Path OSID for managing paths through topologies and a Topology Rules OSID for mnaging the effectiveness of Edges.

Package List Model

Node

Osid Object

A Node represents a node in a Graph.

Inherited elements

Name	Syntax	Many	Description
Identifiable
`id`	id		the `Id`
Extensible
`recordTypes`	type	⋆	the record types available
Browsable
`properties`	Property	⋆	a list of properties
OsidObject
`displayName`	displaytext		the display name
`description`	displaytext		the description
`genusType`	type		the genus type of this object

Edge

Osid Relationship

An Edge represents relationship between two nodes.

Inherited elements

Name	Syntax	Many	Description
Identifiable
`id`	id		the `Id`
Extensible
`recordTypes`	type	⋆	the record types available
Browsable
`properties`	Property	⋆	a list of properties
OsidObject
`displayName`	displaytext		the display name
`description`	displaytext		the description
`genusType`	type		the genus type of this object
Temporal
`isEffective`	boolean		`true` if this is effective, `false` otherwise
`startDate`	datetime		the start date
`endDate`	datetime		the end date
OsidRelationship
`hasEndReason`	boolean		`true` if an end reason is available, `false` otherwise
`endReasonId`	id		a state `Id`
`endReason`	State		a state

Name	Syntax	Many	Description
`isDirectional`	boolean		`true` if this edge is directional, `false` otherwise
`isBiDirectional`	boolean		`true` if this edge is directional and bi-directional, `false` otherwise
`cost`	decimal		a number representing the cost of this edge
`distance`	decimal		a number representing the distance of this edge
`sourceNodeId`	id		the source node `Id`
`sourceNode`	Node		the source node
`destinationNodeId`	id		the detsination node `Id`
`destinationNode`	Node		the detsination node

Graph

Osid Catalog

A Graph represents a collection of nodes and edges.

Inherited elements

Name	Syntax	Many	Description
Identifiable
`id`	id		the `Id`
Extensible
`recordTypes`	type	⋆	the record types available
Browsable
`properties`	Property	⋆	a list of properties
OsidObject
`displayName`	displaytext		the display name
`description`	displaytext		the description
`genusType`	type		the genus type of this object
Sourceable
`providerId`	id		the provider `Id`
`provider`	Resource		the provider
`brandingIds`	id	⋆	a list of asset `Ids`
`branding`	Asset	⋆	a list of assets
`license`	displaytext		the license