mddmb

README

MDDeclarative Model Builder

👁

import "git.fractalqb.de/fractalqb/mddmb" 

This allows you to create [qb]MDD models with a more declarative Go syntax than with the MDD core API or the MDD Model Builder API.

Documentation

Index

• Constants
• func Association(a *assocDefn, defn ...any) *assocDefn
• func Attribute(name string, defn ...AttributeCmd) attrib
• func Between(defn ...any) between
• func Build(m *mdd.Model, defn ...ModelCmd) error
• func BuildAtom(a *mdd.Atom, defn ...AtomCmd) error
• func BuildClass(c *mdd.Class, defn ...ClassCmd) error
• func BuildEnum(e *mdd.Enum, defn ...EnumCmd) error
• func BuildPackage(pkg *mdd.Package, defn ...PackageCmd) error
• func From(defn ...any) from
• func Key(defn ...any) key
• func MixIn(mode mdd.MixMode, classes ...*ClassVar) mix
• func Model(name string, defn ...ModelCmd) (*mdd.Model, error)
• func Restict(atoms ...*AtomVar) restrict
• func Tag(key, value any) tag
• type AtomCmd
• type AtomDefn
  • func Atom(name string, defn ...AtomCmd) AtomDefn
  • func (def AtomDefn) GetFrom(p *mdd.Package) *mdd.Atom
  • func (def AtomDefn) Package(in *mdd.Package) error
  • func (a AtomDefn) Store(in *AtomVar) AtomDefn
• type AtomVar
  • func (t *AtomVar) Attribute(*mdd.Attribute) error
  • func (v AtomVar) SetLang(lang string, mapped any) error
  • func (t *AtomVar) Type() T
• type AttributeCmd
• type ClassCmd
• type ClassDefn
  • func Class(name string, defn ...ClassCmd) ClassDefn
  • func (def ClassDefn) GetFrom(p *mdd.Package) *mdd.Class
  • func (def ClassDefn) Package(in *mdd.Package) error
  • func (c ClassDefn) Store(in *typeVar[*mdd.Class]) ClassDefn
• type ClassVar
• type CommonTypes
  • func (lib *CommonTypes) Package(p *mdd.Package) error
• type Comparability
  • func (c Comparability) Atom(a *mdd.Atom) error
  • func (c Comparability) Enum(e *mdd.Enum) error
  • func (i Comparability) String() string
• type EnumCmd
• type EnumDefn
  • func Enum(name string, defn ...EnumCmd) EnumDefn
  • func (def EnumDefn) GetFrom(p *mdd.Package) *mdd.Enum
  • func (def EnumDefn) Package(in *mdd.Package) error
  • func (e EnumDefn) Store(in *typeVar[*mdd.Enum]) EnumDefn
• type EnumVar
• type Extends
  • func (Extends) Class(*mdd.Class) error
• type Literals
  • func (Literals) Enum(*mdd.Enum) error
• type Many
  • func (Many) Attribute(*mdd.Attribute) error
• type ModelCmd
• type Mult
  • func (Mult) Attribute(*mdd.Attribute) error
• type Num
  • func (Num) Attribute(*mdd.Attribute) error
• type PackageCmd
• type PackageDefn
  • func Package(name string, defn ...PackageCmd) PackageDefn
  • func (p PackageDefn) GetFrom(m *mdd.Model) *mdd.Package
  • func (def PackageDefn) Model(in *mdd.Model) error
  • func (p PackageDefn) Store(in **mdd.Package) PackageDefn

Constants

const (
	Entity classFlag = iota
	Abstract
)

const (
	NotComparable = Comparability(mdd.NotComparable)
	Comparable    = Comparability(mdd.Comparable)
	Ordered       = Comparability(mdd.Ordered)
)

const (
	One multFlag = iota
	Opt
)

const Derived attributeFlag = 0

const Extensible boolExt = true

Functions

func Association

func Association(a *assocDefn, defn ...any) *assocDefn

func Attribute

func Attribute(name string, defn ...AttributeCmd) attrib

func Between

func Between(defn ...any) between

func Build

func Build(m *mdd.Model, defn ...ModelCmd) error

func BuildAtom

func BuildAtom(a *mdd.Atom, defn ...AtomCmd) error

func BuildClass

func BuildClass(c *mdd.Class, defn ...ClassCmd) error

func BuildEnum

func BuildEnum(e *mdd.Enum, defn ...EnumCmd) error

func BuildPackage

func BuildPackage(pkg *mdd.Package, defn ...PackageCmd) error

func From

func From(defn ...any) from

func Key

func Key(defn ...any) key

func MixIn

func MixIn(mode mdd.MixMode, classes ...*ClassVar) mix

func Model

func Model(name string, defn ...ModelCmd) (*mdd.Model, error)

func Restict

func Restict(atoms ...*AtomVar) restrict

func Tag

func Tag(key, value any) tag

Types

type AtomCmd

type AtomCmd interface{ Atom(*mdd.Atom) error }

type AtomDefn

type AtomDefn struct {
	// contains filtered or unexported fields
}

func Atom

func Atom(name string, defn ...AtomCmd) AtomDefn

TODO Comparability -> atomDefn

func (AtomDefn) GetFrom

func (def AtomDefn) GetFrom(p *mdd.Package) *mdd.Atom

func (AtomDefn) Package

func (def AtomDefn) Package(in *mdd.Package) error

func (AtomDefn) Store

func (a AtomDefn) Store(in *AtomVar) AtomDefn

type AtomVar

type AtomVar struct {
	// contains filtered or unexported fields
}

func (*AtomVar) Attribute

func (t *AtomVar) Attribute(*mdd.Attribute) error

func (AtomVar) SetLang

func (v AtomVar) SetLang(lang string, mapped any) error

func (*AtomVar) Type

func (t *AtomVar) Type() T

type AttributeCmd

type AttributeCmd interface{ Attribute(*mdd.Attribute) error }

type ClassCmd

type ClassCmd interface{ Class(*mdd.Class) error }

type ClassDefn

type ClassDefn struct {
	// contains filtered or unexported fields
}

func Class

func Class(name string, defn ...ClassCmd) ClassDefn

func (ClassDefn) GetFrom

func (def ClassDefn) GetFrom(p *mdd.Package) *mdd.Class

func (ClassDefn) Package

func (def ClassDefn) Package(in *mdd.Package) error

func (ClassDefn) Store

func (c ClassDefn) Store(in *typeVar[*mdd.Class]) ClassDefn

type ClassVar

type ClassVar = typeVar[*mdd.Class]

type CommonTypes

type CommonTypes struct {
	// Use this to represent Boolean values
	Bool AtomVar

	// The integer numbers ℤ
	Integer AtomVar

	// Natural numbers including zero ℕ∪{0}
	NonNegInt AtomVar

	// Natural numbers ℕ (according to Peano's original formulation i.e. 0∉ℕ)
	PositiveInt AtomVar

	// Real numbers ℝ (somewhat hard to completely map to implementations)
	Real AtomVar

	// The subset of ℝ that can be exactly represented as a decimal numeral
	Decimal AtomVar

	// Sequence of symbols (most often implemented by a notion of computer
	// string)
	Text AtomVar

	// Denotes a specific day on earth. Its up to you if you consider it to be
	// with or without time-zone.
	Date AtomVar

	// Wall-clock time, independent of any date. Its up to you if you consider
	// it to be with or without time-zone.
	Time AtomVar

	// A precise instant in time.  Its up to you if you consider it to be with
	// or without time-zone.
	Timestamp AtomVar
}

func (*CommonTypes) Package

func (lib *CommonTypes) Package(p *mdd.Package) error

type Comparability

type Comparability mdd.Comparability

func (Comparability) Atom

func (c Comparability) Atom(a *mdd.Atom) error

func (Comparability) Enum

func (c Comparability) Enum(e *mdd.Enum) error

func (Comparability) String

func (i Comparability) String() string

type EnumCmd

type EnumCmd interface{ Enum(*mdd.Enum) error }

type EnumDefn

type EnumDefn struct {
	// contains filtered or unexported fields
}

func Enum

func Enum(name string, defn ...EnumCmd) EnumDefn

func (EnumDefn) GetFrom

func (def EnumDefn) GetFrom(p *mdd.Package) *mdd.Enum

func (EnumDefn) Package

func (def EnumDefn) Package(in *mdd.Package) error

func (EnumDefn) Store

func (e EnumDefn) Store(in *typeVar[*mdd.Enum]) EnumDefn

type EnumVar

type EnumVar = typeVar[*mdd.Enum]

type Extends

type Extends []*ClassVar

func (Extends) Class

func (Extends) Class(*mdd.Class) error

type Literals

type Literals []string

func (Literals) Enum

func (Literals) Enum(*mdd.Enum) error

type Many

type Many uint

func (Many) Attribute

func (Many) Attribute(*mdd.Attribute) error

type ModelCmd

type ModelCmd interface{ Model(*mdd.Model) error }

type Mult

type Mult struct{ Min, Max uint }

func (Mult) Attribute

func (Mult) Attribute(*mdd.Attribute) error

type Num

type Num uint

func (Num) Attribute

func (Num) Attribute(*mdd.Attribute) error

type PackageCmd

type PackageCmd interface{ Package(*mdd.Package) error }

type PackageDefn

type PackageDefn struct {
	// contains filtered or unexported fields
}

func Package

func Package(name string, defn ...PackageCmd) PackageDefn

func (PackageDefn) GetFrom

func (p PackageDefn) GetFrom(m *mdd.Model) *mdd.Package

func (PackageDefn) Model

func (def PackageDefn) Model(in *mdd.Model) error

func (PackageDefn) Store

func (p PackageDefn) Store(in **mdd.Package) PackageDefn