feat!: add isSequenceOf to knora-base ontology (DEV-745)

build.sbt

@@ -202,7 +202,7 @@ lazy val webapi: Project = Project(id = "webapi", base = file("webapi"))
     ),
     buildInfoPackage := "org.knora.webapi.http.version"
   )
-  .dependsOn(shared)
+  .dependsOn(shared, schemaCore)
 
 lazy val webapiJavaRunOptions = Seq(
   // "-showversion",
@@ -312,6 +312,26 @@ lazy val userCore = project
   )
   .dependsOn(shared)
 
+// schema projects
+
+lazy val schemaCore = project
+  .in(file("dsp-schema/core"))
+  .settings(
+    scalacOptions ++= Seq(
+      "-feature",
+      "-unchecked",
+      "-deprecation",
+      "-Yresolve-term-conflict:package",
+      "-Ymacro-annotations"
+    ),
+    name := "schemaCore",
+    libraryDependencies ++= Dependencies.schemaCoreLibraryDependencies,
+    testFrameworks := Seq(new TestFramework("zio.test.sbt.ZTestFramework"))
+  )
+  .dependsOn(shared)
+
+// shared
+
 lazy val shared = project
   .in(file("dsp-shared"))
   .settings(

docs/02-knora-ontologies/knora-base.md

@@ -571,22 +571,33 @@ containing metadata about the link. We can visualise the result as the following
 Knora allows a user to see a link if the requesting user has permission to see the source and target resources as well
 as the `kb:LinkValue`.
 
-### Part-of (part-whole) relation between resources
+### Part-Whole-Relations between Resources
+
+#### isPartOf
+
 A special case of linked resources are _part-of related resources_, i.e. a resource consisting of several other resources. 
 In order to create a part-of relation between two resources, the resource that is part of another resource needs to have
 a property that is a subproperty of `kb:isPartOf`. This property needs to point to the resource class it is part of via 
-its predicate `knora-api:objectType`.
+its predicate `kb:objectType`.
 `kb:isPartOf` itself is a subproperty of `kb:hasLinkTo`. Same as described above for link properties, a corresponding 
 part-of value property is created automatically. This value property has the same name as the part-of property with 
 `Value` appended. For example, if in an ontology `data` a property `data:partOf` was defined, the corresponding value 
 property would be named `data:partOfValue`. This newly created property `data:partOfValue` is defined as a subproperty 
 of `kb:isPartOfValue`.
 
-Part-of relations are recommended for resources of type `StillImageRepresentation`. In that case, the resource that is 
-part of another resource needs to have a property that is a subproperty of `knora-api:seqnum` with an integer as value. 
+Part-of relations are recommended for resources of type `kb:StillImageRepresentation`. In that case, the resource that is 
+part of another resource needs to have a property that is a subproperty of `kb:seqnum` with an integer as value. 
 A client can then use this information to leaf through the parts of the compound resource (p.ex. to leaf through the 
 pages of a book like in [this](https://docs.dasch.swiss/DSP-API/01-introduction/example-project/#resource-classes) example).
 
+#### isSequenceOf
+
+Similar to `kb:isPartOf` for `kb:StillImageRepresentations`, part-whole-relations can be defined for resource that have a time dimension by using `kb:isSequenceOf`. This mostly makes sense for video or audio resources that are subtypes of `kb:MovingImageRepresentation` and `kb:AudioRepresentation`.
+
+`kb:isSequenceOf` is intended to be used in combination with `kb:hasSequenceBounds` which points to a `kb:IntervalValue` that defines the start and end point of the subseqence in relation to the entire audio/video resource. A dedicated frontend behaviour is planned, if these properties are used in combination.
+
+The main difference to `kb:isPartOf` is where actual resoure(s) live: In `kb:isPartOf`, each part *is a* `kb:StillImageRepresentation` and the whole consists of multiple such parts. In `kb:isSequenceOf` on the other hand, the whole is one `kb:MovingImageRepresentation` or `kb:AudioRepresentation`, and the parts only define which sub-sequence of this representation they are.
+
 ### Text with Standoff Markup
 
 DSP-API is designed to be able to store text with markup, which can indicate formatting and structure, as well as the

dsp-schema/core/src/main/scala/dsp/schema/domain/SchemaCommands.scala

@@ -0,0 +1,49 @@
+package dsp.schema.domain
+
+import dsp.errors.ValidationException
+import dsp.valueobjects.LangString
+import dsp.valueobjects.Schema
+import zio.prelude.Validation
+
+import java.time.Instant
+
+case class SmartIri(value: String)
+
+sealed abstract case class CreatePropertyCommand private (
+  ontologyIri: SmartIri, // TODO: make SmartIri a ValueObject at some point
+  lastModificationDate: Instant,
+  propertyIri: SmartIri,
+  subjectType: Option[SmartIri],
+  objectType: SmartIri, // must be `kb:Value`, unless it's a link property, then it should be a `kb:Resource`
+  label: LangString,
+  comment: Option[LangString],
+  superProperties: List[SmartIri],
+  guiObject: Schema.GuiObject
+)
+
+object CreatePropertyCommand {
+  def make(
+    ontologyIri: SmartIri,
+    lastModificationDate: Instant,
+    propertyIri: SmartIri,
+    subjectType: Option[SmartIri],
+    objectType: SmartIri,
+    label: LangString,
+    comment: Option[LangString],
+    superProperties: List[SmartIri],
+    guiObject: Schema.GuiObject
+  ): Validation[ValidationException, CreatePropertyCommand] =
+    Validation.succeed(
+      new CreatePropertyCommand(
+        ontologyIri = ontologyIri,
+        lastModificationDate = lastModificationDate,
+        propertyIri = propertyIri,
+        subjectType = subjectType,
+        objectType = objectType,
+        label = label,
+        comment = comment,
+        superProperties = superProperties,
+        guiObject = guiObject
+      ) {}
+    )
+}

dsp-shared/src/main/scala/dsp/valueobjects/LangString.scala

@@ -0,0 +1,49 @@
+package dsp.valueobjects
+
+import dsp.errors.ValidationException
+import zio.prelude.Validation
+
+sealed abstract case class LangString private (language: LanguageCode, value: String)
+
+object LangString {
+  def make(language: LanguageCode, value: String): Validation[ValidationException, LangString] =
+    if (value.isBlank()) {
+      Validation.fail(ValidationException(LangStringErrorMessages.LangStringValueEmpty))
+    } else {
+      Validation.succeed(new LangString(language, value) {})
+    }
+
+  def make(language: String, value: String): Validation[ValidationException, LangString] =
+    for {
+      languageCode <- LanguageCode.make(language)
+      langString   <- LangString.make(languageCode, value)
+    } yield langString
+
+  def unsafeMake(language: LanguageCode, value: String): LangString =
+    new LangString(language, value) {}
+}
+
+/**
+ * LanguageCode value object.
+ */
+sealed abstract case class LanguageCode private (value: String)
+object LanguageCode { self =>
+  def make(value: String): Validation[ValidationException, LanguageCode] =
+    if (value.isEmpty) {
+      Validation.fail(ValidationException(UserErrorMessages.LanguageCodeMissing))
+    } else if (!V2.SupportedLanguageCodes.contains(value)) {
+      Validation.fail(ValidationException(UserErrorMessages.LanguageCodeInvalid))
+    } else {
+      Validation.succeed(new LanguageCode(value) {})
+    }
+
+  lazy val en: LanguageCode = new LanguageCode(V2.EN) {}
+  lazy val de: LanguageCode = new LanguageCode(V2.DE) {}
+  lazy val fr: LanguageCode = new LanguageCode(V2.FR) {}
+  lazy val it: LanguageCode = new LanguageCode(V2.IT) {}
+  lazy val rm: LanguageCode = new LanguageCode(V2.RM) {}
+}
+
+object LangStringErrorMessages {
+  val LangStringValueEmpty = "String value cannot be empty."
+}

dsp-shared/src/main/scala/dsp/valueobjects/User.scala

@@ -6,13 +6,14 @@
 package dsp.valueobjects
 
 import dsp.errors.BadRequestException
+import dsp.errors.ValidationException
 import org.springframework.security.crypto.bcrypt.BCryptPasswordEncoder
 import org.springframework.security.crypto.scrypt.SCryptPasswordEncoder
 import zio._
 import zio.prelude.Validation
 
-import scala.util.matching.Regex
 import java.security.SecureRandom
+import scala.util.matching.Regex
 
 object User {
 
@@ -198,27 +199,12 @@ object User {
       Validation.succeed(new UserStatus(value) {})
   }
 
-  /**
-   * LanguageCode value object.
-   */
-  sealed abstract case class LanguageCode private (value: String)
-  object LanguageCode { self =>
-    def make(value: String): Validation[Throwable, LanguageCode] =
-      if (value.isEmpty) {
-        Validation.fail(BadRequestException(UserErrorMessages.LanguageCodeMissing))
-      } else if (!V2.SupportedLanguageCodes.contains(value)) {
-        Validation.fail(BadRequestException(UserErrorMessages.LanguageCodeInvalid))
-      } else {
-        Validation.succeed(new LanguageCode(value) {})
-      }
-  }
-
   /**
    * SystemAdmin value object.
    */
   sealed abstract case class SystemAdmin private (value: Boolean)
   object SystemAdmin {
-    def make(value: Boolean): Validation[Throwable, SystemAdmin] =
+    def make(value: Boolean): Validation[ValidationException, SystemAdmin] =
       Validation.succeed(new SystemAdmin(value) {})
   }
 }

dsp-shared/src/test/scala/dsp/valueobjects/UserSpec.scala

@@ -5,10 +5,11 @@
 
 package dsp.valueobjects
 
+import dsp.errors.BadRequestException
+import dsp.errors.ValidationException
 import dsp.valueobjects.User._
 import zio.prelude.Validation
 import zio.test._
-import dsp.errors.BadRequestException
 
 /**
  * This spec is used to test the [[dsp.valueobjects.User]] value objects creation.
@@ -190,13 +191,13 @@ object UserSpec extends ZIOSpecDefault {
   private val languageCodeTest = suite("LanguageCode")(
     test("pass an empty value and return an error") {
       assertTrue(
-        LanguageCode.make("") == Validation.fail(BadRequestException(UserErrorMessages.LanguageCodeMissing))
+        LanguageCode.make("") == Validation.fail(ValidationException(UserErrorMessages.LanguageCodeMissing))
       )
     },
     test("pass an invalid value and return an error") {
       assertTrue(
         LanguageCode.make(invalidLanguageCode) == Validation.fail(
-          BadRequestException(UserErrorMessages.LanguageCodeInvalid)
+          ValidationException(UserErrorMessages.LanguageCodeInvalid)
         )
       )
     },

dsp-user/core/src/main/scala/dsp/user/domain/UserDomain.scala

@@ -5,12 +5,13 @@
 
 package dsp.user.domain
 
+import dsp.errors.ValidationException
 import dsp.valueobjects.Id.UserId
+import dsp.valueobjects.LanguageCode
 import dsp.valueobjects.User._
 import zio.prelude.Validation
 
 import java.util.UUID
-import dsp.errors.BadRequestException
 
 /**
  * Represents the user domain object.
@@ -48,7 +49,7 @@ sealed abstract case class User private (
    *  @param newValue  the new username
    *  @return the updated [[User]]
    */
-  def updateUsername(newValue: Username): Validation[BadRequestException, User] =
+  def updateUsername(newValue: Username): Validation[ValidationException, User] =
     User.make(
       self.id,
       self.givenName,
@@ -66,7 +67,7 @@ sealed abstract case class User private (
    *  @param newValue  the new email
    *  @return the updated [[User]]
    */
-  def updateEmail(newValue: Email): Validation[BadRequestException, User] =
+  def updateEmail(newValue: Email): Validation[ValidationException, User] =
     User.make(
       self.id,
       self.givenName,
@@ -84,7 +85,7 @@ sealed abstract case class User private (
    *  @param newValue  the new given name
    *  @return the updated [[User]]
    */
-  def updateGivenName(newValue: GivenName): Validation[BadRequestException, User] =
+  def updateGivenName(newValue: GivenName): Validation[ValidationException, User] =
     User.make(
       self.id,
       newValue,
@@ -102,7 +103,7 @@ sealed abstract case class User private (
    *  @param newValue  the new family name
    *  @return the updated [[User]]
    */
-  def updateFamilyName(newValue: FamilyName): Validation[BadRequestException, User] =
+  def updateFamilyName(newValue: FamilyName): Validation[ValidationException, User] =
     User.make(
       self.id,
       self.givenName,
@@ -120,7 +121,7 @@ sealed abstract case class User private (
    *  @param newValue  the new password
    *  @return the updated [[User]]
    */
-  def updatePassword(newValue: PasswordHash): Validation[BadRequestException, User] =
+  def updatePassword(newValue: PasswordHash): Validation[ValidationException, User] =
     User.make(
       self.id,
       self.givenName,
@@ -138,7 +139,7 @@ sealed abstract case class User private (
    *  @param newValue  the new language
    *  @return the updated [[User]]
    */
-  def updateLanguage(newValue: LanguageCode): Validation[BadRequestException, User] =
+  def updateLanguage(newValue: LanguageCode): Validation[ValidationException, User] =
     User.make(
       self.id,
       self.givenName,
@@ -157,7 +158,7 @@ sealed abstract case class User private (
    *  @param newValue  the new status
    *  @return the updated [[User]]
    */
-  def updateStatus(newValue: UserStatus): Validation[BadRequestException, User] =
+  def updateStatus(newValue: UserStatus): Validation[ValidationException, User] =
     User.make(
       self.id,
       self.givenName,
@@ -181,7 +182,7 @@ object User {
     language: LanguageCode,
     status: UserStatus
     //role: Role
-  ): Validation[BadRequestException, User] =
+  ): Validation[ValidationException, User] =
     Validation.succeed(new User(id, givenName, familyName, username, email, password, language, status) {})
 
 }

dsp-user/core/src/test/scala/dsp/user/domain/UserDomainSpec.scala

@@ -7,8 +7,9 @@ package dsp.user.domain
 
 import dsp.user.domain.User
 import dsp.user.domain._
-import dsp.valueobjects.User._
 import dsp.user.sharedtestdata.SharedTestData
+import dsp.valueobjects.LanguageCode
+import dsp.valueobjects.User._
 import zio.ZLayer
 import zio._
 import zio.test._

dsp-user/core/src/test/scala/dsp/user/sharedtestdata/SharedTestData.scala

@@ -5,11 +5,12 @@
 
 package dsp.user.sharedtestdata
 
-import dsp.valueobjects.User._
-import dsp.user.domain.User
 import dsp.errors.BadRequestException
-import zio.prelude.Validation
+import dsp.user.domain.User
 import dsp.valueobjects.Id
+import dsp.valueobjects.LanguageCode
+import dsp.valueobjects.User._
+import zio.prelude.Validation
 
 object SharedTestData {
   val passwordStrength = PasswordStrength.make(12)

dsp-user/handler/src/main/scala/dsp/user/handler/UserHandler.scala

@@ -8,16 +8,17 @@ package dsp.user.handler
 import dsp.errors.BadRequestException
 import dsp.errors.DuplicateValueException
 import dsp.errors.ForbiddenException
+import dsp.errors.KnoraException
 import dsp.errors.NotFoundException
 import dsp.errors.RequestRejectedException
 import dsp.user.api.UserRepo
 import dsp.user.domain.User
 import dsp.valueobjects.Id.UserId
+import dsp.valueobjects.LanguageCode
 import dsp.valueobjects.User._
 import zio._
 
 import java.util.UUID
-import dsp.errors.KnoraException
 
 /**
  * The user handler.