feat: add possibility to use dynamic measurement in mapping from/to P…

…OJO (#269)

CHANGELOG.md

@@ -1,5 +1,8 @@
 ## 3.4.0 [unreleased]
 
+### Features
+1. [#269](https://github.com/influxdata/influxdb-client-java/pull/269): Add possibility to use dynamic `measurement` in mapping from/to `POJO`
+
 ### CI
 1. [#267](https://github.com/influxdata/influxdb-client-java/pull/267): Add JDK 17 (LTS) to CI pipeline instead of JDK 16
 

client-core/src/main/java/com/influxdb/annotations/Column.java

@@ -28,15 +28,26 @@
 
 
 /**
- * The annotation is used to customize bidirectional mapping between POJO and Flux query result or lineprotocol.
+ * The annotation to customize bidirectional mapping between POJO and Flux query result or LineProtocol.
  */
 @Retention(RetentionPolicy.RUNTIME)
 @Target(ElementType.FIELD)
 public @interface Column {
 
  String name() default "";
 
+ /**
+ * @return {@link Boolean#TRUE} it an annotated field is Tag
+ */
  boolean tag() default false;
 
+ /**
+ * @return {@link Boolean#TRUE} it an annotated field is Measurement
+ */
+ boolean measurement() default false;
+
+ /**
+ * @return {@link Boolean#TRUE} it an annotated field is Timestamp
+ */
  boolean timestamp () default false;
 }

client-core/src/main/java/com/influxdb/query/internal/FluxResultMapper.java

@@ -75,6 +75,8 @@ public <T> T toPOJO(@Nonnull final FluxRecord record, @Nonnull final Class<T> cl
  col = columnName;
  } else if (recordValues.containsKey("_" + columnName)) {
  col = "_" + columnName;
+ } else if (anno != null && anno.measurement()) {
+ col = "_measurement";
  } else {
  String columnNameInSnakeCase = camelCaseToSnakeCase(columnName);
  if (recordValues.containsKey(columnNameInSnakeCase)) {

client-core/src/test/java/com/influxdb/query/internal/FluxResultMapperTest.java

@@ -104,8 +104,20 @@ public void camelCaseToSnakeCase() {
  Assertions.assertThat(bean.someValue).isEqualTo(20);
  }
 
- public static class BigDecimalBean
- {
+ @Test
+ public void pojoWithMeasurement() {
+ FluxRecord record = new FluxRecord(0);
+ record.getValues().put("_measurement", "mem");
+ record.getValues().put("value", 20);
+ record.getValues().put("tag", "a");
+
+ BeanWithMeasurement bean = mapper.toPOJO(record, BeanWithMeasurement.class);
+ Assertions.assertThat(bean.customField).isEqualTo("mem");
+ Assertions.assertThat(bean.tag).isEqualTo("a");
+ Assertions.assertThat(bean.value).isEqualByComparingTo(new BigDecimal(20));
+ }
+
+ public static class BigDecimalBean {
  @Column(name = "value1")
  BigDecimal value1;
 
@@ -146,4 +158,15 @@ public enum TagEnum {
  tagA,
  tagB
  }
+
+ public static class BeanWithMeasurement {
+ @Column(measurement = true)
+ String customField;
+
+ @Column(name = "tag", tag = true)
+ String tag;
+
+ @Column(name = "value")
+ BigDecimal value;
+ }
 }

client-kotlin/src/test/kotlin/com/influxdb/client/kotlin/ITQueryKotlinApi.kt

@@ -67,8 +67,7 @@ internal class ITQueryKotlinApi : AbstractITInfluxDBClientKotlin() {
  @BeforeEach
  fun `Write testing data`(): Unit = runBlocking {
 
- val client = InfluxDBClientFactory.create(influxDb2Url, "my-user",
- "my-password".toCharArray())
+ val client = InfluxDBClientFactory.create(influxDb2Url, "my-token".toCharArray())
 
  organization = client.organizationsApi
  .findOrganizations().stream()

client-reactive/src/test/java/com/influxdb/client/reactive/AbstractITInfluxDBClientTest.java

@@ -50,7 +50,7 @@ void setUp() throws Exception {
  influxDB_URL = getInfluxDb2Url();
  LOG.log(Level.FINEST, "InfluxDB URL: {0}", influxDB_URL);
 
- InfluxDBClient influxDBClient = InfluxDBClientFactory.create(influxDB_URL, "my-user", "my-password".toCharArray());
+ InfluxDBClient influxDBClient = InfluxDBClientFactory.create(influxDB_URL, "my-token".toCharArray());
 
  organization = influxDBClient.getOrganizationsApi()
  .findOrganizations().stream()
@@ -60,12 +60,7 @@ void setUp() throws Exception {
 
  influxDBClient.close();
 
- try {
- this.influxDBClient = InfluxDBClientReactiveFactory.create(influxDB_URL, "my-user", "my-password".toCharArray());
- } catch (Exception e) {
- Assertions.fail("Can't authorize via password", e);
- }
-
+ this.influxDBClient = InfluxDBClientReactiveFactory.create(influxDB_URL, "my-token".toCharArray());
  }
 
  @AfterEach

client-reactive/src/test/java/com/influxdb/client/reactive/ITWriteQueryReactiveApi.java

@@ -68,8 +68,7 @@ void setUp() throws Exception {
 
  super.setUp();
 
- InfluxDBClient client = InfluxDBClientFactory.create(influxDB_URL, "my-user",
- "my-password".toCharArray());
+ InfluxDBClient client = InfluxDBClientFactory.create(influxDB_URL, "my-token".toCharArray());
 
  bucket = client.getBucketsApi()
  .createBucket(generateName("h2o"), null, organization);

client-scala/src/test/scala/com/influxdb/client/scala/ITQueryScalaApiQuery.scala

@@ -56,7 +56,7 @@ class ITQueryScalaApiQuery extends AbstractITQueryScalaApi with Matchers {
 
  super.setUp()
 
- val client = InfluxDBClientFactory.create(influxDBUtils.getUrl, "my-user", "my-password".toCharArray)
+ val client = InfluxDBClientFactory.create(influxDBUtils.getUrl, "my-token".toCharArray)
 
  organization = client.getOrganizationsApi
  .findOrganizations()
@@ -387,7 +387,7 @@ class ITQueryScalaApiQuery extends AbstractITQueryScalaApi with Matchers {
  // Prepare data
  //
  val records = Range(0, 10000).map(n => s"buffer field=$n $n").mkString("\n")
- val client = InfluxDBClientFactory.create(influxDBUtils.getUrl, "my-user", "my-password".toCharArray)
+ val client = InfluxDBClientFactory.create(influxDBUtils.getUrl, "my-token".toCharArray)
  client.getWriteApiBlocking.writeRecord(bucket.getName, organization.getId, WritePrecision.NS, records)
  client.close()
 

client/src/main/java/com/influxdb/client/internal/MeasurementMapper.java

@@ -23,6 +23,7 @@
 
 import java.lang.reflect.Field;
 import java.time.Instant;
+import java.util.Map;
 import java.util.concurrent.ConcurrentHashMap;
 import java.util.concurrent.ConcurrentMap;
 import java.util.logging.Level;
@@ -54,32 +55,22 @@ <M> Point toPoint(@Nonnull final M measurement, @Nonnull final WritePrecision pr
  Class<?> measurementType = measurement.getClass();
  cacheMeasurementClass(measurementType);
 
- if (measurementType.getAnnotation(Measurement.class) == null) {
- String message = String
- .format("Measurement type '%s' does not have a @Measurement annotation.", measurementType);
-
- throw new InfluxException(message);
- }
-
- Point point = Point.measurement(getMeasurementName(measurementType));
-
- CLASS_FIELD_CACHE.get(measurementType.getName()).forEach((name, field) -> {
+ Point point = Point.measurement(getMeasurementName(measurement, measurementType));
 
+ for (Map.Entry<String, Field> entry : CLASS_FIELD_CACHE.get(measurementType.getName()).entrySet()) {
+ String name = entry.getKey();
+ Field field = entry.getValue();
  Column column = field.getAnnotation(Column.class);
-
- Object value;
- try {
- field.setAccessible(true);
- value = field.get(measurement);
- } catch (IllegalAccessException e) {
-
- throw new InfluxException(e);
+ if (column.measurement()) {
+ continue;
  }
 
+ Object value = getObject(measurement, field);
+
  if (value == null) {
  Object[] params = {field.getName(), measurement};
  LOG.log(Level.FINEST, "Field {0} of {1} has null value", params);
- return;
+ continue;
  }
 
  Class<?> fieldType = field.getType();
@@ -97,16 +88,51 @@ <M> Point toPoint(@Nonnull final M measurement, @Nonnull final WritePrecision pr
  } else {
  point.addField(name, value.toString());
  }
- });
+ }
 
  LOG.log(Level.FINEST, "Mapped measurement: {0} to Point: {1}", new Object[]{measurement, point});
 
  return point;
  }
 
  @Nonnull
- private String getMeasurementName(@Nonnull final Class<?> measurementType) {
- return measurementType.getAnnotation(Measurement.class).name();
+ private <M> String getMeasurementName(@Nonnull final M measurement, @Nonnull final Class<?> measurementType) {
+
+ // from @Measurement annotation for class
+ Measurement measurementAnnotation = measurementType.getAnnotation(Measurement.class);
+ if (measurementAnnotation != null) {
+ return measurementAnnotation.name();
+ }
+
+ // from Field with @Column(measurement = true)
+ Field measurementField = CLASS_FIELD_CACHE.get(measurementType.getName())
+ .values()
+ .stream()
+ .filter(field -> field.getAnnotation(Column.class).measurement())
+ .findFirst()
+ .orElse(null);
+
+ if (measurementField == null) {
+ String message = String
+ .format("Unable to determine Measurement for '%s'. Does it have a @Measurement annotation or "
+ + "field with @Column(measurement = true) annotation?", measurementType);
+
+ throw new InfluxException(message);
+ }
+
+ return getObject(measurement, measurementField).toString();
+ }
+
+ private <M> Object getObject(@Nonnull final M measurement, @Nonnull final Field field) {
+ Object value;
+ try {
+ field.setAccessible(true);
+ value = field.get(measurement);
+ } catch (IllegalAccessException e) {
+
+ throw new InfluxException(e);
+ }
+ return value;
  }
 
  private boolean isNumber(@Nonnull final Class<?> fieldType) {

client/src/test/java/com/influxdb/client/ITUsersApi.java

@@ -197,6 +197,7 @@ void createNewUserAndSetPassword() throws Exception {
 
  @Test
  @Tag("basic_auth")
+ @Disabled("TODO not implemented set password https://github.com/influxdata/influxdb/pull/15981")
  void updatePasswordNotFound() {
 
  Assertions.assertThatThrownBy(() -> usersApi.updateUserPassword("020f755c3c082000", "", "new-password"))

client/src/test/java/com/influxdb/client/WriteApiTest.java

@@ -224,7 +224,9 @@ void writeMeasurementWhichIsNotMappableToPoint() {
  Assertions.assertThat(listener.getValue()).isNotNull();
  Assertions.assertThat(listener.getValue().getThrowable())
  .isInstanceOf(InfluxException.class)
- .hasMessage("Measurement type 'class java.lang.Integer' does not have a @Measurement annotation.");
+ .hasMessage("Unable to determine Measurement for 'class java.lang.Integer'. "
+ + "Does it have a @Measurement annotation or "
+ + "field with @Column(measurement = true) annotation?");
  }
 
  @Test

client/src/test/java/com/influxdb/client/internal/MeasurementMapperTest.java

@@ -122,6 +122,17 @@ void enumTag() {
  Assertions.assertThat(lineProtocol).isEqualTo("pojo,tag=tagA num=5i");
  }
 
+ @Test
+ void pojoMeasurement() {
+ PojoMeasurement pojo = new PojoMeasurement();
+ pojo.tag = "a";
+ pojo.value = 5;
+ pojo.customField = "mem";
+
+ String lineProtocol = mapper.toPoint(pojo, WritePrecision.S).toLineProtocol();
+ Assertions.assertThat(lineProtocol).isEqualTo("mem,tag=a value=5i");
+ }
+
  @Measurement(name = "pojo")
  private static class Pojo {
 
@@ -155,4 +166,15 @@ private enum TagEnum {
  tagA,
  tagB
  }
+
+ public static class PojoMeasurement {
+ @Column(measurement = true)
+ String customField;
+
+ @Column(name = "tag", tag = true)
+ private String tag;
+
+ @Column(name = "value")
+ private Integer value;
+ }
 }