ByteVector property queries

Author: Ivan Dlugos

lib/src/query/query.dart

@@ -1,6 +1,8 @@
 library query;
 
 import 'dart:ffi';
+import 'dart:typed_data';
+
 import 'package:ffi/ffi.dart' show allocate, free, Utf8;
 
 import '../store.dart';
@@ -136,7 +138,29 @@ class QueryByteVectorProperty extends QueryProperty {
       /*required*/ int obxType})
       : super(entityId, propertyId, obxType);
 
-  // TODO conditions
+  Condition _op(List<int> val, ConditionOp cop) {
+    return ByteVectorCondition(cop, this, Uint8List.fromList(val));
+  }
+
+  Condition equals(List<int> val) {
+    return _op(val, ConditionOp.eq);
+  }
+
+  Condition greaterThan(List<int> val) {
+    return _op(val, ConditionOp.gt);
+  }
+
+  Condition greaterOrEqual(List<int> val) {
+    return _op(val, ConditionOp.greaterOrEq);
+  }
+
+  Condition lessThan(List<int> val) {
+    return _op(val, ConditionOp.lt);
+  }
+
+  Condition lessOrEqual(List<int> val) {
+    return _op(val, ConditionOp.lessOrEq);
+  }
 }
 
 class QueryIntegerProperty extends QueryProperty {
@@ -541,6 +565,40 @@ class DoubleCondition extends PropertyCondition<double> {
   }
 }
 
+class ByteVectorCondition extends PropertyCondition<Uint8List> {
+  ByteVectorCondition(ConditionOp op, QueryProperty prop, Uint8List value)
+      : super(op, prop, value);
+
+  int _op1(QueryBuilder builder,
+      int Function(Pointer<OBX_query_builder>, int, Pointer<Void>, int) func) {
+    final cBytes = OBX_bytes_wrapper.managedCopyOf(_value, align: false);
+    try {
+      return func(
+          builder._cBuilder, _property._propertyId, cBytes.ptr, cBytes.size);
+    } finally {
+      cBytes.freeManaged();
+    }
+  }
+
+  @override
+  int apply(QueryBuilder builder, bool isRoot) {
+    switch (_op) {
+      case ConditionOp.eq:
+        return _op1(builder, bindings.obx_qb_equals_bytes);
+      case ConditionOp.lt:
+        return _op1(builder, bindings.obx_qb_less_than_bytes);
+      case ConditionOp.lessOrEq:
+        return _op1(builder, bindings.obx_qb_less_or_equal_bytes);
+      case ConditionOp.gt:
+        return _op1(builder, bindings.obx_qb_greater_than_bytes);
+      case ConditionOp.greaterOrEq:
+        return _op1(builder, bindings.obx_qb_greater_or_equal_bytes);
+      default:
+        throw Exception('Unsupported operation ${_op.toString()}');
+    }
+  }
+}
+
 class ConditionGroup extends Condition {
   final List<Condition> _conditions;
   final int Function(Pointer<OBX_query_builder>, Pointer<Int32>, int) _func;

test/box_test.dart

@@ -39,14 +39,14 @@ void main() {
     final int putId = box.put(TestEntity(
         tString: 'Hello',
         tStrings: ['foo', 'bar'],
-        tListInt: [1, 99, -54],
+        tByteList: [1, 99, -54],
         tUint8List: Uint8List.fromList([2, 50, 78]),
         tInt8List: Int8List.fromList([-16, 20, 43])));
     final TestEntity item = box.get(putId) /*!*/;
     expect(item.id, equals(putId));
     expect(item.tString, equals('Hello'));
     expect(item.tStrings, equals(['foo', 'bar']));
-    expect(item.tListInt, equals([1, 99, -54]));
+    expect(item.tByteList, equals([1, 99, -54]));
     expect(item.tUint8List, equals([2, 50, 78]));
     expect(item.tInt8List, equals([-16, 20, 43]));
   });

test/entity.dart

@@ -54,7 +54,7 @@ class TestEntity {
 
   // OBXPropertyType.ByteVector
   @Property(type: PropertyType.byteVector)
-  List<int> /*?*/ tListInt;
+  List<int> /*?*/ tByteList;
 
   // OBXPropertyType.ByteVector
   Int8List /*?*/ tInt8List;
@@ -74,7 +74,7 @@ class TestEntity {
       this.tInt,
       this.tFloat,
       this.tStrings,
-      this.tListInt,
+      this.tByteList,
       this.tInt8List,
       this.tUint8List,
       this.ignore});

test/objectbox-model.json

@@ -151,7 +151,7 @@
         },
         {
           "id": "28:7286551998282235109",
-          "name": "tListInt",
+          "name": "tByteList",
           "type": 23
         },
         {

test/query_test.dart

@@ -513,6 +513,24 @@ void main() {
     queryReverseOrder.close();
   });
 
+  test('.describeParameters BytesVector', () {
+    final q = box
+        .query(TestEntity_.tUint8List.equals([1, 2]) &
+            TestEntity_.tInt8List.greaterThan([3, 4]) &
+            TestEntity_.tByteList.greaterOrEqual([5, 6, 7]) &
+            TestEntity_.tUint8List.lessThan([8]) &
+            TestEntity_.tUint8List.lessOrEqual([9, 10, 11, 12]))
+        .build();
+    expect(
+        q.describeParameters(),
+        equals('(tUint8List == byte[2]{0x0102}\n'
+            ' AND tInt8List > byte[2]{0x0304}\n'
+            ' AND tByteList >= byte[3]{0x050607}\n'
+            ' AND tUint8List < byte[1]{0x08}\n'
+            ' AND tUint8List <= byte[4]{0x090A0B0C})'));
+    q.close();
+  });
+
   tearDown(() {
     env.close();
   });