Issue #2716 - Independent time-zone mode: opt-out properties

platform-dao/src/main/java/ua/com/fielden/platform/sample/domain/TgEntityWithTimeZoneDatesDao.java

@@ -22,7 +22,7 @@ public TgEntityWithTimeZoneDatesDao(final IFilter filter) {
 
     @Override
     protected IFetchProvider<TgEntityWithTimeZoneDates> createFetchProvider() {
-        return super.createFetchProvider().with("key", "dateProp", "datePropUtc");
+        return super.createFetchProvider().with("key", "dateProp", "datePropUtc", "datePropDependent");
     }
 
 }

platform-pojo-bl/src/main/java/ua/com/fielden/platform/criteria/generator/impl/CriteriaGenerator.java

@@ -215,24 +215,21 @@ private static List<NewProperty> generateCriteriaProperties(final Class<? extend
         return generatedProperties;
     }
 
-    /**
-     * Copies date-related property annotations.
-     * 
-     * @param managedType
-     * @param propertyName
-     * @return
-     */
+    /// Copies date-related property annotations.
+    ///
     private static List<Annotation> copyDateAnnotations(final Class<?> managedType, final String propertyName) {
-        return of(DateOnly.class, TimeOnly.class, PersistentType.class)
+        return of(DateOnly.class, TimeOnly.class, PersistentType.class, DependentTimeZoneMode.class)
             .map(annotationType -> getPropertyAnnotationOptionally(annotationType, managedType, propertyName))
             .flatMap(annotation -> annotation.isPresent() ? of(annotation.get()) : empty())
             .map(annotation -> {
                 if (annotation instanceof DateOnly) {
                     return newDateOnlyAnnotation();
                 } else if (annotation instanceof TimeOnly) {
                     return newTimeOnlyAnnotation();
-                } else {
+                } else if (annotation instanceof PersistentType) {
                     return newUtcAnnotation();
+                } else {
+                    return newDependentTimeZoneModeAnnotation();
                 }
             })
             .collect(toList());

platform-pojo-bl/src/main/java/ua/com/fielden/platform/entity/annotation/DependentTimeZoneMode.java

@@ -0,0 +1,35 @@
+package ua.com.fielden.platform.entity.annotation;
+
+import ua.com.fielden.platform.utils.IDates;
+
+import java.lang.annotation.ElementType;
+import java.lang.annotation.Retention;
+import java.lang.annotation.RetentionPolicy;
+import java.lang.annotation.Target;
+import java.util.Date;
+
+/// An annotation for properties of type [java.util.Date] to enforce dependent time-zone mode in Web UI logic.
+///
+/// Please note, that appropriate [IDates#now()] and [IDates#zoned(Date)] method variations are required in server-side logic.
+/// I.e. it may not be sufficient to annotate the properties with this annotation.
+///
+/// ```java
+///static DateTime now(final IDates dates) {
+///    return new DateTime(getTimeZone(dates));
+///}
+///static DateTime zoned(final Date date, fina IDates dates) {
+///    return new DateTime(date, getTimeZone(dates));
+///}
+///private static DateTimeZone getTimeZone(final IDates dates) {
+///    if (dates.requestTimeZone().isEmpty()) {
+///        throw failure(ERR_TIME_ZONE_IS_MISSING);
+///    }
+///    return dates.requestTimeZone().get();
+///}
+/// ```
+///
+@Retention(RetentionPolicy.RUNTIME)
+@Target({ ElementType.FIELD })
+public @interface DependentTimeZoneMode {
+
+}

platform-pojo-bl/src/main/java/ua/com/fielden/platform/entity/annotation/factory/DateAnnotations.java

@@ -1,25 +1,19 @@
 package ua.com.fielden.platform.entity.annotation.factory;
 
-import java.lang.annotation.Annotation;
-
 import ua.com.fielden.platform.entity.annotation.DateOnly;
+import ua.com.fielden.platform.entity.annotation.DependentTimeZoneMode;
 import ua.com.fielden.platform.entity.annotation.PersistentType;
 import ua.com.fielden.platform.entity.annotation.TimeOnly;
 import ua.com.fielden.platform.types.markers.IUtcDateTimeType;
 
-/**
- * Factory for date annotations.
- * 
- * @author TG Team
- *
- */
+import java.lang.annotation.Annotation;
+
+/// Factory for date annotations.
+///
 public class DateAnnotations {
 
-    /**
-     * Instantiates {@link DateOnly} annotation.
-     * 
-     * @return
-     */
+    /// Instantiates [DateOnly] annotation.
+    ///
     public static DateOnly newDateOnlyAnnotation() {
         return new DateOnly() {
             @Override
@@ -29,11 +23,8 @@ public Class<? extends Annotation> annotationType() {
         };
     }
 
-    /**
-     * Instantiates {@link TimeOnly} annotation.
-     * 
-     * @return
-     */
+    /// Instantiates [TimeOnly] annotation.
+    ///
     public static TimeOnly newTimeOnlyAnnotation() {
         return new TimeOnly() {
             @Override
@@ -43,11 +34,8 @@ public Class<? extends Annotation> annotationType() {
         };
     }
 
-    /**
-     * Instantiates marker annotation for UTC date properties.
-     * 
-     * @return
-     */
+    /// Instantiates marker annotation for UTC date properties.
+    ///
     public static PersistentType newUtcAnnotation() {
         return new PersistentType() {
             @Override
@@ -66,5 +54,16 @@ public Class userType() {
             }
         };
     }
-
+
+    /// Instantiates [DependentTimeZoneMode] annotation.
+    ///
+    public static DependentTimeZoneMode newDependentTimeZoneModeAnnotation() {
+        return new DependentTimeZoneMode() {
+            @Override
+            public Class<? extends Annotation> annotationType() {
+                return DependentTimeZoneMode.class;
+            }
+        };
+    }
+
 }

platform-pojo-bl/src/main/java/ua/com/fielden/platform/sample/domain/TgEntityWithTimeZoneDates.java

@@ -4,6 +4,7 @@
 
 import ua.com.fielden.platform.entity.AbstractPersistentEntity;
 import ua.com.fielden.platform.entity.annotation.CompanionObject;
+import ua.com.fielden.platform.entity.annotation.DependentTimeZoneMode;
 import ua.com.fielden.platform.entity.annotation.IsProperty;
 import ua.com.fielden.platform.entity.annotation.KeyTitle;
 import ua.com.fielden.platform.entity.annotation.KeyType;
@@ -41,6 +42,22 @@ public class TgEntityWithTimeZoneDates extends AbstractPersistentEntity<String>
     @AfterChange(UtcDatesToLocalDefiner.class)
     private Date datePropUtc;
 
+    @IsProperty
+    @MapTo
+    @Title("Date Prop Dependent")
+    @DependentTimeZoneMode
+    private Date datePropDependent;
+
+    @Observable
+    public TgEntityWithTimeZoneDates setDatePropDependent(final Date datePropDependent) {
+        this.datePropDependent = datePropDependent;
+        return this;
+    }
+
+    public Date getDatePropDependent() {
+        return datePropDependent;
+    }
+
     @Observable
     public TgEntityWithTimeZoneDates setDatePropUtc(final Date datePropUtc) {
         this.datePropUtc = datePropUtc;

platform-pojo-bl/src/main/java/ua/com/fielden/platform/serialisation/jackson/DefaultValueContract.java

@@ -1,19 +1,5 @@
 package ua.com.fielden.platform.serialisation.jackson;
 
-import static java.lang.Boolean.FALSE;
-import static java.util.Optional.empty;
-import static java.util.Optional.of;
-import static ua.com.fielden.platform.entity.annotation.IsProperty.DEFAULT_DISPLAY_AS;
-import static ua.com.fielden.platform.entity.annotation.IsProperty.DEFAULT_LENGTH;
-import static ua.com.fielden.platform.entity.annotation.IsProperty.DEFAULT_PRECISION;
-import static ua.com.fielden.platform.entity.annotation.IsProperty.DEFAULT_SCALE;
-import static ua.com.fielden.platform.entity.annotation.IsProperty.DEFAULT_TRAILING_ZEROS;
-import static ua.com.fielden.platform.reflection.TitlesDescsGetter.getDefaultEntityTitleAndDesc;
-import static ua.com.fielden.platform.types.tuples.T2.t2;
-import static ua.com.fielden.platform.utils.EntityUtils.equalsEx;
-
-import java.util.Optional;
-
 import ua.com.fielden.platform.entity.AbstractEntity;
 import ua.com.fielden.platform.entity.annotation.DateOnly;
 import ua.com.fielden.platform.entity.annotation.PersistentType;
@@ -26,15 +12,24 @@
 import ua.com.fielden.platform.types.markers.IUtcDateTimeType;
 import ua.com.fielden.platform.types.tuples.T2;
 
-/**
- * A set of utilities to determine if the value of some property or meta-info is default. It is used internally for Jackson entity serialiser to significantly reduce the amount of
- * the information to be serialised.
- *
- * @author TG Team
- *
- */
+import java.util.Optional;
+
+import static java.lang.Boolean.FALSE;
+import static java.util.Optional.empty;
+import static java.util.Optional.of;
+import static ua.com.fielden.platform.entity.annotation.IsProperty.*;
+import static ua.com.fielden.platform.reflection.AnnotationReflector.isPropertyAnnotationPresent;
+import static ua.com.fielden.platform.reflection.TitlesDescsGetter.getDefaultEntityTitleAndDesc;
+import static ua.com.fielden.platform.types.tuples.T2.t2;
+import static ua.com.fielden.platform.utils.EntityUtils.equalsEx;
+
+/// A set of utilities to determine if the value of some property or meta-info is default.
+/// It is used internally for Jackson entity serialiser to significantly reduce the amount of the information to be serialised.
+///
 public class DefaultValueContract {
     private static final String UTC = "UTC";
+    public static final String DATE_ONLY = "DATE";
+    public static final String TIME_ONLY = "TIME";
 
     private DefaultValueContract() {
     }
@@ -134,18 +129,14 @@ public static boolean isUtc(final Class<?> entityType, final String propertyName
         return UTC.equals(getTimeZone(entityType, propertyName));
     }
 
-    /**
-     * Returns the value that indicates what portion of date property to display.
-     *
-     * @param entityType
-     * @param propertyName
-     * @return
-     */
+    /// Returns the value that indicates which portion of date property to display.
+    ///
     public static String getTimePortionToDisplay(final Class<?> entityType, final String propertyName) {
-        if (AnnotationReflector.isPropertyAnnotationPresent(DateOnly.class, entityType, propertyName)) {
-            return "DATE";
-        } else if (AnnotationReflector.isPropertyAnnotationPresent(TimeOnly.class, entityType, propertyName)) {
-            return "TIME";
+        if (isPropertyAnnotationPresent(DateOnly.class, entityType, propertyName)) {
+            return DATE_ONLY;
+        }
+        else if (isPropertyAnnotationPresent(TimeOnly.class, entityType, propertyName)) {
+            return TIME_ONLY;
         }
         return null;
     }

platform-pojo-bl/src/main/java/ua/com/fielden/platform/serialisation/jackson/EntitySerialiser.java

@@ -199,12 +199,16 @@ private static <T extends AbstractEntity<?>> EntityType createEntityTypeInfo(fin
                 if (!isIgnoreDefault(ignore)) {
                     entityTypeProp.set_ignore(ignore);
                 }
-                if (isPropertyAnnotationPresent(DateOnly.class, type, name)) {
+                final var timePortion = getTimePortionToDisplay(type, name);
+                if (DATE_ONLY.equals(timePortion)) {
                     entityTypeProp.set_date(TRUE);
                 }
-                if (isPropertyAnnotationPresent(TimeOnly.class, type, name)) {
+                else if (TIME_ONLY.equals(timePortion)) {
                     entityTypeProp.set_time(TRUE);
                 }
+                if (isPropertyAnnotationPresent(DependentTimeZoneMode.class, type, name)) {
+                    entityTypeProp.set_dependentTimeZoneMode(TRUE);
+                }
                 final IsProperty isPropertyAnnotation = AnnotationReflector.getPropertyAnnotation(IsProperty.class, type, name);
                 if (isPropertyAnnotation != null) {
                     final Long length = Long.valueOf(isPropertyAnnotation.length());

platform-pojo-bl/src/main/java/ua/com/fielden/platform/serialisation/jackson/EntityTypeProp.java

@@ -58,6 +58,10 @@ public class EntityTypeProp extends AbstractEntity<String> {
     @Title(value = "TimeZone", desc = "TimeZone of date-typed property.")
     private String _timeZone;
 
+    @IsProperty
+    @Title(value = "Dependent Time-zone Mode", desc = "Dependent Time-zone Mode of date-typed property.")
+    private Boolean _dependentTimeZoneMode;
+
     @IsProperty
     @Title(value = "Is Date Only?", desc = "Should display only date portion?")
     private Boolean _date;
@@ -156,6 +160,16 @@ public Boolean get_date() {
         return _date;
     }
 
+    @Observable
+    public EntityTypeProp set_dependentTimeZoneMode(final Boolean _dependentTimeZoneMode) {
+        this._dependentTimeZoneMode = _dependentTimeZoneMode;
+        return this;
+    }
+
+    public Boolean get_dependentTimeZoneMode() {
+        return _dependentTimeZoneMode;
+    }
+
     @Observable
     public EntityTypeProp set_timeZone(final String _timeZone) {
         this._timeZone = _timeZone;

platform-web-resources/src/main/java/ua/com/fielden/platform/web/test/server/config/TgEntityWithTimeZoneDatesWebUiConfig.java

@@ -68,19 +68,21 @@ private EntityCentre<TgEntityWithTimeZoneDates> createCentre(final Injector inje
                     .withSummary("total_count_", "COUNT(SELF)", "Count:The total number of matching TgEntityWithTimeZoneDates.")
                     .withAction(standardEditAction).also()
                 .addProp("dateProp").minWidth(100).also()
-                .addProp("datePropUtc").minWidth(100)
+                .addProp("datePropUtc").minWidth(100).also()
+                .addProp("datePropDependent").minWidth(100)
                 .addPrimaryAction(standardEditAction)
                 .build();
 
         final EntityCentre<TgEntityWithTimeZoneDates> entityCentre = new EntityCentre<>(MiTgEntityWithTimeZoneDates.class, "MiTgEntityWithTimeZoneDates", ecc, injector, null);
         return entityCentre;
     }
     private EntityMaster<TgEntityWithTimeZoneDates> createMaster(final Injector injector) {
-        final String layout = LayoutComposer.mkGridForMaster(640, 1, 2);
+        final String layout = LayoutComposer.mkGridForMaster(960, 1, 3);
 
         final IMaster<TgEntityWithTimeZoneDates> masterConfig = new SimpleMasterBuilder<TgEntityWithTimeZoneDates>().forEntity(TgEntityWithTimeZoneDates.class)
                 .addProp("dateProp").asDateTimePicker().also()
                 .addProp("datePropUtc").asDateTimePicker().also()
+                .addProp("datePropDependent").asDateTimePicker().also()
                 .addAction(MasterActions.REFRESH).shortDesc("Cancel").longDesc("Cancel action")
                 .addAction(MasterActions.SAVE)
                 .setActionBarLayoutFor(Device.DESKTOP, Optional.empty(), LayoutComposer.mkActionLayoutForMaster())

platform-web-ui/src/main/java/ua/com/fielden/platform/web/centre/api/crit/impl/DateCriterionWidget.java

@@ -1,41 +1,29 @@
 package ua.com.fielden.platform.web.centre.api.crit.impl;
 
-import java.util.Map;
-
 import ua.com.fielden.platform.entity.AbstractEntity;
-import ua.com.fielden.platform.serialisation.jackson.DefaultValueContract;
 import ua.com.fielden.platform.web.view.master.api.widgets.datetimepicker.impl.DateTimePickerWidget;
 
-/**
- * An implementation for date double-editor criterion.
- *
- * @author TG Team
- *
- */
+import java.util.Map;
+
+/// An implementation for date double-editor criterion.
+///
 public class DateCriterionWidget extends AbstractRangeCriterionWidget {
 
-    /**
-     * Creates an instance of {@link DateCriterionWidget} for specified entity type and property name.
-     *
-     * @param criteriaType
-     * @param propertyName
-     */
+    /// Creates an instance of [DateCriterionWidget] for specified entity type and property name.
+    ///
     public DateCriterionWidget(final Class<? extends AbstractEntity<?>> root, final Class<?> managedType, final String propertyName) {
         super(root, "centre/criterion/multi/range/tg-date-range-criterion", propertyName,
-                new DateTimePickerWidget(
-                        AbstractCriterionWidget.generateTitleDesc(root, managedType, propertyName).getKey(),
-                        AbstractCriterionWidget.generateNames(root, managedType, propertyName).getKey(),
-                        false,
-                        DefaultValueContract.getTimeZone(managedType, propertyName),
-                        DefaultValueContract.getTimePortionToDisplay(managedType, propertyName)
-                ),
-                new DateTimePickerWidget(
-                        AbstractCriterionWidget.generateTitleDesc(root, managedType, propertyName).getValue(),
-                        AbstractCriterionWidget.generateNames(root, managedType, propertyName).getValue(),
-                        true,
-                        DefaultValueContract.getTimeZone(managedType, propertyName),
-                        DefaultValueContract.getTimePortionToDisplay(managedType, propertyName)
-                ));
+            new DateTimePickerWidget(
+                generateTitleDesc(root, managedType, propertyName).getKey(),
+                generateNames(root, managedType, propertyName).getKey(),
+                false
+            ),
+            new DateTimePickerWidget(
+                generateTitleDesc(root, managedType, propertyName).getValue(),
+                generateNames(root, managedType, propertyName).getValue(),
+                true
+            )
+        );
     }
 
     @Override