fix: Add AnalyticsIndicatorType (#465)

Author: larshelge

src/main/java/org/hisp/dhis/model/analytics/AnalyticsIndicatorType.java

@@ -0,0 +1,47 @@
+/*
+ * Copyright (c) 2004-2025, University of Oslo
+ * All rights reserved.
+ *
+ * Redistribution and use in source and binary forms, with or without
+ * modification, are permitted provided that the following conditions are met:
+ * Redistributions of source code must retain the above copyright notice, this
+ * list of conditions and the following disclaimer.
+ *
+ * Redistributions in binary form must reproduce the above copyright notice,
+ * this list of conditions and the following disclaimer in the documentation
+ * and/or other materials provided with the distribution.
+ * Neither the name of the HISP project nor the names of its contributors may
+ * be used to endorse or promote products derived from this software without
+ * specific prior written permission.
+ *
+ * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
+ * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
+ * WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
+ * DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR
+ * ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
+ * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
+ * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON
+ * ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
+ * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
+ * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
+ */
+package org.hisp.dhis.model.analytics;
+
+import com.fasterxml.jackson.annotation.JsonProperty;
+import java.io.Serializable;
+import lombok.Getter;
+import lombok.NoArgsConstructor;
+import lombok.Setter;
+import lombok.ToString;
+
+@Getter
+@Setter
+@ToString
+@NoArgsConstructor
+public class AnalyticsIndicatorType implements Serializable {
+  @JsonProperty private String name;
+
+  @JsonProperty private Integer factor;
+
+  @JsonProperty private Boolean number;
+}

src/main/java/org/hisp/dhis/model/analytics/MetaDataItem.java

@@ -63,6 +63,8 @@ public class MetaDataItem implements Serializable {
 
   @JsonProperty private String aggregationType;
 
+  @JsonProperty private AnalyticsIndicatorType indicatorType;
+
   /**
    * Constructor.
    *

src/test/java/org/hisp/dhis/analytics/AnalyticsDataApiTest.java

@@ -27,9 +27,12 @@
  */
 package org.hisp.dhis.analytics;
 
+import static org.hisp.dhis.support.Assertions.assertContainsExactly;
+import static org.hisp.dhis.support.Assertions.assertNotBlank;
 import static org.hisp.dhis.support.Assertions.assertNotEmpty;
 import static org.hisp.dhis.support.Assertions.assertSize;
 import static org.junit.jupiter.api.Assertions.assertEquals;
+import static org.junit.jupiter.api.Assertions.assertFalse;
 import static org.junit.jupiter.api.Assertions.assertNotNull;
 import static org.junit.jupiter.api.Assertions.assertTrue;
 
@@ -40,9 +43,12 @@
 import org.hisp.dhis.TestFixture;
 import org.hisp.dhis.model.ValueType;
 import org.hisp.dhis.model.analytics.AnalyticsData;
+import org.hisp.dhis.model.analytics.AnalyticsDimension;
 import org.hisp.dhis.model.analytics.AnalyticsHeader;
+import org.hisp.dhis.model.analytics.AnalyticsIndicatorType;
 import org.hisp.dhis.model.analytics.AnalyticsMetaData;
 import org.hisp.dhis.model.analytics.MetaDataItem;
+import org.hisp.dhis.model.dimension.DimensionItemType;
 import org.hisp.dhis.query.analytics.AnalyticsQuery;
 import org.hisp.dhis.support.TestTags;
 import org.junit.jupiter.api.Tag;
@@ -130,7 +136,7 @@ void testGetAnalyticsDataWithDimensionAndNoItems() {
 
     AnalyticsData data = dhis2.getAnalyticsData(query);
 
-    log.info(data.toString());
+    log.debug(data.toString());
 
     assertEquals(4, data.getWidth());
     assertSize(4, data.getHeaders());
@@ -140,4 +146,56 @@ void testGetAnalyticsDataWithDimensionAndNoItems() {
 
     assertSize(4, firstRow);
   }
+
+  @Test
+  void testGetAnalyticsDataIndicatorAndMetadataDetails() {
+    Dhis2 dhis2 = new Dhis2(TestFixture.DEFAULT_CONFIG);
+
+    AnalyticsQuery query =
+        AnalyticsQuery.instance()
+            // "ANC 1 Coverage"
+            .addDataDimension(List.of("Uvn6LCg7dVU"))
+            .addPeriodDimension(List.of("THIS_YEAR"))
+            // "Sierra Leone"
+            .addOrgUnitFilter(List.of("ImspTQPwCqd"))
+            .setSkipData(true)
+            .setSkipMeta(false)
+            .setIncludeMetadataDetails(true);
+
+    AnalyticsData data = dhis2.getAnalyticsData(query);
+
+    AnalyticsMetaData metadata = data.getMetaData();
+
+    log.info(metadata.toString());
+
+    Map<String, List<String>> dimensions = metadata.getDimensions();
+
+    assertContainsExactly(dimensions.get(AnalyticsDimension.DATA_X), "Uvn6LCg7dVU");
+    assertContainsExactly(dimensions.get(AnalyticsDimension.ORG_UNIT), "ImspTQPwCqd");
+
+    Map<String, MetaDataItem> items = metadata.getItems();
+
+    MetaDataItem indicator = items.get("Uvn6LCg7dVU");
+
+    assertNotNull(indicator);
+    assertEquals("Uvn6LCg7dVU", indicator.getUid());
+    assertNotBlank(indicator.getName());
+    assertNotNull(indicator.getIndicatorType());
+    assertEquals(DimensionItemType.INDICATOR, indicator.getDimensionItemType());
+    assertEquals(ValueType.NUMBER, indicator.getValueType());
+
+    AnalyticsIndicatorType indicatorType = indicator.getIndicatorType();
+
+    assertNotNull(indicatorType);
+
+    assertNotBlank(indicatorType.getName());
+    assertEquals(100, indicatorType.getFactor());
+    assertFalse(indicatorType.getNumber());
+
+    MetaDataItem orgUnit = items.get("ImspTQPwCqd");
+
+    assertNotNull(orgUnit);
+    assertEquals("ImspTQPwCqd", orgUnit.getUid());
+    assertNotBlank(orgUnit.getName());
+  }
 }