Graph Class

Graph is the root object of a graph. Most graph api is on this class but useful api also exist on VertexType and EdgeType.

Inheritance Hierarchy

SystemObject
VelocityDbOptimizedPersistable
VelocityGraphGraph

Namespace: VelocityGraph
Assembly: VelocityGraph (in VelocityGraph.dll) Version: 11.1.0.0 (11.1)

Syntax

C++

Copy

[SerializableAttribute]
public class Graph : OptimizedPersistable, IGraph

<SerializableAttribute>
Public Class Graph
	Inherits OptimizedPersistable
	Implements IGraph

[SerializableAttribute]
public ref class Graph : public OptimizedPersistable, 
	IGraph

[<SerializableAttribute>]
type Graph =  
    class
        inherit OptimizedPersistable
        interface IGraph
    end

The Graph type exposes the following members.

Constructors

	Name	Description
	Graph	Creates a new Graph

Top

Properties

	Name	Description
	Features	Returns the features of the underlying graph.
	ObjectsPerPage	Place this type of of object on its own page (Overrides OptimizedPersistableObjectsPerPage.)
	VertexIdSetPerType	true if using a vertex id set per type. Decided by constructor parameter when creating a Graph

Top

Methods

	Name	Description
	AddEdge	Add an edge to the graph. The added edges requires a recommended identifier, a tail vertex, an head vertex, and a label. Like adding a vertex, the provided object identifier may be ignored by the implementation.
	AddVertex	Create a new vertex (of VertexType "default"), add it to the graph, and return the newly created vertex.
	AddVertex(Object)	Create a new vertex (of VertexType "default"), add it to the graph, and return the newly created vertex.
	Clear	Removes all edges and vertices from the graph.
	CombineIntersection	Combines to sets of edges by intersection
	ContainsVertex	Returns a value indicating whether a Vertex exists for the specified vertex id.
	CountEdges	Returns a count of all edges in this graph
	CountVertices	Get a count of all vertices in this graph
	Edges	Enumerates all the edges of the given type between two given nodes (tail and head).
	ExportToGraphJson(Stream)	Write the data in a Graph to a GraphJson JSON OutputStream.
	ExportToGraphJson(String)	Write the data in a Graph to a GraphJson JSON OutputStream.
	ExportToGraphJson(Stream, GraphJsonSettings)	Write the data in a Graph to a GraphJson JSON OutputStream.
	ExportToGraphJson(String, GraphJsonSettings)	Write the data in a Graph to a GraphJson JSON OutputStream.
	ExportToGraphSon(Stream, IEnumerableString, IEnumerableString, GraphSonMode)	Write the data in a Graph to a GraphSon JSON OutputStream.
	ExportToGraphSon(String, IEnumerableString, IEnumerableString, GraphSonMode)	Write the data in a Graph to a GraphSon JSON OutputStream.
	FindEdgeType	Finds the type id associated with a particular edge type. Lookup by name.
	FindEdgeTypes	Get an array of all edge types in this graph
	FindVertex	Finds vertex having the given value for the given property.
	FindVertexProperty	Finds a PropertyType of VertexType.
	FindVertexType	Finds the type id associated with a particular vertexe type. Lookup by name.
	FindVertexTypes	Get an array of all vertex types in this graph
	GetEdge	Return the edge referenced by the provided object identifier. If no edge is referenced by that identifier, then return null.
	GetEdges	Return an iterable to all the edges in the graph.
	GetEdges(String, Object)	Return an iterable to all the edges in the graph that have a particular key/value property.
	GetEdgesT(String, T)	Return an iterable to all the edges in the graph that have a particular key/value property.
	GetEdgeType	Get a EdgeType associated with an Edge id
	GetValues	Enumerates all the values for the given vertex/edge property
	GetVertex(Int32)	Look up a Vertex
	GetVertex(Object)	Return the vertex referenced by the provided object identifier. If no vertex is referenced by that identifier, then return null.
	GetVertexType	Given a Vertex id, returns the corresponding Vertex.
	GetVertices	Return an iterable to all the vertices in the graph.
	GetVertices(String, Object)	Return an iterable to all the vertices in the graph that have a particular key/value property.
	ImportGraphJson(String)	Input the GraphJson JSON stream data into the graph. In practice, usually the provided graph is empty.
	ImportGraphJson(Stream, Int32)	Input the GrapJson JSON stream data into the graph. In practice, usually the provided graph is empty.
	ImportGraphSon(String)	Input the GraphSon JSON stream data into the graph. In practice, usually the provided graph is empty.
	ImportGraphSon(Stream, Int32)	Input the GraphSon JSON stream data into the graph. In practice, usually the provided graph is empty.
	NewEdge(EdgeType, Vertex, Vertex)	Creates a new edge instance.
	NewEdge(EdgeType, PropertyType, Object, PropertyType, Object)	Creates a new edge instance. The tail of the edge will be any node having the given tailV Value for the given tailAttr Property identifier, and the head of the edge will be any node having the given headV Value for the given headAttr Property identifier.
	NewEdgeProperty	Creates a new Property.
	NewEdgeType(String, Boolean, EdgeType)	Creates a new edge type.
	NewEdgeType(String, Boolean, VertexType, VertexType, EdgeType)	Creates a new edge type.
	NewVertex	Creates a new node instance.
	NewVertexProperty	Creates a new Property.
	NewVertexType	Creates a new node type.
	Open	Opens a graph
	Persist	Persists this object. Override in your subclasses when you want fields of your class to be persisted in some special way. (Overrides OptimizedPersistablePersist(Placement, SessionBase, Boolean, Boolean, QueueIOptimizedPersistable).)
	Query	Generate a query object that can be used to fine tune which edges/vertices are retrieved from the graph.
	RemoveEdge	Remove the provided edge from the graph.
	RemovePropertyType	Removes a property type except if any vertex or edge is using it
	RemoveVertex	Remove the provided vertex from the graph. Upon removing the vertex, all the edges by which the vertex is connected must be removed as well.
	RemoveVertexType	Removes a VertexType from this graph. An exception is thrown if the VertexType is in use.
	Select(PropertyType, FuncIComparable, IComparable, Boolean, IComparable)	Enumerates all elements satisfying the given condition for the given property and value
	Select(PropertyType, FuncIComparable, IComparable, IComparable, Boolean, IComparable, IComparable)	numerates all elements satisfying the given condition for the given property and value range
	Shutdown	A shutdown function is required to properly close the graph. This is important for implementations that utilize disk-based serializations.
	ToString	Displays class name plus object id (Overrides OptimizedPersistableToString.)
	Traverse	Selects all neighbor Vertices from or to each of the node OID in the given collection and for the given edge type.
	Unpersist	Removes an object from the persistent store and makes the object a transient object. It does not automatically make referenced objects unpersisted. Best way to do so is to override this virtual function in your own classes. (Overrides OptimizedPersistableUnpersist(SessionBase).)

Top

Extension Methods

	Name	Description
	AddEdge	Add an edge to the graph with specified id and provided properties. (Defined by GraphHelpers.)
	AddVertex	Add a vertex to the graph with specified id and provided properties. (Defined by GraphHelpers.)
	CopyGraph	Copy the vertex/edges of one graph over to another graph. The id of the elements in the from graph are attempted to be used in the to graph. This method only works for graphs where the user can control the element ids. (Defined by GraphHelpers.)
	CreateTinkerGraph	(Defined by GraphHelpers.)
	GraphString	(Defined by StringFactory.)
	LoadGml	(Defined by GraphHelpers.)
	LoadGraphml	(Defined by GraphHelpers.)
	LoadGraphson	(Defined by GraphHelpers.)
	ReIndexElementsT	For those graphs that do no support automatic reindexing of elements when a key is provided for indexing, this method can be used to simulate that behavior. The elements in the graph are iterated and their properties (for the provided keys) are removed and then added. Be sure that the key indices have been created prior to calling this method so that they can pick up the property mutations calls. Finally, if the graph is a TransactionalGraph, then a 1000 mutation buffer is used for each commit. (Defined by KeyIndexableGraphHelpers.)
	SaveDotNet	(Defined by GraphHelpers.)
	SaveGml	(Defined by GraphHelpers.)
	SaveGraphml	(Defined by GraphHelpers.)
	SaveGraphson	(Defined by GraphHelpers.)
	ToStringDetails(SessionBase, Boolean)	Overloaded. Object details as a string (Defined by Utilities.)
	ToStringDetails(Schema, TypeVersion, Boolean)	Overloaded. Currently only used by Database Manager (Defined by Utilities.)

Top

Reference

VelocityGraph Namespace