diff --git a/java/com.sap.sse.test/src/com/sap/see/pairinglist/test/PairingListTemplateFactoryTest.java b/java/com.sap.sse.test/src/com/sap/see/pairinglist/test/PairingListTemplateFactoryTest.java index 3027e8b233b..f4d5cbff520 100644 --- a/java/com.sap.sse.test/src/com/sap/see/pairinglist/test/PairingListTemplateFactoryTest.java +++ b/java/com.sap.sse.test/src/com/sap/see/pairinglist/test/PairingListTemplateFactoryTest.java @@ -1,6 +1,6 @@ package com.sap.see.pairinglist.test; -import static org.junit.Assert.assertNotNull; +import static org.junit.Assert.assertNotNull; import java.util.ArrayList; import java.util.stream.IntStream; diff --git a/java/com.sap.sse/src/com/sap/sse/pairinglist/PairingListTemplate.java b/java/com.sap.sse/src/com/sap/sse/pairinglist/PairingListTemplate.java index 0c6726890f2..fd94c37ae25 100644 --- a/java/com.sap.sse/src/com/sap/sse/pairinglist/PairingListTemplate.java +++ b/java/com.sap.sse/src/com/sap/sse/pairinglist/PairingListTemplate.java @@ -18,13 +18,19 @@ public interface PairingListTemplate { CompetitionFormat competitionFormat); /** - * Returns the quality of a pairing list template. + * The value corresponds to the quality of a pairing list template. The quality is calculated by the + * standard deviation of values in association matrix. * - * @return quality of pairing list template, stated as the standard deviation, - * which is calculated by team association. + * @return double, stated as the standard deviation. */ double getQuality(); - //TODO: Javadoc - int[][] getPairingListTemplate(); + /** + * Every row of this array represents a single group of a flight with competitors per group (competitors/groups) + * in their columns. Competitors starts counting at zero. When calling this method the pairing list template is + * already generated. + * + * @return two dimensional int array with flights*groups rows and competitors/groups columns + */ + int[][] getPairingListTemplate(); } \ No newline at end of file