HNSW index: add generic setParameter(float[]) method

Author: greenrobot-team

objectbox-java/src/main/java/io/objectbox/Property.java

@@ -40,11 +40,12 @@
 import io.objectbox.query.PropertyQueryConditionImpl.StringCondition;
 import io.objectbox.query.PropertyQueryConditionImpl.StringCondition.Operation;
 import io.objectbox.query.PropertyQueryConditionImpl.StringStringCondition;
+import io.objectbox.query.Query;
 import io.objectbox.query.QueryBuilder.StringOrder;
 
 /**
  * Meta data describing a Property of an ObjectBox Entity.
- * Properties are typically used when defining {@link io.objectbox.query.Query Query} conditions
+ * Properties are typically used when defining {@link Query Query} conditions
  * using {@link io.objectbox.query.QueryBuilder QueryBuilder}.
  * Access properties using the generated underscore class of an entity (e.g. {@code Example_.id}).
  */
@@ -315,6 +316,9 @@ public PropertyQueryCondition<ENTITY> between(double lowerBoundary, double upper
      * be used as the "ef" HNSW parameter to increase the search quality in combination with a query limit. For example,
      * use maxResultCount of 100 with a Query limit of 10 to have 10 results that are of potentially better quality than
      * just passing in 10 for maxResultCount (quality/performance tradeoff).
+     * <p>
+     * To change the given parameters after building the query, use {@link Query#setParameter(Property, float[])} and
+     * {@link Query#setParameter(Property, long)} or their alias equivalent.
      */
     public PropertyQueryCondition<ENTITY> nearestNeighbors(float[] queryVector, int maxResultCount) {
         return new NearestNeighborCondition<>(this, queryVector, maxResultCount);

objectbox-java/src/main/java/io/objectbox/query/Query.java

@@ -655,6 +655,30 @@ public Query<T> setParameter(String alias, boolean value) {
         return setParameter(alias, value ? 1 : 0);
     }
 
+    /**
+     * Changes the parameter of the query condition for {@code property} to a new {@code value}.
+     *
+     * @param property Property reference from generated entity underscore class, like {@code Example_.example}.
+     * @param value The new {@code float[]} value to use for the query condition.
+     */
+    public Query<T> setParameter(Property<?> property, float[] value) {
+        checkOpen();
+        nativeSetParameter(handle, property.getEntityId(), property.getId(), null, value);
+        return this;
+    }
+
+    /**
+     * Changes the parameter of the query condition with the matching {@code alias} to a new {@code value}.
+     *
+     * @param alias as defined using {@link PropertyQueryCondition#alias(String)}.
+     * @param value The new {@code float[]} value to use for the query condition.
+     */
+    public Query<T> setParameter(String alias, float[] value) {
+        checkOpen();
+        nativeSetParameter(handle, 0, 0, alias, value);
+        return this;
+    }
+
     /**
      * Sets a parameter previously given to the {@link QueryBuilder} to new values.
      */
@@ -795,30 +819,6 @@ public Query<T> setParameter(String alias, byte[] value) {
         return this;
     }
 
-    /**
-     * Sets parameters previously given to {@link Property#nearestNeighbors(float[], int)}.
-     *
-     * @param property Property reference from generated entity underscore class, like {@code Example_.example}.
-     */
-    public Query<T> setParametersNearestNeighbors(Property<?> property, float[] queryVector, int maxResultCount) {
-        checkOpen();
-        nativeSetParameter(handle, property.getEntityId(), property.getId(), null, queryVector);
-        nativeSetParameter(handle, property.getEntityId(), property.getId(), null, maxResultCount);
-        return this;
-    }
-
-    /**
-     * Sets parameters previously given to {@link Property#nearestNeighbors(float[], int)}.
-     *
-     * @param alias as defined using {@link PropertyQueryCondition#alias(String)}.
-     */
-    public Query<T> setParametersNearestNeighbors(String alias, float[] queryVector, int maxResultCount) {
-        checkOpen();
-        nativeSetParameter(handle, 0, 0, alias, queryVector);
-        nativeSetParameter(handle, 0, 0, alias, maxResultCount);
-        return this;
-    }
-
     /**
      * Removes (deletes) all Objects matching the query
      *