stefan-ka
commented
3 years ago Hi @sunilk-m, thanks for reporting!
I'm not sure if we should go for such a generic solution since the tactic DDD syntax is based on Sculptor and already supports many of your needs (let me know if I'm wrong).
It is possible to define the database table name as follows:
Entity Customer {
aggregateRoot
databaseTable = "Customer" // see here
String firstname
String lastname
}... its also possible to define the column name on attribute level:
Entity Customer {
aggregateRoot
databaseTable = "Customer" // see here
String firstname databaseColumn = "firstname"
String lastname databaseColumn = "lastname"
}As you can see here the attribute rule supports other keywords such as required, nullable, notChangeable, etc. The only thing that is not available is unique.
Maybe we could just add a corresponding unique keyword? Would that be sufficient or do you have other requirements that are missing @sunilk-m? I get the idea of the generic solution that would allow adding any arbitrary additional attributes but I want to challenge if its really needed. What do you think @socadk?
sunilk-m
socadk
StevenVanDijk
Annotation provide the ability to extend the language without having to modify the grammer and can be very valuable for generating code from the model by providing the appropriate guidance to the generator. It should be possible to add annotation to any element in the model. The example below describes in more detail. From the model we can provide the annotation as shown below. The @Table/@Document can be used on Entity and if JPA classes are generated then it can be used to drive the generator to generate the appropriate annotation on the JPA class. Similarly the @Unique annotation can be used to mark an attribute as unique. The corresponding attribute in the generated JPA class will be marked as unique. To define a combination of unique attribute we can use @Unique annotation with the same name.
BoundedContext VendorManagement { .... Aggregate Vendor { @Table/@Document(name="vendors") Entity Vendor { String id key @Unique(name= "") String name String description } } ... }
The corresponding generated JPA class might look like this in case of table @Entity public class Vendor { ... @Id private String id; @Column(unique=true) private String name; private String description; ... }
The corresponding generated JPA class might look like this in case of Document (eg Arangodb) @Document("vendors") public class Vendor { ... @Id private String id; private String name; private String description; ... } These are basic examples, in case of graph db storage we can also define entities as nodes and edges to define the vertices and edges by using appropriate stereotypes.
In order to support annotations, context mapper grammer will have to be enhanced to define annotations on each of the modeling elements. The supported annotation should be defined separately in a different file which can be reused across teams and can also be used to validate the usage. The annotation can be defined using the following format <name>
This information can be used for validations also.
An option should also be provided to hide the annotation by default and can be displayed only if user is interested in viewing those details
Alternative is to specify this externally as additional metadata information to guide the generator but this leads to duplication which can be avoided by providing support in the tool itself.