Rework of options with builders and fluent APIS

Author: clun

astra-db-java/src/main/java/com/datastax/astra/client/Collection.java

@@ -22,7 +22,6 @@
 
 import com.datastax.astra.client.exception.DataAPIFaultyResponseException;
 import com.datastax.astra.client.exception.DataApiException;
-import com.datastax.astra.client.exception.DataApiResponseException;
 import com.datastax.astra.client.exception.TooManyDocumentsToCountException;
 import com.datastax.astra.client.model.BulkWriteOptions;
 import com.datastax.astra.client.model.BulkWriteResult;
@@ -48,6 +47,7 @@
 import com.datastax.astra.client.model.ObjectId;
 import com.datastax.astra.client.model.Page;
 import com.datastax.astra.client.model.ReplaceOneOptions;
+import com.datastax.astra.client.model.ReturnDocument;
 import com.datastax.astra.client.model.UUIDv6;
 import com.datastax.astra.client.model.UUIDv7;
 import com.datastax.astra.client.model.Update;
@@ -788,7 +788,7 @@ public CompletableFuture<InsertManyResult > insertManyAsync(List<? extends T> do
      * @throws RuntimeException if there is an error in merging the results of concurrent insertions.
      */
     public InsertManyResult insertMany(List<? extends T> documents) {
-        return insertMany(documents, InsertManyOptions.builder().build());
+        return insertMany(documents, new InsertManyOptions());
     }
 
     /**
@@ -902,7 +902,7 @@ private Callable<InsertManyResult> getInsertManyResultCallable(List<? extends T>
      *         that retrieval operations can be performed safely without the concern of {@link java.util.NoSuchElementException}.
      */
     public Optional<T> findOne(Filter filter) {
-        return findOne(filter, FindOneOptions.builder().build());
+        return findOne(filter, new FindOneOptions());
     }
 
     /**
@@ -1087,7 +1087,7 @@ public FindIterable<T> find(Filter filter, FindOptions options) {
      * @return A {@link FindIterable} for iterating over all documents in the collection.
      */
     public FindIterable<T> find() {
-        return find(null, FindOptions.builder().build());
+        return find(null, new FindOptions());
     }
 
     /**
@@ -1101,7 +1101,7 @@ public FindIterable<T> find() {
      * @return A {@link FindIterable} for iterating over the documents that match the filter.
      */
     public FindIterable<T> find(Filter filter) {
-        return find(filter, FindOptions.builder().build());
+        return find(filter, new FindOptions());
     }
 
     /**
@@ -1119,10 +1119,7 @@ public FindIterable<T> find(Filter filter) {
      * @return A {@link FindIterable} for iterating over the sorted and limited documents.
      */
     public FindIterable<T> find(Filter filter, float[] vector, int limit) {
-        return find(filter, FindOptions.builder()
-                .vector(vector)
-                .limit(limit)
-                .build());
+        return find(filter, FindOptions.Builder.vector(vector).limit(limit));
     }
 
     /**
@@ -1138,10 +1135,7 @@ public FindIterable<T> find(Filter filter, float[] vector, int limit) {
      * @return A {@link FindIterable} for iterating over the sorted and limited documents.
      */
     public FindIterable<T> find(Filter filter, String vectorize, int limit) {
-        return find(filter, FindOptions.builder()
-                .vectorize(vectorize)
-                .limit(limit)
-                .build());
+        return find(filter, FindOptions.Builder.vectorize(vectorize).limit(limit));
     }
 
     /**
@@ -1358,7 +1352,7 @@ public int countDocuments(Filter filter, int upperBound) throws TooManyDocuments
      *
      */
     public DeleteResult deleteOne(Filter filter) {
-        return deleteOne(filter, DeleteOneOptions.builder().build());
+        return deleteOne(filter, new DeleteOneOptions());
     }
 
     /**
@@ -1487,7 +1481,7 @@ public Optional<T> findOneAndReplace(Filter filter, T replacement, FindOneAndRep
                 .withProjection(options.getProjection())
                 .withOptions(new Document()
                         .appendIfNotNull("upsert", options.getUpsert())
-                        .appendIfNotNull("returnDocument", options.getReturnDocument().name())
+                        .appendIfNotNull("returnDocument", options.getReturnDocument())
                 );
 
         ApiResponse res = runCommand(findOneAndReplace);
@@ -1535,7 +1529,7 @@ public UpdateResult replaceOne(Filter filter, T replacement, ReplaceOneOptions r
                 .withReplacement(replacement)
                 .withOptions(new Document()
                         .appendIfNotNull("upsert", replaceOneOptions.getUpsert())
-                        .append("returnDocument", FindOneAndReplaceOptions.ReturnDocument.before.name())
+                        .append("returnDocument", ReturnDocument.BEFORE.getKey())
                 );
 
         // Execute the `findOneAndReplace`
@@ -1600,7 +1594,7 @@ private FindOneAndReplaceResult<T> executeFindOneAndReplace(Command cmd) {
      * returned
      */
     public Optional<T> findOneAndUpdate(Filter filter, Update update) {
-        return findOneAndUpdate(filter, update, FindOneAndUpdateOptions.builder().build());
+        return findOneAndUpdate(filter, update, new FindOneAndUpdateOptions());
     }
 
     /**
@@ -1629,7 +1623,7 @@ public Optional<T> findOneAndUpdate(Filter filter, Update update, FindOneAndUpda
                 .withProjection(options.getProjection())
                 .withOptions(new Document()
                         .appendIfNotNull("upsert", options.getUpsert())
-                        .append("returnDocument", options.getReturnDocument().name())
+                        .append("returnDocument", options.getReturnDocument())
                 );
 
         ApiResponse res = runCommand(cmd);
@@ -1653,7 +1647,7 @@ public Optional<T> findOneAndUpdate(Filter filter, Update update, FindOneAndUpda
      *      the result of the update one operation
      */
     public UpdateResult updateOne(Filter filter, Update update) {
-        return updateOne(filter, update, UpdateOneOptions.builder().build());
+        return updateOne(filter, update, new UpdateOneOptions());
     }
 
     /**
@@ -1710,7 +1704,7 @@ private static UpdateResult getUpdateResult(ApiResponse apiResponse) {
      *      the result of the update many operation
      */
     public UpdateResult updateMany(Filter filter, Update update) {
-        return updateMany(filter, update, UpdateManyOptions.builder().build());
+        return updateMany(filter, update, new UpdateManyOptions());
     }
 
     /**

astra-db-java/src/main/java/com/datastax/astra/client/model/DeleteOneOptions.java

@@ -20,15 +20,13 @@
  * #L%
  */
 
-import com.datastax.astra.internal.utils.Assert;
-import lombok.Getter;
-
-import java.util.List;
+import com.datastax.astra.internal.utils.OptionsUtils;
+import lombok.Data;
 
 /**
  * Options to delete One document.
  */
-@Getter
+@Data
 public class DeleteOneOptions {
 
     /**
@@ -39,9 +37,7 @@ public class DeleteOneOptions {
     /**
      * Default constructor.
      */
-    public DeleteOneOptions(DeleteOneOptionsBuilder builder) {
-        this.sort = builder.sort;
-    }
+    public DeleteOneOptions() {}
 
     /**
      * Syntax sugar as delete option is only a sort
@@ -51,129 +47,82 @@ public DeleteOneOptions(DeleteOneOptionsBuilder builder) {
      * @return
      *      current command.
      */
-    public static DeleteOneOptions sort(Sort sort) {
-        return new DeleteOneOptionsBuilder().sort(sort).build();
+    public DeleteOneOptions sort(Sort... sort) {
+        setSort(OptionsUtils.sort(sort));
+        return this;
     }
 
     /**
-     * Create a builder for those options.
+     * Add a criteria with $vectorize in the sort clause
      *
-     * @return
-     *      instance of the builder.
+     * @param vectorize an expression to look for vectorization
+     * @param sorts The sort criteria to be applied to the findOne operation.
+     * @return current command
      */
-    public static DeleteOneOptionsBuilder builder() {
-        return new DeleteOneOptionsBuilder();
+    public DeleteOneOptions vectorize(String vectorize, Sort ... sorts) {
+        setSort(Sorts.vectorize(vectorize));
+        if (sorts != null) {
+            getSort().putAll(OptionsUtils.sort(sorts));
+        }
+        return this;
     }
 
     /**
-     * Find is an operation with multiple options to filter, sort, project, skip, limit, and more.
-     * This builder will help to chain options.
+     * Add a criteria with $vector in the sort clause
+     *
+     * @param vector vector float
+     * @param sorts The sort criteria to be applied to the findOne operation.
+     * @return current command
      */
-    public static class DeleteOneOptionsBuilder {
+    public DeleteOneOptions vector(float[] vector, Sort... sorts) {
+        setSort(Sorts.vector(vector));
+        if (sorts != null) {
+            getSort().putAll(OptionsUtils.sort(sorts));
+        }
+        return this;
+    }
 
-        /**
-         * Order by.
-         */
-        private Document sort;
+    /**
+     * Builder for creating {@link DeleteOneOptions} instances with a fluent API.
+     */
+    public static class Builder {
 
         /**
-         * Default Builder.
+         * Hide constructor.
          */
-        public DeleteOneOptionsBuilder() {}
+        private Builder() {}
 
         /**
-         * Fluent api.
+         * Initializes the building process with sorting options.
          *
-         * @param pSort
-         *      list of sorts
-         * @return
-         *      Self reference
+         * @param sort The sort criteria to be applied to the delete operation.
+         * @return A new {@link DeleteOneOptions} instance configured with the provided sort criteria.
          */
-        public DeleteOneOptionsBuilder sort(Sort pSort) {
-            Assert.notNull(pSort, "sort");
-            if (this.sort == null) {
-                this.sort = new Document();
-            }
-            this.sort.put(pSort.getField(), pSort.getOrder().getCode());
-            return this;
+        public static DeleteOneOptions sort(Sort... sort) {
+            return new DeleteOneOptions().sort(sort);
         }
 
         /**
-         * Fluent api.
+         * Initializes the building process with vectorize options.
          *
-         * @param sorts
-         *      list of sorts
-         * @return
-         *      Self reference
+         * @param vectorize The vectorize criteria to be applied to the findOne operation
+         * @param sorts The sort criteria to be applied to the findOne operation.
+         * @return A new {@link DeleteOneOptions} instance configured with the provided vectorize criteria.
          */
-        public DeleteOneOptionsBuilder sort(List<Sort> sorts) {
-            Assert.notNull(sorts, "sort");
-            if (this.sort == null) {
-                sort = new Document();
-            }
-            for (Sort s : sorts) {
-                this.sort.put(s.getField(), s.getOrder().getCode());
-            }
-            return this;
+        public static DeleteOneOptions vectorize(String vectorize, Sort... sorts) {
+            return new DeleteOneOptions().vectorize(vectorize, sorts);
         }
 
         /**
-         * Fluent api.
+         * Initializes the building process with vector options.
          *
-         * @param pSort
-         *      add a filter
-         * @return
-         *      current command.
+         * @param vector The vector criteria to be applied to the findOne operation
+         * @param sorts The sort criteria to be applied to the findOne operation.
+         * @return A new {@link DeleteOneOptions} instance configured with the provided vector criteria.
          */
-        public DeleteOneOptionsBuilder sort(Document pSort) {
-            Assert.notNull(pSort, "sort");
-            if (this.sort == null) {
-                sort = new Document();
-            }
-            this.sort.putAll(pSort);
-            return this;
+        public static DeleteOneOptions vector(float[] vector, Sort... sorts) {
+            return new DeleteOneOptions().vector(vector, sorts);
         }
-
-        /**
-         * Builder for the find Options.
-         *
-         * @return
-         *      the find options object
-         */
-        public DeleteOneOptions build() {
-            return new DeleteOneOptions(this);
-        }
-
     }
 
-    /**
-     * Fluent api.
-     *
-     * @param pSort
-     *      add a filter
-     * @return
-     *      current command.
-     */
-    public DeleteOneOptions sortingBy(Document pSort) {
-        Assert.notNull(pSort, "sort");
-        if (this.sort == null) {
-            sort = new Document();
-        }
-        this.sort.putAll(pSort);
-        return this;
-    }
-
-    /**
-     * Add a sort clause to the current field.
-     *
-     * @param fieldName
-     *      field name
-     * @param ordering
-     *      field ordering
-     * @return
-     *      current reference  find
-     */
-    public DeleteOneOptions sortingBy(String fieldName, SortOrder ordering) {
-        return sortingBy(new Document().append(fieldName, ordering.getCode()));
-    }
 }

astra-db-java/src/main/java/com/datastax/astra/client/model/DeleteResult.java

@@ -20,13 +20,13 @@
  * #L%
  */
 
-import lombok.AllArgsConstructor;
-import lombok.Data;
+import lombok.Getter;
+import lombok.Setter;
 
 /**
  * Hold the result of delete commands (deleteOne, deleteMany).
  */
-@Data @AllArgsConstructor
+@Getter @Setter
 public class DeleteResult {
 
     /**
@@ -36,7 +36,11 @@ public class DeleteResult {
 
     /**
      * Default constructor.
+     *
+     * @param deletedCount
+     *      number of items deleted
      */
-    public DeleteResult() {}
-
+    public DeleteResult(int deletedCount) {
+        this.deletedCount = deletedCount;
+    }
 }

astra-db-java/src/main/java/com/datastax/astra/client/model/DistinctIterable.java

@@ -73,7 +73,7 @@ public DistinctIterable(Collection<DOC> collection, String fieldName, Filter fil
         this.filter      = filter;
         this.fieldName   = fieldName;
         this.fieldClass  = fieldClass;
-        this.options     = FindOptions.builder().build();
+        this.options     = new FindOptions();
     }
 
     /** {@inheritDoc} */