#1297 - ENH: Add DtoQuery ... such that we can map native SQL queries automatically into "DTO beans"

src/main/java/io/ebeaninternal/api/SpiDtoQuery.java

@@ -0,0 +1,46 @@
+package io.ebeaninternal.api;
+
+import io.ebean.DtoQuery;
+import io.ebeaninternal.server.dto.DtoMappingRequest;
+import io.ebeaninternal.server.dto.DtoQueryPlan;
+
+/**
+ * Internal extension to DtoQuery.
+ */
+public interface SpiDtoQuery<T> extends DtoQuery<T>, SpiSqlBinding {
+
+  /**
+   * Return the key for query plan.
+   */
+  String planKey();
+
+  /**
+   * Get the query plan for the cache.
+   */
+  DtoQueryPlan getQueryPlan(String planKey);
+
+  /**
+   * Build the query plan.
+   */
+  DtoQueryPlan buildPlan(DtoMappingRequest request);
+
+  /**
+   * Put the query plan into the cache.
+   */
+  void putQueryPlan(String planKey, DtoQueryPlan plan);
+
+  /**
+   * Return true if the query is in relaxed mapping mode.
+   */
+  boolean isRelaxedMode();
+
+  /**
+   * Return the label for the query.
+   */
+  String getLabel();
+
+  /**
+   * Return the associated DTO bean type.
+   */
+  Class<T> getType();
+}

src/main/java/io/ebeaninternal/api/SpiEbeanServer.java

@@ -20,6 +20,8 @@ import io.ebeaninternal.server.query.CQuery;
 import io.ebeaninternal.server.transaction.RemoteTransactionEvent;
 
 import java.util.List;
+import java.util.function.Consumer;
+import java.util.function.Predicate;
 
 /**
  * Service Provider extension to EbeanServer.
@@ -224,4 +226,24 @@ public interface SpiEbeanServer extends EbeanServer, BeanLoader, BeanCollectionL
    */
   void scopedTransactionExit(Object returnOrThrowable, int opCode);
 
+  /**
+   * DTO findList query.
+   */
+  <T> List<T> findDtoList(SpiDtoQuery<T> query);
+
+  /**
+   * DTO findOne query.
+   */
+  <T> T findDtoOne(SpiDtoQuery<T> query);
+
+  /**
+   * DTO findEach query.
+   */
+  <T> void findDtoEach(SpiDtoQuery<T> query, Consumer<T> consumer);
+
+  /**
+   * DTO findEachWhile query.
+   */
+  <T> void findDtoEachWhile(SpiDtoQuery<T> query, Predicate<T> consumer);
+
 }

src/main/java/io/ebeaninternal/api/SpiSqlBinding.java

@@ -0,0 +1,38 @@
+package io.ebeaninternal.api;
+
+/**
+ * SQL query binding (for SqlQuery and DtoQuery).
+ */
+public interface SpiSqlBinding {
+
+  /**
+   * Return the named or positioned parameters.
+   */
+  BindParams getBindParams();
+
+  /**
+   * return the query.
+   */
+  String getQuery();
+
+  /**
+   * Return the first row to fetch.
+   */
+  int getFirstRow();
+
+  /**
+   * Return the maximum number of rows to fetch.
+   */
+  int getMaxRows();
+
+  /**
+   * Return the query timeout.
+   */
+  int getTimeout();
+
+  /**
+   * Return the hint for Statement.setFetchSize().
+   */
+  int getBufferFetchSizeHint();
+
+}

src/main/java/io/ebeaninternal/api/SpiSqlQuery.java

@@ -5,36 +5,6 @@ import io.ebean.SqlQuery;
 /**
  * SQL query - Internal extension to SqlQuery.
  */
-public interface SpiSqlQuery extends SqlQuery {
-
-  /**
-   * Return the named or positioned parameters.
-   */
-  BindParams getBindParams();
-
-  /**
-   * return the query.
-   */
-  String getQuery();
-
-  /**
-   * Return the first row to fetch.
-   */
-  int getFirstRow();
-
-  /**
-   * Return the maximum number of rows to fetch.
-   */
-  int getMaxRows();
-
-  /**
-   * Return the query timeout.
-   */
-  int getTimeout();
-
-  /**
-   * Return the hint for Statement.setFetchSize().
-   */
-  int getBufferFetchSizeHint();
+public interface SpiSqlQuery extends SqlQuery, SpiSqlBinding {
 
 }