Message DSL - Revision history

Worayeno: /* Message Model Files */

2017-11-07T08:30:33Z

‎Message Model Files

Worayeno: /* severity */

2017-11-06T15:55:54Z

‎severity

Worayeno: /* severity */

2017-11-06T15:50:12Z

‎severity

Worayeno: /* severity */

2017-11-06T15:49:26Z

‎severity

Worayeno: /* severity */

2017-11-06T15:48:28Z

‎severity

Worayeno: /* Overview */

2017-10-27T07:43:34Z

‎Overview

Worayeno: /* parameter */

2017-10-25T12:55:43Z

‎parameter

Worayeno: /* parameter */

2017-10-25T11:53:56Z

‎parameter

Worayeno at 11:29, 25 October 2017

2017-10-25T11:29:54Z

Worayeno at 11:28, 25 October 2017

2017-10-25T11:28:24Z

Show changes

@@ Line 3: / Line 3: @@
 ==Message Model Files==
-The Message DSL model unifies the content of all possible output messages and makes them available for other DSL models such as [[Action DSL]].
+The Message DSL model unifies the content of all possible output messages and makes them available for other DSL models such as [[Action DSL]]. These messages are defined in text files with the file extension '''<code>.message</code>'''.
 Message model files are made up of the following sections:

@@ Line 360: / Line 360: @@
 <syntaxhighlight lang="java">
 message <message name> {
-         severity { log-debug | log-error | log-info | log-trace | log-warn | show-error | show-info | show-warning}
+         severity { [log-debug | log-error | log-info | log-trace | log-warn | show-error | show-info | show-warning]* }
          output { all | { [ log “log text” ] | show “message text” } }
+}
@@ Line 405: / Line 405: @@
                                 log “user action allowed – employee termination in process”
                                 show "Fire process started"
+                }

@@ Line 353: / Line 353: @@
 ====severity====
-By setting a <code>severity</code>{…} block you are able to enumerate the list of severity levels (error, info, warning) that have to be either shown only in the console output or in a log file, or even both. This helps you categorize and filter the type of (available) output, you would like to consider or persist into a log file.
+By setting a <code>'''severity'''</code> {…} block you are able to enumerate the list of severity levels (error, info, warning) that have to be either shown only in the console output or in a log file, or even both. This helps you categorize and filter the type of (available) output, you would like to consider or persist into a log file.
 There are currently eight severity levels available:

@@ Line 361: / Line 361: @@
 message <message name> {
          severity { log-debug | log-error | log-info | log-trace | log-warn | show-error | show-info | show-warning}
          output { all | { [ log “log text” ] | show “message text” } }
+}
@@ Line 370: / Line 369: @@
 <syntaxhighlight lang="java">
 package net.osbee.sample.foodmart.messages {
          category Guest {
                 message Welcome {
                         parameter {
                                 String name
+                        }
                         severity {
                                 log-debug log-error log-trace log-warn
+                        }
                         output {
                                 log “welcome-msg shown to the user”
@@ Line 389: / Line 384: @@
+         }
          category Employee {
                 message Fired {
                         parameter {
@@ Line 397: / Line 390: @@
                                 String date
+                        }
                         severity {
                                 show-error show-info log-debug log-trace log-warn
+                        }
                         output {
                                 log “user action allowed – employee fired”
                                 show "You successfully fired this employee"
+                        }
+                }
                 message FireStarted {
                         severity {
                                 log-debug log-error log-trace log-warn show-info
+                        }
                         output {
                                 log “user action allowed – employee termination in process”

@@ Line 353: / Line 353: @@
 ====severity====
-* Log: log-debug | log-error | log-info | log-trace | log-warn
+There are currently eight severity levels available:
-* Show: show-error | show-info | show-warn
-−
 ► '''Syntax''':
 <syntaxhighlight lang="java">
 </syntaxhighlight>
 == Copyright Notice ==
 {{Copyright Notice}}

@@ Line 1: / Line 1: @@
 ==Purpose==
 The Message DSL contains all defined message outputs that either will be shown in the application as reponses and notifications (eg. Pop-Up Dialog), or redirected instead as console output (later also possibly persisted in log-files) with a selected list of severity level reports; both resulting of user interactions with the application.
 ==Message Model Files==

@@ Line 40: / Line 40: @@
-====category====
+===category===
 With the keyword '''category''' followed by an identifier name, you are able to define a group of messages, which can be referenced in other DSL’s via its fully qualified name. It is the first reference level before accessing the messages themselves.
@@ Line 74: / Line 74: @@
 Please note that at least one category has to be defined in order to create and/or show messages.
-=====message=====
+====message====
 With the keyword '''message''' followed by a message name identifier you are able to define the basic message structure itself within a group of messages (message category).
@@ Line 99: / Line 99: @@
 In order to create messages, you must define their <code>'''output'''{…}</code> block, which specifies the content of the message that has to be shown in the application, and if needed can also be logged to the console.
-=====output=====
+====output====
 ► '''Syntax''':
 <syntaxhighlight lang="java">
@@ Line 126: / Line 126: @@
-======all======
+=====all=====
 With the output option '''all''' followed by a string containing the message text, you define a message, which will be shown to the user not just as a pop-up notification but also as information text inside the console log.
@@ Line 179: / Line 179: @@
 </syntaxhighlight>
-======show======
+=====show=====
 With the output-option '''show''' followed by a string containing the message text, you define a pop-up notification that will be show to the user.
@@ Line 235: / Line 235: @@
 With the optional keyword '''log''' followed by a string containing a text you define a String to be shown in the console log. A '''log''' entry declaration has always to be followed by a '''show''' entry declaration. You may set a different output text with this option in contrast to the use of an '''all''' entry.
-======log======
+=====log=====
 ► '''Syntax''':
 <syntaxhighlight lang="java">
@@ Line 294: / Line 294: @@
 </syntaxhighlight>
-=====parameter=====
+====parameter====
 By defining a <code>'''parameter'''{…}</code> block you are able to define a list of parameter, whose values can be incorporated and used inside message text in order to create more detailed and complex messages.
@@ Line 362: / Line 362: @@
-=====severity=====
+====severity====
 * Log: log-debug | log-error | log-info | log-trace | log-warn