Java Doc (IV)

src/main/java/de/samply/share/client/quality/report/file/excel/instances/basic/BasicExcelRowElements.java

@@ -13,9 +13,9 @@ public class BasicExcelRowElements extends ExcelRowElements {
   private final List<BasicExcelColumnMetaInfo> metaInfos;
 
   /**
-   * Todo.
+   * Contains information (title and eventually link) of each cell of an excel row.
    *
-   * @param metaInfos Todo.
+   * @param metaInfos information (title and eventually link) of each cell of an excel row.
    */
   public BasicExcelRowElements(List<BasicExcelColumnMetaInfo> metaInfos) {
 

src/main/java/de/samply/share/client/quality/report/file/excel/instances/patientids/PatientIdsExcelRowContext.java

@@ -27,9 +27,10 @@ public abstract class PatientIdsExcelRowContext implements ExcelRowContext {
   private final List<BasicExcelColumnMetaInfo> metaInfos = new ArrayList<>();
 
   /**
-   * Todo.
+   * Context with patient ids for an excel row.
    *
-   * @param qualityResults Todo.
+   * @param qualityResults Quality results with a list of patient ids and the validity of the row
+   *                       (pair data element - attribute).
    */
   public PatientIdsExcelRowContext(AlphabeticallySortedMismatchedQualityResults qualityResults) {
 

src/main/java/de/samply/share/client/quality/report/file/excel/instances/patientids/PatientIdsList.java

@@ -12,13 +12,13 @@ public class PatientIdsList implements Iterable<List<String>> {
   private List<String> maxList = new ArrayList<>();
 
   /**
-   * Todo.
+   * add collection of patient ids.
    *
-   * @param myCollection Todo.
+   * @param patientIds List of patient ids.
    */
-  public void addList(Collection<String> myCollection) {
+  public void addList(Collection<String> patientIds) {
 
-    List<String> myList = new ArrayList<>(myCollection);
+    List<String> myList = new ArrayList<>(patientIds);
     Collections.sort(myList);
 
     lists.add(myList);

src/main/java/de/samply/share/client/quality/report/file/excel/instances/statistics/dataelementstats/DataElementStatsExcelRowContext.java

@@ -20,11 +20,13 @@ public class DataElementStatsExcelRowContext extends
 
 
   /**
-   * Todo.
+   * Data element statistics for an excel row.
    *
-   * @param qualityResults           Todo.
-   * @param qualityResultsStatistics Todo.
-   * @param excelRowMapper           Todo.
+   * @param qualityResults           Group of patient ids and validation of pair data element -
+   *                                 attribute.
+   * @param qualityResultsStatistics Statistics of the quality results.
+   * @param excelRowMapper           Adds additional information to the quality results, like the
+   *                                 centraxx mapping.
    */
   public DataElementStatsExcelRowContext(QualityResults qualityResults,
       QualityResultsStatistics qualityResultsStatistics,

src/main/java/de/samply/share/client/quality/report/file/excel/instances/statistics/dataelementstats/DataElementStatsExcelRowContextFactory.java

@@ -12,10 +12,10 @@ public class DataElementStatsExcelRowContextFactory {
   private final DataElementStatsExcelRowMapper excelRowMapper;
 
   /**
-   * Todo.
+   * Creates context with data element statistics for an excel row.
    *
    * @param excelRowMapperUtils Todo.
-   * @param dktkIdManager       Todo.
+   * @param dktkIdManager       Get slot DKTK-ID for mdr id.
    * @param centraXxMapper      Todo.
    */
   public DataElementStatsExcelRowContextFactory(ExcelRowMapperUtils excelRowMapperUtils,
@@ -27,11 +27,11 @@ public DataElementStatsExcelRowContextFactory(ExcelRowMapperUtils excelRowMapper
   }
 
   /**
-   * Todo.
+   * Creates excel row with mdr data elements, validation and statistics.
    *
-   * @param qualityResults           Todo.
-   * @param qualityResultsStatistics Todo.
-   * @return Todo.
+   * @param qualityResults           patient ids and validation of pair data element - attribute.
+   * @param qualityResultsStatistics statistics of quality result.
+   * @return context with the whole information.
    */
   public DataElementStatsExcelRowContext createExcelRowContext(QualityResults qualityResults,
       QualityResultsStatistics qualityResultsStatistics) {

src/main/java/de/samply/share/client/quality/report/file/excel/instances/statistics/dataelementstats/DataElementStatsExcelRowElements.java

@@ -9,6 +9,10 @@
 import de.samply.share.client.quality.report.file.excel.row.elements.ExcelRowElements;
 import de.samply.share.common.utils.MdrIdDatatype;
 
+/**
+ * Statistics of quality report. More information on: Methods Inf Med 2019; 58(02/03): 086-093 DOI:
+ * 10.1055/s-0039-1693685
+ */
 public class DataElementStatsExcelRowElements extends ExcelRowElements {
 
   public DataElementStatsExcelRowElements() {
@@ -30,10 +34,10 @@ public ExcelCellElement getElementTitle(int order) {
   }
 
   /**
-   * Todo.
+   * Set link for a mdr data element.
    *
-   * @param link  Todo.
-   * @param mdrId Todo.
+   * @param link  link of an mdr data element.
+   * @param mdrId id of the mdr data element.
    */
   public void setMdrLink(String link, MdrIdDatatype mdrId) {
 
@@ -58,9 +62,9 @@ private String getLinkTitle(MdrIdDatatype mdrId) {
   }
 
   /**
-   * Todo.
+   * Set the mdr data element slot DKTK-ID.
    *
-   * @param dktkId Todo.
+   * @param dktkId DKTK-ID.
    */
   public void setDktkId(String dktkId) {
 
@@ -70,9 +74,9 @@ public void setDktkId(String dktkId) {
   }
 
   /**
-   * Todo.
+   * Set mdr designation of mdr data element.
    *
-   * @param mdrDatenElement Todo.
+   * @param mdrDatenElement mdr data element designation.
    */
   public void setMdrDatenElement(String mdrDatenElement) {
 
@@ -82,9 +86,9 @@ public void setMdrDatenElement(String mdrDatenElement) {
   }
 
   /**
-   * Todo.
+   * set centraxx data element.
    *
-   * @param cxxDatenElement Todo.
+   * @param cxxDatenElement centraxx data element.
    */
   public void setCxxDatenElement(String cxxDatenElement) {
 
@@ -94,9 +98,9 @@ public void setCxxDatenElement(String cxxDatenElement) {
   }
 
   /**
-   * Todo.
+   * Set number of patients with mdr data element.
    *
-   * @param numberOfPatientsWithDataElement Todo.
+   * @param numberOfPatientsWithDataElement number of patients with mdr data element.
    */
   public void setNumberOfPatientsWithDataElement(Integer numberOfPatientsWithDataElement) {
 
@@ -107,9 +111,10 @@ public void setNumberOfPatientsWithDataElement(Integer numberOfPatientsWithDataE
   }
 
   /**
-   * Todo.
+   * Set percentage of patients with data element out of total patients.
    *
-   * @param percentageOfPatientsWithDataElementOutOfTotalPatients Todo.
+   * @param percentageOfPatientsWithDataElementOutOfTotalPatients percentage of patients with data
+   *                                                              element out of total patients.
    */
   public void setPercentageOfPatientsWithDataElementOutOfTotalPatients(
       Double percentageOfPatientsWithDataElementOutOfTotalPatients) {
@@ -122,9 +127,10 @@ public void setPercentageOfPatientsWithDataElementOutOfTotalPatients(
   }
 
   /**
-   * Todo.
+   * SEt number of patients with match only for data element.
    *
-   * @param numberOfPatientsWithMatchOnlyForDataElement Todo.
+   * @param numberOfPatientsWithMatchOnlyForDataElement number of patients with match only for data
+   *                                                    element.
    */
   public void setNumberOfPatientsWithMatchOnlyForDataElement(
       Integer numberOfPatientsWithMatchOnlyForDataElement) {
@@ -137,9 +143,16 @@ public void setNumberOfPatientsWithMatchOnlyForDataElement(
   }
 
   /**
-   * Todo.
+   * Set percentage of patients with match only for data element out of patients with data element.
    *
-   * @param percentageOfPatientsWithMatchOnlyForDataElementOutOfPatientsWithDataElement Todo.
+   * @param percentageOfPatientsWithMatchOnlyForDataElementOutOfPatientsWithDataElement Set percentage
+   *                                                                                    of patients
+   *                                                                                    with match
+   *                                                                                    only for data
+   *                                                                                    element out
+   *                                                                                    of patients
+   *                                                                                    with data
+   *                                                                                    element.
    */
   public void setPercentageOfPatientsWithMatchOnlyForDataElementOutOfPatientsWithDataElement(
       Double percentageOfPatientsWithMatchOnlyForDataElementOutOfPatientsWithDataElement) {
@@ -153,7 +166,7 @@ public void setPercentageOfPatientsWithMatchOnlyForDataElementOutOfPatientsWithD
   }
 
   /**
-   * Todo.
+   * Set percentage of patients with match only for data element out of total patients.
    *
    * @param percentageOfPatientsWithMatchOnlyForDataElementOutOfTotalPatients Todo.
    */
@@ -169,9 +182,10 @@ public void setPercentageOfPatientsWithMatchOnlyForDataElementOutOf_TotalPatient
   }
 
   /**
-   * Todo.
+   * Set number of patients with any mismatch for data element.
    *
-   * @param numberOfPatientsWithAnyMismatchForDataElement Todo.
+   * @param numberOfPatientsWithAnyMismatchForDataElement number of patients with any mismatch for
+   *                                                      data element.
    */
   public void setNumberOfPatientsWithAnyMismatchForDataElement(
       Integer numberOfPatientsWithAnyMismatchForDataElement) {
@@ -184,9 +198,18 @@ public void setNumberOfPatientsWithAnyMismatchForDataElement(
   }
 
   /**
-   * Todo.
+   * Set percentage of patients with any mismatch for data element out of patients with data
+   * element.
    *
-   * @param percentageOfPatientsWithAnyMismatchForDataElementOutOfPatientsWithDataElement Todo.
+   * @param percentageOfPatientsWithAnyMismatchForDataElementOutOfPatientsWithDataElement Set percentage
+   *                                                                                      of patients
+   *                                                                                      with any
+   *                                                                                      mismatch
+   *                                                                                      for data
+   *                                                                                      element
+   *                                                                                      out of patients
+   *                                                                                      with data
+   *                                                                                      element.
    */
   public void setPercentageOfPatientsWithAnyMismatchForDataElementOutOfPatientsWithDataElement(
       Double percentageOfPatientsWithAnyMismatchForDataElementOutOfPatientsWithDataElement) {
@@ -200,9 +223,12 @@ public void setPercentageOfPatientsWithAnyMismatchForDataElementOutOfPatientsWit
   }
 
   /**
-   * ToDo.
+   * Set percentage of patients with any mismatch for data elemento out of total patients.
    *
-   * @param percentageOfPatientsWithAnyMismatchForDataElementOutOfTotalPatients ToDo.
+   * @param percentageOfPatientsWithAnyMismatchForDataElementOutOfTotalPatients percentage of patients
+   *                                                                            with any mismatch
+   *                                                                            for data elemento
+   *                                                                            out of total patients.
    */
   public void setPercentageOfPatientsWithAnyMismatchForDataElementOutOfTotalPatients(
       Double percentageOfPatientsWithAnyMismatchForDataElementOutOfTotalPatients) {
@@ -216,9 +242,9 @@ public void setPercentageOfPatientsWithAnyMismatchForDataElementOutOfTotalPatien
   }
 
   /**
-   * ToDo.
+   * Set general rehearsal priorization.
    *
-   * @param priorization ToDo.
+   * @param priorization general rehearsal priorization.
    */
   public void setGeneralRehearsalPriorization(String priorization) {
 
@@ -228,9 +254,9 @@ public void setGeneralRehearsalPriorization(String priorization) {
   }
 
   /**
-   * ToDo.
+   * Set general rehearsal a contained in quality report.
    *
-   * @param value ToDo.
+   * @param value general rehearsal a contained in quality report.
    */
   public void setGeneralRehearsalAContainedInQR(boolean value) {
     NaturalLanguageBooleanExcelCellElement excelCellElement =
@@ -240,9 +266,9 @@ public void setGeneralRehearsalAContainedInQR(boolean value) {
   }
 
   /**
-   * ToDo.
+   * Set general rehearsal b low mismatch.
    *
-   * @param value ToDo.
+   * @param value general rehearsal b low mismatch.
    */
   public void setGeneralRehearsalBLowMismatch(boolean value) {
 
@@ -253,9 +279,9 @@ public void setGeneralRehearsalBLowMismatch(boolean value) {
   }
 
   /**
-   * ToDo.
+   * Set general rehearsal A and B.
    *
-   * @param value ToDo.
+   * @param value general rehearsal A and B.
    */
   public void setGeneralRehearsalAAndB(boolean value) {
 

src/main/java/de/samply/share/client/quality/report/file/excel/instances/statistics/dataelementstats/DataElementStatsExcelRowMapper.java

@@ -17,11 +17,11 @@ public class DataElementStatsExcelRowMapper {
   private final CentraxxMapper centraXxMapper;
 
   /**
-   * ToDo.
+   * Excel row containing additional information for the quality report.
    *
-   * @param dktkIdManager       ToDo.
-   * @param excelRowMapperUtils ToDo.
-   * @param centraXxMapper      ToDo.
+   * @param dktkIdManager       Mapper mdr id - DKTK-ID.
+   * @param excelRowMapperUtils Additional information related to the mdr data element.
+   * @param centraXxMapper      Mapper mdr data element - centraxx data element.
    */
   public DataElementStatsExcelRowMapper(DktkIdMdrIdConverter dktkIdManager,
       ExcelRowMapperUtils excelRowMapperUtils, CentraxxMapper centraXxMapper) {
@@ -33,11 +33,11 @@ public DataElementStatsExcelRowMapper(DktkIdMdrIdConverter dktkIdManager,
   }
 
   /**
-   * ToDo.
+   * Convert excel row parameters in data element stats excel row.
    *
-   * @param excelRowParameters ToDo.
-   * @return ToDo.
-   * @throws ExcelRowMapperException ToDo.
+   * @param excelRowParameters Excel row parameter.
+   * @return Data element stats excel row.
+   * @throws ExcelRowMapperException Encapsulates exceptions within the class.
    */
   public DataElementStatsExcelRowElements convert(
       DataElementStatsExcelRowParameters excelRowParameters) throws ExcelRowMapperException {

src/main/java/de/samply/share/client/quality/report/file/excel/instances/statistics/table1/Table1ExcelRowElements.java

@@ -25,9 +25,9 @@ private void addElement(ElementOrder elementOrder, ExcelCellElement element) {
   }
 
   /**
-   * Todo.
+   * Add mdr data element group.
    *
-   * @param dataElementGroup Todo.
+   * @param dataElementGroup mdr data element group.
    */
   public void addDataElementGroup(String dataElementGroup) {
 
@@ -37,9 +37,9 @@ public void addDataElementGroup(String dataElementGroup) {
   }
 
   /**
-   * Todo.
+   * Add percentage.
    *
-   * @param percentage Todo.
+   * @param percentage Percentage.
    */
   public void addPercentrage(Double percentage) {
 

src/main/java/de/samply/share/client/quality/report/file/excel/instances/statistics/table1/Table1ExcelRowMapper.java

@@ -5,9 +5,9 @@
 public class Table1ExcelRowMapper {
 
   /**
-   * Todo.
+   * Creates excel row elements.
    *
-   * @param dataElementGroup Todo.
+   * @param dataElementGroup mdr data element group.
    * @param percentage       Todo.
    * @return Todo.
    */

src/main/java/de/samply/share/client/quality/report/file/excel/instances/statistics/table2/Table2ExcelRowContext.java

@@ -17,7 +17,7 @@ public class Table2ExcelRowContext extends ExcelRowContextImpl<Table2ExcelRowPar
 
 
   /**
-   * Todo.
+   * Excel row context .
    *
    * @param qualityResults           Todo.
    * @param qualityResultsStatistics Todo.