TIMAAT #9 - Umsetzung einer Ansicht zur Betrachtung von zugewiesenen Inhaltsdaten von Kategorien

.github/workflows/docker-image-build.yml

@@ -1,6 +1,7 @@
 name: Build & Push Multi-Arch Docker Image
 
 on:
+  workflow_dispatch: 
   push:
     branches:
       - master
@@ -62,4 +63,4 @@ jobs:
           platforms: linux/amd64,linux/arm64
           push: true
           tags: ${{ steps.meta.outputs.tags }}
-          labels: ${{ steps.meta.outputs.labels }}
+          labels: ${{ steps.meta.outputs.labels }}

docker/timaat-entrypoint.sh

@@ -18,9 +18,7 @@ for var in "${required_vars[@]}"; do
   fi
 done
 echo "Verify database and create or upgrade schema (if necessary)"
-if [ "$(mysql -u"${DATABASE_USER}" -p"${DATABASE_PASSWORD}" -h"${DATABASE_HOST}" -P"${DATABASE_PORT}" -N -s -e \
-  "SELECT COUNT(*) FROM information_schema.tables WHERE \
-     table_schema='${DATABASE_SCHEMA_NAME}' AND table_name='db_version';")" -eq 1 ]; then
+if [ "$(mysql -u"${DATABASE_USER}" -p"${DATABASE_PASSWORD}" -h"${DATABASE_HOST}" -P"${DATABASE_PORT}" -N -s -e "SELECT COUNT(*) FROM information_schema.tables WHERE table_schema='${DATABASE_SCHEMA_NAME}' AND table_name='db_version';")" -eq 1 ]; then
 echo "Database schema already exists. Executing schema update when necessary."
   mysql -u"${DATABASE_USER}" -p"${DATABASE_PASSWORD}" -h"${DATABASE_HOST}" -P"${DATABASE_PORT}" ${DATABASE_SCHEMA_NAME} < /var/lib/timmat/sql/db_update.sql
 else

docs/database.md

@@ -43,4 +43,10 @@ The versioning of the database schema follows the following pattern:
 ### 0.15.0
 
 * Added column `thumbnail_position_ms` to table `medium_video` to persist thumbnail position of videos
-* Added column `thumbnail_position_ms` to table `annotation` to persist thumbnail position of annotations 
+* Added column `thumbnail_position_ms` to table `annotation` to persist thumbnail position of annotations 
+
+### 0.15.1
+
+* Removed unused column `category_set_id` from table `annotation_has_category`
+* Added tables `actor_has_category_set` and `actor_has_category` to link actors with categories
+* Added view `analysis_segment_structure_element` which combines information of all segment structure type tables

pom.xml

@@ -2,7 +2,7 @@
   <modelVersion>4.0.0</modelVersion>
   <groupId>TIMAATTest</groupId>
   <artifactId>TIMAATTest</artifactId>
-  <version>0.15.0-SNAPSHOT</version>
+  <version>1.0.0-SNAPSHOT</version>
   <packaging>war</packaging>
   <properties>
     <!-- <buildDirectory>c:\xampp\tomcat-1\webapps</buildDirectory> -->
@@ -24,7 +24,9 @@
         <version>3.11.0</version>
         <configuration>
           <release>11</release>
-          <!-- Remove the conflicting source/target settings -->
+          <generatedSourcesDirectory>
+            ${project.build.directory}/generated-sources/annotations
+          </generatedSourcesDirectory>
         </configuration>
       </plugin>
 
@@ -44,6 +46,7 @@
               </includes>
             </resource>
           </webResources>
+
         </configuration>
       </plugin>
 
@@ -171,6 +174,11 @@
       <artifactId>eclipselink</artifactId>
       <version>3.0.2</version>
     </dependency>
+    <dependency>
+        <groupId>org.eclipse.persistence</groupId>
+        <artifactId>org.eclipse.persistence.jpa.modelgen.processor</artifactId>
+        <version>3.0.2</version>
+    </dependency>
     <!-- https://mvnrepository.com/artifact/jakarta.xml.bind/jakarta.xml.bind-api -->
     <dependency>
       <groupId>jakarta.xml.bind</groupId>

src/main/java/de/bitgilde/TIMAAT/db/DbAccessComponent.java

@@ -6,6 +6,7 @@
 
 import java.util.logging.Level;
 import java.util.logging.Logger;
+import java.util.stream.Stream;
 
 /**
  * Components which require database connectivity can extend to this class.
@@ -43,6 +44,31 @@ protected <RESULT_TYPE> RESULT_TYPE executeDbTransaction(DbTransactionOperation<
         }
     }
 
+  /**
+   * Exceutes a {@link DbTransactionOperation} having a stream as result
+   * Always use this when working with {@link Stream}s. Otherwise the db transaction is already closed
+   * and results can't be gathered.
+   *
+   * @param dbTransactionOperation
+   * @return
+   * @param <RESULT_TYPE>
+   * @throws DbTransactionExecutionException
+   */
+    protected <RESULT_TYPE> Stream<RESULT_TYPE> executeStreamDbTransaction(DbTransactionOperation<Stream<RESULT_TYPE>> dbTransactionOperation) throws DbTransactionExecutionException {
+      logger.log(Level.FINE, "Start execution of db transaction");
+      EntityManager em = emf.createEntityManager();
+      try {
+        em.getTransaction().begin();
+        Stream<RESULT_TYPE> result = dbTransactionOperation.execute(em);
+
+        return result.onClose(em::close);
+      } catch (Exception e) {
+        logger.log(Level.SEVERE, "Error in execution of db transaction", e);
+        em.getTransaction().rollback();
+        throw new DbTransactionExecutionException(e);
+      }
+    }
+
     @FunctionalInterface
     public interface DbTransactionOperation<RESULT_TYPE> {
         /**

src/main/java/de/bitgilde/TIMAAT/di/binder/TIMAATBinder.java

@@ -9,12 +9,17 @@
 import de.bitgilde.TIMAAT.rest.security.authorization.AnnotationAuthorizationVerifier;
 import de.bitgilde.TIMAAT.rest.security.authorization.DbAnnotationAuthorizationVerifier;
 import de.bitgilde.TIMAAT.sse.EntityUpdateEventService;
-import de.bitgilde.TIMAAT.storage.entity.AnnotationStorage;
+import de.bitgilde.TIMAAT.storage.entity.actor.ActorStorage;
+import de.bitgilde.TIMAAT.storage.entity.analysislist.AnalysisListStorage;
+import de.bitgilde.TIMAAT.storage.entity.annotation.AnnotationStorage;
 import de.bitgilde.TIMAAT.storage.entity.AudioAnalysisResultStorage;
-import de.bitgilde.TIMAAT.storage.entity.MediumStorage;
+import de.bitgilde.TIMAAT.storage.entity.CategorySetStorage;
+import de.bitgilde.TIMAAT.storage.entity.CategoryStorage;
+import de.bitgilde.TIMAAT.storage.entity.medium.MediumStorage;
 import de.bitgilde.TIMAAT.storage.entity.MediumVideoStorage;
-import de.bitgilde.TIMAAT.storage.entity.MusicStorage;
+import de.bitgilde.TIMAAT.storage.entity.music.MusicStorage;
 import de.bitgilde.TIMAAT.storage.entity.TagStorage;
+import de.bitgilde.TIMAAT.storage.entity.segment.SegmentStructureElementsStorage;
 import de.bitgilde.TIMAAT.storage.file.AnnotationFileStorage;
 import de.bitgilde.TIMAAT.storage.file.AudioFileStorage;
 import de.bitgilde.TIMAAT.storage.file.ImageFileStorage;
@@ -74,9 +79,14 @@ protected void configure() {
             bindAsContract(MusicStorage.class).in(Singleton.class);
             bindAsContract(AnnotationStorage.class).in(Singleton.class);
             bindAsContract(TagStorage.class).in(Singleton.class);
+            bindAsContract(ActorStorage.class).in(Singleton.class);
             bindAsContract(MediumStorage.class).in(Singleton.class);
+            bindAsContract(AnalysisListStorage.class).in(Singleton.class);
             bindAsContract(MediumVideoStorage.class).in(Singleton.class);
             bindAsContract(AnnotationFileStorage.class).in(Singleton.class);
+            bindAsContract(CategoryStorage.class).in(Singleton.class);
+            bindAsContract(CategorySetStorage.class).in(Singleton.class);
+            bindAsContract(SegmentStructureElementsStorage.class).in(Singleton.class);
 
             bind(DbAnnotationAuthorizationVerifier.class).to(AnnotationAuthorizationVerifier.class).in(Singleton.class);
             bindAsContract(AnalysisListAuthorizationVerifier.class).in(Singleton.class);

src/main/java/de/bitgilde/TIMAAT/model/DataTableInfo.java

@@ -19,20 +19,20 @@
 /**
  * @author Mirko Scherf <mscherf@uni-mainz.de>
  */
-public class DataTableInfo {
+public class DataTableInfo<ENTITY_TYPE> {
 
 	public int draw;
 	public long recordsTotal;
 	public long recordsFiltered;
 
-	public List<?> data;
+	public List<ENTITY_TYPE> data;
 
 
 	public DataTableInfo() {
 
 	}
 
-	public DataTableInfo(int draw, long recordsTotal, long recordsFiltered, List<?> data) {
+	public DataTableInfo(int draw, long recordsTotal, long recordsFiltered, List<ENTITY_TYPE> data) {
 		this.draw = draw;
 		this.recordsTotal = recordsTotal;
 		this.recordsFiltered = recordsFiltered;

src/main/java/de/bitgilde/TIMAAT/model/FIPOP/Actor.java

@@ -1,15 +1,9 @@
 package de.bitgilde.TIMAAT.model.FIPOP;
 
-import java.io.Serializable;
-import java.sql.Timestamp;
-import java.util.List;
-import java.util.Objects;
-
 import com.fasterxml.jackson.annotation.JsonBackReference;
 import com.fasterxml.jackson.annotation.JsonIgnore;
 import com.fasterxml.jackson.annotation.JsonManagedReference;
 import com.fasterxml.jackson.annotation.JsonProperty;
-
 import jakarta.persistence.CascadeType;
 import jakarta.persistence.Column;
 import jakarta.persistence.Entity;
@@ -25,6 +19,11 @@
 import jakarta.persistence.OneToOne;
 import jakarta.persistence.Transient;
 
+import java.io.Serializable;
+import java.sql.Timestamp;
+import java.util.List;
+import java.util.Objects;
+
 /*
  Licensed under the Apache License, Version 2.0 (the "License");
    you may not use this file except in compliance with the License.
@@ -136,6 +135,30 @@ public class Actor implements Serializable {
 		)
 	private List<Role> roles;
 
+  @ManyToMany
+  @JoinTable(
+          name="actor_has_category_set"
+          , joinColumns={
+          @JoinColumn(name="actor_id")
+  }
+          , inverseJoinColumns={
+          @JoinColumn(name="category_set_id")
+  }
+  )
+  private List<CategorySet> categorySets;
+
+  @ManyToMany
+  @JoinTable(
+          name="actor_has_category"
+          , joinColumns={
+          @JoinColumn(name="actor_id")
+  }
+          , inverseJoinColumns={
+          @JoinColumn(name="category_id")
+  }
+  )
+  private List<Category> categories;
+
 	//bi-directional many-to-many association to Medium_Image
 	@ManyToMany
 	@JoinTable(
@@ -568,4 +591,19 @@ public void setTags(List<Tag> tags) {
 		this.tags = tags;
 	}
 
+  public List<Category> getCategories() {
+    return categories;
+  }
+
+  public void setCategories(List<Category> categories) {
+    this.categories = categories;
+  }
+
+  public List<CategorySet> getCategorySets() {
+    return categorySets;
+  }
+
+  public void setCategorySets(List<CategorySet> categorySets) {
+    this.categorySets = categorySets;
+  }
 }

src/main/java/de/bitgilde/TIMAAT/model/FIPOP/AnalysisAction.java

@@ -1,11 +1,8 @@
 package de.bitgilde.TIMAAT.model.FIPOP;
 
-import java.io.Serializable;
-import java.util.List;
-
 import com.fasterxml.jackson.annotation.JsonBackReference;
+import com.fasterxml.jackson.annotation.JsonIgnore;
 import com.fasterxml.jackson.annotation.JsonProperty;
-
 import jakarta.persistence.CascadeType;
 import jakarta.persistence.Column;
 import jakarta.persistence.Entity;
@@ -21,6 +18,9 @@
 import jakarta.persistence.Table;
 import jakarta.persistence.Transient;
 
+import java.io.Serializable;
+import java.util.List;
+
 /*
  Licensed under the Apache License, Version 2.0 (the "License");
    you may not use this file except in compliance with the License.
@@ -43,7 +43,7 @@
 @Entity
 @Table(name="analysis_action")
 @NamedQuery(name="AnalysisAction.findAll", query="SELECT a FROM AnalysisAction a")
-public class AnalysisAction implements Serializable {
+public class AnalysisAction implements Serializable, SegmentStructureEntity {
 	private static final long serialVersionUID = 1L;
 
 	@Id
@@ -114,19 +114,33 @@ public long getStartTime() {
 		return this.startTime;
 	}
 
-	public void setStartTime(long startTime) {
+  @JsonIgnore
+  @Override
+  public String getName() {
+    return analysisActionTranslations.get(0).getName();
+  }
+
+  public void setStartTime(long startTime) {
 		this.startTime = startTime;
 	}
 
+  @Override
 	public List<Category> getCategories() {
 		return this.categories;
 	}
-
+  @Override
 	public void setCategories(List<Category> categories) {
 		this.categories = categories;
 	}
 
-	public AnalysisScene getAnalysisScene() {
+
+  @JsonIgnore
+  @Override
+  public MediumAnalysisList getMediumAnalysisList() {
+    return getAnalysisScene().getAnalysisSegment().getMediumAnalysisList();
+  }
+
+  public AnalysisScene getAnalysisScene() {
 		return this.analysisScene;
 	}
 

src/main/java/de/bitgilde/TIMAAT/model/FIPOP/AnalysisScene.java

@@ -1,12 +1,9 @@
 package de.bitgilde.TIMAAT.model.FIPOP;
 
-import java.io.Serializable;
-import java.util.List;
-
 import com.fasterxml.jackson.annotation.JsonBackReference;
+import com.fasterxml.jackson.annotation.JsonIgnore;
 import com.fasterxml.jackson.annotation.JsonManagedReference;
 import com.fasterxml.jackson.annotation.JsonProperty;
-
 import jakarta.persistence.CascadeType;
 import jakarta.persistence.Column;
 import jakarta.persistence.Entity;
@@ -22,6 +19,9 @@
 import jakarta.persistence.Table;
 import jakarta.persistence.Transient;
 
+import java.io.Serializable;
+import java.util.List;
+
 /*
  Licensed under the Apache License, Version 2.0 (the "License");
    you may not use this file except in compliance with the License.
@@ -44,7 +44,7 @@
 @Entity
 @Table(name="analysis_scene")
 @NamedQuery(name="AnalysisScene.findAll", query="SELECT a FROM AnalysisScene a")
-public class AnalysisScene implements Serializable {
+public class AnalysisScene implements Serializable, SegmentStructureEntity {
 	private static final long serialVersionUID = 1L;
 
 	@Id
@@ -120,19 +120,33 @@ public long getStartTime() {
 		return this.startTime;
 	}
 
-	public void setStartTime(long startTime) {
+  @JsonIgnore
+  @Override
+  public String getName() {
+    return analysisSceneTranslations.get(0).getName();
+  }
+
+  public void setStartTime(long startTime) {
 		this.startTime = startTime;
 	}
 
+  @Override
 	public List<Category> getCategories() {
 		return this.categories;
 	}
 
+  @Override
 	public void setCategories(List<Category> categories) {
 		this.categories = categories;
 	}
 
-	public List<AnalysisAction> getAnalysisActions() {
+  @JsonIgnore
+  @Override
+  public MediumAnalysisList getMediumAnalysisList() {
+    return analysisSegment.getMediumAnalysisList();
+  }
+
+  public List<AnalysisAction> getAnalysisActions() {
 		return this.analysisActions;
 	}