Merge pull request #3311 from ebean-orm/feature/findSingleAttributeOr…

…Empty enh: Add findSingleAttributeOrEmpty() returning Optional
ebean-orm · Jan 19, 2024 · 089dd8e · 089dd8e
2 parents 2a62d41 + 4477038
commit 089dd8e
Show file tree

Hide file tree

Showing 6 changed files with 105 additions and 2 deletions.
diff --git a/ebean-api/src/main/java/io/ebean/Query.java b/ebean-api/src/main/java/io/ebean/Query.java
@@ -970,6 +970,25 @@ enum LockWait {
   @Nullable
   <A> A findSingleAttribute();
 
+  /**
+   * Execute the query returning a single optional attribute value.
+   * <p>
+   * <h3>Example</h3>
+   * <pre>{@code
+   *
+   *  Optional<String> maybeName =
+   *    new QCustomer()
+   *      .select(name)
+   *      .id.eq(42)
+   *      .status.eq(NEW)
+   *      .findSingleAttributeOrEmpty();
+   *
+   * }</pre>
+   *
+   * @return an optional value for the selected property
+   */
+  <A> Optional<A> findSingleAttributeOrEmpty();
+
   /**
    * Return true if this is countDistinct query.
    */

diff --git a/ebean-core/src/main/java/io/ebeaninternal/server/query/DefaultFetchGroupQuery.java b/ebean-core/src/main/java/io/ebeaninternal/server/query/DefaultFetchGroupQuery.java
@@ -305,6 +305,11 @@ public <A> A findSingleAttribute() {
     throw new RuntimeException("EB102: Only select() and fetch() clause is allowed on FetchGroup");
   }
 
+  @Override
+  public <A> Optional<A> findSingleAttributeOrEmpty() {
+    throw new RuntimeException("EB102: Only select() and fetch() clause is allowed on FetchGroup");
+  }
+
   @Override
   public boolean isCountDistinct() {
     throw new RuntimeException("EB102: Only select() and fetch() clause is allowed on FetchGroup");

diff --git a/ebean-core/src/main/java/io/ebeaninternal/server/querydefn/DefaultOrmQuery.java b/ebean-core/src/main/java/io/ebeaninternal/server/querydefn/DefaultOrmQuery.java
@@ -1161,7 +1161,7 @@ private void prepareForPaging() {
     // add the rawSql statement - if any
     if (orderByIsEmpty()) {
       if (rawSql != null && rawSql.getSql() != null) {
-        order(rawSql.getSql().getOrderBy());
+        orderBy(rawSql.getSql().getOrderBy());
       }
     }
     if (checkPagingOrderBy()) {
@@ -1517,7 +1517,6 @@ public final <K> Map<K, T> findMap() {
   }
 
   @Override
-  @SuppressWarnings("unchecked")
   public final <A> List<A> findSingleAttributeList() {
     return server.findSingleAttributeList(this);
   }
@@ -1533,6 +1532,11 @@ public final <A> A findSingleAttribute() {
     return !list.isEmpty() ? list.get(0) : null;
   }
 
+  @Override
+  public final <A> Optional<A> findSingleAttributeOrEmpty() {
+    return Optional.ofNullable(findSingleAttribute());
+  }
+
   @Override
   public final T findOne() {
     return server.findOne(this);

diff --git a/ebean-querybean/src/main/java/io/ebean/typequery/TQRootBean.java b/ebean-querybean/src/main/java/io/ebean/typequery/TQRootBean.java
@@ -1867,6 +1867,28 @@ public <A> A findSingleAttribute() {
     return query.findSingleAttribute();
   }
 
+  /**
+   * Execute the query returning a single optional attribute value.
+   * <p>
+   * <h3>Example</h3>
+   * <pre>{@code
+   *
+   *  Optional<String> maybeName =
+   *    new QCustomer()
+   *      .select(name)
+   *      .id.eq(42)
+   *      .status.eq(NEW)
+   *      .findSingleAttributeOrEmpty();
+   *
+   * }</pre>
+   *
+   * @return an optional value for the selected property
+   */
+  @Nullable
+  public <A> Optional<A> findSingleAttributeOrEmpty() {
+    return query.findSingleAttributeOrEmpty();
+  }
+
   /**
    * Execute the query processing the beans one at a time.
    * <p>

diff --git a/ebean-querybean/src/test/java/org/querytest/QCustomerTest.java b/ebean-querybean/src/test/java/org/querytest/QCustomerTest.java
@@ -1069,6 +1069,32 @@ public void testSelectFormula() {
     assertThat(maxDate).isNotNull();
   }
 
+  @Test
+  public void findSingleAttributeOrEmpty() {
+
+    Customer cust = new Customer();
+    cust.setName("MaybeIExist yeah");
+    cust.setStatus(Customer.Status.GOOD);
+    cust.setRegistered(new Date());
+    cust.save();
+
+    Optional<String> customerName = new QCustomer()
+      .select(name)
+      .status.eq(Customer.Status.GOOD)
+      .name.startsWith("MaybeIExist")
+      .findSingleAttributeOrEmpty();
+
+    assertThat(customerName).isPresent();
+
+    Optional<String> customerName2 = new QCustomer()
+      .select(name)
+      .status.eq(Customer.Status.GOOD)
+      .name.eq("NahIDoNotExist")
+      .findSingleAttributeOrEmpty();
+
+    assertThat(customerName2).isEmpty();
+  }
+
 
   @Test
   public void testFetchByScalarValue() {

diff --git a/ebean-test/src/test/java/org/tests/query/other/TestQuerySingleAttribute.java b/ebean-test/src/test/java/org/tests/query/other/TestQuerySingleAttribute.java
@@ -20,6 +20,7 @@
 import java.sql.Date;
 import java.time.LocalDate;
 import java.util.List;
+import java.util.Optional;
 
 import static org.assertj.core.api.Assertions.assertThat;
 
@@ -139,6 +140,32 @@ void findSingleAttribute() {
     assertThat(name).isNotNull();
   }
 
+  @Test
+  void findSingleAttributeOrEmpty() {
+    ResetBasicData.reset();
+
+    Query<Customer> query = DB.find(Customer.class)
+      .select("name")
+      .where().eq("name", "Rob").query();
+
+    Optional<String> name = query.findSingleAttributeOrEmpty();
+
+    assertThat(sqlOf(query)).contains("select t0.name from o_customer t0");
+    assertThat(name).isPresent().contains("Rob");
+  }
+
+  @Test
+  void findSingleAttributeOrEmpty_when_empty() {
+    ResetBasicData.reset();
+
+    Query<Customer> query = DB.find(Customer.class)
+      .select("name")
+      .where().eq("name", "I_Do_Not_ExistO!").query();
+
+    Optional<String> name = query.findSingleAttributeOrEmpty();
+    assertThat(name).isEmpty();
+  }
+
   @Test
   void findSingleAttributeList_with_join_column() {
     ResetBasicData.reset();