graph

Documentation

Overview

Package graph is inmemory representation for company hierarchy. All read requests are served from this package. It's consumers responsibility to update this package after any write call to persistent layer.

Index

• Variables
• type Graph
  • func Initialize(nodes []*Node) (*Graph, error)
  • func (g *Graph) EmplaceNode(node *Node) error
  • func (g *Graph) GetChildren(id string) ([]*Node, error)
  • func (g *Graph) UpdateParent(id, newPar string) error
• type Node
  • func NewEmptyNode() Node

Variables

var ErrDuplicateID = errors.New("id alreary exists")

ErrDuplicateID triggers when given id already exists

var ErrInvalidParentID = errors.New("parent not found")

ErrInvalidParentID ...

Types

type Graph

type Graph struct {
	Root  *Node
	Nodes map[string]*Node
}

Graph is in memory representation of hierarchy.

func Initialize

func Initialize(nodes []*Node) (*Graph, error)

Initialize creates a new graph object

func (*Graph) EmplaceNode

func (g *Graph) EmplaceNode(node *Node) error

EmplaceNode emplaces the given node into the graph. Updates the parent child relationship.

func (*Graph) GetChildren

func (g *Graph) GetChildren(id string) ([]*Node, error)

GetChildren returns all the childrens of a given node

func (*Graph) UpdateParent

func (g *Graph) UpdateParent(id, newPar string) error

UpdateParent sets the parent to parameter 'newPar'

type Node

type Node struct {
	ID       string `json:"id"`
	ParID    string `json:"pid"`
	Height   int    `json:"height"`
	Children map[string]*Node
}

Node is the building block of Graph. Node ID is chosen as the unique identifier for each node. Which is not the best practice, but will serve the given problem sufficiently.

func NewEmptyNode

func NewEmptyNode() Node

NewEmptyNode ...