DTO DSL - Revision history

Cmollik: /* DTO */

2017-07-05T08:32:49Z

‎DTO

Cmollik at 19:20, 4 April 2017

2017-04-04T19:20:49Z

Hamid: /* Comments */

2017-01-12T23:07:47Z

‎Comments

Hamid: /* Operations */

2017-01-12T23:06:11Z

‎Operations

Hamid: /* Custom Mappers */

2017-01-12T23:03:19Z

‎Custom Mappers

Hamid: /* Custom Mappers */

2017-01-12T23:01:23Z

‎Custom Mappers

Hamid: /* Inherited Features */

2017-01-12T22:59:19Z

‎Inherited Features

Hamid: /* Inherited Features */

2017-01-12T22:58:02Z

‎Inherited Features

Hamid: /* Inherited Features */

2017-01-12T22:56:13Z

‎Inherited Features

Hamid: /* References */

2017-01-12T22:49:25Z

‎References

@@ Line 83: / Line 83: @@
 Data Transfer Objects ('''DTOs''') are the most complex elements in the DTO DSL. A DTO wraps an '''entity''' defined in the [[Entity DSL]] together with its properties and references into a single object used for communication purposes.
-DTO are defined by name, properties, references and wrapper methods. A DTO normally does not implement business logic.
+DTOs are defined by name, properties, references and wrapper methods. A DTO normally does not implement business logic.
 For each DTO that is defined in a package, the DTO DSL automatically generates a Java DTO class and a corresponding mapper class that handles data transfer and conversion between DTO and entity.

← Older revision		Revision as of 19:20, 4 April 2017
Line 1:		Line 1:
−	~~==Copyright Notice==~~

−	~~{{Copyright Notice}}~~

	==Purpose==		==Purpose==
Line 257:		Line 255:

	[[File:dto-19.png\|center\|frame\|''Figure 19 - A comment before the <code>package</code> keyword ends up in all generated Java classes (DTO and mapper classes).'']]		[[File:dto-19.png\|center\|frame\|''Figure 19 - A comment before the <code>package</code> keyword ends up in all generated Java classes (DTO and mapper classes).'']]
		+	==Copyright Notice==
		+
		+	{{Copyright Notice}}

@@ Line 252: / Line 252: @@
-[[File:dto-18.png|center|frame|''Figure 18 - The comments added in the DTO DSL are transformed to Java-style comments in the generated code.'']]
+[[File:dto-18.png|center|frame|''Figure 18 - The comments added in the DTO DSL are transformed into Java-style comments in the generated code.'']]
 Comments before the <code>package</code> keyword are copied over to all generated Java classes - this is the place for copyright notices.
 [[File:dto-19.png|center|frame|''Figure 19 - A comment before the <code>package</code> keyword ends up in all generated Java classes (DTO and mapper classes).'']]

@@ Line 235: / Line 235: @@
 ==Operations==
-The DTO DSL supports the declaration of operations that can be performed within the DTOs. These operations are based on Xbase and offer a huge set of semantic features, extending the featureset of Java. Xbase additionally offers features like closures. When using operations, bear in mind that it is no good practice to implement business logic within DTOs. Operations can be declared by the <code>def</code> keyword followed by braces containing the inlined operation.
+The DTO DSL supports the declaration of operations that can be performed within the DTOs. These operations are based on Xbase and offer a huge set of semantic features, extending the featureset of Java. Xbase additionally offers features like closures. When using operations, bear in mind that it is not good practice to implement business logic within DTOs. Operations can be declared by the <code>def</code> keyword followed by braces containing the inline operation.
 ► Syntax:
@@ Line 245: / Line 245: @@
 </syntaxhighlight>
-[[File:dto-17.png|center|frame|''Figure 17 - The <code>def</code> keyword allows the inlining of custom methods in the DTO DSL code. These methods are translated to the appropriate Java methods.'']]
+[[File:dto-17.png|center|frame|''Figure 17 - The <code>def</code> keyword allows the inlining of custom methods in the DTO DSL code. These methods are translated into the appropriate Java methods.'']]
 ==Comments==

@@ Line 216: / Line 216: @@
 The DTO DSL provides a mechanism for creating custom mappers between DTOs and entities. These can be defined after the declaration of a property or reference, and they control the information exchange for the respective feature.
-In order to create a custom mapper, the <code>toDTO</code> and <code>fromDTO</code> keywords are used, followed by the mapper definition in curly braces. <code>toDTO</code> controls the flow of information from entity to DTO, <code>fromDTO</code> vice versa. Within the curly braces, the special words <code>in</code> and <code>out</code> may be used to reference source and destination of the mapping.
+In order to create a custom mapper, the <code>toDTO</code> and <code>fromDTO</code> keywords are used, followed by the mapper definition in curly braces. <code>toDTO</code> controls the flow of information from entity to DTO, <code>fromDTO</code> vice versa. Within the curly braces, the special words <code>in</code> and <code>out</code> may be used to reference the source and destination of the mapping.
 ► Syntax:
@@ Line 231: / Line 231: @@
 </syntaxhighlight>
-[[File:dto-16.png|center|frame|''Figure 16 - The <code>toDto</code> section creates a custom mapping from entity to DTO: First a local variable <code>ArrayList</code> is created, then an InfoDetail with a disclaimer is added to each entry. The <code>in</code> keyword is used to reference the entity for the iteration.'']]
+[[File:dto-16.png|center|frame|''Figure 16 - The <code>toDto</code> section creates a custom mapping from entity to DTO: First, a local variable <code>ArrayList</code> is created, then an InfoDetail with a disclaimer is added to each entry. The <code>in</code> keyword is used to reference the entity for the iteration.'']]
 ==Operations==

@@ Line 214: / Line 214: @@
 ==Custom Mappers==
-The DTO DSL provides a mechanism for creating custom mappers between DTOs and entities. These can be defined after the declaration of a property or reference and control the information exchange for the respective feature.
+The DTO DSL provides a mechanism for creating custom mappers between DTOs and entities. These can be defined after the declaration of a property or reference, and they control the information exchange for the respective feature.
-In order to create a custom mapper, the <code>toDTO</code> and <code>fromDTO</code> keywords are used, followed by the mapper definition in curly braces. <code>toDTO</code> controls the flow of information from entity to DTO, <code>fromDTO</code> vice versa. Within the curly braces, the special words in and out may be used to reference source and destination of the mapping.
+In order to create a custom mapper, the <code>toDTO</code> and <code>fromDTO</code> keywords are used, followed by the mapper definition in curly braces. <code>toDTO</code> controls the flow of information from entity to DTO, <code>fromDTO</code> vice versa. Within the curly braces, the special words <code>in</code> and <code>out</code> may be used to reference source and destination of the mapping.
 ► Syntax:

@@ Line 210: / Line 210: @@
 <br>
-[[File:dto-15.png|center|frame|''Figure 15 - The <code>inherit ref</code> keyword allows for mapping entity references to DTO references. Content assist is available, and multiplicities and opposite references are automatically carried over from the entity model file. The <code>mapto</code> keyword indicates the DTO that serves as the other end of the reference.'']]
+[[File:dto-15.png|center|frame|''Figure 15 - The <code>inherit ref</code> keywords allow for mapping entity references to DTO references. Content assist is available, and multiplicities and opposite references are automatically carried over from the entity model file. The <code>mapto</code> keyword indicates the DTO that serves as the other end of the reference.'']]
 ==Custom Mappers==

@@ Line 195: / Line 195: @@
 There are two types of inherited features: inherited properties and inherited references.
-Inherited features are defined by the <code>inherit</code> keyword followed by the feature type and the name of the feature in the entity. After that, the DTO a referenced entity or an embedded bean is mapped to may be specified using the <code>mapto</code> keyword.
+Inherited features are defined by the <code>inherit</code> keyword followed by the feature type and the name of the feature in the entity. After that, the DTO to which a referenced entity or an embedded bean is mapped may be specified using the <code>mapto</code> keyword.
 Finally, custom mapper directives may be specified (see [[#Custom Mappers|Custom Mappers]]).
 *'''inherit var''': used for mapping entity properties to DTO properties

@@ Line 206: / Line 206: @@
 </syntaxhighlight>
-[[File:dto-14.png|center|frame|''Figure 14 - The <code>inherit</code> var keyword is used to map entity properties to DTO properties. Content assist is available. The mapto keyword specifies which DTO an embedded bean is mapped to.'']]
+[[File:dto-14.png|center|frame|''Figure 14 - The <code>inherit</code> var keyword is used to map entity properties to DTO properties. Content assist is available. The <code>mapto</code> keyword specifies which DTO an embedded bean is mapped to.'']]
 <br>

@@ Line 184: / Line 184: @@
 **<code>[1..*]</code> defines a non-nullable, one-to-many relationship. An <code>opposite</code> reference is required.
 **<code>[0..*]</code>, or simply <code>[*]</code>, defines a nullable, one-to-many relationship. An <code>opposite</code> reference is required.
-*'''opposite reference''': In the [[Entity DSL]], lifecycle references between entities need the specification of an opposite reference in order to navigate back to the original object after following the reference. The DTO DSL includes a mechanism to map such references using the opposite keyword.
+*'''opposite reference''': In the [[Entity DSL]], lifecycle references between entities need the specification of an <code>opposite</code> reference in order to navigate back to the original object after following the reference. The DTO DSL includes a mechanism to map such references using the <code>opposite</code> keyword.
-*'''cascade''': The cascade specifier controls the behaviour of the database on delete operations. In the DTO DSL, these cascading references can be mapped to DTOs by the same keyword.
+*'''cascade''': The cascade specifier controls the behavior of the database on delete operations. If <code>cascade</code> is specified, dependent records are also deleted. In the DTO DSL, these cascading references can be mapped to DTOs by the same keyword.
-[[File:dto-13.png|center|frame|''Figure 13 - An example of two DTOs referencing each other. The second DTO aps a cascading non-nullable to-many reference.'']]
+[[File:dto-13.png|center|frame|''Figure 13 - An example of two DTOs referencing each other. The second DTO maps a cascading, non-nullable, one-to-many reference.'']]
 ==Inherited Features==