Updated documentation

This commit is contained in:
Artorias 2025-03-23 20:42:41 +01:00
parent c6523bf96e
commit 3f69161ebf
4 changed files with 13 additions and 0 deletions

View file

@ -67,6 +67,7 @@ public class Token {
* Die Token-Dokumente (Speech --> analysisResults --> token) aus der MongoDB lesen
* @param tokenDocs Eine Liste von Mongo-Dokumenten
* @return Eine Liste der Token
* Implementiert von Leon
*/
public static List<Token> readTokensFromMongo(List<Document> tokenDocs) {
List<Token> tokens = new ArrayList<>();
@ -83,6 +84,7 @@ public class Token {
* Zählt alle verschiedenen POS Vorkommen auf
* @param tokenList
* @return Jede POS art mit ihrer Anzahl an Vorkommen
* Implementiert von Leon
*/
public static Map<String, Integer> countPOS(List<Token> tokenList) {
Map<String, Integer> posCounts = new HashMap<>();

View file

@ -26,6 +26,8 @@ import static org.texttechnologylab.project.gruppe_05_1.Main.JCAS_SPEECHES_TYPES
/**
* Extrahiert NLPAnalyseergebnisse aus komprimierten XMIDateien und lädt sie batchweise in MongoDB hoch.
* Liest .xmi.gz Dateien aus einem ZIPArchiv, erstellt für jede Rede ein "analysisResults" Dokument und führt BulkWrites durch.
* Implementiert von Leon
* Modifiziert von Henry
*/
public class XmiExtractor {
@ -42,6 +44,8 @@ public class XmiExtractor {
* Liest alle .xmi.gz Dateien aus dem ZIPArchiv "speeches/20.zip", extrahiert deren NLPDaten
* und lädt sie in Form von BATCH_SIZE Dokumenten in MongoDB hoch.
* @throws IOException falls die ZIPDatei nicht gefunden oder ein Lese-/Schreibfehler auftritt
* Implementiert von Leon
* Modifiziert von Henry
*/
public void extractAndUploadXmiData() throws IOException {
InputStream resourceStream = getClass().getClassLoader().getResourceAsStream("speeches/20.zip");
@ -96,6 +100,8 @@ public class XmiExtractor {
* Liest ein komprimiertes XMI ein und erstellt BulkUpdateOperationen für MongoDB.
* @param inputStream komprimierter XMIInputStream
* @param filename Name der Datei im ZIPArchiv (für speechKey)
* Implementiert von Leon
* Modifiziert von Henry
*/
private void processXmiGzStream(InputStream inputStream, String filename) {
JCas jCas = null;
@ -197,6 +203,7 @@ public class XmiExtractor {
* Extrahiert aus dem Dateinamen (z.B. "20/ABC123.xmi.gz") den speechKey.
* @param filename Name der Datei innerhalb des ZIPArchivs
* @return speechKey oder null, wenn das Format nicht erkannt wird
* Implementiert von Leon
*/
private static String extractSpeechKeyFromFilename(String filename) {
String baseName = filename.replace(".xmi.gz", "");
@ -205,6 +212,7 @@ public class XmiExtractor {
/**
* Führt alle gesammelten BulkWrite-Operationen in MongoDB aus und leert den Batch.
* Implementiert von Henry
*/
private synchronized void flushBatch() {
if (!bulkOperations.isEmpty()) {

View file

@ -71,6 +71,7 @@ public class FrontEndController {
* Aggregiert für alle Reden die NLPErgebnisse (Topics, POS, Named Entities, erste SentimentObjekte)
* und liefert die zusammengefassten Daten an die ChartsAnsicht.
* @param ctx Javalin Context zum Rendern der Seite mit den aggregierten ChartDaten
* Implementiert von Leon
*/
public static void getCharts(Context ctx) {
MongoCollection<Document> col = MongoPprUtils.getSpeechCollection();

View file

@ -55,6 +55,8 @@ public class SpeechController {
/**
* Zeige eine bestimmte Rede des Parlamentariers an
* @param ctx Javalin Context
* Implementiert von Valentin
* Modifiziert von Leon
*/
@OpenApi(
summary = "Zeige eine bestimmte Rede des Parlamentariers an",