From eb935f2af36700424006f73192f025f02955d3ec Mon Sep 17 00:00:00 2001 From: Axel Uhl Date: Thu, 12 Dec 2019 17:23:45 +0100 Subject: [PATCH] generalized handling of MarkProperties referenced by MarkConfiguration; this to solve in particular the issue with submitting a MarkPropertiesBasedMarkConfiguration with isSaveToInventory==true that has led to the erroneous creation of yet another MarkProperties object --- .../FreestyleMarkConfiguration.java | 10 ++++--- .../coursetemplate/MarkConfiguration.java | 26 +++++++++-------- .../MarkPropertiesBasedMarkConfiguration.java | 9 ++++++ .../RegattaMarkConfiguration.java | 7 +++-- ...arkTemplateBasedMarkConfigurationImpl.java | 14 ++++++++++ ...CourseAndMarkConfigurationFactoryImpl.java | 11 +++----- .../server/impl/SharedSailingDataImpl.java | 28 +++++++++++-------- 7 files changed, 68 insertions(+), 37 deletions(-) diff --git a/java/com.sap.sailing.domain.shared.android/src/com/sap/sailing/domain/coursetemplate/FreestyleMarkConfiguration.java b/java/com.sap.sailing.domain.shared.android/src/com/sap/sailing/domain/coursetemplate/FreestyleMarkConfiguration.java index b6f47cc5f2f..390e9f025db 100755 --- a/java/com.sap.sailing.domain.shared.android/src/com/sap/sailing/domain/coursetemplate/FreestyleMarkConfiguration.java +++ b/java/com.sap.sailing.domain.shared.android/src/com/sap/sailing/domain/coursetemplate/FreestyleMarkConfiguration.java @@ -12,11 +12,13 @@ package com.sap.sailing.domain.coursetemplate; public interface FreestyleMarkConfiguration extends MarkConfiguration { CommonMarkProperties getFreestyleProperties(); - /** - * @return a non-{@code null} object if this mark configuration originated from a {@link MarkProperties} - * object where the {@link #getFreestyleProperties() freestyle properties} override one or more of the - * {@link MarkProperties}' attributes. + * @return a non-{@code null} object if this mark configuration originated from a {@link MarkProperties} object + * where the {@link #getFreestyleProperties() freestyle properties} override one or more of the + * {@link MarkProperties}' attributes. If {@link #isStoreToInventory()} is {@code true}, this means + * that the {@link MarkProperties} object returned by this method shall be updated accordingly to + * reflect the {@link #getFreestyleProperties() freestyle properties} after the update. */ + @Override MarkProperties getOptionalMarkProperties(); } diff --git a/java/com.sap.sailing.domain.shared.android/src/com/sap/sailing/domain/coursetemplate/MarkConfiguration.java b/java/com.sap.sailing.domain.shared.android/src/com/sap/sailing/domain/coursetemplate/MarkConfiguration.java index 95e5f97833c..62e5ec47cad 100644 --- a/java/com.sap.sailing.domain.shared.android/src/com/sap/sailing/domain/coursetemplate/MarkConfiguration.java +++ b/java/com.sap.sailing.domain.shared.android/src/com/sap/sailing/domain/coursetemplate/MarkConfiguration.java @@ -13,22 +13,24 @@ import com.sap.sailing.domain.base.Mark; * * * The combined set of properties merged according to the rules above can be obtained by calling - * {@link #getEffectiveProperties()}.

+ * {@link #getEffectiveProperties()}. + *

* - * The {@link #isStoreToInventory()} method tells whether, when applying this configuration to create - * or use a {@link Mark}, the {@link #getEffectiveProperties() effective mark properties} shall be - * recorded as a new {@link MarkProperties} object in the inventory. + * The {@link #isStoreToInventory()} method tells whether, when applying this configuration to create or use a + * {@link Mark}, the {@link #getEffectiveProperties() effective mark properties} shall be recorded as a new + * {@link MarkProperties} object in the inventory. * * @author Axel Uhl (D043530) * @@ -36,6 +38,8 @@ import com.sap.sailing.domain.base.Mark; public interface MarkConfiguration extends ControlPointWithMarkConfiguration { MarkTemplate getOptionalMarkTemplate(); + MarkProperties getOptionalMarkProperties(); + CommonMarkProperties getEffectiveProperties(); Positioning getEffectivePositioning(); diff --git a/java/com.sap.sailing.domain.shared.android/src/com/sap/sailing/domain/coursetemplate/MarkPropertiesBasedMarkConfiguration.java b/java/com.sap.sailing.domain.shared.android/src/com/sap/sailing/domain/coursetemplate/MarkPropertiesBasedMarkConfiguration.java index 94acf10973b..09d215fedd3 100755 --- a/java/com.sap.sailing.domain.shared.android/src/com/sap/sailing/domain/coursetemplate/MarkPropertiesBasedMarkConfiguration.java +++ b/java/com.sap.sailing.domain.shared.android/src/com/sap/sailing/domain/coursetemplate/MarkPropertiesBasedMarkConfiguration.java @@ -11,6 +11,15 @@ package com.sap.sailing.domain.coursetemplate; */ public interface MarkPropertiesBasedMarkConfiguration extends MarkConfiguration { MarkProperties getMarkProperties(); + + /** + * The "optional" {@link MarkProperties} for this type of mark configuration are the {@link #getMarkProperties() + * MarkProperties} referenced by this object and hence never {@code null}. + */ + @Override + default MarkProperties getOptionalMarkProperties() { + return getMarkProperties(); + } /** * No need to store a {@link MarkProperties} object to the inventory; we are using an unmodified diff --git a/java/com.sap.sailing.domain.shared.android/src/com/sap/sailing/domain/coursetemplate/RegattaMarkConfiguration.java b/java/com.sap.sailing.domain.shared.android/src/com/sap/sailing/domain/coursetemplate/RegattaMarkConfiguration.java index bc487db7ca5..5feff63804a 100755 --- a/java/com.sap.sailing.domain.shared.android/src/com/sap/sailing/domain/coursetemplate/RegattaMarkConfiguration.java +++ b/java/com.sap.sailing.domain.shared.android/src/com/sap/sailing/domain/coursetemplate/RegattaMarkConfiguration.java @@ -9,8 +9,10 @@ import com.sap.sailing.domain.base.Mark; * location/position/tracking data. *

* - * An optional non-{@code null} {@link MarkTemplate} may be returned from {@link #getOptionalMarkTemplate()} which then leads to - * recording a usage relation between the regatta {@link Mark} and said {@link MarkTemplate}. + * An optional non-{@code null} {@link MarkTemplate} may be returned from {@link #getOptionalMarkTemplate()} which then + * leads to recording a usage relation between the regatta {@link Mark} and said {@link MarkTemplate}. + * {@link #getOptionalMarkProperties()} can reference a {@link MarkProperties} object if the {@link #getMark mark} was + * originally created from that {@link MarkProperties} object. *

* * The {@link #getEffectiveProperties() effective properties} will contain @@ -23,5 +25,4 @@ import com.sap.sailing.domain.base.Mark; */ public interface RegattaMarkConfiguration extends MarkConfiguration { Mark getMark(); - MarkProperties getOptionalMarkProperties(); } diff --git a/java/com.sap.sailing.domain.shared.android/src/com/sap/sailing/domain/coursetemplate/impl/MarkTemplateBasedMarkConfigurationImpl.java b/java/com.sap.sailing.domain.shared.android/src/com/sap/sailing/domain/coursetemplate/impl/MarkTemplateBasedMarkConfigurationImpl.java index b11eaf355b4..c20bfbec9cf 100644 --- a/java/com.sap.sailing.domain.shared.android/src/com/sap/sailing/domain/coursetemplate/impl/MarkTemplateBasedMarkConfigurationImpl.java +++ b/java/com.sap.sailing.domain.shared.android/src/com/sap/sailing/domain/coursetemplate/impl/MarkTemplateBasedMarkConfigurationImpl.java @@ -1,6 +1,8 @@ package com.sap.sailing.domain.coursetemplate.impl; import com.sap.sailing.domain.coursetemplate.CommonMarkProperties; +import com.sap.sailing.domain.coursetemplate.MarkProperties; +import com.sap.sailing.domain.coursetemplate.MarkPropertiesBasedMarkConfiguration; import com.sap.sailing.domain.coursetemplate.MarkTemplate; import com.sap.sailing.domain.coursetemplate.MarkTemplateBasedMarkConfiguration; import com.sap.sailing.domain.coursetemplate.StorablePositioning; @@ -29,4 +31,16 @@ public class MarkTemplateBasedMarkConfigurationImpl extends MarkConfigurationImp return getOptionalMarkTemplate().getShortName(); } + /** + * When configuring a mark from a {@link MarkTemplate} using an instance of this type, no + * {@link MarkProperties} can be specified, and therefore this method always returns {@code null}. + * To provide {@link MarkProperties} that configure a mark and connect it with other properties + * that are based on a {@link MarkTemplate}, use {@link MarkPropertiesBasedMarkConfiguration} + * with a non-{@code null} {@link MarkPropertiesBasedMarkConfiguration#getOptionalMarkTemplate()} + * return value. + */ + @Override + public MarkProperties getOptionalMarkProperties() { + return null; + } } diff --git a/java/com.sap.sailing.server/src/com/sap/sailing/server/impl/CourseAndMarkConfigurationFactoryImpl.java b/java/com.sap.sailing.server/src/com/sap/sailing/server/impl/CourseAndMarkConfigurationFactoryImpl.java index ca82611eb9e..eda16a048be 100644 --- a/java/com.sap.sailing.server/src/com/sap/sailing/server/impl/CourseAndMarkConfigurationFactoryImpl.java +++ b/java/com.sap.sailing.server/src/com/sap/sailing/server/impl/CourseAndMarkConfigurationFactoryImpl.java @@ -152,16 +152,14 @@ public class CourseAndMarkConfigurationFactoryImpl implements CourseAndMarkConfi final Map effectiveConfigurations = new HashMap<>(); for (MarkConfiguration markConfiguration : courseConfiguration.getAllMarks()) { if (markConfiguration.isStoreToInventory()) { - MarkProperties markPropertiesOrNull = null; - if (markConfiguration instanceof FreestyleMarkConfiguration) { - markPropertiesOrNull = ((FreestyleMarkConfiguration) markConfiguration).getOptionalMarkProperties(); - } else if (markConfiguration instanceof RegattaMarkConfiguration) { - markPropertiesOrNull = ((RegattaMarkConfiguration) markConfiguration).getOptionalMarkProperties(); - } + MarkProperties markPropertiesOrNull = markConfiguration.getOptionalMarkProperties(); if (markPropertiesOrNull == null) { // If no mark properties exist yet, a new one is created markPropertiesOrNull = getSharedSailingData().createMarkProperties(markConfiguration.getEffectiveProperties(), Collections.emptySet()); } else { + // in the case of a MarkPropertiesBasedMarkConfiguration, the following call is expected to notice + // the identity between the mark properties object to update and the mark properties that constitute + // the effective properties and then skip the update. getSharedSailingData().updateMarkProperties(markPropertiesOrNull.getId(), markConfiguration.getEffectiveProperties(), null, null, Collections.emptySet()); } Positioning positioningOrNull = markConfiguration.getOptionalPositioning(); @@ -243,7 +241,6 @@ public class CourseAndMarkConfigurationFactoryImpl implements CourseAndMarkConfi public CourseConfiguration createCourseTemplateAndUpdatedConfiguration( final CourseConfiguration courseConfiguration, Iterable tags) { final CourseConfigurationWithMarkRoles courseConfigurationAfterInventory = handleSaveToInventory(courseConfiguration); - final Map markTemplatesByMarkConfigurations = new HashMap<>(); final Map marksConfigurationsMapping = new HashMap<>(); for (MarkConfiguration markConfiguration : courseConfigurationAfterInventory.getAllMarks()) { diff --git a/java/com.sap.sailing.shared.server/src/com/sap/sailing/shared/server/impl/SharedSailingDataImpl.java b/java/com.sap.sailing.shared.server/src/com/sap/sailing/shared/server/impl/SharedSailingDataImpl.java index 01d52060347..e54c92bba12 100644 --- a/java/com.sap.sailing.shared.server/src/com/sap/sailing/shared/server/impl/SharedSailingDataImpl.java +++ b/java/com.sap.sailing.shared.server/src/com/sap/sailing/shared/server/impl/SharedSailingDataImpl.java @@ -225,8 +225,10 @@ public class SharedSailingDataImpl implements ReplicatingSharedSailingData, Clea if (markProperties == null) { throw new NullPointerException(String.format("Could not find mark properties with id %s", uuid.toString())); } - getSecurityService().checkCurrentUserUpdatePermission(markProperties); - apply(s -> internalUpdateMarkProperties(uuid, properties, position, deviceIdentifier, tags)); + if (markProperties != properties) { // no update required if same object + getSecurityService().checkCurrentUserUpdatePermission(markProperties); + apply(s -> internalUpdateMarkProperties(uuid, properties, position, deviceIdentifier, tags)); + } return getMarkPropertiesById(uuid); } @@ -234,16 +236,18 @@ public class SharedSailingDataImpl implements ReplicatingSharedSailingData, Clea public Void internalUpdateMarkProperties(UUID idOfMarkProperties, CommonMarkProperties properties, Position position, DeviceIdentifier deviceIdentifier, Iterable tags) { final MarkPropertiesImpl markProperties = (MarkPropertiesImpl) markPropertiesById.get(idOfMarkProperties); - markProperties.setColor(properties.getColor()); - markProperties.setFixedPosition(position); - markProperties.setPattern(properties.getPattern()); - markProperties.setShape(properties.getShape()); - markProperties.setShortName(properties.getShortName()); - markProperties.setTrackingDeviceIdentifier(deviceIdentifier); - markProperties.setType(properties.getType()); - markProperties.setTags(tags); - mongoObjectFactory.storeMarkProperties(deviceIdentifierServiceFinder, markProperties); - markPropertiesById.put(idOfMarkProperties, markProperties); + if (markProperties != properties) { // no update required if same object + markProperties.setColor(properties.getColor()); + markProperties.setFixedPosition(position); + markProperties.setPattern(properties.getPattern()); + markProperties.setShape(properties.getShape()); + markProperties.setShortName(properties.getShortName()); + markProperties.setTrackingDeviceIdentifier(deviceIdentifier); + markProperties.setType(properties.getType()); + markProperties.setTags(tags); + mongoObjectFactory.storeMarkProperties(deviceIdentifierServiceFinder, markProperties); + markPropertiesById.put(idOfMarkProperties, markProperties); + } return null; }