D-Net

<?xml version="1.0" encoding="UTF-8"?>

<de:comments xmlns:de="http://de.tukl.softech.agileReview">

  <de:author name="mafju"/>

  <de:files>

    <de:project name="icm-iis-transformers">

      <de:folder name="src">

        <de:folder name="main">

          <de:folder name="resources">

            <de:folder name="eu">

              <de:folder name="dnetlib">

                <de:folder name="iis">

                  <de:folder name="transformers">

                    <de:folder name="documentssimilarity">

                      <de:folder name="oozie_app">

                        <de:file name="workflow.xml">

                          <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">

                            <de:text>Adding the

<delete path="${nameNode}${workingDir}/output_document_metadata" />

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>

                            <de:replies/>

                          </de:comment>

                          <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">

                            <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>

                            <de:replies>

                              <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>

                              <de:reply author="mafju" creation-date="2013-12-10T16:06:09.028+01:00">On the other hand:

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`.

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.

3) Even when the code is generated automatically, we should strive to make it clean and readable.</de:reply>

                              <de:reply author="micon" creation-date="2013-12-10T16:30:44.502+01:00">Agreed. Fixed.

There could be an *optional* &lt;variable-name> tag, when not present, then the name would be generated from the class name.</de:reply>

                            </de:replies>

                          </de:comment>

                          <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">

                            <de:text>According to the current (sadly not explicitly stated) customs, the workflow should specify its parameters in the &lt;parameters> secton at the beginning of the file.</de:text>

                            <de:replies>

                              <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>

                            </de:replies>

                          </de:comment>

                        </de:file>

                      </de:folder>

                    </de:folder>

                  </de:folder>

                </de:folder>

              </de:folder>

            </de:folder>

          </de:folder>

        </de:folder>

        <de:folder name="test">

          <de:folder name="java">

            <de:folder name="eu">

              <de:folder name="dnetlib">

                <de:folder name="iis">

                  <de:folder name="transformers">

                    <de:folder name="documentssimilarity">

                      <de:file name="WorkflowTest.java">

                        <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">

                          <de:text>You should change the name of the author of this test</de:text>

                          <de:replies/>

                        </de:comment>

                      </de:file>

                    </de:folder>

                  </de:folder>

                </de:folder>

              </de:folder>

            </de:folder>

          </de:folder>

        </de:folder>

      </de:folder>

    </de:project>

  </de:files>

</de:comments>