base

Documentation

Index

• Constants
• type BranchNavigator
• type Concern
• type InvalidKindError
  • func (r InvalidKindError) Error() string
• type InvalidRefError
  • func (r InvalidRefError) Error() string
• type ListOptions
• type Model
• type ParentNavigator
• type Ref
• type Tree
  • func (r *Tree) Ancestry(leaf Model, navigator ParentNavigator) (treeRoot *TreeNode, err error)
  • func (r *Tree) Build(root Model, navigator BranchNavigator) (treeRoot *TreeNode, err error)
• type TreeNode

Constants

const (
	MaxDetail = libmodel.MaxDetail
)

Types

type BranchNavigator

type BranchNavigator interface {
	Next(Model) ([]Model, error)
}

Tree navigator. Navigate down the children.

type Concern

type Concern struct {
	Label      string `json:"label"`
	Category   string `json:"category"`
	Assessment string `json:"assessment"`
}

VM concerns.

type InvalidKindError

type InvalidKindError struct {
	Object interface{}
}

Invalid kind.

func (InvalidKindError) Error

func (r InvalidKindError) Error() string

type InvalidRefError

type InvalidRefError struct {
	Ref
}

Invalid reference.

func (InvalidRefError) Error

func (r InvalidRefError) Error() string

type ListOptions

type ListOptions = libmodel.ListOptions

type Model

type Model = libmodel.Model

type ParentNavigator

type ParentNavigator interface {
	Next(Model) (Model, error)
}

Tree navigator. Navigate up the parent tree.

type Ref

type Ref struct {
	// The kind (type) of the referenced.
	Kind string `json:"kind"`
	// The ID of object referenced.
	ID string `json:"id"`
}

An object reference.

type Tree

type Tree struct {
	// Depth limit (0=unlimited).
	Depth int
}

Tree.

func (*Tree) Ancestry

func (r *Tree) Ancestry(leaf Model, navigator ParentNavigator) (treeRoot *TreeNode, err error)

Build the (ancestry) tree.

func (*Tree) Build

func (r *Tree) Build(root Model, navigator BranchNavigator) (treeRoot *TreeNode, err error)

Build the tree.

type TreeNode

type TreeNode struct {
	// Parent node.
	Parent *TreeNode
	// Kind of model.
	Kind string
	// Model.
	Model Model
	// Child nodes.
	Children []*TreeNode
}

Tree node.