Added descriptor classes for processing data definition

Author: dariol83

eu.dariolucia.reatmetric.api/src/main/java/eu/dariolucia/reatmetric/api/activity/ActivityArgumentDescriptor.java

@@ -0,0 +1,92 @@
+/*
+ * Copyright (c)  2020 Dario Lucia (https://www.dariolucia.eu)
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *          http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+package eu.dariolucia.reatmetric.api.activity;
+
+import eu.dariolucia.reatmetric.api.value.ValueTypeEnum;
+
+public class ActivityArgumentDescriptor {
+
+    private final String name;
+    private final String description;
+    private final ValueTypeEnum rawDataType;
+    private final ValueTypeEnum engineeringDataType;
+    private final String unit;
+    private final boolean fixed;
+    private final boolean defaultValuePresent;
+    private final Object engineeringDefaultValue;
+    private final Object rawDefaultValue;
+    private final boolean decalibrationSet;
+    private final boolean checkSet;
+
+    public ActivityArgumentDescriptor(String name, String description, ValueTypeEnum rawDataType, ValueTypeEnum engineeringDataType, String unit, boolean fixed, boolean defaultValuePresent, Object engineeringDefaultValue, Object rawDefaultValue, boolean decalibrationSet, boolean checkSet) {
+        this.name = name;
+        this.description = description;
+        this.rawDataType = rawDataType;
+        this.engineeringDataType = engineeringDataType;
+        this.unit = unit;
+        this.fixed = fixed;
+        this.defaultValuePresent = defaultValuePresent;
+        this.engineeringDefaultValue = engineeringDefaultValue;
+        this.rawDefaultValue = rawDefaultValue;
+        this.decalibrationSet = decalibrationSet;
+        this.checkSet = checkSet;
+    }
+
+    public String getName() {
+        return name;
+    }
+
+    public String getDescription() {
+        return description;
+    }
+
+    public ValueTypeEnum getRawDataType() {
+        return rawDataType;
+    }
+
+    public ValueTypeEnum getEngineeringDataType() {
+        return engineeringDataType;
+    }
+
+    public String getUnit() {
+        return unit;
+    }
+
+    public boolean isFixed() {
+        return fixed;
+    }
+
+    public boolean isDefaultValuePresent() {
+        return defaultValuePresent;
+    }
+
+    public Object getEngineeringDefaultValue() {
+        return engineeringDefaultValue;
+    }
+
+    public Object getRawDefaultValue() {
+        return rawDefaultValue;
+    }
+
+    public boolean isDecalibrationSet() {
+        return decalibrationSet;
+    }
+
+    public boolean isCheckSet() {
+        return checkSet;
+    }
+}

eu.dariolucia.reatmetric.api/src/main/java/eu/dariolucia/reatmetric/api/activity/ActivityDescriptor.java

@@ -0,0 +1,62 @@
+/*
+ * Copyright (c)  2020 Dario Lucia (https://www.dariolucia.eu)
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *          http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+package eu.dariolucia.reatmetric.api.activity;
+
+import eu.dariolucia.reatmetric.api.common.AbstractSystemEntityDescriptor;
+import eu.dariolucia.reatmetric.api.common.Pair;
+import eu.dariolucia.reatmetric.api.model.SystemEntityPath;
+import eu.dariolucia.reatmetric.api.model.SystemEntityType;
+
+import java.util.List;
+
+public class ActivityDescriptor extends AbstractSystemEntityDescriptor {
+
+    private final String description;
+    private final String defaultRoute;
+    private final String activityType;
+    private final List<ActivityArgumentDescriptor> argumentDescriptors;
+    private final List<Pair<String, String>> properties;
+
+    public ActivityDescriptor(SystemEntityPath path, int externalId, String description, String defaultRoute, String activityType, List<ActivityArgumentDescriptor> argumentDescriptors, List<Pair<String, String>> properties) {
+        super(path, externalId, SystemEntityType.ACTIVITY);
+        this.description = description;
+        this.defaultRoute = defaultRoute;
+        this.activityType = activityType;
+        this.argumentDescriptors = List.copyOf(argumentDescriptors);
+        this.properties = List.copyOf(properties);
+    }
+
+    public String getDescription() {
+        return description;
+    }
+
+    public String getDefaultRoute() {
+        return defaultRoute;
+    }
+
+    public String getActivityType() {
+        return activityType;
+    }
+
+    public List<ActivityArgumentDescriptor> getArgumentDescriptors() {
+        return argumentDescriptors;
+    }
+
+    public List<Pair<String, String>> getProperties() {
+        return properties;
+    }
+}

eu.dariolucia.reatmetric.api/src/main/java/eu/dariolucia/reatmetric/api/activity/IActivityOccurrenceDataProvisionService.java

@@ -18,10 +18,15 @@
 package eu.dariolucia.reatmetric.api.activity;
 
 import eu.dariolucia.reatmetric.api.common.IDataItemStateProvisionService;
+import eu.dariolucia.reatmetric.api.common.exceptions.ReatmetricException;
+import eu.dariolucia.reatmetric.api.model.SystemEntityPath;
 
 /**
  * This interface is a specialisation of the {@link IDataItemStateProvisionService}, for activity occurrences.
  */
 public interface IActivityOccurrenceDataProvisionService extends IDataItemStateProvisionService<IActivityOccurrenceDataSubscriber, ActivityOccurrenceDataFilter, ActivityOccurrenceData> {
-   
+
+    ActivityDescriptor getDescriptor(SystemEntityPath path) throws ReatmetricException;
+
+    ActivityDescriptor getDescriptor(int externalId) throws ReatmetricException;
 }

eu.dariolucia.reatmetric.api/src/main/java/eu/dariolucia/reatmetric/api/common/AbstractSystemEntityDescriptor.java

@@ -0,0 +1,64 @@
+/*
+ * Copyright (c)  2020 Dario Lucia (https://www.dariolucia.eu)
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *          http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+package eu.dariolucia.reatmetric.api.common;
+
+import eu.dariolucia.reatmetric.api.model.SystemEntityPath;
+import eu.dariolucia.reatmetric.api.model.SystemEntityType;
+
+import java.io.Serializable;
+
+/**
+ * Objects of this class are descriptions of the specific system entity they refer to.
+ */
+public abstract class AbstractSystemEntityDescriptor implements Serializable {
+
+    /**
+     *
+     */
+    private static final long serialVersionUID = 1L;
+
+    private final SystemEntityPath path;
+    private final int externalId;
+    private final SystemEntityType type;
+
+    protected AbstractSystemEntityDescriptor(SystemEntityPath path, int externalId, SystemEntityType type) {
+        this.path = path;
+        this.externalId = externalId;
+        this.type = type;
+    }
+
+    public SystemEntityPath getPath() {
+        return path;
+    }
+
+    public int getExternalId() {
+        return externalId;
+    }
+
+    public SystemEntityType getType() {
+        return type;
+    }
+
+    @Override
+    public String toString() {
+        return "{" +
+                "externalId=" + getExternalId() +
+                ", path=" + getPath() +
+                ", type=" + getType() +
+                "}";
+    }
+}

eu.dariolucia.reatmetric.api/src/main/java/eu/dariolucia/reatmetric/api/events/EventDescriptor.java

@@ -0,0 +1,55 @@
+/*
+ * Copyright (c)  2020 Dario Lucia (https://www.dariolucia.eu)
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *          http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+package eu.dariolucia.reatmetric.api.events;
+
+import eu.dariolucia.reatmetric.api.common.AbstractSystemEntityDescriptor;
+import eu.dariolucia.reatmetric.api.messages.Severity;
+import eu.dariolucia.reatmetric.api.model.SystemEntityPath;
+import eu.dariolucia.reatmetric.api.model.SystemEntityType;
+
+public class EventDescriptor extends AbstractSystemEntityDescriptor {
+
+    private final String description;
+    private final Severity severity;
+    private final String eventType;
+    private final boolean conditionDriven;
+
+    public EventDescriptor(SystemEntityPath path, int externalId, String description, Severity severity, String eventType, boolean conditionDriven) {
+        super(path, externalId, SystemEntityType.EVENT);
+        this.description = description;
+        this.severity = severity;
+        this.eventType = eventType;
+        this.conditionDriven = conditionDriven;
+    }
+
+    public String getDescription() {
+        return description;
+    }
+
+    public Severity getSeverity() {
+        return severity;
+    }
+
+    public String getEventType() {
+        return eventType;
+    }
+
+    public boolean isConditionDriven() {
+        return conditionDriven;
+    }
+
+}

eu.dariolucia.reatmetric.api/src/main/java/eu/dariolucia/reatmetric/api/events/IEventDataProvisionService.java

@@ -18,11 +18,16 @@
 package eu.dariolucia.reatmetric.api.events;
 
 import eu.dariolucia.reatmetric.api.common.IDataItemProvisionService;
+import eu.dariolucia.reatmetric.api.common.exceptions.ReatmetricException;
+import eu.dariolucia.reatmetric.api.model.SystemEntityPath;
 
 /**
  *
  * @author dario
  */
 public interface IEventDataProvisionService extends IDataItemProvisionService<IEventDataSubscriber, EventDataFilter, EventData> {
 
+    EventDescriptor getDescriptor(SystemEntityPath path) throws ReatmetricException;
+
+    EventDescriptor getDescriptor(int externalId) throws ReatmetricException;
 }

eu.dariolucia.reatmetric.api/src/main/java/eu/dariolucia/reatmetric/api/model/ISystemModelProvisionService.java

@@ -17,6 +17,7 @@
 
 package eu.dariolucia.reatmetric.api.model;
 
+import eu.dariolucia.reatmetric.api.common.AbstractSystemEntityDescriptor;
 import eu.dariolucia.reatmetric.api.common.exceptions.ReatmetricException;
 import eu.dariolucia.reatmetric.api.processing.exceptions.ProcessingModelException;
 
@@ -47,4 +48,9 @@ public interface ISystemModelProvisionService {
     void enable(SystemEntityPath path) throws ReatmetricException;
 
     void disable(SystemEntityPath path) throws ReatmetricException;
+
+    AbstractSystemEntityDescriptor getDescriptorOf(int id) throws ReatmetricException;
+
+    AbstractSystemEntityDescriptor getDescriptorOf(SystemEntityPath path) throws ReatmetricException;
+
 }

eu.dariolucia.reatmetric.api/src/main/java/eu/dariolucia/reatmetric/api/model/SystemEntityPath.java

@@ -30,7 +30,7 @@ public final class SystemEntityPath implements Comparable<SystemEntityPath>, Ser
     /**
 	 * 
 	 */
-	private static final long serialVersionUID = 8858858517842953497L;
+	private static final long serialVersionUID = 1L;
 
 	public static SystemEntityPath fromString(String systemEntity) {
         String[] parts = systemEntity.split("\\.", -1);

eu.dariolucia.reatmetric.api/src/main/java/eu/dariolucia/reatmetric/api/parameters/IParameterDataProvisionService.java

@@ -18,11 +18,16 @@
 package eu.dariolucia.reatmetric.api.parameters;
 
 import eu.dariolucia.reatmetric.api.common.IDataItemStateProvisionService;
+import eu.dariolucia.reatmetric.api.common.exceptions.ReatmetricException;
+import eu.dariolucia.reatmetric.api.model.SystemEntityPath;
 
 /**
  *
  * @author dario
  */
 public interface IParameterDataProvisionService extends IDataItemStateProvisionService<IParameterDataSubscriber, ParameterDataFilter, ParameterData> {
-   
+
+    ParameterDescriptor getDescriptor(SystemEntityPath path) throws ReatmetricException;
+
+    ParameterDescriptor getDescriptor(int externalId) throws ReatmetricException;
 }