feature: [ANDROSDK-2309] support isEmpty/isNotEmpty filter operators (#2657)

Author: andresmr

core/api/core.api

@@ -2494,6 +2494,7 @@ public final class org/hisp/dhis/android/core/arch/repositories/filters/internal
 	public final fun gt (Ljava/lang/String;)Lorg/hisp/dhis/android/core/arch/repositories/collection/BaseRepository;
 	public final fun in (Ljava/util/Set;)Lorg/hisp/dhis/android/core/arch/repositories/collection/BaseRepository;
 	public final fun inRelativePeriod (Lorg/hisp/dhis/android/core/common/RelativePeriod;)Lorg/hisp/dhis/android/core/arch/repositories/collection/BaseRepository;
+	public final fun isEmpty (Z)Lorg/hisp/dhis/android/core/arch/repositories/collection/BaseRepository;
 	public final fun le (Ljava/lang/String;)Lorg/hisp/dhis/android/core/arch/repositories/collection/BaseRepository;
 	public final fun like (Ljava/lang/String;)Lorg/hisp/dhis/android/core/arch/repositories/collection/BaseRepository;
 	public final fun lt (Ljava/lang/String;)Lorg/hisp/dhis/android/core/arch/repositories/collection/BaseRepository;
@@ -2627,6 +2628,8 @@ public final class org/hisp/dhis/android/core/arch/repositories/filters/internal
 	public final fun ge (Ljava/lang/String;)Lorg/hisp/dhis/android/core/arch/repositories/collection/BaseRepository;
 	public final fun gt (Ljava/lang/String;)Lorg/hisp/dhis/android/core/arch/repositories/collection/BaseRepository;
 	public final fun in (Ljava/util/Collection;)Lorg/hisp/dhis/android/core/arch/repositories/collection/BaseRepository;
+	public final fun isNotNullAndIsNotBlank ()Lorg/hisp/dhis/android/core/arch/repositories/collection/BaseRepository;
+	public final fun isNullOrBlank ()Lorg/hisp/dhis/android/core/arch/repositories/collection/BaseRepository;
 	public final fun le (Ljava/lang/String;)Lorg/hisp/dhis/android/core/arch/repositories/collection/BaseRepository;
 	public final fun like (Ljava/lang/String;)Lorg/hisp/dhis/android/core/arch/repositories/collection/BaseRepository;
 	public final fun lt (Ljava/lang/String;)Lorg/hisp/dhis/android/core/arch/repositories/collection/BaseRepository;
@@ -2887,6 +2890,8 @@ public final class org/hisp/dhis/android/core/arch/repositories/scope/internal/F
 	public static final field LT Lorg/hisp/dhis/android/core/arch/repositories/scope/internal/FilterItemOperator;
 	public static final field NOT_EQ Lorg/hisp/dhis/android/core/arch/repositories/scope/internal/FilterItemOperator;
 	public static final field NOT_IN Lorg/hisp/dhis/android/core/arch/repositories/scope/internal/FilterItemOperator;
+	public static final field NOT_NULL_AND_NOT_BLANK Lorg/hisp/dhis/android/core/arch/repositories/scope/internal/FilterItemOperator;
+	public static final field NULL_OR_BLANK Lorg/hisp/dhis/android/core/arch/repositories/scope/internal/FilterItemOperator;
 	public static final field SW Lorg/hisp/dhis/android/core/arch/repositories/scope/internal/FilterItemOperator;
 	public static final field VOID Lorg/hisp/dhis/android/core/arch/repositories/scope/internal/FilterItemOperator;
 	public final fun getApiOperator ()Ljava/lang/String;
@@ -2977,7 +2982,6 @@ public class org/hisp/dhis/android/core/arch/repositories/scope/internal/Reposit
 	public static final field Companion Lorg/hisp/dhis/android/core/arch/repositories/scope/internal/RepositoryScopeFilterItemBuilder$Companion;
 	protected field key Ljava/lang/String;
 	protected field operator Lorg/hisp/dhis/android/core/arch/repositories/scope/internal/FilterItemOperator;
-	protected field value Ljava/lang/String;
 	public fun <init> ()V
 	public fun build ()Lorg/hisp/dhis/android/core/arch/repositories/scope/internal/RepositoryScopeFilterItem;
 	protected final fun getKey ()Ljava/lang/String;

core/src/androidTest/java/org/hisp/dhis/android/core/event/internal/EventDataFilterStoreIntegrationShould.kt

@@ -55,6 +55,7 @@ class EventDataFilterStoreIntegrationShould : ObjectStoreAbstractIntegrationShou
             .eq(null)
             .like(null)
             .dateFilter(null)
+            .isEmpty(null)
             .build()
     }
 }

core/src/androidTest/java/org/hisp/dhis/android/core/programstageworkinglist/ProgramStageWorkingListAttributeValueFilterStoreIntegrationShould.kt

@@ -56,6 +56,7 @@ class ProgramStageWorkingListAttributeValueFilterStoreIntegrationShould :
             .lt(null)
             .like(null)
             .dateFilter(null)
+            .isEmpty(null)
             .build()
     }
 }

core/src/androidTest/java/org/hisp/dhis/android/core/programstageworkinglist/ProgramStageWorkingListEventDataFilterStoreIntegrationShould.kt

@@ -54,6 +54,7 @@ class ProgramStageWorkingListEventDataFilterStoreIntegrationShould :
             .lt(null)
             .like(null)
             .dateFilter(null)
+            .isEmpty(null)
             .build()
     }
 }

core/src/androidTest/java/org/hisp/dhis/android/core/trackedentity/internal/AttributeValueFilterStoreIntegrationShould.kt

@@ -57,6 +57,7 @@ class AttributeValueFilterStoreIntegrationShould : ObjectStoreAbstractIntegratio
             .eq(null)
             .like(null)
             .dateFilter(null)
+            .isEmpty(null)
             .build()
     }
 }

core/src/main/java/org/hisp/dhis/android/core/arch/repositories/filters/internal/EventDataFilterConnector.kt

@@ -74,6 +74,11 @@ class EventDataFilterConnector<R : BaseRepository> internal constructor(
         return repositoryFactory.updated(filter)
     }
 
+    fun isEmpty(empty: Boolean): R {
+        val filter = EventDataFilter.builder().dataItem(key).isEmpty(empty).build()
+        return repositoryFactory.updated(filter)
+    }
+
     fun inRelativePeriod(period: RelativePeriod): R {
         val dateFilter = DateFilterPeriod.builder().type(DatePeriodType.RELATIVE).period(period).build()
         val filter = EventDataFilter.builder().dataItem(key).dateFilter(dateFilter).build()

core/src/main/java/org/hisp/dhis/android/core/arch/repositories/filters/internal/ValueSubQueryFilterConnector.kt

@@ -34,6 +34,7 @@ import org.hisp.dhis.android.core.arch.repositories.scope.RepositoryScope
 import org.hisp.dhis.android.core.arch.repositories.scope.internal.FilterItemOperator
 import org.hisp.dhis.android.persistence.common.querybuilders.WhereClauseBuilder
 
+@Suppress("TooManyFunctions")
 class ValueSubQueryFilterConnector<R : BaseRepository> internal constructor(
     repositoryFactory: BaseRepositoryFactory<R>,
     scope: RepositoryScope,
@@ -50,7 +51,7 @@ class ValueSubQueryFilterConnector<R : BaseRepository> internal constructor(
 
     /**
      * Returns a new repository whose scope is the one of the current repository plus the new filter being applied.
-     * The like filter checks if the given field has a value equal to the value provided.
+     * The eq filter checks if the given field has a value equal to the value provided.
      * @param value value to compare with the target field
      * @return the new repository
      */
@@ -60,7 +61,7 @@ class ValueSubQueryFilterConnector<R : BaseRepository> internal constructor(
 
     /**
      * Returns a new repository whose scope is the one of the current repository plus the new filter being applied.
-     * The like filter checks if the given field has a value lower or equal than the value provided.
+     * The le filter checks if the given field has a value lower or equal than the value provided.
      * @param value value to compare with the target field
      * @return the new repository
      */
@@ -70,7 +71,7 @@ class ValueSubQueryFilterConnector<R : BaseRepository> internal constructor(
 
     /**
      * Returns a new repository whose scope is the one of the current repository plus the new filter being applied.
-     * The like filter checks if the given field has a value strictly lower than the value provided.
+     * The lt filter checks if the given field has a value strictly lower than the value provided.
      * @param value value to compare with the target field
      * @return the new repository
      */
@@ -80,7 +81,7 @@ class ValueSubQueryFilterConnector<R : BaseRepository> internal constructor(
 
     /**
      * Returns a new repository whose scope is the one of the current repository plus the new filter being applied.
-     * The like filter checks if the given field has a value strictly greater or equal than the value provided.
+     * The ge filter checks if the given field has a value strictly greater or equal than the value provided.
      * @param value value to compare with the target field
      * @return the new repository
      */
@@ -90,7 +91,7 @@ class ValueSubQueryFilterConnector<R : BaseRepository> internal constructor(
 
     /**
      * Returns a new repository whose scope is the one of the current repository plus the new filter being applied.
-     * The like filter checks if the given field has a value strictly greater than the value provided.
+     * The gt filter checks if the given field has a value strictly greater than the value provided.
      * @param value value to compare with the target field
      * @return the new repository
      */
@@ -100,7 +101,7 @@ class ValueSubQueryFilterConnector<R : BaseRepository> internal constructor(
 
     /**
      * Returns a new repository whose scope is the one of the current repository plus the new filter being applied.
-     * The like filter checks if the given field has a value included in the list provided.
+     * The in filter checks if the given field has a value included in the list provided.
      * @param values value list to compare with the target field
      * @return the new repository
      */
@@ -119,6 +120,37 @@ class ValueSubQueryFilterConnector<R : BaseRepository> internal constructor(
         return inLinkTable(FilterItemOperator.LIKE, wrapValue("%$value%"))
     }
 
+    /**
+     * Returns a new repository whose scope is the one of the current repository plus the new filter being applied.
+     * The isNullOrBlank filter checks if the given field is null or blank.
+     * @return the new repository
+     */
+    fun isNullOrBlank(): R {
+        val whereClause = WhereClauseBuilder()
+            .appendIsNullOrValue(linkChild, "")
+            .appendKeyStringValue(dataElementColumn, dataElementId)
+            .build()
+        return inTableWhere(whereClause)
+    }
+
+    /**
+     * Returns a new repository whose scope is the one of the current repository plus the new filter being applied.
+     * The isNotNullAndIsNotBlank filter checks if the given field is not null and not blank.
+     * @return the new repository
+     */
+    fun isNotNullAndIsNotBlank(): R {
+        val whereClause = WhereClauseBuilder()
+            .appendComplexQuery(
+                WhereClauseBuilder()
+                    .appendIsNotNullValue(linkChild)
+                    .appendNotKeyStringValue(linkChild, "")
+                    .build(),
+            )
+            .appendKeyStringValue(dataElementColumn, dataElementId)
+            .build()
+        return inTableWhere(whereClause)
+    }
+
     private fun inLinkTable(operator: FilterItemOperator, value: String): R {
         val whereClause = WhereClauseBuilder()
             .appendKeyOperatorValue(linkChild, operator.sqlOperator, value)

core/src/main/java/org/hisp/dhis/android/core/arch/repositories/scope/internal/FilterItemOperator.kt

@@ -40,4 +40,19 @@ enum class FilterItemOperator(val sqlOperator: String, val apiOperator: String,
     SW("LIKE", "sw", "SW"),
     EW("LIKE", "ew", "EW"),
     VOID("", "", ""),
+    NULL_OR_BLANK("", "null", "NULL"),
+    NOT_NULL_AND_NOT_BLANK("", "!null", "!NULL"),
+    ;
+
+    /**
+     * Builds the full SQL condition for this operator. NULL_OR_BLANK and NOT_NULL_AND_NOT_BLANK cannot be expressed
+     * as "column sqlOperator value" because they need the column name in both sides of the OR/AND condition.
+     */
+    internal fun getSqlCondition(column: String, valueStr: String? = null): String {
+        return when (this) {
+            NULL_OR_BLANK -> "($column IS NULL OR $column = '')"
+            NOT_NULL_AND_NOT_BLANK -> "($column IS NOT NULL AND $column != '')"
+            else -> "$column $sqlOperator $valueStr"
+        }
+    }
 }

core/src/main/java/org/hisp/dhis/android/core/arch/repositories/scope/internal/RepositoryScopeFilterItem.kt

@@ -33,11 +33,11 @@ import org.hisp.dhis.android.annotations.ModelBuilder
 data class RepositoryScopeFilterItem(
     val key: String,
     val operator: FilterItemOperator,
-    val value: String,
+    val value: String?,
 ) {
     fun key(): String = key
     fun operator(): FilterItemOperator = operator
-    fun value(): String = value
+    fun value(): String? = value
 
     fun toBuilder(): Builder = RepositoryScopeFilterItemBuilder.from(this)
 

core/src/main/java/org/hisp/dhis/android/core/arch/repositories/scope/internal/WhereClauseFromScopeBuilder.kt

@@ -36,7 +36,7 @@ internal class WhereClauseFromScopeBuilder(private val builder: WhereClauseBuild
             return "1"
         }
         for (item in scope.filters()) {
-            builder.appendKeyOperatorValue(item.key(), item.operator().sqlOperator, item.value())
+            builder.appendComplexQuery(item.operator().getSqlCondition(item.key(), item.value() ?: ""))
         }
         for (item in scope.complexFilters()) {
             builder.appendComplexQuery(item.whereQuery())