Reworked complex properties, extracted overlap with entities

Author: hylkevds

FROST-Server.Core.Model/src/main/java/de/fraunhofer/iosb/ilt/frostserver/model/ComplexValue.java

@@ -17,11 +17,13 @@
  */
 package de.fraunhofer.iosb.ilt.frostserver.model;
 
+import com.fasterxml.jackson.annotation.JsonIgnore;
+import de.fraunhofer.iosb.ilt.frostserver.model.core.ContainerType;
 import de.fraunhofer.iosb.ilt.frostserver.property.Property;
 
 /**
  * Interface that values of complex properties should implement to make it
- * easier to access sub-properties.
+ * easier to access sub-properties. An Entity is also a ComplexValue.
  *
  * @param <S> The type of the complex value (for fluent API)
  */
@@ -65,4 +67,15 @@ public interface ComplexValue<S extends ComplexValue<S>> {
      */
     public S setProperty(String name, Object value);
 
+    /**
+     * Returns true if the property is explicitly set to a value, even if this
+     * value is null.
+     *
+     * @param property the property to check.
+     * @return true if the property is explicitly set.
+     */
+    public boolean isSetProperty(Property property);
+
+    @JsonIgnore
+    public ContainerType getType();
 }

FROST-Server.Core.Model/src/main/java/de/fraunhofer/iosb/ilt/frostserver/model/ComplexValueImpl.java

@@ -19,7 +19,6 @@
 
 import com.fasterxml.jackson.annotation.JsonAnyGetter;
 import com.fasterxml.jackson.annotation.JsonAnySetter;
-import com.fasterxml.jackson.annotation.JsonIgnore;
 import de.fraunhofer.iosb.ilt.frostserver.property.Property;
 import de.fraunhofer.iosb.ilt.frostserver.property.type.TypeComplex;
 import java.util.Collections;
@@ -40,7 +39,7 @@ public ComplexValueImpl(TypeComplex type) {
         this.type = type;
     }
 
-    @JsonIgnore
+    @Override
     public TypeComplex getType() {
         return type;
     }
@@ -80,8 +79,13 @@ public ComplexValueImpl setProperty(String name, Object value) {
         return this;
     }
 
+    @Override
+    public boolean isSetProperty(Property property) {
+        return properties.containsKey(property.getJsonName());
+    }
+
     public static TypeComplex.Instantiator createFor(TypeComplex type) {
-        return () -> new ComplexValueImpl(type);
+        return t -> new ComplexValueImpl(t);
     }
 
 }

FROST-Server.Core.Model/src/main/java/de/fraunhofer/iosb/ilt/frostserver/model/DefaultEntity.java

@@ -37,8 +37,7 @@
 import java.util.Set;
 
 /**
- *
- * @author hylke
+ * The default entity implementation.
  */
 public class DefaultEntity implements Entity {
 
@@ -132,12 +131,12 @@ public DefaultEntity setSelfLink(String selfLink) {
     }
 
     @Override
-    public EntityType getEntityType() {
+    public EntityType getType() {
         return entityType;
     }
 
     @Override
-    public DefaultEntity setEntityType(EntityType entityType) {
+    public DefaultEntity setType(EntityType entityType) {
         if (this.entityType != null) {
             throw new IllegalArgumentException("the type of this entity is alread yet to " + this.entityType.entityName);
         }

FROST-Server.Core.Model/src/main/java/de/fraunhofer/iosb/ilt/frostserver/model/EntityChangedMessage.java

@@ -145,7 +145,7 @@ public Entity getEntity() {
 
     public EntityChangedMessage setEntity(Entity entity) {
         this.entity = entity;
-        this.entityType = entity.getEntityType();
+        this.entityType = entity.getType();
         return this;
     }
 

FROST-Server.Core.Model/src/main/java/de/fraunhofer/iosb/ilt/frostserver/model/EntityType.java

@@ -19,6 +19,7 @@
 
 import static de.fraunhofer.iosb.ilt.frostserver.util.Constants.NOT_IMPLEMENTED_MULTI_VALUE_PK;
 
+import de.fraunhofer.iosb.ilt.frostserver.model.core.ContainerType;
 import de.fraunhofer.iosb.ilt.frostserver.model.core.Entity;
 import de.fraunhofer.iosb.ilt.frostserver.model.core.EntitySet;
 import de.fraunhofer.iosb.ilt.frostserver.model.core.EntityValidator;
@@ -53,10 +54,8 @@
 
 /**
  * The types of entities in STA.
- *
- * @author jab, scf
  */
-public class EntityType implements Annotatable, Comparable<EntityType> {
+public class EntityType implements Annotatable, Comparable<EntityType>, ContainerType<EntityType> {
 
     private static final Logger LOGGER = LoggerFactory.getLogger(EntityType.class.getName());
 
@@ -139,6 +138,12 @@ public EntityType(String singular, String plural, boolean adminOnly) {
         this.adminOnly = adminOnly;
     }
 
+    @Override
+    public boolean isOpenType() {
+        return false;
+    }
+
+    @Override
     public EntityType registerProperty(Property property) {
         properties.add(property);
         propertiesByName.put(property.getName(), property);
@@ -288,6 +293,12 @@ public Property getProperty(String name) {
         return propertiesByName.get(name);
     }
 
+    @Override
+    public Map<String, Property> getPropertiesByName() {
+        return propertiesByName;
+    }
+
+    @Override
     public EntityPropertyMain getEntityProperty(String name) {
         Property<?> property = propertiesByName.get(name);
         if (property instanceof EntityPropertyMain entityPropertyMain) {
@@ -325,7 +336,7 @@ public NavigationPropertyEntitySet getNavigationPropertyEntitySet(String name) {
      *
      * @return The Set of PROPERTIES that Entities of this type have.
      */
-    public Set<Property> getPropertySet() {
+    public Set<Property> getProperties() {
         return properties;
     }
 
@@ -334,6 +345,7 @@ public Set<Property> getPropertySet() {
      *
      * @return The set of Entity properties.
      */
+    @Override
     public Set<EntityPropertyMain> getEntityProperties() {
         return entityProperties;
     }
@@ -377,7 +389,7 @@ public Set<NavigationPropertyMain<EntitySet>> getNavigationSets() {
      * incorrect (i.e. Observation with both a Datastream and a MultiDatastream.
      */
     public void validateCreate(Entity entity) throws IncompleteEntityException {
-        for (Property property : getPropertySet()) {
+        for (Property property : getProperties()) {
             if (entity.isSetProperty(property)) {
                 if (property.isReadOnly()) {
                     entity.unsetProperty(property);
@@ -398,7 +410,7 @@ public void validateCreate(Entity entity) throws IncompleteEntityException {
     }
 
     public void validateUpdate(Entity entity) throws IncompleteEntityException {
-        for (Property property : getPropertySet()) {
+        for (Property property : getProperties()) {
             if (!(property instanceof EntityPropertyMain)) {
                 continue;
             }
@@ -419,8 +431,8 @@ public void validateUpdate(Entity entity) throws IncompleteEntityException {
 
     public void setParent(PathElementEntitySet containingSet, Entity entity) throws IncompleteEntityException {
         EntityType setType = containingSet.getEntityType();
-        if (setType != entity.getEntityType()) {
-            throw new IllegalArgumentException("Set of type " + setType + " can not contain a " + entity.getEntityType());
+        if (setType != entity.getType()) {
+            throw new IllegalArgumentException("Set of type " + setType + " can not contain a " + entity.getType());
         }
         PathElement parent = containingSet.getParent();
         if (parent == null) {

FROST-Server.Core.Model/src/main/java/de/fraunhofer/iosb/ilt/frostserver/model/core/ContainerType.java

@@ -0,0 +1,69 @@
+/*
+ * Copyright (C) 2024 Fraunhofer Institut IOSB, Fraunhoferstr. 1, D 76131
+ * Karlsruhe, Germany.
+ *
+ * This program is free software: you can redistribute it and/or modify
+ * it under the terms of the GNU Lesser General Public License as published by
+ * the Free Software Foundation, either version 3 of the License, or
+ * (at your option) any later version.
+ *
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+ * GNU Lesser General Public License for more details.
+ *
+ * You should have received a copy of the GNU Lesser General Public License
+ * along with this program.  If not, see <http://www.gnu.org/licenses/>.
+ */
+package de.fraunhofer.iosb.ilt.frostserver.model.core;
+
+import de.fraunhofer.iosb.ilt.frostserver.property.EntityPropertyMain;
+import de.fraunhofer.iosb.ilt.frostserver.property.Property;
+import java.util.Map;
+import java.util.Set;
+
+/**
+ * Interface for Complex Types and Entity Types that contain sub-properties.
+ *
+ * @param <T> The type of the implementing class, for method chaining.
+ */
+public interface ContainerType<T extends ContainerType<T>> {
+
+    /**
+     * Register a new Property on this container type.
+     *
+     * @param property The property to register.
+     * @return this.
+     */
+    public T registerProperty(Property property);
+
+    /**
+     * Check if this type allows user-defined properties.
+     *
+     * @return true if this is an open type, false otherwise.
+     */
+    public boolean isOpenType();
+
+    /**
+     * Get all the entity properties registered on this container type.
+     *
+     * @return all the properties.
+     */
+    public Set<EntityPropertyMain> getEntityProperties();
+
+    /**
+     * Get the entity property with the given name.
+     *
+     * @param name The name of the property.
+     * @return The property with the given name, or null.
+     */
+    public EntityPropertyMain getEntityProperty(String name);
+
+    /**
+     * Get the map of all properties by their name.
+     *
+     * @return The name-property map.
+     */
+    public Map<String, Property> getPropertiesByName();
+
+}

FROST-Server.Core.Model/src/main/java/de/fraunhofer/iosb/ilt/frostserver/model/core/Entity.java

@@ -18,6 +18,7 @@
 package de.fraunhofer.iosb.ilt.frostserver.model.core;
 
 import com.fasterxml.jackson.annotation.JsonIgnore;
+import de.fraunhofer.iosb.ilt.frostserver.model.ComplexValue;
 import de.fraunhofer.iosb.ilt.frostserver.model.EntityChangedMessage;
 import de.fraunhofer.iosb.ilt.frostserver.model.EntityType;
 import de.fraunhofer.iosb.ilt.frostserver.path.PathElementEntity;
@@ -30,11 +31,8 @@
 
 /**
  * Interface defining basic methods of an Entity.
- *
- * @author jab
- * @author scf
  */
-public interface Entity extends NavigableElement {
+public interface Entity extends NavigableElement, ComplexValue<Entity> {
 
     /**
      * Get the primary key definition of the (EntityType of the) Entity. This is
@@ -62,11 +60,9 @@ public interface Entity extends NavigableElement {
 
     public Entity setSelfLink(String selfLink);
 
-    /**
-     * @return The type of this entity.
-     */
     @JsonIgnore
-    public EntityType getEntityType();
+    @Override
+    public EntityType getType();
 
     /**
      * Sets the type of the entity if it had not been previously set. This will
@@ -75,25 +71,7 @@ public interface Entity extends NavigableElement {
      * @param entityType The type of the entity to set.
      * @return this;
      */
-    public Entity setEntityType(EntityType entityType);
-
-    /**
-     * Returns true if the property is explicitly set to a value, even if this
-     * value is null.
-     *
-     * @param property the property to check.
-     * @return true if the property is explicitly set.
-     */
-    public boolean isSetProperty(Property property);
-
-    /**
-     * Get the value of the given Property as it is set on this Entity.
-     *
-     * @param <P> The type of the value of the property.
-     * @param property The property to get
-     * @return The value of the property.
-     */
-    public <P> P getProperty(Property<P> property);
+    public Entity setType(EntityType entityType);
 
     /**
      * Get the value pointed to by the given Path.
@@ -103,15 +81,15 @@ public interface Entity extends NavigableElement {
      */
     public Object getProperty(Path path);
 
-    /**
-     * Set the value of the given property.
-     *
-     * @param <P> The type of the value of the property.
-     * @param property The property to set the value for.
-     * @param value The value to set for the given property.
-     * @return This.
-     */
-    public <P> Entity setProperty(Property<P> property, P value);
+    @Override
+    public default Object getProperty(String name) {
+        return null;
+    }
+
+    @Override
+    public default Entity setProperty(String name, Object value) {
+        return this;
+    }
 
     public Entity unsetProperty(Property property);
 
@@ -169,7 +147,7 @@ public default void setEntityPropertiesSet() {
      * incorrect (i.e. Observation with both a Datastream and a MultiDatastream.
      */
     public default void validateCreate() throws IncompleteEntityException {
-        getEntityType().validateCreate(this);
+        getType().validateCreate(this);
     }
 
     /**
@@ -182,7 +160,7 @@ public default void validateCreate() throws IncompleteEntityException {
      * incorrect (i.e. Observation with both a Datastream and a MultiDatastream.
      */
     public default void validateUpdate() throws IncompleteEntityException {
-        getEntityType().validateUpdate(this);
+        getType().validateUpdate(this);
     }
 
     /**
@@ -206,7 +184,7 @@ public default void validateUpdate() throws IncompleteEntityException {
      */
     @JsonIgnore
     public default ResourcePath getPath() {
-        EntityType type = getEntityType();
+        EntityType type = getType();
         PathElementEntity epe = new PathElementEntity(type, null);
         epe.setPkValues(getPrimaryKeyValues());
         ResourcePath resourcePath = new ResourcePath();

FROST-Server.Core.Model/src/main/java/de/fraunhofer/iosb/ilt/frostserver/model/core/EntityReferenceList.java

@@ -40,8 +40,8 @@ public List<Entity> resolve(final EntityType reqType, final ModelRegistry mr, fi
         return value.stream()
                 .map(r -> {
                     final Entity e = r.resolve(mr, isAdmin);
-                    if (reqType != e.getEntityType()) {
-                        throw new IllegalArgumentException("Entity of type " + e.getEntityType() + " can not be added to set of " + reqType);
+                    if (reqType != e.getType()) {
+                        throw new IllegalArgumentException("Entity of type " + e.getType() + " can not be added to set of " + reqType);
                     }
                     return e;
                 })

FROST-Server.Core.Model/src/main/java/de/fraunhofer/iosb/ilt/frostserver/model/core/TimeDefaultValidator.java

@@ -40,7 +40,7 @@ public class TimeDefaultValidator implements EntityValidator {
     @Override
     public void validate(Entity entity) throws IncompleteEntityException {
         if (epTime == null) {
-            epTime = entity.getEntityType().getEntityProperty(propertyName);
+            epTime = entity.getType().getEntityProperty(propertyName);
         }
         if (entity.getProperty(epTime) == null) {
             entity.setProperty(epTime, new TimeInstant(Moment.nowInSystemTime()));