Paradigm.Graph protocol (paradigm v0.3.0)

Defines the protocol for Graph implementations. This decouples operations (conformance, abstraction, transforms) from the underlying graph storage.

Summary

class_id()

node_id()

t()

All the types that implement this protocol.

get_name(graph)

@type class_id() :: Paradigm.id()

@type node_id() :: Paradigm.id()

@type t() :: term()

All the types that implement this protocol.

@spec follow_reference(t(), node_id(), any()) :: Node.t() | nil

@spec get_all_classes(t()) :: [class_id()]

@spec get_all_nodes(t()) :: [node_id()]

@spec get_all_nodes_of_class(t(), class_id() | [class_id()]) :: [node_id()]

@spec get_content_hash(t()) :: String.t() | nil

@spec get_description(t()) :: String.t() | nil

@spec get_name(t()) :: String.t() | nil

@spec get_node(t(), node_id()) :: Node.t() | nil

@spec insert_node(t(), Paradigm.Graph.Node.t()) :: t()

@spec insert_nodes(t(), [Paradigm.Graph.Node.t()]) :: t()

@spec stream_all_nodes(t()) :: Enumerable.t(Node.t())