Click or drag to resize

Edge Class

An Edge links two vertices. Along with its key/value properties, an edge has both a directionality and a label. The directionality determines which vertex is the tail vertex (out vertex) and which vertex is the head vertex (in vertex). The edge label determines the type of relationship that exists between the two vertices. Diagrammatically, outVertex ---label---> inVertex.
Inheritance Hierarchy

Namespace:  VelocityGraph
Assembly:  VelocityGraph (in VelocityGraph.dll) Version: (11.1)
public class Edge : Element, IEdge, IElement, 
	IDictionary<string, Object>, ICollection<KeyValuePair<string, Object>>, 
	IEnumerable<KeyValuePair<string, Object>>, IEnumerable, 
	IDictionary, ICollection, IEqualityComparer<Edge>

The Edge type exposes the following members.

Public propertyEdgeId
Gets the edge id
Public propertyEdgeType
Gets the edge type
Public propertyHead
Gets the head vertex
Public propertyId
An identifier that is unique to its inheriting class. All vertices of a graph must have unique identifiers. All edges of a graph must have unique identifiers.
(Overrides DictionaryElementId.)
Public propertyTail
Gets the tail vertex
Public methodEquals(Object)
Determines whether the specified Edge is equal to the current one.
(Overrides ObjectEquals(Object).)
Public methodEquals(Edge, Edge)
Determines whether the specified objects are equal.
Public methodGetEdgePeer
Gets the other end for the given edge.
Public methodGetHashCode
Use id as hash code
(Overrides ElementGetHashCode.)
Public methodGetHashCode(Edge)
Returns a hash code for the specified object.
Public methodGetProperty(String)
Return the object value associated with the provided string key. If no value exists for that key, return null.
(Overrides DictionaryElementGetProperty(String).)
Public methodGetProperty(PropertyType)
Gets the Value for the given Property id
Public methodGetPropertyKeys
Return all the keys associated with the element.
(Overrides DictionaryElementGetPropertyKeys.)
Public methodRemove
Remove the edge from the graph.
(Overrides DictionaryElementRemove.)
Public methodRemoveProperty
Un-assigns a key/value property from the edge. The object value of the removed property is returned.
(Overrides DictionaryElementRemoveProperty(String).)
Public methodSetProperty(String, Object)
Assign a key/value property to the edge. If a value already exists for this key, then the previous key/value is overwritten.
(Overrides DictionaryElementSetProperty(String, Object).)
Public methodSetProperty(PropertyType, IComparable)
Sets the value for a property
Public methodToString
Returns a string that represents the current object.
(Overrides ObjectToString.)
Extension Methods
Public Extension MethodAreEqual
A standard method for determining if two elements are equal. This method should be used by any Element.equals() implementation to ensure consistent behavior.
(Defined by ElementHelpers.)
Public Extension MethodCopyProperties
Copy the properties (key and value) from one element to another. The properties are preserved on the from element. ElementPropertiesRule that share the same key on the to element are overwritten.
(Defined by ElementHelpers.)
Public Extension MethodEdgeString (Defined by StringFactory.)
Public Extension MethodGetProperties
Get a clone of the properties of the provided element. In other words, a HashMap is created and filled with the key/values of the element's properties.
(Defined by ElementHelpers.)
Public Extension MethodHaveEqualIds
Simply tests if the element ids are equal().
(Defined by ElementHelpers.)
Public Extension MethodHaveEqualProperties
Determines whether two elements have the same properties. To be true, both must have the same property keys and respective values must be equals().
(Defined by ElementHelpers.)
Public Extension MethodRelabelEdge
An edge is relabeled by creating a new edge with the same properties, but new label. Note that an edge is deleted and an edge is added.
(Defined by EdgeHelpers.)
Public Extension MethodSetProperties(IDictionaryString, Object)Overloaded.
Set the properties of the provided element using the provided dictionary.
(Defined by ElementHelpers.)
Public Extension MethodSetProperties(Object)Overloaded.
Set the properties of the provided element using the provided key value pairs. The var args of Objects must be divisible by 2. All odd elements in the array must be a string key.
(Defined by ElementHelpers.)
Public Extension MethodValidateProperty
Determines whether the property key/value for the specified element can be legally set. This is typically used as a pre-condition check prior to setting a property. Throws ArgumentException whether the triple is legal and if not, a clear reason message is provided
(Defined by ElementHelpers.)
See Also