AppUpIn5Extensions - Revision history

Worayeno at 10:27, 23 January 2018

2018-01-23T10:27:43Z

Worayeno: /* Reference */

2018-01-23T09:40:22Z

‎Reference

Worayeno: /* Reference */

2018-01-23T09:19:48Z

‎Reference

Worayeno: /* Metadata options */

2018-01-23T09:13:32Z

‎Metadata options

Worayeno: /* AppUpIn5 - Extensions 1.0 */

2018-01-23T09:11:13Z

‎AppUpIn5 - Extensions 1.0

Worayeno: /* AppUpIn5 - Extensions 1.0 */

2018-01-23T09:10:29Z

‎AppUpIn5 - Extensions 1.0

Worayeno: /* Id */

2018-01-23T08:51:23Z

‎Id

Worayeno: /* AppUpIn5 - Extensions 1.0 */

2018-01-23T08:49:20Z

‎AppUpIn5 - Extensions 1.0

Worayeno at 16:51, 22 January 2018

2018-01-22T16:51:33Z

Show changes

Worayeno: /* AppUpIn5 - Extensions 1.0 */

2018-01-22T16:22:25Z

‎AppUpIn5 - Extensions 1.0

@@ Line 17: / Line 17: @@
 You get access to those new functionalities by opening a csv file with the CSV2App module editor of the OS.bee Software Factory, and by making a left mouse click on the column you wish to edit the metadata from.
-<br>[[File:Brandtype.png|none|frame|''Figure 1: Brandtype.csv im CSV2 Editor'']]<br>
+<br>[[File:Brandtype.png|none|frame|''Figure 1: Brandtype.csv in CSV2 Editor'']]<br>
 The settings dialog of the corresponding column will then appear. The several options provided in this dialog are organized in two parts: the meta data section and the sorting section.
@@ Line 36: / Line 36: @@
-(1) By selecting the ''ID'' checkbox, (2) and then pressing the OK button, the user set the column ''id'' as the ''ID''-column of the entity created later on, like shown on the figure below. Each entity has always one UUID attribute, therefore each csv file must have one ''ID''-column. The generated code later on will look like this snippet on figure 4.
+(1) By selecting the ''ID'' checkbox, (2) and then pressing the OK button, the user set the column ''id'' as the ''ID''-column of the entity created later on, like shown on the figure below. Each entity has always one UUID attribute. Therefore each csv file must have one ''ID''-column. The generated code later on will look like this snippet on figure 4.
 <br>[[File:Brandtypeid.png|frame|none|''Figure 4: Entity dsl model - "id" attribute of Brandtype'']]<br>
@@ Line 67: / Line 67: @@
-Besides the fact that here 1-n relations are created between entities, a reference attribute will also be generated in each entity. This is needed in order to show the information data of each relation graphically (here as table) in the application interface. This is characterized by the use of a <code>properties{...}</code> block.
+Besides the fact that here 1-n relations are created between entities, a reference attribute will also be generated in each one of them. This is needed in order to show the information data of each relation graphically (here as table) in the application interface. This is characterized by the use of a <code>properties{...}</code> block.
 ===Domain key===
@@ Line 76: / Line 76: @@
 In the case of the entity ''Brandtype'', an adequate candidate for the domain key is the column ''brandTypeNm'' containing the names of brand types, which are easy for users to read and identify data from in the application later on.
-(1) By selecting the domain key checkbox, (2) and then pressing the OK button, the user define the column ''brandTypeNm'' as the domain key column of the entity Brandtype.
+(1) By selecting the domain key checkbox, (2) and then pressing the OK button, the user defines the column ''brandTypeNm'' as the domain key column of the entity Brandtype.
 <br>[[File:Brandtypenm.png|frame|none|''Figure 10:  Settings dialog column "brandTypeNm" of Brandtype'']]<br>
-This results into the creation of the domain key attribute of the entity ''Brandtype'' as shown on the figure below.
+The result is the creation of the domain key attribute of the entity ''Brandtype'' as shown on the figure below.
 <br>[[File:BrandtypenmEntity.png|frame|none|''Figure 11: Domain key in entity dsl model'']]<br>
@@ Line 87: / Line 87: @@
 ===Media data===
-The media data option allows the user to define a column as a multimedia column. It allows user to specify from which columns information can be gathered from, in order to create the appropiate structures to store and upload any type of files in your application. This type of column contains the filenames of the multimedia files without extension. In addition to both the mime type and the extension, the user has also to define the directory path, where those files are located.
+The media data option allows the user to define a column as a multimedia column. It allows user to specify from which columns information can be gathered from, in order to create the appropriate structures to store and upload any type of files in your application. This type of column contains the filenames of the multimedia files without extension. In addition to both the mime type and the extension, the user has also to define the directory path, where those files are located.
 <br>[[File:Mediadata.png|thumb|600px|none|''Figure 12: Media data section'']]<br>
@@ Line 97: / Line 97: @@
-The user can not just select one of the predefined extension formats (bmp, csv, jpg, mp3, pdf, txt, xml), but also edit an extension format on his own (java or sql...).
+The user can not just select one of the predefined extension formats (bmp, csv, jpg, mp3, pdf, txt, xml), but also edit an extension format on his own (java or sql ...).
 <br>[[File:Mediadata5.png|thumb|600px|none|''Figure 14: Extensions'']]<br>
@@ Line 120: / Line 120: @@
 ==General Notice==
-As soon as the user press the button "Create App", an error message will eventually be displayed to inform the user to complete or adapt the metadata configuration of the considered csv file.
+As soon as the user press the button "Create App", an error message will eventually be displayed to inform the user to complete or adapt the meta data configuration of the considered csv file.
-* '''Please note that a proper configuration of column definitions has to be done by the user as soon as id, reference or domain keys candidates have been detected.''' Candidates are columns of a csv file, which meet the criteria for either an id, a reference (both from alphanumerical string with UUID format as described above) or a domain key column. Setting the metadata of those columns is then '''mandatory'''.
+* '''Please note that a proper configuration of column definitions has to be done by the user as soon as id, reference or domain keys candidates have been detected.''' Candidates are columns of a csv file, which meet the criteria for either an id, a reference (both from alphanumerical string with UUID format as described above) or a domain key column. Setting the meta data of those columns is then '''mandatory'''.
@@ Line 131: / Line 131: @@
-Further information over the usage of metadata such as '''id''', '''reference''' and '''domain key''' can be found in the [[Entity DSL]] documentation page.
+Further information over the usage of meta data such as '''id''', '''reference''' and '''domain key''' can be found in the [[Entity DSL]] documentation page.
 ==Sorting options==

@@ Line 59: / Line 59: @@
 The result of this relation at the end of the app creation would then look like this.
-<br>[[File:RefBrandtypeId1.png|thumb|600px|none|''Figure 8: Reference result on "brandTypeId"'']]<br>
+<br>[[File:Refbrandtypenormal.png|thumb|600px|none|''Figure 8: Reference result on "brandTypeId"'']]<br>
 The optional tag <code>cascade</code> allows, when selected, the deletion of all elements of the n-side of the relation, when the one-side element is deleted. In our example, the removal of one brand type would then result to the deletion of all the brands categorized by that type. The generated relation would then look like this in contrast to last example.
-<br>[[File:RefBrandtypeId2.png|thumb|600px|none|''Figure 9: Reference result on "brandTypeId"'']]<br>
+<br>[[File:Refbrandtypecascade.png|thumb|600px|none|''Figure 9: Reference result on "brandTypeId" with cascade'']]<br>

← Older revision		Revision as of 09:19, 23 January 2018
Line 49:		Line 49:
	For instance, we would like to create a reference between the entity ''Brandtype'' and the new entity to be created ''Brand'', whose csv file contains the ''brandTypeId'' as column. As you can see on the left side of figure 6, showing the content of the entity dsl model file, the entity ''Brandtype'' has already been created.		For instance, we would like to create a reference between the entity ''Brandtype'' and the new entity to be created ''Brand'', whose csv file contains the ''brandTypeId'' as column. As you can see on the left side of figure 6, showing the content of the entity dsl model file, the entity ''Brandtype'' has already been created.

−	<br>[[File:~~RefEntityBrand~~.png\|thumb\|600px\|none\|''Figure 6: Entity model file and Brand.csv file.'']]<br>	+	<br>[[File:RefEntBrand.png\|thumb\|600px\|none\|''Figure 6: Entity model file and Brand.csv file.'']]<br>

@@ Line 33: / Line 33: @@
 With a left mouse click on the column named ''id'' of the csv file ''BrandType.csv'', the user opens the settings dialog of this column.
-<br><br>[[File:SettingsID.png|frame|none|''Figure 3: Settings dialog column "id" of Brandtype'']]
+<br>[[File:SettingsID.png|frame|none|''Figure 3: Settings dialog column "id" of Brandtype'']]<br>
 (1) By selecting the ''ID'' checkbox, (2) and then pressing the OK button, the user set the column ''id'' as the ''ID''-column of the entity created later on, like shown on the figure below. Each entity has always one UUID attribute, therefore each csv file must have one ''ID''-column. The generated code later on will look like this snippet on figure 4.
-<br><br>[[File:Brandtypeid.png|frame|none|''Figure 4: Entity dsl model - "id" attribute of Brandtype'']]
+<br>[[File:Brandtypeid.png|frame|none|''Figure 4: Entity dsl model - "id" attribute of Brandtype'']]<br>
 ===Reference===
 With the reference option you are able to set column data as reference data (or foreign key) pointing to the ''Universal Unique Identifier'' (primary key) of another '''already existing entity'''. These data are also alphanumerical values, as mentioned in the section above concerning the id-option.
-<br><br>[[File:RefArea.png|frame|none|''Figure 5: Reference area.'']]
+<br>[[File:RefArea.png|frame|none|''Figure 5: Reference area.'']]<br>
-−
 A reference column results into the creation of a 1-n relation between the new entity, which will be created on the basis of the considered csv file and the referenced entity, which already exists in the entity model file of your project. The condition of having this target entity to be referenced on already existing in the model translates into a specific '''order of execution''' of the application creation:  successively pressing the button ''Create App'' in the right order to be able to choose the target entity.
@@ Line 50: / Line 49: @@
 For instance, we would like to create a reference between the entity ''Brandtype'' and the new entity to be created ''Brand'', whose csv file contains the ''brandTypeId'' as column. As you can see on the left side of figure 6, showing the content of the entity dsl model file, the entity ''Brandtype'' has already been created.
-<br><br>[[File:RefEntityBrand.png|thumb|600px|none|''Figure 6: Entity model file and Brand.csv file.'']]
+<br>[[File:RefEntityBrand.png|thumb|600px|none|''Figure 6: Entity model file and Brand.csv file.'']]<br>
 (1) By selecting the reference checkbox, (2) selecting ''Brandtype'' in the list of all existing entities, (3) and then by pressing the OK button, the user set the column ''brandTypeId'' as a reference key pointing to the UUID of the entity ''Brandtype''.
-<br><br>[[File:RefBrandtypeId.png|thumb|600px|none|''Figure 7: Settings dialog column "brandTypeId" of Brand'']]
+<br>[[File:RefBrandtypeId.png|thumb|600px|none|''Figure 7: Settings dialog column "brandTypeId" of Brand'']]<br>
 The result of this relation at the end of the app creation would then look like this.
-<br><br>[[File:RefBrandtypeId1.png|thumb|600px|none|''Figure 8: Reference result on "brandTypeId"'']]
+<br>[[File:RefBrandtypeId1.png|thumb|600px|none|''Figure 8: Reference result on "brandTypeId"'']]<br>
-−
 The optional tag <code>cascade</code> allows, when selected, the deletion of all elements of the n-side of the relation, when the one-side element is deleted. In our example, the removal of one brand type would then result to the deletion of all the brands categorized by that type. The generated relation would then look like this in contrast to last example.
-<br><br>[[File:RefBrandtypeId2.png|thumb|600px|none|''Figure 9: Reference result on "brandTypeId"'']]
+<br>[[File:RefBrandtypeId2.png|thumb|600px|none|''Figure 9: Reference result on "brandTypeId"'']]<br>
-−
@@ Line 81: / Line 78: @@
 (1) By selecting the domain key checkbox, (2) and then pressing the OK button, the user define the column ''brandTypeNm'' as the domain key column of the entity Brandtype.
-<br><br>[[File:Brandtypenm.png|frame|none|''Figure 10:  Settings dialog column "brandTypeNm" of Brandtype'']]
+<br>[[File:Brandtypenm.png|frame|none|''Figure 10:  Settings dialog column "brandTypeNm" of Brandtype'']]<br>
-−
 This results into the creation of the domain key attribute of the entity ''Brandtype'' as shown on the figure below.
-<br><br>[[File:BrandtypenmEntity.png|frame|none|''Figure 11: Domain key in entity dsl model'']]
+<br>[[File:BrandtypenmEntity.png|frame|none|''Figure 11: Domain key in entity dsl model'']]<br>
@@ Line 93: / Line 89: @@
 The media data option allows the user to define a column as a multimedia column. It allows user to specify from which columns information can be gathered from, in order to create the appropiate structures to store and upload any type of files in your application. This type of column contains the filenames of the multimedia files without extension. In addition to both the mime type and the extension, the user has also to define the directory path, where those files are located.
-<br><br>[[File:Mediadata.png|thumb|600px|none|''Figure 12: Media data section'']]
+<br>[[File:Mediadata.png|thumb|600px|none|''Figure 12: Media data section'']]<br>
 The currently supported mime types are the following: plain, jpg, mpeg, octetstream and pdf.
-<br><br>[[File:Mediadata4.png|thumb|600px|none|''Figure 13: Mimetypes'']]
+<br>[[File:Mediadata4.png|thumb|600px|none|''Figure 13: Mimetypes'']]<br>
 The user can not just select one of the predefined extension formats (bmp, csv, jpg, mp3, pdf, txt, xml), but also edit an extension format on his own (java or sql...).
-<br><br>[[File:Mediadata5.png|thumb|600px|none|''Figure 14: Extensions'']]
@@ Line 110: / Line 107: @@
 Only columns containing text data can be defined as media data column by the user.
-<br><br>[[File:Mediadata1.png|thumb|600px|none|''Figure 15: Media data on column "bsin"'']]
+<br>[[File:Mediadata1.png|thumb|600px|none|''Figure 15: Media data on column "bsin"'']]<br>
 The column ''bsin'' of the entity Brand contains media file name. Besides being provided with the Brand.csv file, we also have the corresponding jpg-files illustrated here in figure 16.
-<br><br>[[File:Mediadata2.png|thumb|600px|none|''Figure 16: Media file location'']]
+<br>[[File:Mediadata2.png|thumb|600px|none|''Figure 16: Media file location'']]<br>
 After opening the settings dialog of the column ''bsin'', (1) the user needs first to select the media data checkbox, which allows the modification of the information needed. (2) The user sets the path directory with the help of directory chooser, which appears after pressing the Path button and then selects the directory, in which the files are located. (3) The mime type and extension of the files have to be chosen within the corresponding combo boxes. (4) After pressing the OK button, the user sets the column ''bsin'' as a multimedia column. This will then result into the creation of both attributes ''bsin'' and ''bsinmedia'' of the entity Brand later on, as shown below.
-<br><br>[[File:Mediadata3.png|thumb|600px|none|''Figure 17: Blobmapping attribute in entity Brand'']]
+<br>[[File:Mediadata3.png|thumb|600px|none|''Figure 17: Blobmapping attribute in entity Brand'']]<br>
-−
 ==General Notice==

@@ Line 17: / Line 17: @@
 You get access to those new functionalities by opening a csv file with the CSV2App module editor of the OS.bee Software Factory, and by making a left mouse click on the column you wish to edit the metadata from.
-<br><br>[[File:Brandtype.png|none|frame|''Figure 1: Brandtype.csv im CSV2 Editor'']]
+<br>[[File:Brandtype.png|none|frame|''Figure 1: Brandtype.csv im CSV2 Editor'']]<br>
 The settings dialog of the corresponding column will then appear. The several options provided in this dialog are organized in two parts: the meta data section and the sorting section.
-<br><br>[[File:Settingdialog.png|frame|none|''Figure 2: Settings dialog of column "id"'']]
+<br>[[File:Settingdialog.png|frame|none|''Figure 2: Settings dialog of column "id"'']]<br>
 The sorting options are always available to the user, whereas the meta data options are only available based on the analysis of the type of data contained in the selected column.

@@ Line 20: / Line 20: @@
 The setting dialog of the corresponding column will appear and several options will be available for you to choose, based on the analysis of the type of data contained in this column and the configurations you would have made so far.
-<br><br>[[File:Brandtype1.png|frame|none|''Figure 2: Settings dialog of column "id"'']]
+<br><br>[[File:Settingdialog.png|frame|none|''Figure 2: Settings dialog of column "id"'']]
 ==Metadata options==

@@ Line 15: / Line 15: @@
 == ''AppUpIn5 - Extensions 1.0'' ==
-You get access to those new functionalities by opening a csv file with the CSV2App module editor of the OS.bee Software Factory, and by making a left mouse click on the column you wish to edit the metadata from.[[File:Brandtype.png|left|frame|''Figure 1: Brandtype.csv im CSV2 Editor'']]<br><br><br><br><br><br><br><br><br><br><br><br><br>
+You get access to those new functionalities by opening a csv file with the CSV2App module editor of the OS.bee Software Factory, and by making a left mouse click on the column you wish to edit the metadata from.<br><br>[[File:Brandtype.png|left|frame|''Figure 1: Brandtype.csv im CSV2 Editor'']]<br><br><br><br><br><br><br><br><br><br><br><br><br>
-The setting dialog of the corresponding column will appear and several options will be available for you to choose, based on the analysis of the type of data contained in this column and the configurations you would have made so far.[[File:Brandtype1.png|frame|left|''Figure 2: Settings dialog of column "id"'']]<br><br><br><br><br><br><br><br><br><br><br><br><br>
+The setting dialog of the corresponding column will appear and several options will be available for you to choose, based on the analysis of the type of data contained in this column and the configurations you would have made so far.<br><br>[[File:Brandtype1.png|frame|left|''Figure 2: Settings dialog of column "id"'']]<br><br><br><br><br><br><br><br><br><br><br><br><br>
 ==Metadata options==