1
|
<?xml version="1.0" encoding="UTF-8"?>
|
2
|
<de:comments xmlns:de="http://de.tukl.softech.agileReview">
|
3
|
<de:author name="mafju"/>
|
4
|
<de:files>
|
5
|
<de:project name="icm-iis-transformers">
|
6
|
<de:folder name="src">
|
7
|
<de:folder name="main">
|
8
|
<de:folder name="resources">
|
9
|
<de:folder name="eu">
|
10
|
<de:folder name="dnetlib">
|
11
|
<de:folder name="iis">
|
12
|
<de:folder name="transformers">
|
13
|
<de:folder name="documentssimilarity">
|
14
|
<de:folder name="oozie_app">
|
15
|
<de:file name="workflow.xml">
|
16
|
<de:comment id="c0" author="mafju" reviewID="2013-12-06 transformer for documentssimilarity" creation-date="2013-12-06T11:02:26.857+01:00" last-modified="2013-12-10T15:53:27.200+01:00" priority="0" recipient="micon" status="1" revision="0">
|
17
|
<de:text>Adding the
|
18
|
|
19
|
<delete path="${nameNode}${workingDir}/output_document_metadata" />
|
20
|
|
21
|
line is redundant since the output should be parametrized and it will be deleted by a parent workflow that binds the parameter to a concrete path.</de:text>
|
22
|
<de:replies/>
|
23
|
</de:comment>
|
24
|
<de:comment id="c1" author="mafju" reviewID="2013-12-06 transformer for documentssimilarity" creation-date="2013-12-06T12:41:37.681+01:00" last-modified="2013-12-10T16:46:18.968+01:00" priority="0" recipient="micon" status="1" revision="0">
|
25
|
<de:text>I would consider changing the name of the input port "extracted_document_metadata_merged_with_original" to a shorter one, e.g. "document_metadata"</de:text>
|
26
|
<de:replies>
|
27
|
<de:reply author="micon" creation-date="2013-12-10T15:48:45.241+01:00">That's a good point. Though I would leave it as it is beacuse the corresponence with a class name can be clearly seen. Also the anti-boilerplate generator of workflows would generate names of variables directly from the given class names.</de:reply>
|
28
|
<de:reply author="mafju" creation-date="2013-12-10T16:06:09.028+01:00">On the other hand:
|
29
|
|
30
|
1) The name of the parameter is like argument passed to a function, and the name of the schema/class is like the type of the parameter passed to a function. The first one describes how the object is used in the context of this function (workflow node), the second one gives a more global context. There is no need to make them them the same, e.g. a function `generate_ID` might accept two parameters of the same type: `name: String`, `surname: String`.
|
31
|
|
32
|
2) The information encoded in the name of the class/schema is encoded in 2 places: name of the schema, name of the variable. This is a violation of the DRY principle.
|
33
|
|
34
|
3) Even when the code is generated automatically, we should strive to make it clean and readable.</de:reply>
|
35
|
<de:reply author="micon" creation-date="2013-12-10T16:30:44.502+01:00">Agreed. Fixed.
|
36
|
|
37
|
There could be an *optional* <variable-name> tag, when not present, then the name would be generated from the class name.</de:reply>
|
38
|
</de:replies>
|
39
|
</de:comment>
|
40
|
<de:comment id="c2" author="mafju" reviewID="2013-12-06 transformer for documentssimilarity" creation-date="2013-12-06T12:46:57.369+01:00" last-modified="2013-12-10T15:56:42.726+01:00" priority="0" recipient="micon" status="1" revision="0">
|
41
|
<de:text>According to the current (sadly not explicitly stated) customs, the workflow should specify its parameters in the <parameters> secton at the beginning of the file.</de:text>
|
42
|
<de:replies>
|
43
|
<de:reply author="micon" creation-date="2013-12-10T15:46:24.976+01:00">It was a hack to make the workflow run. Paths were hard-coded instead. Fixed now.</de:reply>
|
44
|
</de:replies>
|
45
|
</de:comment>
|
46
|
</de:file>
|
47
|
</de:folder>
|
48
|
</de:folder>
|
49
|
</de:folder>
|
50
|
</de:folder>
|
51
|
</de:folder>
|
52
|
</de:folder>
|
53
|
</de:folder>
|
54
|
</de:folder>
|
55
|
<de:folder name="test">
|
56
|
<de:folder name="java">
|
57
|
<de:folder name="eu">
|
58
|
<de:folder name="dnetlib">
|
59
|
<de:folder name="iis">
|
60
|
<de:folder name="transformers">
|
61
|
<de:folder name="documentssimilarity">
|
62
|
<de:file name="WorkflowTest.java">
|
63
|
<de:comment id="c3" author="mafju" reviewID="2013-12-06 transformer for documentssimilarity" creation-date="2013-12-06T12:50:44.253+01:00" last-modified="2013-12-10T15:56:46.150+01:00" priority="0" recipient="micon" status="1" revision="0">
|
64
|
<de:text>You should change the name of the author of this test</de:text>
|
65
|
<de:replies/>
|
66
|
</de:comment>
|
67
|
</de:file>
|
68
|
</de:folder>
|
69
|
</de:folder>
|
70
|
</de:folder>
|
71
|
</de:folder>
|
72
|
</de:folder>
|
73
|
</de:folder>
|
74
|
</de:folder>
|
75
|
</de:folder>
|
76
|
</de:project>
|
77
|
</de:files>
|
78
|
</de:comments>
|