CM.Metamodel

Metamodel used to create actual models within system provides simple way for compiler-driven modelling without restricting usage of various Haskell constructs of structure and behavior coding.

Documentation

type Identifier = String

Type synonym for identifier use

class Show i => Identifiable i where

Class encapsulating the identity principle

Methods

identifier :: i -> Identifier

Get identifier of element (default: show)

identic :: i -> i -> Bool

Check if two elements are identic

Instances

Identifiable MetaElement

Methods

identifier :: MetaElement -> Identifier

identic :: MetaElement -> MetaElement -> Bool

class (Show e, Read e) => CMElement e where

Generic element of conceptual model

Minimal complete definition

toMeta

Methods

simpleConstraints :: [e -> Validity]

List of simple contraints (no need to know its model)

complexConstaints :: ConceptualModel m => [m -> e -> Validity]

List of complex (model-aware) contraints

constraints :: ConceptualModel m => m -> [e -> Validity]

List of all contraints (default: simple + complex)

evalConstraints :: ConceptualModel m => m -> e -> [Validity]

Evaluate all contraints and get list of Validity as result

valid :: ConceptualModel m => m -> e -> Bool

Check if element is valid (conforms all constraints)

violations :: ConceptualModel m => m -> e -> [String]

Get list of all constraints violations (empty list if valid)

elementName :: e -> String

Name of element type (default is derived by show)

toMeta :: ConceptualModel m => m -> e -> MetaElement

Convert element to MetaElement (recommended: use functions from subclasses)

fromMeta :: e -> MetaElement -> Maybe e

Optional function from converting back from MetaElement

Instances

CMElement MetaElement

Methods

simpleConstraints :: [MetaElement -> Validity]

complexConstaints :: ConceptualModel m => [m -> MetaElement -> Validity]

constraints :: ConceptualModel m => m -> [MetaElement -> Validity]

evalConstraints :: ConceptualModel m => m -> MetaElement -> [Validity]

valid :: ConceptualModel m => m -> MetaElement -> Bool

violations :: ConceptualModel m => m -> MetaElement -> [String]

elementName :: MetaElement -> String

toMeta :: ConceptualModel m => m -> MetaElement -> MetaElement

fromMeta :: MetaElement -> MetaElement -> Maybe MetaElement

class CMElement a => ConceptualModel a where

Whole conceptual model class

Minimal complete definition

cmodelElements

Methods

cmodelElements :: a -> [MetaElement]

Get all elements of the model

validModel :: a -> Bool

Check whether all elements in model are valid and is valid itself

cmodelName :: a -> String

Name of model type (default: elementName)

toMetaModel :: ConceptualModel b => b -> a -> MetaElement

Convert to MetaModel with use of cmodelName and cmodelElements

class (CMElement a, Identifiable a) => Entity a where

Entities for representing concepts

Minimal complete definition

entityAttributes

Methods

entityAttributes :: a -> [MetaAttribute]

Get all attributes of the entity

entityName :: a -> String

Name of entity type (default: elementName)

entitySuperNames :: a -> [String]

Name of supertypes (default: '[]')

entitySubNames :: a -> [String]

Names of subtypes (default: '[]')

toMetaEntity :: ConceptualModel m => m -> a -> MetaElement

Convert to MetaEntity with use of entityName, entityAttributes and others

Instances

Entity MetaElement

Methods

entityAttributes :: MetaElement -> [MetaAttribute]

entityName :: MetaElement -> String

entitySuperNames :: MetaElement -> [String]

entitySubNames :: MetaElement -> [String]

toMetaEntity :: ConceptualModel m => m -> MetaElement -> MetaElement

class (CMElement a, Identifiable a) => Relationship a where

Relationship that connects multiple entities

Minimal complete definition

relationshipParticipations

Methods

relationshipParticipations :: a -> [MetaParticipation]

Get all participations in the relationship

relationshipName :: a -> String

Name of relationship type (default: elementName)

toMetaRelationship :: ConceptualModel m => m -> a -> MetaElement

Convert to MetaRelationship with use of relationshipName and relationshipParticipations

data ParticipationQuantity

Quantity of participation type

Constructors

Limited Word

Quantity limited by positive number

Unlimited

Unlimited quantity (i.e. infinity)

Unique

Special unique (i.e. always must be exactly 1)

Instances

Eq ParticipationQuantity

Methods

(==) :: ParticipationQuantity -> ParticipationQuantity -> Bool

(/=) :: ParticipationQuantity -> ParticipationQuantity -> Bool

Ord ParticipationQuantity

Methods

compare :: ParticipationQuantity -> ParticipationQuantity -> Ordering

(<) :: ParticipationQuantity -> ParticipationQuantity -> Bool

(<=) :: ParticipationQuantity -> ParticipationQuantity -> Bool

(>) :: ParticipationQuantity -> ParticipationQuantity -> Bool

(>=) :: ParticipationQuantity -> ParticipationQuantity -> Bool

max :: ParticipationQuantity -> ParticipationQuantity -> ParticipationQuantity

min :: ParticipationQuantity -> ParticipationQuantity -> ParticipationQuantity

Read ParticipationQuantity

Methods

readsPrec :: Int -> ReadS ParticipationQuantity

readList :: ReadS [ParticipationQuantity]

readPrec :: ReadPrec ParticipationQuantity

readListPrec :: ReadPrec [ParticipationQuantity]

Show ParticipationQuantity

Methods

showsPrec :: Int -> ParticipationQuantity -> ShowS

show :: ParticipationQuantity -> String

showList :: [ParticipationQuantity] -> ShowS

data ParticipationType

Type of participation (i.e. multiplicity)

Constructors

Mandatory ParticipationQuantity

Type for mandatory relationship (1..N)

Optional ParticipationQuantity

Type for optional relationship (0..N)

Custom ParticipationQuantity ParticipationQuantity

Type for custom relationship (X..Y)

Instances

Eq ParticipationType

Methods

(==) :: ParticipationType -> ParticipationType -> Bool

(/=) :: ParticipationType -> ParticipationType -> Bool

Read ParticipationType

Methods

readsPrec :: Int -> ReadS ParticipationType

readList :: ReadS [ParticipationType]

readPrec :: ReadPrec ParticipationType

readListPrec :: ReadPrec [ParticipationType]

Show ParticipationType

Methods

showsPrec :: Int -> ParticipationType -> ShowS

show :: ParticipationType -> String

showList :: [ParticipationType] -> ShowS

data MetaAttribute

Attribute representation in meta level

Constructors

MetaAttribute

Fields

• maName :: String
• maType :: String
• maValue :: String

Instances

Eq MetaAttribute

Methods

(==) :: MetaAttribute -> MetaAttribute -> Bool

(/=) :: MetaAttribute -> MetaAttribute -> Bool

Read MetaAttribute

Methods

readsPrec :: Int -> ReadS MetaAttribute

readList :: ReadS [MetaAttribute]

readPrec :: ReadPrec MetaAttribute

readListPrec :: ReadPrec [MetaAttribute]

Show MetaAttribute

Methods

showsPrec :: Int -> MetaAttribute -> ShowS

show :: MetaAttribute -> String

showList :: [MetaAttribute] -> ShowS

data MetaParticipation

Participation representation in meta level

Constructors

MetaParticipation

Fields

• mpName :: String
• mpType :: String
• mpIdentifier :: String
• mpPType :: ParticipationType

Instances

Eq MetaParticipation

Methods

(==) :: MetaParticipation -> MetaParticipation -> Bool

(/=) :: MetaParticipation -> MetaParticipation -> Bool

Read MetaParticipation

Methods

readsPrec :: Int -> ReadS MetaParticipation

readList :: ReadS [MetaParticipation]

readPrec :: ReadPrec MetaParticipation

readListPrec :: ReadPrec [MetaParticipation]

Show MetaParticipation

Methods

showsPrec :: Int -> MetaParticipation -> ShowS

show :: MetaParticipation -> String

showList :: [MetaParticipation] -> ShowS

data MetaElement

CMElement representation in meta level

Constructors

MetaEntity

Entity representation in meta level

Fields

• meName :: String
• meIdentifier :: String
• meAttributes :: [MetaAttribute]
• meValid :: Bool
• meSuperNames :: [String]
• meSubNames :: [String]

MetaRelationship

Relationship representation in meta level

Fields

• mrName :: String
• mrIdentifier :: String
• mrParticipations :: [MetaParticipation]
• mrValid :: Bool

MetaModel

ConceptualModel representation in meta level

Fields

• mmName :: Maybe String
• mmIdentifier :: Maybe String
• mmElements :: [MetaElement]
• mmValid :: Bool

Instances

Eq MetaElement

Methods

(==) :: MetaElement -> MetaElement -> Bool

(/=) :: MetaElement -> MetaElement -> Bool

Read MetaElement

Methods

readsPrec :: Int -> ReadS MetaElement

readList :: ReadS [MetaElement]

readPrec :: ReadPrec MetaElement

readListPrec :: ReadPrec [MetaElement]

Show MetaElement

Methods

showsPrec :: Int -> MetaElement -> ShowS

show :: MetaElement -> String

showList :: [MetaElement] -> ShowS

Entity MetaElement

Methods

entityAttributes :: MetaElement -> [MetaAttribute]

entityName :: MetaElement -> String

entitySuperNames :: MetaElement -> [String]

entitySubNames :: MetaElement -> [String]

toMetaEntity :: ConceptualModel m => m -> MetaElement -> MetaElement

CMElement MetaElement

Methods

simpleConstraints :: [MetaElement -> Validity]

complexConstaints :: ConceptualModel m => [m -> MetaElement -> Validity]

constraints :: ConceptualModel m => m -> [MetaElement -> Validity]

evalConstraints :: ConceptualModel m => m -> MetaElement -> [Validity]

valid :: ConceptualModel m => m -> MetaElement -> Bool

violations :: ConceptualModel m => m -> MetaElement -> [String]

elementName :: MetaElement -> String

toMeta :: ConceptualModel m => m -> MetaElement -> MetaElement

fromMeta :: MetaElement -> MetaElement -> Maybe MetaElement

Identifiable MetaElement

Methods

identifier :: MetaElement -> Identifier

identic :: MetaElement -> MetaElement -> Bool

metaElementName :: MetaElement -> String

Get element name from any MetaElement

metaElementIdentifier :: MetaElement -> String

Get identifier from any MetaElement

metaElementValid :: MetaElement -> Bool

Check if any MetaElement is valid

tupleToAttribute :: (String, String, String) -> MetaAttribute

Convert tuple to MetaAttribute

tupleToParticipation :: (String, String, String, ParticipationType) -> MetaParticipation

Convert tuple to MetaParticipation