The fields id and retrievableId are now variable fields for Descriptors.

vitrivr · May 29, 2024 · 0a176e7 · 0a176e7 · lucaro · May 29, 2024
1 parent 109c266
commit 0a176e7
Show file tree

Hide file tree

Showing 25 changed files with 51 additions and 50 deletions.
diff --git a/vitrivr-engine-core/src/main/kotlin/org/vitrivr/engine/core/model/descriptor/Descriptor.kt b/vitrivr-engine-core/src/main/kotlin/org/vitrivr/engine/core/model/descriptor/Descriptor.kt
@@ -18,16 +18,15 @@ typealias DescriptorId = UUID
  */
 interface Descriptor : Persistable {
     /** The [DescriptorId] held by this [Descriptor]. */
-    val id: DescriptorId
+    var id: DescriptorId
 
     /** The [RetrievableId] of the [Retrievable] that is being described by this [Descriptor]. */
-    val retrievableId: RetrievableId?
+    var retrievableId: RetrievableId?
 
     /** The [Schema.Field] backing this [Descriptor]. */
     val field: Schema.Field<*, out Descriptor>?
 
-
-    /** */
+    /** Flag indicating whether this [Descriptor] is persistent or not. */
     override val transient: Boolean
         get() = this.field != null
 

diff --git a/...core/src/main/kotlin/org/vitrivr/engine/core/model/descriptor/scalar/BooleanDescriptor.kt b/...core/src/main/kotlin/org/vitrivr/engine/core/model/descriptor/scalar/BooleanDescriptor.kt
@@ -15,8 +15,8 @@ import org.vitrivr.engine.core.model.types.Value
  */
 
 data class BooleanDescriptor(
-    override val id: DescriptorId,
-    override val retrievableId: RetrievableId,
+    override var id: DescriptorId,
+    override var retrievableId: RetrievableId?,
     override val value: Value.Boolean,
     override val field: Schema.Field<*, BooleanDescriptor>? = null
 ) : ScalarDescriptor<Value.Boolean> {

diff --git a/...-core/src/main/kotlin/org/vitrivr/engine/core/model/descriptor/scalar/DoubleDescriptor.kt b/...-core/src/main/kotlin/org/vitrivr/engine/core/model/descriptor/scalar/DoubleDescriptor.kt
@@ -15,8 +15,8 @@ import org.vitrivr.engine.core.model.types.Value
  */
 
 data class DoubleDescriptor(
-    override val id: DescriptorId,
-    override val retrievableId: RetrievableId,
+    override var id: DescriptorId,
+    override var retrievableId: RetrievableId?,
     override val value: Value.Double,
     override val field: Schema.Field<*, DoubleDescriptor>? = null
 ) : ScalarDescriptor<Value.Double> {

diff --git a/...e-core/src/main/kotlin/org/vitrivr/engine/core/model/descriptor/scalar/FloatDescriptor.kt b/...e-core/src/main/kotlin/org/vitrivr/engine/core/model/descriptor/scalar/FloatDescriptor.kt
@@ -15,8 +15,8 @@ import org.vitrivr.engine.core.model.types.Value
  */
 
 data class FloatDescriptor(
-    override val id: DescriptorId,
-    override val retrievableId: RetrievableId,
+    override var id: DescriptorId,
+    override var retrievableId: RetrievableId?,
     override val value: Value.Float,
     override val field: Schema.Field<*, FloatDescriptor>? = null
 ) : ScalarDescriptor<Value.Float> {

diff --git a/...ine-core/src/main/kotlin/org/vitrivr/engine/core/model/descriptor/scalar/IntDescriptor.kt b/...ine-core/src/main/kotlin/org/vitrivr/engine/core/model/descriptor/scalar/IntDescriptor.kt
@@ -15,8 +15,8 @@ import org.vitrivr.engine.core.model.types.Value
  */
 
 data class IntDescriptor(
-    override val id: DescriptorId,
-    override val retrievableId: RetrievableId,
+    override var id: DescriptorId,
+    override var retrievableId: RetrievableId?,
     override val value: Value.Int,
     override val field: Schema.Field<*, IntDescriptor>? = null
 ) : ScalarDescriptor<Value.Int> {

diff --git a/...ne-core/src/main/kotlin/org/vitrivr/engine/core/model/descriptor/scalar/LongDescriptor.kt b/...ne-core/src/main/kotlin/org/vitrivr/engine/core/model/descriptor/scalar/LongDescriptor.kt
@@ -15,8 +15,8 @@ import org.vitrivr.engine.core.model.types.Value
  */
 
 data class LongDescriptor(
-    override val id: DescriptorId,
-    override val retrievableId: RetrievableId,
+    override var id: DescriptorId,
+    override var retrievableId: RetrievableId?,
     override val value: Value.Long,
     override val field: Schema.Field<*, LongDescriptor>? = null
 ) : ScalarDescriptor<Value.Long> {

diff --git a/...-core/src/main/kotlin/org/vitrivr/engine/core/model/descriptor/scalar/StringDescriptor.kt b/...-core/src/main/kotlin/org/vitrivr/engine/core/model/descriptor/scalar/StringDescriptor.kt
@@ -15,8 +15,8 @@ import org.vitrivr.engine.core.model.types.Value
  */
 
 data class StringDescriptor(
-    override val id: DescriptorId,
-    override val retrievableId: RetrievableId?,
+    override var id: DescriptorId,
+    override var retrievableId: RetrievableId?,
     override val value: Value.String,
     override val field: Schema.Field<*, StringDescriptor>? = null
 ) : ScalarDescriptor<Value.String> {

diff --git a/...e-core/src/main/kotlin/org/vitrivr/engine/core/model/descriptor/struct/LabelDescriptor.kt b/...e-core/src/main/kotlin/org/vitrivr/engine/core/model/descriptor/struct/LabelDescriptor.kt
@@ -14,8 +14,8 @@ import org.vitrivr.engine.core.model.types.Value
  * @version 1.0.0
  */
 data class LabelDescriptor(
-    override val id: DescriptorId,
-    override val retrievableId: RetrievableId?,
+    override var id: DescriptorId,
+    override var retrievableId: RetrievableId?,
     val label: Value.String,
     val confidence: Value.Float,
     override val field: Schema.Field<*, LabelDescriptor>? = null

diff --git a/...-core/src/main/kotlin/org/vitrivr/engine/core/model/descriptor/struct/RasterDescriptor.kt b/...-core/src/main/kotlin/org/vitrivr/engine/core/model/descriptor/struct/RasterDescriptor.kt
@@ -8,8 +8,8 @@ import org.vitrivr.engine.core.model.types.Type
 import org.vitrivr.engine.core.model.types.Value
 
 data class RasterDescriptor(
-    override val id: DescriptorId,
-    override val retrievableId: RetrievableId,
+    override var id: DescriptorId,
+    override var retrievableId: RetrievableId?,
     val hist: List<Value.Float>,
     val raster: List<Value.Float>,
     override val field: Schema.Field<*, RasterDescriptor>? = null

diff --git a/...ore/src/main/kotlin/org/vitrivr/engine/core/model/descriptor/struct/SkeletonDescriptor.kt b/...ore/src/main/kotlin/org/vitrivr/engine/core/model/descriptor/struct/SkeletonDescriptor.kt
@@ -8,8 +8,8 @@ import org.vitrivr.engine.core.model.types.Type
 import org.vitrivr.engine.core.model.types.Value
 
 data class SkeletonDescriptor(
-    override val id: DescriptorId,
-    override val retrievableId: RetrievableId,
+    override var id: DescriptorId,
+    override var retrievableId: RetrievableId?,
     val person: Value.Int,
     val skeleton: List<Value.Float>,
     val weights: List<Value.Float>,

diff --git a/...lin/org/vitrivr/engine/core/model/descriptor/struct/metadata/MediaDimensionsDescriptor.kt b/...lin/org/vitrivr/engine/core/model/descriptor/struct/metadata/MediaDimensionsDescriptor.kt
@@ -17,8 +17,8 @@ import java.util.*
  * @version 1.0.0
  */
 data class MediaDimensionsDescriptor(
-    override val id: DescriptorId,
-    override val retrievableId: RetrievableId,
+    override var id: DescriptorId,
+    override var retrievableId: RetrievableId?,
     val width: Value.Int,
     val height: Value.Int,
     override val field: Schema.Field<*, MediaDimensionsDescriptor>? = null

diff --git a/...org/vitrivr/engine/core/model/descriptor/struct/metadata/Rectangle2DMetadataDescriptor.kt b/...org/vitrivr/engine/core/model/descriptor/struct/metadata/Rectangle2DMetadataDescriptor.kt
@@ -16,8 +16,8 @@ import java.util.*
  * @version 1.0.0
  */
 data class Rectangle2DMetadataDescriptor(
-    override val id: DescriptorId,
-    override val retrievableId: RetrievableId,
+    override var id: DescriptorId,
+    override var retrievableId: RetrievableId?,
     val leftX: Value.Int,
     val leftY: Value.Int,
     val width: Value.Int,

diff --git a/...in/org/vitrivr/engine/core/model/descriptor/struct/metadata/TemporalMetadataDescriptor.kt b/...in/org/vitrivr/engine/core/model/descriptor/struct/metadata/TemporalMetadataDescriptor.kt
@@ -16,8 +16,8 @@ import java.util.*
  * @version 1.0.0
  */
 data class TemporalMetadataDescriptor(
-    override val id: DescriptorId,
-    override val retrievableId: RetrievableId, //retrievable Id must come first, due to reflection
+    override var id: DescriptorId,
+    override var retrievableId: RetrievableId?, //retrievable Id must come first, due to reflection
     val startNs: Value.Long,
     val endNs: Value.Long,
     override val field: Schema.Field<*, TemporalMetadataDescriptor>? = null

diff --git a/...trivr/engine/core/model/descriptor/struct/metadata/source/FileSourceMetadataDescriptor.kt b/...trivr/engine/core/model/descriptor/struct/metadata/source/FileSourceMetadataDescriptor.kt
@@ -16,8 +16,8 @@ import java.util.*
  * @version 1.0.0
  */
 data class FileSourceMetadataDescriptor(
-    override val id: DescriptorId,
-    override val retrievableId: RetrievableId,
+    override var id: DescriptorId,
+    override var retrievableId: RetrievableId?,
     val path: Value.String,
     val size: Value.Long,
     override val field: Schema.Field<*, FileSourceMetadataDescriptor>? = null

diff --git a/...in/org/vitrivr/engine/core/model/descriptor/struct/metadata/source/MapStructDescriptor.kt b/...in/org/vitrivr/engine/core/model/descriptor/struct/metadata/source/MapStructDescriptor.kt
@@ -10,8 +10,8 @@ import org.vitrivr.engine.core.model.types.Value
 import java.util.*
 
 data class MapStructDescriptor(
-    override val id: DescriptorId,
-    override val retrievableId: RetrievableId,
+    override var id: DescriptorId,
+    override var retrievableId: RetrievableId?,
     val columnTypes: Map<String, String>,
     val columnValues: Map<String, Any?>,
     override val transient: Boolean = false,

diff --git a/...rivr/engine/core/model/descriptor/struct/metadata/source/VideoSourceMetadataDescriptor.kt b/...rivr/engine/core/model/descriptor/struct/metadata/source/VideoSourceMetadataDescriptor.kt
@@ -16,8 +16,8 @@ import java.util.*
  * @version 1.0.0
  */
 class VideoSourceMetadataDescriptor(
-    override val id: DescriptorId,
-    override val retrievableId: RetrievableId,
+    override var id: DescriptorId,
+    override var retrievableId: RetrievableId?,
     val width: Value.Int,
     val height: Value.Int,
     val fps: Value.Double,

diff --git a/...rc/main/kotlin/org/vitrivr/engine/core/model/descriptor/vector/BooleanVectorDescriptor.kt b/...rc/main/kotlin/org/vitrivr/engine/core/model/descriptor/vector/BooleanVectorDescriptor.kt
@@ -16,8 +16,8 @@ import java.util.*
  */
 
 data class BooleanVectorDescriptor(
-    override val id: UUID = UUID.randomUUID(),
-    override val retrievableId: RetrievableId? = null,
+    override var id: UUID = UUID.randomUUID(),
+    override var retrievableId: RetrievableId? = null,
     override val vector: List<Value.Boolean>,
     override val field: Schema.Field<*, BooleanVectorDescriptor>? = null
 ) : VectorDescriptor<Value.Boolean> {

diff --git a/...src/main/kotlin/org/vitrivr/engine/core/model/descriptor/vector/DoubleVectorDescriptor.kt b/...src/main/kotlin/org/vitrivr/engine/core/model/descriptor/vector/DoubleVectorDescriptor.kt
@@ -16,8 +16,8 @@ import java.util.*
  */
 
 data class DoubleVectorDescriptor(
-    override val id: UUID = UUID.randomUUID(),
-    override val retrievableId: RetrievableId? = null,
+    override var id: UUID = UUID.randomUUID(),
+    override var retrievableId: RetrievableId? = null,
     override val vector: List<Value.Double>,
     override val field: Schema.Field<*, DoubleVectorDescriptor>? = null
 ) : VectorDescriptor<Value.Double> {

diff --git a/.../src/main/kotlin/org/vitrivr/engine/core/model/descriptor/vector/FloatVectorDescriptor.kt b/.../src/main/kotlin/org/vitrivr/engine/core/model/descriptor/vector/FloatVectorDescriptor.kt
@@ -17,8 +17,8 @@ import java.util.*
  */
 
 data class FloatVectorDescriptor(
-    override val id: UUID = UUID.randomUUID(),
-    override val retrievableId: RetrievableId? = null,
+    override var id: UUID = UUID.randomUUID(),
+    override var retrievableId: RetrievableId? = null,
     override val vector: List<Value.Float>,
     override val field: Schema.Field<*, FloatVectorDescriptor>? = null
 ) : VectorDescriptor<Value.Float> {

diff --git a/...re/src/main/kotlin/org/vitrivr/engine/core/model/descriptor/vector/IntVectorDescriptor.kt b/...re/src/main/kotlin/org/vitrivr/engine/core/model/descriptor/vector/IntVectorDescriptor.kt
@@ -16,8 +16,8 @@ import java.util.*
  */
 
 data class IntVectorDescriptor(
-    override val id: UUID = UUID.randomUUID(),
-    override val retrievableId: RetrievableId? = null,
+    override var id: UUID = UUID.randomUUID(),
+    override var retrievableId: RetrievableId? = null,
     override val vector: List<Value.Int>,
     override val field: Schema.Field<*, IntVectorDescriptor>? = null
 ) : VectorDescriptor<Value.Int> {

diff --git a/...e/src/main/kotlin/org/vitrivr/engine/core/model/descriptor/vector/LongVectorDescriptor.kt b/...e/src/main/kotlin/org/vitrivr/engine/core/model/descriptor/vector/LongVectorDescriptor.kt
@@ -16,8 +16,8 @@ import java.util.*
  */
 
 data class LongVectorDescriptor(
-    override val id: UUID = UUID.randomUUID(),
-    override val retrievableId: RetrievableId? = null,
+    override var id: UUID = UUID.randomUUID(),
+    override var retrievableId: RetrievableId? = null,
     override val vector: List<Value.Long>,
     override val field: Schema.Field<*, LongVectorDescriptor>? = null
 ) : VectorDescriptor<Value.Long> {

diff --git a/...dule-fes/src/main/kotlin/org/vitrivr/engine/base/features/external/implementations/ASR.kt b/...dule-fes/src/main/kotlin/org/vitrivr/engine/base/features/external/implementations/ASR.kt
@@ -3,7 +3,6 @@ package org.vitrivr.engine.base.features.external.implementations
 import org.vitrivr.engine.base.features.external.common.ApiWrapper
 import org.vitrivr.engine.base.features.external.common.ExternalFesAnalyser
 import org.vitrivr.engine.base.features.external.common.FesExtractor
-import org.vitrivr.engine.base.features.fulltext.FulltextRetriever
 import org.vitrivr.engine.core.context.IndexContext
 import org.vitrivr.engine.core.context.QueryContext
 import org.vitrivr.engine.core.model.content.Content
@@ -16,11 +15,15 @@ import org.vitrivr.engine.core.model.query.fulltext.SimpleFulltextQuery
 import org.vitrivr.engine.core.model.retrievable.Retrievable
 import org.vitrivr.engine.core.model.retrievable.RetrievableId
 import org.vitrivr.engine.core.model.types.Value
-import org.vitrivr.engine.core.model.types.Value.String as StringValue
 import org.vitrivr.engine.core.operators.Operator
 import org.vitrivr.engine.core.operators.ingest.Extractor
 import org.vitrivr.engine.core.operators.retrieve.Retriever
+import org.vitrivr.engine.module.features.feature.fulltext.FulltextRetriever
 import java.util.*
+import kotlin.IllegalArgumentException
+import kotlin.String
+import kotlin.require
+import org.vitrivr.engine.core.model.types.Value.String as StringValue
 
 /**
  * Implementation of the [ASR] [ExternalFesAnalyser] that uses an external FES API to analyse audio content.

diff --git a/...c/main/kotlin/org/vitrivr/engine/base/features/external/implementations/DenseEmbedding.kt b/...c/main/kotlin/org/vitrivr/engine/base/features/external/implementations/DenseEmbedding.kt
@@ -1,7 +1,6 @@
 package org.vitrivr.engine.base.features.external.implementations
 
 import org.vitrivr.engine.base.features.external.common.ApiWrapper
-import org.vitrivr.engine.base.features.external.common.DenseRetriever
 import org.vitrivr.engine.base.features.external.common.ExternalFesAnalyser
 import org.vitrivr.engine.base.features.external.common.FesExtractor
 import org.vitrivr.engine.core.context.IndexContext
@@ -19,6 +18,7 @@ import org.vitrivr.engine.core.model.types.Value
 import org.vitrivr.engine.core.operators.Operator
 import org.vitrivr.engine.core.operators.ingest.Extractor
 import org.vitrivr.engine.core.operators.retrieve.Retriever
+import org.vitrivr.engine.module.features.feature.external.common.DenseRetriever
 import java.util.*
 
 /**

diff --git a/...src/main/kotlin/org/vitrivr/engine/base/features/external/implementations/ImageCaption.kt b/...src/main/kotlin/org/vitrivr/engine/base/features/external/implementations/ImageCaption.kt
@@ -3,7 +3,6 @@ package org.vitrivr.engine.base.features.external.implementations
 import org.vitrivr.engine.base.features.external.common.ApiWrapper
 import org.vitrivr.engine.base.features.external.common.ExternalFesAnalyser
 import org.vitrivr.engine.base.features.external.common.FesExtractor
-import org.vitrivr.engine.base.features.fulltext.FulltextRetriever
 import org.vitrivr.engine.core.context.IndexContext
 import org.vitrivr.engine.core.context.QueryContext
 import org.vitrivr.engine.core.model.content.element.ImageContent
@@ -18,6 +17,7 @@ import org.vitrivr.engine.core.model.types.Value
 import org.vitrivr.engine.core.operators.Operator
 import org.vitrivr.engine.core.operators.ingest.Extractor
 import org.vitrivr.engine.core.operators.retrieve.Retriever
+import org.vitrivr.engine.module.features.feature.fulltext.FulltextRetriever
 import java.util.*
 
 

diff --git a/...dule-fes/src/main/kotlin/org/vitrivr/engine/base/features/external/implementations/OCR.kt b/...dule-fes/src/main/kotlin/org/vitrivr/engine/base/features/external/implementations/OCR.kt
@@ -3,11 +3,9 @@ package org.vitrivr.engine.base.features.external.implementations
 import org.vitrivr.engine.base.features.external.common.ApiWrapper
 import org.vitrivr.engine.base.features.external.common.ExternalFesAnalyser
 import org.vitrivr.engine.base.features.external.common.FesExtractor
-import org.vitrivr.engine.base.features.fulltext.FulltextRetriever
 import org.vitrivr.engine.core.context.IndexContext
 import org.vitrivr.engine.core.context.QueryContext
 import org.vitrivr.engine.core.model.content.Content
-import org.vitrivr.engine.core.model.content.element.ContentElement
 import org.vitrivr.engine.core.model.content.element.ImageContent
 import org.vitrivr.engine.core.model.content.element.TextContent
 import org.vitrivr.engine.core.model.descriptor.scalar.StringDescriptor
@@ -20,6 +18,7 @@ import org.vitrivr.engine.core.model.types.Value
 import org.vitrivr.engine.core.operators.Operator
 import org.vitrivr.engine.core.operators.ingest.Extractor
 import org.vitrivr.engine.core.operators.retrieve.Retriever
+import org.vitrivr.engine.module.features.feature.fulltext.FulltextRetriever
 import java.util.*
 
 /**