Model | b-merode-modelBuilder

A Model is an artifact that includes all the meta-elements described in B-MERODE (business object types, fsms, methods, etc.) It also allows to export and import models. Furthermore, it can be used to evaluate the model's consistency.

Models are mutable

specfield: id (string) : unique id of the model
specfield: businessObjectTypes : set of BusinessObjectTypes included in the model
specfield: attributeTypes : set of AttributeTypes included in the model
specfield: businessEventTypes : set of BusinessEventTypes included in the model
specfield: existenceDependencies: set of ExistenceDependency objects included in the model
specfield: finiteStateMachines : set of FSMs included in the model
specfield: states : set of States included in the model's FSMs
specfield: transitions: set of Transitions included in the model's FSMs
specfield: methods: set of Methods inlcuded in the model
specfield: ept: EventParticipantTable applicable to the model
specfield: art: AttributeReadingTable applicable to the model
specfield: iars: set of InstanceAccessRules applicable to the model

Hierarchy

Model

Index

Constructors

constructor

Properties

Methods

Constructors

constructor

new Model(id: string): Model

- Defined in model/model.ts:47
Creates a new model m so that:
- m.id = id &&
- m.businessObjectTypes = [] &&
- m.attributeTypes = [] &&
- m.businessEventTypes = [] &&
- m.existenceDependencies = [] &&
- m.finiteStateMachines = [] &&
- m.states = [] &&
- m.transitions = [] &&
- m.methods = [] &&
- m.ept = null &&
- m.apt = null &&
- m.instanceAccessRules = []
Parameters
- id: string
  
  Unqiue ID of the model
Returns Model

Properties

Private attributeReadingTable

attributeReadingTable: AttributeReadingTable

Private attributeTypes

attributeTypes: Map<string, AttributeType>

Private businessEventTypes

businessEventTypes: Map<string, BusinessEventType>

Private businessObjectTypes

businessObjectTypes: Map<string, BusinessObjectType>

Private eventParticipantTable

eventParticipantTable: EventParticipantTable

Private existenceDependencies

existenceDependencies: Map<string, ExistenceDependency>

Private finiteStateMachines

finiteStateMachines: Map<string, FSM>

Private id

id: string

Private instanceAccessRules

instanceAccessRules: Set<InstanceAccessRule>

Private methods

methods: Map<string, Method>

Private states

states: Map<string, State>

Private transitions

transitions: Map<string, Transition>

Methods

addAttributeType

addAttributeType(at: AttributeType): void

- Defined in model/model.ts:128
modifies

this

effects

this_post.attributeTypes = this.attributeTypes U { at }

Parameters
- at: AttributeType
  
  AttributeType to add to this
Returns void

addBusinessEventType

addBusinessEventType(businessEventType: BusinessEventType): void

- Defined in model/model.ts:137
modifies

this

effects

this_post.businessEventTypes = this.businessEventTypes U { businessEventType }

Parameters
- businessEventType: BusinessEventType
  
  Business event type to add to this
Returns void

addBusinessObjectType

addBusinessObjectType(bot: BusinessObjectType): void

- Defined in model/model.ts:155
modifies

this

effects

this_post.businessObjectTypes = this.businessObjectTypes U { bot }

Parameters
- bot: BusinessObjectType
  
  Business object type to add to this
Returns void

addExistenceDependency

addExistenceDependency(ed: ExistenceDependency): void

- Defined in model/model.ts:196
modifies

this

effects

this_post.existenceDependencies = this.existenceDependencies U { ed }

Parameters
- ed: ExistenceDependency
  
  Existence dependcy to add to this
Returns void

Private addFSM

addFSM(fsm: FSM): void

- Defined in model/model.ts:183
modifies

this

effects

this_post.finiteStateMachines = this.finiteStateMachines U { fsm }

Parameters
- fsm: FSM
  
  FSM to add to this
Returns void

addInstanceAccessRule

addInstanceAccessRule(iar: InstanceAccessRule): void

- Defined in model/model.ts:119
modifies

this

effects

this_post.instanceAccessRules = this.instanceAccessRules U { iar }

Parameters
- iar: InstanceAccessRule
  
  InstanceAccessRule to add to the model
Returns void

addMethod

addMethod(method: Method): void

- Defined in model/model.ts:146
modifies

this

effects

this_post.methods = this.methods U { method }

Parameters
- method: Method
  
  Method to add to this
Returns void

Private addState

addState(state: State): void

- Defined in model/model.ts:165
modifies

this

effects

this_post.states = this.states U { state }

Parameters
- state: State
  
  State to add to this
Returns void

Private addTransition

addTransition(transition: Transition): void

- Defined in model/model.ts:174
modifies

this

effects

this_post.transitions = this.transitions U { transition }

Parameters
- transition: Transition
  
  Transition to add to this
Returns void

getAttributeType

getAttributeType(id: string): AttributeType

- Defined in model/model.ts:461
Parameters
- id: string
Returns AttributeType

getBusinessEventType

getBusinessEventType(id: string): BusinessEventType

- Defined in model/model.ts:481
Parameters
- id: string
Returns BusinessEventType

getBusinessEventTypes

getBusinessEventTypes(): Array<BusinessEventType>

- Defined in model/model.ts:477
Returns Array<BusinessEventType>

getBusinessObjectType

getBusinessObjectType(id: string): BusinessObjectType

- Defined in model/model.ts:469
Parameters
- id: string
Returns BusinessObjectType

getBusinessObjectTypeFromName

getBusinessObjectTypeFromName(botName: string): BusinessObjectType

- Defined in model/model.ts:88
throws

An error in case there is no business object type in this, with botName as a name

willreturn

Otherwise, returns a business object type "bot" so that bot.name = botName && bot is in this

Parameters
- botName: string
  
  Name of the business object type to retrieve
Returns BusinessObjectType

getBusinessObjectTypes

getBusinessObjectTypes(): Array<BusinessObjectType>

- Defined in model/model.ts:457
Returns Array<BusinessObjectType>

package

package(): IModelPackage

- Defined in model/model.ts:206
modifies

this

effects

this_post.ept = a default EPT generated for this in case this.ept is not defined

willreturn

a JSON that represents the serialized version of this

Returns IModelPackage

setAttributeReadingTable

setAttributeReadingTable(art: AttributeReadingTable): void

- Defined in model/model.ts:110
modifies

this

effectts

this_post.art = art

Parameters
- art: AttributeReadingTable
  
  AttributetReadingTable to use for the current model
Returns void

setEventParticipantTable

setEventParticipantTable(ept: EventParticipantTable): void

- Defined in model/model.ts:101
modifies

this

effects

this_post.ept = ept

Parameters
- ept: EventParticipantTable
  
  EventParticipantTable to use for the current model
Returns void

Static Private loadAttributeReadingTableFromModel

loadAttributeReadingTableFromModel(model: Model, modelElement: IAttributeReadingTableModelFormat): AttributeReadingTable

- Defined in model/model.ts:434
Parameters
- model: Model
- modelElement: IAttributeReadingTableModelFormat
Returns AttributeReadingTable

Static Private loadAttributeTypeFromModel

loadAttributeTypeFromModel(modelElement: IAttributeTypeModelFormat): AttributeType

- Defined in model/model.ts:285
willreturn

a new AttributeType imported from the serialized model format

Parameters
- modelElement: IAttributeTypeModelFormat
  
  attribute type in the serialized model format
Returns AttributeType

Static Private loadBusinessEventTypesFromModel

loadBusinessEventTypesFromModel(modelElement: IBusinessEventTypeModelFormat): BusinessEventType

- Defined in model/model.ts:309
willreturn

a new BusinessEventType imported from the serialized model format.

Parameters
- modelElement: IBusinessEventTypeModelFormat
  
  business object type in the serialized model format.
Returns BusinessEventType

Static Private loadBusinessObjectTypeFromModel

loadBusinessObjectTypeFromModel(model: Model, modelElement: IBusinessObjectTypeModelFormat): BusinessObjectType

- Defined in model/model.ts:376
willreturn

a Business Object Type loaded from the serialized model format

Parameters
- model: Model
  
  Model being loaded from a file
- modelElement: IBusinessObjectTypeModelFormat
  
  Business object type to be loaded, in serialzed model format
Returns BusinessObjectType

Static Private loadEventParticipantTableFromModel

loadEventParticipantTableFromModel(model: Model, modelElement: IEventParticipantTableModelFormat): EventParticipantTable

- Defined in model/model.ts:420
Parameters
- model: Model
- modelElement: IEventParticipantTableModelFormat
Returns EventParticipantTable

Static Private loadExistenceDependencyFromModel

loadExistenceDependencyFromModel(model: Model, modelElement: IExistenceDependencyModelFormat): ExistenceDependency

- Defined in model/model.ts:410
willreturn

an ExistenceDependency loaded from the serialized model format

Parameters
- model: Model
  
  Model being loaded from file
- modelElement: IExistenceDependencyModelFormat
  
  ExistenceDependency to load, in the serialized model format.
Returns ExistenceDependency

Static loadFromFile

loadFromFile(filePath: string): Model

- Defined in model/model.ts:235
willreturn

a new model m that is imported from the serialized model format file located at filePath

Parameters
- filePath: string
  
  Path where the file containing the serialized model can be found
Returns Model

Static Private loadFsmFromModel

loadFsmFromModel(model: Model, modelElement: IFSMModelFormat): FSM

- Defined in model/model.ts:395
willreturn

a FSM loaded from the serialized model format

Parameters
- model: Model
  
  Model being loaded from a file
- modelElement: IFSMModelFormat
  
  FSM to be loaded, in the serialized model format
Returns FSM

Static Private loadInstanceAccessRuleFromModel

loadInstanceAccessRuleFromModel(model: Model, modelElement: IInstanceAccessRuleModelFormat): InstanceAccessRule

- Defined in model/model.ts:449
Parameters
- model: Model
- modelElement: IInstanceAccessRuleModelFormat
Returns InstanceAccessRule

Static Private loadMethodFromModel

loadMethodFromModel(model: Model, modelElement: IMethodModelFormat): Method

- Defined in model/model.ts:320
willreturn

a new method imported from the serialized model format

Parameters
- model: Model
  
  the model being loaded from a file
- modelElement: IMethodModelFormat
  
  the method to import in the serialized model format
Returns Method

Static Private loadStateFromModel

loadStateFromModel(modelElement: IStateModelFormat): State

- Defined in model/model.ts:348
willreturn

a state loaded from the serialized model format.

Parameters
- modelElement: IStateModelFormat
  
  state to be loaded, in the serialized model format.
Returns State

Static Private loadTransitionFromModel

loadTransitionFromModel(model: Model, modelElement: ITransitionModelFormat): Transition

- Defined in model/model.ts:360
willreturn

a Transition loaded from the serialized model format

Parameters
- model: Model
  
  Model being loaded from a file
- modelElement: ITransitionModelFormat
  
  Transition to be loaded, in the serialized model format.
Returns Transition

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

id: string

Returns Model

Properties

Private attributeReadingTable

Private attributeTypes

Private businessEventTypes

Private businessObjectTypes

Private eventParticipantTable

Private existenceDependencies

Private finiteStateMachines

Private id

Private instanceAccessRules

Private methods

Private states

Private transitions

Methods

addAttributeType

Parameters

at: AttributeType

Returns void

addBusinessEventType

Parameters

businessEventType: BusinessEventType

Returns void

addBusinessObjectType

Parameters

bot: BusinessObjectType

Returns void

addExistenceDependency

Parameters

ed: ExistenceDependency

Returns void

Private addFSM

Parameters

fsm: FSM

Returns void

addInstanceAccessRule

Parameters

iar: InstanceAccessRule

Returns void

addMethod

Parameters

method: Method

Returns void

Private addState

Parameters

state: State

Returns void

Private addTransition

Parameters

transition: Transition

Returns void

getAttributeType

Parameters

id: string

Returns AttributeType

getBusinessEventType

Parameters

id: string

Returns BusinessEventType

getBusinessEventTypes

Returns Array<BusinessEventType>

getBusinessObjectType

Parameters

id: string

Returns BusinessObjectType

getBusinessObjectTypeFromName

Parameters

botName: string

Returns BusinessObjectType

getBusinessObjectTypes

Returns Array<BusinessObjectType>