Storage Classes update with dedicated Model Classes

Author: piconem

src/main/java/it/wldt/adapter/physical/PhysicalAssetActionRequest.java

@@ -1,10 +1,6 @@
 package it.wldt.adapter.physical;
 
-import org.slf4j.Logger;
-import org.slf4j.LoggerFactory;
-
 import java.util.Map;
-import java.util.Objects;
 
 /**
  * Author:

src/main/java/it/wldt/adapter/physical/PhysicalAssetPropertyVariation.java

@@ -1,55 +1,110 @@
 package it.wldt.adapter.physical;
 
+import it.wldt.storage.model.StorageRecord;
+
 import java.util.Map;
 
+/**
+ * Author: Marco Picone (picone.m@gmail.com)
+ * Date: 01/08/2024
+ * Physical Asset Property Variation Class
+ * Represents a Physical Asset Property Variation in the Digital Twin Framework
+ */
 public class PhysicalAssetPropertyVariation {
 
+    // Timestamp of the variation
     private long timestamp;
 
+    // Property Key associated to the variation
     private String propertykey;
 
+    // Body of the variation
     private Object body;
 
+    // Metadata associated to the variation
     private Map<String, Object> variationMetadata;
 
+    /**
+     * Default Constructor
+     */
     private PhysicalAssetPropertyVariation() {
     }
 
+    /**
+     * Constructor
+     *
+     * @param timestamp Timestamp of the variation
+     * @param propertykey Property Key associated to the variation
+     * @param body Body of the variation
+     * @param variationMetadata Metadata associated to the variation
+     */
     public PhysicalAssetPropertyVariation(long timestamp, String propertykey, Object body, Map<String, Object> variationMetadata) {
         this.timestamp = timestamp;
         this.propertykey = propertykey;
         this.body = body;
         this.variationMetadata = variationMetadata;
     }
 
+    /**
+     * Get the timestamp of the variation
+     * @return timestamp of the variation
+     */
     public long getTimestamp() {
         return timestamp;
     }
 
+    /**
+     * Set the timestamp of the variation
+     * @param timestamp timestamp of the variation
+     */
     public void setTimestamp(long timestamp) {
         this.timestamp = timestamp;
     }
 
+    /**
+     * Get the Property Key associated to the variation
+     * @return Property Key associated to the variation
+     */
     public String getPropertykey() {
         return propertykey;
     }
 
+    /**
+     * Set the Property Key associated to the variation
+     * @param propertykey Property Key associated to the variation
+     */
     public void setPropertykey(String propertykey) {
         this.propertykey = propertykey;
     }
 
+    /**
+     * Get the Body of the variation
+     * @return Body of the variation
+     */
     public Object getBody() {
         return body;
     }
 
+    /**
+     * Set the Body of the variation
+     * @param body Body of the variation
+     */
     public void setBody(Object body) {
         this.body = body;
     }
 
+    /**
+     * Get the Metadata associated to the variation
+     * @return Metadata associated to the variation
+     */
     public Map<String, Object> getVariationMetadata() {
         return variationMetadata;
     }
 
+    /**
+     * Set the Metadata associated to the variation
+     * @param variationMetadata Metadata associated to the variation
+     */
     public void setVariationMetadata(Map<String, Object> variationMetadata) {
         this.variationMetadata = variationMetadata;
     }

src/main/java/it/wldt/core/state/DigitalTwinStateEventNotification.java

@@ -1,8 +1,5 @@
 package it.wldt.core.state;
 
-import it.wldt.exception.EventBusException;
-import java.util.Map;
-
 /**
  * Authors:
  *          Marco Picone, Ph.D. (picone.m@gmail.com)

src/main/java/it/wldt/storage/DefaultWldtStorage.java

@@ -19,6 +19,7 @@
 import it.wldt.core.state.DigitalTwinStateManager;
 import it.wldt.exception.StorageException;
 import it.wldt.exception.WldtRuntimeException;
+import it.wldt.adapter.physical.PhysicalAssetPropertyVariation;
 import it.wldt.storage.query.DefaultQueryManager;
 import it.wldt.storage.query.QueryManager;
 import it.wldt.storage.query.QueryRequest;

src/main/java/it/wldt/storage/StorageManager.java

@@ -0,0 +1,49 @@
+package it.wldt.storage.model;
+
+/**
+ * Storage Record Class
+ * Represents a singola record in the storage with a unique id
+ */
+public class StorageRecord {
+
+    // Storage Record Id
+    private String id;
+
+    /**
+     * Default Constructor
+     */
+    public StorageRecord() {
+    }
+
+    /**
+     * Constructor
+     *
+     * @param id Storage Record Id
+     */
+    public StorageRecord(String id) {
+        this.id = id;
+    }
+
+    /**
+     * Get the Storage Record Id
+     * @return Storage Record Id
+     */
+    public String getId() {
+        return id;
+    }
+
+    /**
+     * Set the Storage Record Id
+     * @param id Storage Record Id
+     */
+    public void setId(String id) {
+        this.id = id;
+    }
+
+    @Override
+    public String toString() {
+        return "StorageRecord{" +
+                "id='" + id + '\'' +
+                '}';
+    }
+}

src/main/java/it/wldt/storage/WldtStorage.java

@@ -0,0 +1,122 @@
+package it.wldt.storage.model.digital;
+
+import it.wldt.storage.model.StorageRecord;
+
+import java.util.Map;
+
+/**
+ * Author: Marco Picone (picone.m@gmail.com)
+ * Date: 01/08/2024
+ * Digital Action Request Record Class
+ * Represents a Digital Action Request Record in the storage
+ */
+public class DigitalActionRequestRecord extends StorageRecord {
+
+    // Timestamp of the request
+    private long requestTimestamp;
+
+    // Action Key associated to the request
+    private String actionkey;
+
+    // Request Body
+    private Object requestBody;
+
+    // Metadata associated to the request
+    private Map<String, Object> requestMetadata;
+
+    /**
+     * Default Constructor
+     */
+    public DigitalActionRequestRecord() {
+    }
+
+    /**
+     * Constructor with all the required parameters
+     * @param requestTimestamp timestamp of the request
+     * @param actionkey action key associated to the request
+     * @param requestBody body of the request
+     * @param requestMetadata metadata associated to the request
+     */
+    public DigitalActionRequestRecord(long requestTimestamp, String actionkey, Object requestBody, Map<String, Object> requestMetadata) {
+        this.requestTimestamp = requestTimestamp;
+        this.actionkey = actionkey;
+        this.requestBody = requestBody;
+        this.requestMetadata = requestMetadata;
+    }
+
+    /**
+     * Get the timestamp of the request
+     * @return timestamp of the request
+     */
+    public long getRequestTimestamp() {
+        return requestTimestamp;
+    }
+
+    /**
+     * Set the timestamp of the request
+     * @param requestTimestamp timestamp of the request
+     */
+    public void setRequestTimestamp(long requestTimestamp) {
+        this.requestTimestamp = requestTimestamp;
+    }
+
+    /**
+     * Get the action key associated to the request
+     * @return action key associated to the request
+     */
+    public String getActionkey() {
+        return actionkey;
+    }
+
+    /**
+     * Set the action key associated to the request
+     * @param actionkey action key associated to the request
+     */
+    public void setActionkey(String actionkey) {
+        this.actionkey = actionkey;
+    }
+
+    /**
+     * Get the body of the request
+     * @return body of the request
+     */
+    public Object getRequestBody() {
+        return requestBody;
+    }
+
+    /**
+     * Set the body of the request
+     * @param requestBody body of the request
+     */
+    public void setRequestBody(Object requestBody) {
+        this.requestBody = requestBody;
+    }
+
+    /**
+     * Get the metadata associated to the request
+     * @return metadata associated to the request
+     */
+    public Map<String, Object> getRequestMetadata() {
+        return requestMetadata;
+    }
+
+    /**
+     * Set the metadata associated to the request
+     * @param requestMetadata metadata associated to the request
+     */
+    public void setRequestMetadata(Map<String, Object> requestMetadata) {
+        this.requestMetadata = requestMetadata;
+    }
+
+    @Override
+    public String toString() {
+        final StringBuilder sb = new StringBuilder("DigitalActionRequestRecord{");
+        sb.append("recordId=").append(getId());
+        sb.append("requestTimestamp=").append(requestTimestamp);
+        sb.append(", actionkey='").append(actionkey).append('\'');
+        sb.append(", requestBody=").append(requestBody);
+        sb.append(", requestMetadata=").append(requestMetadata);
+        sb.append('}');
+        return sb.toString();
+    }
+}

src/main/java/it/wldt/storage/model/StorageRecord.java

@@ -0,0 +1,78 @@
+package it.wldt.storage.model.lifecycle;
+
+import it.wldt.core.engine.LifeCycleState;
+import it.wldt.storage.model.StorageRecord;
+
+/**
+ * Author: Marco Picone (picone.m@gmail.com)
+ * Date: 01/08/2024
+ * Life Cycle Variation Record Class
+ * Represents a Life Cycle Variation Record in the storage
+ */
+public class LifeCycleVariationRecord extends StorageRecord {
+
+    // Life Cycle State associated to the variation
+    private LifeCycleState lifeCycleState;
+
+    // Timestamp of the variation
+    private long timestamp;
+
+    /**
+     * Default Constructor
+     */
+    public LifeCycleVariationRecord() {
+    }
+
+    /**
+     * Constructor
+     *
+     * @param lifeCycleState Life Cycle State associated to the variation
+     * @param timestamp Timestamp of the variation
+     */
+    public LifeCycleVariationRecord(LifeCycleState lifeCycleState, long timestamp) {
+        this.lifeCycleState = lifeCycleState;
+        this.timestamp = timestamp;
+    }
+
+    /**
+     * Get the Life Cycle State associated to the variation
+     * @return Life Cycle State associated to the variation
+     */
+    public LifeCycleState getLifeCycleState() {
+        return lifeCycleState;
+    }
+
+    /**
+     * Set the Life Cycle State associated to the variation
+     * @param lifeCycleState Life Cycle State associated to the variation
+     */
+    public void setLifeCycleState(LifeCycleState lifeCycleState) {
+        this.lifeCycleState = lifeCycleState;
+    }
+
+    /**
+     * Get the timestamp of the variation
+     * @return timestamp of the variation
+     */
+    public long getTimestamp() {
+        return timestamp;
+    }
+
+    /**
+     * Set the timestamp of the variation
+     * @param timestamp timestamp of the variation
+     */
+    public void setTimestamp(long timestamp) {
+        this.timestamp = timestamp;
+    }
+
+    @Override
+    public String toString() {
+        return "LifeCycleVariationRecord{" +
+                "recordId=" + getId() +
+                "lifeCycleState=" + lifeCycleState +
+                ", timestamp=" + timestamp +
+                '}';
+    }
+
+}