diff --git a/java/com.sap.sailing.datamining.shared/src/com/sap/sailing/datamining/shared/ManeuverSettings.java b/java/com.sap.sailing.datamining.shared/src/com/sap/sailing/datamining/shared/ManeuverSettings.java index 93dc8a3985d..5e3bf3ec4d2 100644 --- a/java/com.sap.sailing.datamining.shared/src/com/sap/sailing/datamining/shared/ManeuverSettings.java +++ b/java/com.sap.sailing.datamining.shared/src/com/sap/sailing/datamining/shared/ManeuverSettings.java @@ -2,6 +2,11 @@ package com.sap.sailing.datamining.shared; import com.sap.sse.common.settings.SerializableSettings; +/** + * + * @author Vladislav Chumak (D069712) + * + */ public abstract class ManeuverSettings extends SerializableSettings { private static final long serialVersionUID = -393430331972342L; diff --git a/java/com.sap.sailing.datamining.shared/src/com/sap/sailing/datamining/shared/ManeuverSettingsImpl.java b/java/com.sap.sailing.datamining.shared/src/com/sap/sailing/datamining/shared/ManeuverSettingsImpl.java index 9a5174d27ae..736d3782b29 100644 --- a/java/com.sap.sailing.datamining.shared/src/com/sap/sailing/datamining/shared/ManeuverSettingsImpl.java +++ b/java/com.sap.sailing.datamining.shared/src/com/sap/sailing/datamining/shared/ManeuverSettingsImpl.java @@ -1,5 +1,10 @@ package com.sap.sailing.datamining.shared; +/** + * + * @author Vladislav Chumak (D069712) + * + */ public class ManeuverSettingsImpl extends ManeuverSettings { private static final long serialVersionUID = 69258712144L; diff --git a/java/com.sap.sailing.datamining.shared/src/com/sap/sailing/datamining/shared/ManeuverSpeedDetailsAggregation.java b/java/com.sap.sailing.datamining.shared/src/com/sap/sailing/datamining/shared/ManeuverSpeedDetailsAggregation.java index ba0ea079579..10cc6fbbfb9 100644 --- a/java/com.sap.sailing.datamining.shared/src/com/sap/sailing/datamining/shared/ManeuverSpeedDetailsAggregation.java +++ b/java/com.sap.sailing.datamining.shared/src/com/sap/sailing/datamining/shared/ManeuverSpeedDetailsAggregation.java @@ -2,6 +2,11 @@ package com.sap.sailing.datamining.shared; import java.io.Serializable; +/** + * + * @author Vladislav Chumak (D069712) + * + */ public interface ManeuverSpeedDetailsAggregation extends Serializable { double[] getValuePerTWA(); diff --git a/java/com.sap.sailing.datamining.shared/src/com/sap/sailing/datamining/shared/ManeuverSpeedDetailsAggregationImpl.java b/java/com.sap.sailing.datamining.shared/src/com/sap/sailing/datamining/shared/ManeuverSpeedDetailsAggregationImpl.java index 97c90736f09..2c95ebca69b 100644 --- a/java/com.sap.sailing.datamining.shared/src/com/sap/sailing/datamining/shared/ManeuverSpeedDetailsAggregationImpl.java +++ b/java/com.sap.sailing.datamining.shared/src/com/sap/sailing/datamining/shared/ManeuverSpeedDetailsAggregationImpl.java @@ -1,5 +1,10 @@ package com.sap.sailing.datamining.shared; +/** + * + * @author Vladislav Chumak (D069712) + * + */ public class ManeuverSpeedDetailsAggregationImpl implements ManeuverSpeedDetailsAggregation { private static final long serialVersionUID = 9177124509619315750L; private double[] valuePerTWA; diff --git a/java/com.sap.sailing.datamining.shared/src/com/sap/sailing/datamining/shared/ManeuverSpeedDetailsSettings.java b/java/com.sap.sailing.datamining.shared/src/com/sap/sailing/datamining/shared/ManeuverSpeedDetailsSettings.java index 96297cc6c7a..3200df60c3b 100644 --- a/java/com.sap.sailing.datamining.shared/src/com/sap/sailing/datamining/shared/ManeuverSpeedDetailsSettings.java +++ b/java/com.sap.sailing.datamining.shared/src/com/sap/sailing/datamining/shared/ManeuverSpeedDetailsSettings.java @@ -3,6 +3,11 @@ package com.sap.sailing.datamining.shared; import com.sap.sailing.domain.common.NauticalSide; import com.sap.sse.common.settings.SerializableSettings; +/** + * + * @author Vladislav Chumak (D069712) + * + */ public abstract class ManeuverSpeedDetailsSettings extends SerializableSettings { private static final long serialVersionUID = -39384430331972342L; diff --git a/java/com.sap.sailing.datamining.shared/src/com/sap/sailing/datamining/shared/ManeuverSpeedDetailsSettingsImpl.java b/java/com.sap.sailing.datamining.shared/src/com/sap/sailing/datamining/shared/ManeuverSpeedDetailsSettingsImpl.java index 843c5baad9c..4571acea4c3 100644 --- a/java/com.sap.sailing.datamining.shared/src/com/sap/sailing/datamining/shared/ManeuverSpeedDetailsSettingsImpl.java +++ b/java/com.sap.sailing.datamining.shared/src/com/sap/sailing/datamining/shared/ManeuverSpeedDetailsSettingsImpl.java @@ -2,6 +2,11 @@ package com.sap.sailing.datamining.shared; import com.sap.sailing.domain.common.NauticalSide; +/** + * + * @author Vladislav Chumak (D069712) + * + */ public class ManeuverSpeedDetailsSettingsImpl extends ManeuverSpeedDetailsSettings { private static final long serialVersionUID = 61329258712144L; diff --git a/java/com.sap.sailing.datamining/src/com/sap/sailing/datamining/data/HasManeuverSpeedDetailsContext.java b/java/com.sap.sailing.datamining/src/com/sap/sailing/datamining/data/HasManeuverSpeedDetailsContext.java index 73b372a9f5d..9e4d9d29c3a 100644 --- a/java/com.sap.sailing.datamining/src/com/sap/sailing/datamining/data/HasManeuverSpeedDetailsContext.java +++ b/java/com.sap.sailing.datamining/src/com/sap/sailing/datamining/data/HasManeuverSpeedDetailsContext.java @@ -5,6 +5,12 @@ import com.sap.sse.datamining.annotations.Connector; import com.sap.sse.datamining.annotations.Dimension; import com.sap.sse.datamining.annotations.Statistic; +/** + * Contains statistics for speed trend analysis within maneuvers. + * + * @author Vladislav Chumak (D069712) + * + */ public interface HasManeuverSpeedDetailsContext { // FIXME due to UI bug there is at least one dimension per fact required diff --git a/java/com.sap.sailing.datamining/src/com/sap/sailing/datamining/data/ManeuverSpeedDetailsStatistic.java b/java/com.sap.sailing.datamining/src/com/sap/sailing/datamining/data/ManeuverSpeedDetailsStatistic.java index c904c3aa45d..dd6d53269ea 100644 --- a/java/com.sap.sailing.datamining/src/com/sap/sailing/datamining/data/ManeuverSpeedDetailsStatistic.java +++ b/java/com.sap.sailing.datamining/src/com/sap/sailing/datamining/data/ManeuverSpeedDetailsStatistic.java @@ -3,6 +3,11 @@ package com.sap.sailing.datamining.data; import com.sap.sailing.datamining.shared.ManeuverSpeedDetailsSettings; import com.sap.sailing.domain.common.NauticalSide; +/** + * + * @author Vladislav Chumak (D069712) + * + */ public interface ManeuverSpeedDetailsStatistic { double[] getManeuverValuePerTWA(); diff --git a/java/com.sap.sailing.datamining/src/com/sap/sailing/datamining/impl/components/ManeuverSpeedDetailsRetrievalProcessor.java b/java/com.sap.sailing.datamining/src/com/sap/sailing/datamining/impl/components/ManeuverSpeedDetailsRetrievalProcessor.java index d4b48b87434..08e7c1df14f 100644 --- a/java/com.sap.sailing.datamining/src/com/sap/sailing/datamining/impl/components/ManeuverSpeedDetailsRetrievalProcessor.java +++ b/java/com.sap.sailing.datamining/src/com/sap/sailing/datamining/impl/components/ManeuverSpeedDetailsRetrievalProcessor.java @@ -23,6 +23,11 @@ import com.sap.sse.common.impl.MillisecondsDurationImpl; import com.sap.sse.datamining.components.Processor; import com.sap.sse.datamining.impl.components.AbstractRetrievalProcessor; +/** + * + * @author Vladislav Chumak (D069712) + * + */ public class ManeuverSpeedDetailsRetrievalProcessor extends AbstractRetrievalProcessor { diff --git a/java/com.sap.sailing.datamining/src/com/sap/sailing/datamining/impl/components/ManeuverSpeedDetailsUtils.java b/java/com.sap.sailing.datamining/src/com/sap/sailing/datamining/impl/components/ManeuverSpeedDetailsUtils.java index a7451d433a6..ce0d2a01618 100644 --- a/java/com.sap.sailing.datamining/src/com/sap/sailing/datamining/impl/components/ManeuverSpeedDetailsUtils.java +++ b/java/com.sap.sailing.datamining/src/com/sap/sailing/datamining/impl/components/ManeuverSpeedDetailsUtils.java @@ -4,6 +4,11 @@ import java.util.function.Function; import com.sap.sailing.domain.common.NauticalSide; +/** + * + * @author Vladislav Chumak (D069712) + * + */ public class ManeuverSpeedDetailsUtils { public static NauticalSide determineNauticalSideByClosestAngleDistance(double firstBearingAngle, diff --git a/java/com.sap.sailing.datamining/src/com/sap/sailing/datamining/impl/components/aggregators/ManeuverSpeedDetailsStatisticAggregationProcessorHelper.java b/java/com.sap.sailing.datamining/src/com/sap/sailing/datamining/impl/components/aggregators/ManeuverSpeedDetailsStatisticAggregationProcessorHelper.java index d1681f09408..243efbb3e88 100644 --- a/java/com.sap.sailing.datamining/src/com/sap/sailing/datamining/impl/components/aggregators/ManeuverSpeedDetailsStatisticAggregationProcessorHelper.java +++ b/java/com.sap.sailing.datamining/src/com/sap/sailing/datamining/impl/components/aggregators/ManeuverSpeedDetailsStatisticAggregationProcessorHelper.java @@ -13,6 +13,11 @@ import com.sap.sailing.datamining.shared.ManeuverSpeedDetailsSettings; import com.sap.sse.datamining.impl.components.GroupedDataEntry; import com.sap.sse.datamining.shared.GroupKey; +/** + * + * @author Vladislav Chumak (D069712) + * + */ public class ManeuverSpeedDetailsStatisticAggregationProcessorHelper { private final Map resultMap = new HashMap<>(); diff --git a/java/com.sap.sailing.datamining/src/com/sap/sailing/datamining/impl/components/aggregators/ManeuverSpeedDetailsStatisticAvgAggregationProcessor.java b/java/com.sap.sailing.datamining/src/com/sap/sailing/datamining/impl/components/aggregators/ManeuverSpeedDetailsStatisticAvgAggregationProcessor.java index 1022e9d361e..1d24bab1406 100644 --- a/java/com.sap.sailing.datamining/src/com/sap/sailing/datamining/impl/components/aggregators/ManeuverSpeedDetailsStatisticAvgAggregationProcessor.java +++ b/java/com.sap.sailing.datamining/src/com/sap/sailing/datamining/impl/components/aggregators/ManeuverSpeedDetailsStatisticAvgAggregationProcessor.java @@ -15,6 +15,11 @@ import com.sap.sse.datamining.impl.components.SimpleAggregationProcessorDefiniti import com.sap.sse.datamining.impl.components.aggregators.AbstractParallelGroupedDataAggregationProcessor; import com.sap.sse.datamining.shared.GroupKey; +/** + * + * @author Vladislav Chumak (D069712) + * + */ public class ManeuverSpeedDetailsStatisticAvgAggregationProcessor extends AbstractParallelGroupedDataAggregationProcessor { diff --git a/java/com.sap.sailing.datamining/src/com/sap/sailing/datamining/impl/components/aggregators/ManeuverSpeedDetailsStatisticMedianAggregationProcessor.java b/java/com.sap.sailing.datamining/src/com/sap/sailing/datamining/impl/components/aggregators/ManeuverSpeedDetailsStatisticMedianAggregationProcessor.java index 63f105f11bb..779be722941 100644 --- a/java/com.sap.sailing.datamining/src/com/sap/sailing/datamining/impl/components/aggregators/ManeuverSpeedDetailsStatisticMedianAggregationProcessor.java +++ b/java/com.sap.sailing.datamining/src/com/sap/sailing/datamining/impl/components/aggregators/ManeuverSpeedDetailsStatisticMedianAggregationProcessor.java @@ -17,6 +17,11 @@ import com.sap.sse.datamining.impl.components.SimpleAggregationProcessorDefiniti import com.sap.sse.datamining.impl.components.aggregators.AbstractParallelGroupedDataStoringAggregationProcessor; import com.sap.sse.datamining.shared.GroupKey; +/** + * + * @author Vladislav Chumak (D069712) + * + */ public class ManeuverSpeedDetailsStatisticMedianAggregationProcessor extends AbstractParallelGroupedDataStoringAggregationProcessor { diff --git a/java/com.sap.sailing.datamining/src/com/sap/sailing/datamining/impl/data/ManeuverSpeedDetailsStatisticImpl.java b/java/com.sap.sailing.datamining/src/com/sap/sailing/datamining/impl/data/ManeuverSpeedDetailsStatisticImpl.java index f68d7599079..4e7aaf5b787 100644 --- a/java/com.sap.sailing.datamining/src/com/sap/sailing/datamining/impl/data/ManeuverSpeedDetailsStatisticImpl.java +++ b/java/com.sap.sailing.datamining/src/com/sap/sailing/datamining/impl/data/ManeuverSpeedDetailsStatisticImpl.java @@ -4,6 +4,11 @@ import com.sap.sailing.datamining.data.ManeuverSpeedDetailsStatistic; import com.sap.sailing.datamining.shared.ManeuverSpeedDetailsSettings; import com.sap.sailing.domain.common.NauticalSide; +/** + * + * @author Vladislav Chumak (D069712) + * + */ public class ManeuverSpeedDetailsStatisticImpl implements ManeuverSpeedDetailsStatistic { private double[] maneuverValuePerTWA; diff --git a/java/com.sap.sailing.datamining/src/com/sap/sailing/datamining/impl/data/ManeuverSpeedDetailsWithContext.java b/java/com.sap.sailing.datamining/src/com/sap/sailing/datamining/impl/data/ManeuverSpeedDetailsWithContext.java index 9468a15bb04..78cadce5ed2 100644 --- a/java/com.sap.sailing.datamining/src/com/sap/sailing/datamining/impl/data/ManeuverSpeedDetailsWithContext.java +++ b/java/com.sap.sailing.datamining/src/com/sap/sailing/datamining/impl/data/ManeuverSpeedDetailsWithContext.java @@ -9,6 +9,11 @@ import com.sap.sailing.datamining.impl.components.ManeuverSpeedDetailsUtils; import com.sap.sailing.datamining.shared.ManeuverSpeedDetailsSettings; import com.sap.sailing.domain.common.NauticalSide; +/** + * + * @author Vladislav Chumak (D069712) + * + */ public class ManeuverSpeedDetailsWithContext implements HasManeuverSpeedDetailsContext { private final HasManeuverContext maneuverContext; diff --git a/java/com.sap.sailing.domain/src/com/sap/sailing/util/TrackedRaceUtil.java b/java/com.sap.sailing.domain/src/com/sap/sailing/util/TrackedRaceUtil.java index ac107a8564b..6e831bc7c08 100644 --- a/java/com.sap.sailing.domain/src/com/sap/sailing/util/TrackedRaceUtil.java +++ b/java/com.sap.sailing.domain/src/com/sap/sailing/util/TrackedRaceUtil.java @@ -11,16 +11,26 @@ import com.sap.sailing.domain.tracking.GPSFixTrack; import com.sap.sse.common.Duration; import com.sap.sse.common.TimePoint; +/** + * Util class which is used for bearing calculation for positions within a GPS track of a competitor. + * + * @author Vladislav Chumak (D069712) + * + */ public class TrackedRaceUtil { /** * Gets a list of bearings between the provided time range (inclusive the boundaries). The bearings are retrieved by - * means of track.getEstimatedSpeed(timePoint) with the provided frequency between each bearing step. + * means of {@link GPSFixTrack#getEstimatedSpeed(TimePoint)} with the provided frequency between each bearing step. * * @param track + * The GPS track of competitor to use for bearings calculation * @param fromTimePoint + * The from time point (inclusive) for resulting bearing steps * @param tillTimePoint + * The till time point (inclusive) for resulting bearing steps * @param frequency - * @return + * Time distance between bearing time point + * @return The list of bearings between the provided time range */ public static List getBearingSteps(GPSFixTrack track, TimePoint fromTimePoint, TimePoint tillTimePoint, Duration frequency) { @@ -59,6 +69,13 @@ public class TrackedRaceUtil { return relevantBearings; } + /** + * Represents a bearing step within a certain part of a GPS track. It consists of time point, speed with bearing, + * and course change in degrees. + * + * @author Vladislav Chumak (D069712) + * + */ public static class BearingStep { private final TimePoint timePoint; private final SpeedWithBearing speedWithBearing; diff --git a/java/com.sap.sailing.gwt.ui/src/main/java/com/sap/sailing/gwt/ui/client/shared/charts/ChartToCsvExporter.java b/java/com.sap.sailing.gwt.ui/src/main/java/com/sap/sailing/gwt/ui/client/shared/charts/ChartToCsvExporter.java index 1940d0f423d..5794dcad546 100644 --- a/java/com.sap.sailing.gwt.ui/src/main/java/com/sap/sailing/gwt/ui/client/shared/charts/ChartToCsvExporter.java +++ b/java/com.sap.sailing.gwt.ui/src/main/java/com/sap/sailing/gwt/ui/client/shared/charts/ChartToCsvExporter.java @@ -8,20 +8,33 @@ import com.google.gwt.i18n.client.NumberFormat; import com.google.gwt.user.client.Window; import com.sap.sailing.gwt.ui.client.StringMessages; +/** + * Provides a service for export of chart data into CSV format. + * + * @author Vladislav Chumak (D069712) + * + */ public class ChartToCsvExporter { - + private final StringMessages stringMessages; public ChartToCsvExporter(StringMessages stringMessages) { this.stringMessages = stringMessages; } - + + /** + * Converts the data of the chart into CSV format and copies that into clipboard. Finally, window alert gets shown + * to the user with information that the CSV has been put into clipboard. + * + * @param chartToExport + * Chart with data to export + */ public void exportChartAsCsvToClipboard(Chart chartToExport) { String csvContentExport = createCsvExportContentForStatisticsCurve(chartToExport); copyTextToClipboard(csvContentExport); Window.alert(stringMessages.csvCopiedToClipboard()); } - + private static String createCsvExportContentForStatisticsCurve(Chart chartToExport) { if (chartToExport != null && chartToExport.getSeries().length > 0) { StringBuilder csvStr = new StringBuilder("Series name"); @@ -81,9 +94,9 @@ public class ChartToCsvExporter { document.body.appendChild(textArea); textArea.select(); try { - var successful = document.execCommand('copy'); + var successful = document.execCommand('copy'); } catch (err) { - console.log('Unable to copy'); + console.log('Unable to copy'); } document.body.removeChild(textArea); }-*/; diff --git a/java/com.sap.sailing.gwt.ui/src/main/java/com/sap/sailing/gwt/ui/datamining/presentation/ChartFactory.java b/java/com.sap.sailing.gwt.ui/src/main/java/com/sap/sailing/gwt/ui/datamining/presentation/ChartFactory.java index 9da5333afd4..ff99f38bad9 100644 --- a/java/com.sap.sailing.gwt.ui/src/main/java/com/sap/sailing/gwt/ui/datamining/presentation/ChartFactory.java +++ b/java/com.sap.sailing.gwt.ui/src/main/java/com/sap/sailing/gwt/ui/datamining/presentation/ChartFactory.java @@ -14,6 +14,12 @@ import org.moxieapps.gwt.highcharts.client.plotOptions.Marker; import com.sap.sailing.gwt.ui.client.StringMessages; +/** + * Contains factory methods for various data mining charts. + * + * @author Vladislav Chumak (D069712) + * + */ public class ChartFactory extends Chart { public static Chart createPolarChart() { diff --git a/java/com.sap.sailing.gwt.ui/src/main/java/com/sap/sailing/gwt/ui/datamining/presentation/ManeuverSettingsDialogComponent.java b/java/com.sap.sailing.gwt.ui/src/main/java/com/sap/sailing/gwt/ui/datamining/presentation/ManeuverSettingsDialogComponent.java index a97d504bcc6..80a6a5a2841 100644 --- a/java/com.sap.sailing.gwt.ui/src/main/java/com/sap/sailing/gwt/ui/datamining/presentation/ManeuverSettingsDialogComponent.java +++ b/java/com.sap.sailing.gwt.ui/src/main/java/com/sap/sailing/gwt/ui/datamining/presentation/ManeuverSettingsDialogComponent.java @@ -13,6 +13,11 @@ import com.sap.sse.gwt.client.dialog.DataEntryDialog; import com.sap.sse.gwt.client.dialog.DataEntryDialog.Validator; import com.sap.sse.gwt.client.shared.components.SettingsDialogComponent; +/** + * + * @author Vladislav Chumak (D069712) + * + */ public class ManeuverSettingsDialogComponent implements SettingsDialogComponent { private ManeuverSettings settings; diff --git a/java/com.sap.sailing.gwt.ui/src/main/java/com/sap/sailing/gwt/ui/datamining/presentation/ManeuverSpeedDetailsChartConfigurationPanel.java b/java/com.sap.sailing.gwt.ui/src/main/java/com/sap/sailing/gwt/ui/datamining/presentation/ManeuverSpeedDetailsChartConfigurationPanel.java index b722c99d37e..23bed60acaf 100644 --- a/java/com.sap.sailing.gwt.ui/src/main/java/com/sap/sailing/gwt/ui/datamining/presentation/ManeuverSpeedDetailsChartConfigurationPanel.java +++ b/java/com.sap.sailing.gwt.ui/src/main/java/com/sap/sailing/gwt/ui/datamining/presentation/ManeuverSpeedDetailsChartConfigurationPanel.java @@ -10,6 +10,12 @@ import com.google.gwt.user.client.ui.IntegerBox; import com.google.gwt.user.client.ui.Label; import com.sap.sailing.gwt.ui.client.StringMessages; +/** + * A control panel for maneuver speed details charts. + * + * @author Vladislav Chumak (D069712) + * + */ public class ManeuverSpeedDetailsChartConfigurationPanel extends HorizontalPanel { private IntegerBox minCountDataIntegerBox = new IntegerBox(); diff --git a/java/com.sap.sailing.gwt.ui/src/main/java/com/sap/sailing/gwt/ui/datamining/presentation/ManeuverSpeedDetailsSettingsDialogComponent.java b/java/com.sap.sailing.gwt.ui/src/main/java/com/sap/sailing/gwt/ui/datamining/presentation/ManeuverSpeedDetailsSettingsDialogComponent.java index 48de205cbf7..665ea2c9408 100644 --- a/java/com.sap.sailing.gwt.ui/src/main/java/com/sap/sailing/gwt/ui/datamining/presentation/ManeuverSpeedDetailsSettingsDialogComponent.java +++ b/java/com.sap.sailing.gwt.ui/src/main/java/com/sap/sailing/gwt/ui/datamining/presentation/ManeuverSpeedDetailsSettingsDialogComponent.java @@ -15,6 +15,11 @@ import com.sap.sse.gwt.client.dialog.DataEntryDialog; import com.sap.sse.gwt.client.dialog.DataEntryDialog.Validator; import com.sap.sse.gwt.client.shared.components.SettingsDialogComponent; +/** + * + * @author Vladislav Chumak (D069712) + * + */ public class ManeuverSpeedDetailsSettingsDialogComponent implements SettingsDialogComponent {