You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@streampipes.apache.org by bo...@apache.org on 2024/05/06 07:54:35 UTC

(streampipes) branch iotdb-property-converter created (now 1dbe764a2c)

This is an automated email from the ASF dual-hosted git repository.

bossenti pushed a change to branch iotdb-property-converter
in repository https://gitbox.apache.org/repos/asf/streampipes.git


      at 1dbe764a2c feat: add property converter for IoTDB

This branch includes the following new commits:

     new 1dbe764a2c feat: add property converter for IoTDB

The 1 revisions listed above as "new" are entirely new to this
repository and will be described in separate emails.  The revisions
listed as "add" were already present in the repository and have only
been added to this reference.



(streampipes) 01/01: feat: add property converter for IoTDB

Posted by bo...@apache.org.
This is an automated email from the ASF dual-hosted git repository.

bossenti pushed a commit to branch iotdb-property-converter
in repository https://gitbox.apache.org/repos/asf/streampipes.git

commit 1dbe764a2cd8953811b5b1bae1288a4662e1800f
Author: bossenti <bo...@posteo.de>
AuthorDate: Mon May 6 09:51:27 2024 +0200

    feat: add property converter for IoTDB
---
 .../ts/store/iotdb/IotDbMeasurementRecord.java     |  36 ++++++++
 .../ts/store/iotdb/IotDbPropertyConverter.java     |  90 ++++++++++++++++++
 .../ts/store/iotdb/IotDbPropertyConverterTest.java | 102 +++++++++++++++++++++
 3 files changed, 228 insertions(+)

diff --git a/streampipes-ts-store-iotdb/src/main/java/org/apache/streampipes/ts/store/iotdb/IotDbMeasurementRecord.java b/streampipes-ts-store-iotdb/src/main/java/org/apache/streampipes/ts/store/iotdb/IotDbMeasurementRecord.java
new file mode 100644
index 0000000000..63cb18f4b4
--- /dev/null
+++ b/streampipes-ts-store-iotdb/src/main/java/org/apache/streampipes/ts/store/iotdb/IotDbMeasurementRecord.java
@@ -0,0 +1,36 @@
+/*
+ * Licensed to the Apache Software Foundation (ASF) under one or more
+ * contributor license agreements.  See the NOTICE file distributed with
+ * this work for additional information regarding copyright ownership.
+ * The ASF licenses this file to You 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 org.apache.streampipes.ts.store.iotdb;
+
+import org.apache.iotdb.tsfile.file.metadata.enums.TSDataType;
+
+/**
+ * Represents a record containing a measurement and its associated metadata
+ * to be inserted into the Apache IoTDB.
+ * <p>
+ * This record encapsulates the measurement name, data type, and its corresponding value.
+ *
+ * @param measurementName The name of the measurement.
+ * @param dataType        The data type of the measurement value.
+ * @param value           The value of the measurement.
+ */
+public record IotDbMeasurementRecord(String measurementName,
+                                     TSDataType dataType,
+                                     Object value) {
+}
diff --git a/streampipes-ts-store-iotdb/src/main/java/org/apache/streampipes/ts/store/iotdb/IotDbPropertyConverter.java b/streampipes-ts-store-iotdb/src/main/java/org/apache/streampipes/ts/store/iotdb/IotDbPropertyConverter.java
new file mode 100644
index 0000000000..c0793ba9eb
--- /dev/null
+++ b/streampipes-ts-store-iotdb/src/main/java/org/apache/streampipes/ts/store/iotdb/IotDbPropertyConverter.java
@@ -0,0 +1,90 @@
+/*
+ * Licensed to the Apache Software Foundation (ASF) under one or more
+ * contributor license agreements.  See the NOTICE file distributed with
+ * this work for additional information regarding copyright ownership.
+ * The ASF licenses this file to You 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 org.apache.streampipes.ts.store.iotdb;
+
+import org.apache.iotdb.tsfile.file.metadata.enums.TSDataType;
+import org.apache.streampipes.commons.exceptions.SpRuntimeException;
+import org.apache.streampipes.model.runtime.field.PrimitiveField;
+import org.apache.streampipes.model.schema.EventProperty;
+import org.apache.streampipes.model.schema.EventPropertyPrimitive;
+import org.apache.streampipes.vocabulary.SO;
+import org.apache.streampipes.vocabulary.XSD;
+
+/**
+ * Converts StreamPipes {@link EventProperty} into {@link IotDbMeasurementRecord}s.
+ */
+public class IotDbPropertyConverter {
+
+  /**
+   * Converts a {@link EventPropertyPrimitive }into an {@link IotDbMeasurementRecord}.
+   *
+   * @param eventPropertyPrimitive The primitive event property to be converted
+   * @param primitiveField         The primitive field containing the property value
+   * @param sanitizedRuntimeName   The sanitized name of the property
+   * @return An IoTDB measurement record representing the converted property
+   */
+  public IotDbMeasurementRecord convertPrimitiveProperty(
+      EventPropertyPrimitive eventPropertyPrimitive,
+      PrimitiveField primitiveField,
+      String sanitizedRuntimeName
+  ) {
+    var runtimeType = eventPropertyPrimitive.getRuntimeType();
+    Object value;
+    TSDataType iotDbType;
+
+    if (XSD.INTEGER.toString().equals(runtimeType)) {
+      iotDbType = TSDataType.INT32;
+      value = primitiveField.getAsInt();
+    } else if (XSD.LONG.toString().equals(runtimeType)) {
+      iotDbType = TSDataType.INT64;
+      value = primitiveField.getAsLong();
+    } else if (XSD.FLOAT.toString().equals(runtimeType)) {
+      iotDbType = TSDataType.FLOAT;
+      value = primitiveField.getAsFloat();
+     }else if (XSD.DOUBLE.toString().equals(runtimeType) || SO.NUMBER.equals(runtimeType)) {
+      iotDbType = TSDataType.DOUBLE;
+      value = primitiveField.getAsDouble();
+    } else if (XSD.BOOLEAN.toString().equals(runtimeType)) {
+      iotDbType = TSDataType.BOOLEAN;
+      value = primitiveField.getAsBoolean();
+    } else if (XSD.STRING.toString().equals(runtimeType)){
+      iotDbType = TSDataType.TEXT;
+      value = primitiveField.getAsString();
+    } else {
+      throw new SpRuntimeException("Unsupported runtime type '%s' - cannot be mapped to a IoTDB data type".formatted(runtimeType));
+    }
+
+    return new IotDbMeasurementRecord(sanitizedRuntimeName, iotDbType, value);
+  }
+
+  /**
+   * Converts a non-primitive event property into an {@link IotDbMeasurementRecord}.
+   *
+   * @param eventProperty       The non-primitive event property to be converted
+   * @param sanitizedRuntimeName The sanitized name of the property
+   * @return An IoTDB measurement record representing the converted property
+   * @throws SpRuntimeException If an error occurs during conversion
+   */
+  public IotDbMeasurementRecord convertNonPrimitiveProperty(
+      EventProperty eventProperty,
+      String sanitizedRuntimeName) throws SpRuntimeException {
+    throw new SpRuntimeException("Handling non-primitive event properties is not yet supported " +
+        "when using IoTDB as time series store.");
+  }
+}
diff --git a/streampipes-ts-store-iotdb/src/test/java/org/apache/streampipes/ts/store/iotdb/IotDbPropertyConverterTest.java b/streampipes-ts-store-iotdb/src/test/java/org/apache/streampipes/ts/store/iotdb/IotDbPropertyConverterTest.java
new file mode 100644
index 0000000000..29d0aab2ae
--- /dev/null
+++ b/streampipes-ts-store-iotdb/src/test/java/org/apache/streampipes/ts/store/iotdb/IotDbPropertyConverterTest.java
@@ -0,0 +1,102 @@
+/*
+ * Licensed to the Apache Software Foundation (ASF) under one or more
+ * contributor license agreements.  See the NOTICE file distributed with
+ * this work for additional information regarding copyright ownership.
+ * The ASF licenses this file to You 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 org.apache.streampipes.ts.store.iotdb;
+
+import org.apache.iotdb.tsfile.file.metadata.enums.TSDataType;
+import org.apache.streampipes.commons.exceptions.SpRuntimeException;
+import org.apache.streampipes.model.runtime.field.PrimitiveField;
+import org.apache.streampipes.model.schema.EventPropertyPrimitive;
+import org.apache.streampipes.vocabulary.SO;
+import org.apache.streampipes.vocabulary.XSD;
+import org.junit.jupiter.api.Test;
+
+import static org.junit.jupiter.api.Assertions.assertEquals;
+import static org.junit.jupiter.api.Assertions.assertThrows;
+
+public class IotDbPropertyConverterTest {
+
+  @Test
+  public void convertNonPrimitiveProperty() {
+    assertThrows(
+        SpRuntimeException.class,
+        () -> new IotDbPropertyConverter().convertNonPrimitiveProperty(null, null)
+    );
+  }
+
+  @Test
+  public void convertPrimitivePropertyInteger() {
+
+    var property = new EventPropertyPrimitive(XSD.INTEGER.toString(), "test", null, null);
+    var field = new PrimitiveField("test", "test", 5);
+
+    var result = new IotDbPropertyConverter().convertPrimitiveProperty(property, field, "sanitizedTest");
+
+    assertEquals("sanitizedTest", result.measurementName());
+    assertEquals(5, result.value());
+    assertEquals(TSDataType.INT32, result.dataType());
+  }
+
+  @Test
+  public void convertPrimitivePropertyString() {
+
+    var property = new EventPropertyPrimitive(XSD.STRING.toString(), "test", null, null);
+    var field = new PrimitiveField("test", "test", "value");
+
+    var result = new IotDbPropertyConverter().convertPrimitiveProperty(property, field, "sanitizedTest");
+
+    assertEquals("sanitizedTest", result.measurementName());
+    assertEquals("value", result.value());
+    assertEquals(TSDataType.TEXT, result.dataType());
+  }
+
+  @Test
+  public void convertPrimitivePropertyFloat() {
+
+    var property = new EventPropertyPrimitive(XSD.FLOAT.toString(), "test", null, null);
+    var field = new PrimitiveField("test", "test", 0.5f);
+
+    var result = new IotDbPropertyConverter().convertPrimitiveProperty(property, field, "sanitizedTest");
+
+    assertEquals("sanitizedTest", result.measurementName());
+    assertEquals(0.5f, result.value());
+    assertEquals(TSDataType.FLOAT, result.dataType());
+  }
+
+  @Test
+  public void convertPrimitivePropertyNumber() {
+
+    var property = new EventPropertyPrimitive(SO.NUMBER.toString(), "test", null, null);
+    var field = new PrimitiveField("test", "test", 5.24);
+
+    var result = new IotDbPropertyConverter().convertPrimitiveProperty(property, field, "sanitizedTest");
+
+    assertEquals("sanitizedTest", result.measurementName());
+    assertEquals(5.24, result.value());
+    assertEquals(TSDataType.DOUBLE, result.dataType());
+  }
+
+  @Test
+  public void convertPrimitivePropertyUnknown() {
+
+    var property = new EventPropertyPrimitive(XSD.ANY_TYPE.toString(), "test", null, null);
+    var field = new PrimitiveField("test", "test", 5);
+
+    assertThrows(SpRuntimeException.class, () -> new IotDbPropertyConverter().convertPrimitiveProperty(property, field, "sanitizedTest"));
+  }
+}