DTO Service DSL - Revision history

Yang: /* package definition */

2017-11-23T14:03:18Z

‎package definition

Yang: /* package definition */

2017-11-23T14:00:54Z

‎package definition

Yang: /* DTO Service DSL */

2017-11-23T14:00:41Z

‎DTO Service DSL

Yang: /* package definition */

2017-11-23T13:59:52Z

‎package definition

Yang: /* package definition */

2017-11-23T11:50:55Z

‎package definition

Yang: Created page with "== Introduction == Dto Service model works for the DTO when it needs to communicate with persistence unit. All necessary information about the persistence which is not define..."

2017-11-23T10:38:34Z

Created page with "== Introduction == Dto Service model works for the DTO when it needs to communicate with persistence unit. All necessary information about the persistence which is not define..."

New page

== Introduction ==

Dto Service model works for the DTO when it needs to communicate with persistence unit. All necessary information about the persistence which is not defined in DTO model will be read here.

== DTO Service DSL ==
The DTO Sevice model is automatically generated when DTO has been defined. It defines which persistence unit the DTO should communicate with and self-defined select-clause can also be defined here.

The main semantic elements of the DTO Service DSL are:
*'''package''' - The root element that contains all the other elements. A model can contain multiple packages.
*'''dtoservice''' - define the DTO service name and which DTO it serves to .
*'''mutable persistenceUnit''' - define the persistence Unit, which the DTO will communicate with.
*'''def''' - define the java function with dto parameter for the service.

====Syntax====

=====package definition=====

► '''Syntax''':
<syntaxhighlight lang="java">
package <service name> {
dtoservice <dtoservice name> provides <dto name> {
mutable persistenceUnit <persistenceUnit name>

[def <jvmType> <function name> (<dtotype name> <var name> )
{<block expression>}
]
}
. . .
}

</syntaxhighlight>

► '''Example''':
<syntaxhighlight lang="java">
package net.osbee.sample.foodmart.dtos.service {
dtoservice McurrencyNameStreamDtoService provides McurrencyNameStreamDto{
mutable persistenceUnit businessdata
}

dtoservice CashSlipDtoService provides CashSlipDto {
mutable persistenceUnit businessdata

def double calcTotal( CashSlipDto slip ) {
val ql = createJPQL( "select sum(p.price) from CashSlipPosition p where p.slip.id = :headerUUID"
, # {"headerUUID" -> slip.^id} )
val result = this.findValues( ql )
return result.get( 00 ) as Double
}

}
}

</syntaxhighlight>

* For every dtoservice, a new .java files will be generated, <dtoservice name>.java. This .java files is generated in folder ./src-gen/<package name>/.
In this file, a java class extended from AbstractDTOServiceWithMutablePersistence named of <dtoservice name> will be generated.

* In the self-defined java function, you can define any database select-clause as you want.

== Copyright Notice ==
{{Copyright Notice}}

@@ Line 35: / Line 35: @@
    In this file, a java class extended from AbstractDTOServiceWithMutablePersistence named of <dtoservice name> will be generated：
    This java class defines the '''EntityManagerFactory''', it is used to support instantiation of '''EntityManager'''.
-   An EntityManager instance is associated with a persistence context.
+   An '''EntityManager''' instance is associated with a '''persistence context'''.
-   A persistence context is a set of entity instances in which for any persistent entity identity there is a unique entity instance. Within the persistence context, the entity instances and their lifecycle are managed.
+   A '''persistence context''' is a set of entity instances in which for any '''persistent entity''' identity there is a unique entity instance. Within the '''persistence context''', the entity instances and their lifecycle are managed.
-   The EntityManager API is used to create and remove persistent entity instances, to find entities by their primary key, and to query over entities.
+   The '''EntityManager''' API is used to create and remove persistent entity instances, to find entities by their primary key, and to query over entities. The set of entities that can be managed by a given '''EntityManager''' instance is defined by a '''persistence unit'''.
-  The set of entities that can be managed by a given EntityManager instance is defined by a persistence unit.
+   A '''persistence unit''' defines the set of all classes that are related or grouped by the application, and which must be co-located in their mapping to a single database.
-   A persistence unit defines the set of all classes that are related or grouped by the application, and which must be colocated in their mapping to a single database.

@@ Line 34: / Line 34: @@
 * For every dtoservice, a new .java files will be generated, <dtoservice name>.java. This .java files is generated in folder ./src-gen/<package name>/.
    In this file, a java class extended from AbstractDTOServiceWithMutablePersistence named of <dtoservice name> will be generated：
-   This java class defines the 'EntityManagerFactory', it is used to support instantiation of 'EntityManager'.
+   This java class defines the '''EntityManagerFactory''', it is used to support instantiation of '''EntityManager'''.
    An EntityManager instance is associated with a persistence context.
    A persistence context is a set of entity instances in which for any persistent entity identity there is a unique entity instance. Within the persistence context, the entity instances and their lifecycle are managed.

@@ Line 34: / Line 34: @@
 * For every dtoservice, a new .java files will be generated, <dtoservice name>.java. This .java files is generated in folder ./src-gen/<package name>/.
    In this file, a java class extended from AbstractDTOServiceWithMutablePersistence named of <dtoservice name> will be generated：
-   This java class defines the EntityManagerFactory, it is used to support instantiation of EntityManager.
+   This java class defines the 'EntityManagerFactory', it is used to support instantiation of 'EntityManager'.
    An EntityManager instance is associated with a persistence context.
    A persistence context is a set of entity instances in which for any persistent entity identity there is a unique entity instance. Within the persistence context, the entity instances and their lifecycle are managed.

@@ Line 33: / Line 33: @@
 * For every dtoservice, a new .java files will be generated, <dtoservice name>.java. This .java files is generated in folder ./src-gen/<package name>/.
-   In this file, a java class extended from AbstractDTOServiceWithMutablePersistence named of <dtoservice name> will be generated.
+   In this file, a java class extended from AbstractDTOServiceWithMutablePersistence named of <dtoservice name> will be generated：
-   This java class defines the EntityManagerFactory, it is used  to support instantiation of EntityManager .
+   This java class defines the EntityManagerFactory, it is used to support instantiation of EntityManager.
    An EntityManager instance is associated with a persistence context.
    A persistence context is a set of entity instances in which for any persistent entity identity there is a unique entity instance. Within the persistence context, the entity instances and their lifecycle are managed.

@@ Line 30: / Line 30: @@
 </syntaxhighlight>
 ► '''Example''':
@@ Line 52: / Line 65: @@
 </syntaxhighlight>
 == Copyright Notice ==
 {{Copyright Notice}}