Complex Service

• Prepare a new actifsource Project as seen in the Actifsource Tutorial – Simple Service

  • Setup the Target Folder src

  • Create a Generic Domain Model

  • Create a Specific Domain Model

  • Create a Code Template

• Use the following package structure

Create a Generic Domain Model

• Create a Generic Domain Model in the DiagramEditor named ServiceDesign in the Package generic

• The Design shall contain the following Domain Classes

  • Service, Call, Parameter, Type

• Insert a Composition between

  • Service and Call

  • Call and Parameter

• Insert a Association between

  • Call and Type

  • Parameter and Type

• Adjust the Cardinalities as shown above

Warning: The layout for the relations transition and targetState might differ in your editor

Create a Specific Domain Model

• Create a Service named Patient in the Package specific

• Add the Calls Create and Delete

• Add the Parameter LastName, FirstName and Id as shown above

• Add the returnTypes as shown above

• Create a Code Template named ServiceImpl in the Package template

• Write code as shown above

• The function shall be placed in the Context Call Selector is Service.call

• The function parameters shall be placed in the Context Parameter; Selector is Call.parameter

• Save the Code Template

• You’ll find the generated code PatientImpl.java in the Target Folder src

---

• Use Java Functions to

  • extract recurring text fragments from your templates

  • capture complex expressions to keep your templates clean and easy to read

• Use Java Classes generated from your Generic Domain Model to write and maintain complex Java Functions

Extract Function

• We should extract identical terms to honor the DRY principle (Don’t Repeat Yourself)

• In your template select the text you want to extract into a function
• The light bulb at the left hand indicates Quick Assist is available

• Activate QuickAssist by clicking the light bulb or by pressing Ctrl+1
• Click Extract JavaFunction

• Name the function className
• Click Finish

Using Function

• The new function className returns the extracted fragment from your template
• The static function className is added to the static Java class ServiceImpl.ServiceFunctions in class ServiceImpl; this class is automatically generated by actifsource
• The term Service.name_Impl has been replaced by the function Service.className
• Java Functions are shown in italics in the actifsource Template Editor

• Let’s replace the second occurrence of the term Service.name_Impl
• Use Content Assist (Ctrl+Space) on Service to insert the function className for your class name

• Open the underlying Function Model (Ctrl+Alt+Left-Click)
• Alternatively, you can use the Tool Open Link in JavaEditor from the actifsource Template Editor toolbar

Editing Functions

• Change function declaration here if needed
• Please notice that the Function declaration was placed in the template

• Open the underlying Java Function (Ctrl+Left-Click)
• Alternatively, you can use the Tool Open Link in JavaEditor from the actifsource Template Editor toolbar

• The class ServiceImpl is opened in the Java Editor showing your function className

• Make sure to place additional imports within the corresponding Protected Regions
• Please note that all code outside Protected Regions will be overwritten if the respective source file is re-generated.

---

• Function Declarations are managed as actifsource Resources
• All Function Declarations are placed in Functions Spaces
• Templates are Functions Spaces by default
• Functions Spaces can exist without Templates
• Function Spaces are Resources and can therefore be placed in Packages

Advanced Context Operations

• Let’s add a new line after the Call Context in the Service Context
• Place cursor on the last position of the Call Context

• Press Cursor-Right
• While the cursor stays at its position, the Service Context is now highlighted
• Alternatively, you can use the context navigation from the actifsource Template Editor toolbar

• Press Enter
• A new line has been added in the Parent Context

Add Context via Quick Assist

• Let’s look at a quick and easy way to insert a new Context
• Insert the Variable Service.call using Content Assist (Ctrl+Space)

• The light bulb at the left hand indicates Quick Assist is available
• Activate QuickAssist by clicking the light bulb or pressing Ctrl+1

• Click on Create Line Context

• The Variable Service.call has been replaced by Call

Built-In Functions

• Let’s use Built-In Functions on Attributes
• Press '.' (dot) and Content Assist (Ctrl+Space) after name to see all available Built-In Functions

• Complete the member variable declaration as shown above

Extract Function in Function Space

• Call.name_Impl shall be the name of a new Template
• Select the term Call.name_Impl
• Activate QuickAssist by clicking on the light bulb or pressing Ctrl+1
• Click Extract TemplateFunction
• Template Functions behave like templates and are easier to handle than Java functions

• Name the function className
• Click New Template to create a new template which acts as Function Space for the new function className

• Check the Package
• Name the Template CallImpl
• Press Finish

• Press Finish

• The Term Call.name_Impl has been replaced by Call.className@CallImpl
• className@CallImpl indicates that the Function className belongs to the Function Space CallImpl

• A new Template named CallImpl has been created in the Package template
• Use the Function className in the file line of your template

• Write a simple class as shown above
• Write a method execute with returnType and Parameter
• Please notice that you might copy the whole parameter expression from the ServiceImpl Template
• Place a Protected Context in the function body

Templates and Folders

• Open the underlying Template Function for className (Ctrl+Left-Click)
• Alternatively, you can use the Tool Open Link in JavaEditor from the actifsource Template Editor toolbar

• The function className is handled as a Template Function (partial template)
• Template Functions are easy to handle
• A TemplateFunction may call itself to follow recursive meta model designs (Composite Pattern)

• Generated artifacts are placed in the Target Folder of your project

• You may want to place generated artifacts in specific sub folders

• Add Service.name/ as folder information in the file line of the Template ServiceImpl as shown above

• We want all Call implementations to be generated in the same folder as their corresponding Service
• Add Service.name as the folder name in the file line of the Template CallImpl as shown above
• Save the Templates CallImpl and ServiceImpl
• Protected Regions of the generated files are preserved

Copy with Context

• Extract a TemplateLineFunction memberName for the member variable name

• Also use the function memberName in the function body as shown above

• Open the underlying TemplateLineFunction for memberName (Ctrl+Left-Click)
• Alternatively, you can use the Tool Open Link in JavaEditor from the actifsource Template Editor toolbar

• The function className is handled as a TemplateLineFunction
• Template Line Functions are the easiest way to reuse information
• Template Line Functions do not allow context

• We want to copy Parameter.name including the Parameter Context and the separating comma from the functions parameter list
• Select the Term Parameter.name
• From the Context Menu, select Copy with Context
• From the Subcontext Menu, select Parameter

• Place your cursor between the brackets
• Select Paste from the Context Menu (Ctrl+V)

• The text and its corresponding context are inserted

---