Merge remote-tracking branch 'origin/main'

# Conflicts:
#	src/TextOutput.java

README.md

@@ -1,49 +1,66 @@
 #Texteditor
-Texteditor is a program to edit a text by in- and output into the console.
+Texteditor is a program to edit a text by using the input and is then able to output it as desired via the console. 
 #Usermanual
 #ADD a paragraph
 ```ADD```
-First please enter the command add to add a new paragraph at the end of text. Then enter the text you want to add .  
+Adds custom text to the last paragraph.<br/> <br/>
+Enter the command add to add a new paragraph at the end of text. After submitting the add command you will be prompted to enter the text to add as last paragraph.
 
 ```ADD [n]```
-If you want to add a paragraph between existing paragraphs then please use the command add and then enter the paragraphnumber it should get. 
+Adds custom text to the desired paragraph.<br/> <br/>
-After that enter the text you want to add to that paragraph.
+Enter the command add with the paragraph number where it should be added.
+After submitting the add [n] command you will be prompted to enter the text to add in the corresponding paragraph.
 
 #DUMMY Text
 ```DUMMY```
-First please enter the command dummy to enter a pre written paragraph into the text.
+Inserts a dummy text at the end of the text.<br/> <br/>
+Enter the command dummy to enter a pre-written paragraph into the text as your last paragraph.
 
 ```DUMMY [n]```
-If you want to enter a pre written dummy paragraph between existing paragraphs then please enter the command dummy and then enter the paragraphnumber it should get.
+Inserts a dummy text in the selected paragraph.<br/> <br/>
+Enter the command dummy with a paragraph number to insert a pre-written dummy text in the corresponding paragraph.
 
 #REPLACE a Text
 ```REPLACE```
-First please enter the command replace then enter the characters that you want to replace. After that please enter
+Replaces desired words in the whole text with a desired replacement.<br/> <br/>
-the new characters that should replace the old characters. If don't enter a paragraphnumber, the change will be made in the last paragraph.
+Enter the command replace, after submitting the command replace enter the characters that should be replaced. After submitting the characters you will be
+need to input the characters wich will replace the previous characters.
 
 ```REPLACE [n]```
-If you want to replace a text from a specific paragraph, please enter the command and the paragraphnumber and then enter the characters you want to
+Replaces desired words in the chosen paragraph [n] text with a desired replacement.<br/> <br/>
-replace. After you entered the characters you want to replace please enter now the new characters that should replace the
+Enter the command replace with a desired paragraph where the characters should be replaced, 
-old characters.
+after submitting the command replace enter the characters that should be replaced. After submitting the characters you will be
+need to input the characters wich will replace the previous characters.
 
 #DELETE a Text
 ```DEL```
-First please enter the command del to delete the last paragraph.
+Deletes the last paragraph.<br/> <br/>
+Enter the command del to delete the last paragraph.
 
 ```DEL [n]```
-If you want to delete a specific paragraph then please enter the command del and then the paragraph you want to delete.
+Deletes the selected paragraph.<br/> <br/>
+Enter the command del with a paragraph number, the corresponding paragraph will then be deleted.
 
-#INDEX
+#INDEX the words
 ```INDEX```
-Please enter the command index to show the index.
+Diplays the index of words used 3 times or more.<br/> <br/>
+Enter the command index to display the words that are displayed more than three times in a paragraph with their corresponding paragraphs.
 
-#PRINT the Text
+#Print the Text
 ```PRINT```
-Please enter the command print to print out the current text you have. To change the output format, use the commands ```FORMAT FIX``` and ```FORMAT RAW```
+Prints the text with the previously set format option.<br/> <br/>
+Enter the command print to print out the current text you have. The Text will be printed with the settings set before (see FORMAT the Text).
+If no settings have been set the standard to output is the RAW format.
 
 #FORMAT the Text
 ```FORMAT RAW```
-Please enter the command format raw to change the print format to raw. After you changed the format to raw, each paragraph will be printed on one line with it's paragraph number.
+Sets the format to raw.<br/> <br/>
+Enter the command format raw to change the print format to raw. After you changed the format to raw you can use the command ```PRINT``` again 
+and each paragraph will be printed on one line with its corresponding paragraph number.
 
 ```FORMAT FIX [n]```
-Please enter the command format fix and the line length which should be used. After you changed the format to fix, the defined line length will be used to print the text.
+Sets the format fix with the maximum line length.<br/> <br/>
+Enter the command format fix and the max line length which will be used. After you changed the format to fix you can use the command ```PRINT``` again 
+and the text will be displayed with the max length in mind and a new line will be created if no space is left for a paragraph.
+If the word is too long to fit the paragraph it will be displayed as whole, ignoring the max length.
+

docs/EquivalentClass.md

@@ -1,4 +1,4 @@
-#Equivalent
+# Equivalentclass
 
 ### Text.java Index method
 

docs/Pflichtenheft.md

@@ -2,7 +2,8 @@
 
 ## Aufgabe
 
-Programmieren Sie eine einfache Textverarbeitung mit Ein- und Ausgabe über die Konsole. Diese soll als eigenständige Anwendung laufen und über den folgenden Befehlssatz gesteuert werden:
+Programmieren Sie eine einfache Textverarbeitung mit Ein- und Ausgabe über die Konsole. Diese soll als eigenständige
+Anwendung laufen und über den folgenden Befehlssatz gesteuert werden:
 
 | Befehl | Beschreibung |
 | :--- | :--- |
@@ -19,19 +20,29 @@ Programmieren Sie eine einfache Textverarbeitung mit Ein- und Ausgabe über die
 ## Anforderungen
 
 - Ihre Anwendung muss eigenständig laufen, also durch Aufruf von main() und ohne BlueJ.
-- Schreiben Sie Rückmeldungen zu Fehlern (z.B. «Unbekanntes Kommando») statt auf die Standardausgabe (System.out) auf die Standardfehlerausgabe (Sytem.err). Die Syntax ist analog zu der von System.out bekannten ("System.err.println").
+- Schreiben Sie Rückmeldungen zu Fehlern (z.B. «Unbekanntes Kommando») statt auf die Standardausgabe (System.out) auf
-- Sie dürfen alle in der Vorlesung bis zur Abgabe durchgenommenen Konstrukte benutzen, jedoch nur diese. Dies schliesst insbesondere ein: Allen Stoff im BlueJ-Buch bis und mit Kapitel 9, JUnit Testing, Packages zur Verwaltung Ihres Codes. Es schliesst insbesondere aus: Vererbung, Einbindung von Paketen ausserhalb java.util.*
+  die Standardfehlerausgabe (Sytem.err). Die Syntax ist analog zu der von System.out bekannten ("System.err.println").
-- Als "Absatz" definieren wir eine über die unten beschriebene Scanner.nextline() - Methode eingelesenen String. Validieren Sie den erhaltenen Input und filtern Sie alle Sonderzeichen (d.h. der in die Anwendung übernommene Text darf nur Buchstaben, Zahlen, Leerzeichen und Satzzeichen enthalten).
+- Sie dürfen alle in der Vorlesung bis zur Abgabe durchgenommenen Konstrukte benutzen, jedoch nur diese. Dies schliesst
+  insbesondere ein: Allen Stoff im BlueJ-Buch bis und mit Kapitel 9, JUnit Testing, Packages zur Verwaltung Ihres Codes.
+  Es schliesst insbesondere aus: Vererbung, Einbindung von Paketen ausserhalb java.util.*
+- Als "Absatz" definieren wir eine über die unten beschriebene Scanner.nextline() - Methode eingelesenen String.
+  Validieren Sie den erhaltenen Input und filtern Sie alle Sonderzeichen (d.h. der in die Anwendung übernommene Text
+  darf nur Buchstaben, Zahlen, Leerzeichen und Satzzeichen enthalten).
 - Das Einlesen und Abspeichern von Dateien ist in diesem Projekt nicht notwendig.
-- Ihr Code ist in Javadoc (mindestens für Klassen und Public Methods und zusätzlich für Konstruktoren, jedoch generell ohne Getter/Setter) und wo sinnvoll in Zeilenkommentaren zur Funktionalität dokumentiert. Ihr Klassendiagramm ist auf GitHub abgelegt. Die zur Übersetzung und Start nötigen Aufrufe sind separat im README für Ihr Repo dokumentiert.
+- Ihr Code ist in Javadoc (mindestens für Klassen und Public Methods und zusätzlich für Konstruktoren, jedoch generell
-- Definieren Sie Unit Tests für die Index-Funktionalität, implementieren Sie diese in JUnit und führen Sie sie aus. Dokumentieren Sie die Tests.
+  ohne Getter/Setter) und wo sinnvoll in Zeilenkommentaren zur Funktionalität dokumentiert. Ihr Klassendiagramm ist auf
+  GitHub abgelegt. Die zur Übersetzung und Start nötigen Aufrufe sind separat im README für Ihr Repo dokumentiert.
+- Definieren Sie Unit Tests für die Index-Funktionalität, implementieren Sie diese in JUnit und führen Sie sie aus.
+  Dokumentieren Sie die Tests.
 - Wenden Sie die relevanten Abschnitte im Clean-Code-Handbuch an.
 
 ## Hinweise
 
 - Achten Sie beim Klassenentwurf auf Kohäsion und Kopplung und beachten Sie auch die Hinweise im Clean-Code-Handbuch.
-- Fehlervermeidung und JUnit wird in Programmieren 1 durchgenommen. Planen Sie genügend Zeit ein, um Ihre Tests zu definieren, umzusetzen und allfällige Fehler zu korrigieren.
+- Fehlervermeidung und JUnit wird in Programmieren 1 durchgenommen. Planen Sie genügend Zeit ein, um Ihre Tests zu
-- Für Management und Dokumentation von Arbeitsschritten empfehlen wir das Issue Tracking in GitHub. Andere Lösungen sind denkbar.
+  definieren, umzusetzen und allfällige Fehler zu korrigieren.
+- Für Management und Dokumentation von Arbeitsschritten empfehlen wir das Issue Tracking in GitHub. Andere Lösungen sind
+  denkbar.
 - Eine Quelle für Blindtext ist https://lipsum.com/. Andere Texte sind möglich.
 
 ## Vorgehen
@@ -48,7 +59,9 @@ Wir empfehlen, etwa folgendermassen vorzugehen:
 
 ## Abgabe
 
-Legen Sie für das Projekt ein Repository gemäss der bereits aus Projekt 1 bekannten Anleitung an. Der von Ihnen erarbeitete Code muss zur Abgabe bis zur bekanntgegebenen Deadline dort hochgeladen werden. Abgaben auf anderen Services (github.com, OneDrive, etc.) werden nicht gewertet.
+Legen Sie für das Projekt ein Repository gemäss der bereits aus Projekt 1 bekannten Anleitung an. Der von Ihnen
+erarbeitete Code muss zur Abgabe bis zur bekanntgegebenen Deadline dort hochgeladen werden. Abgaben auf anderen
+Services (github.com, OneDrive, etc.) werden nicht gewertet.
 
 ## Bewertung
 
@@ -56,24 +69,32 @@ Für diese Aufgabe erhalten Sie maximal 15 Punkte. In die Bewertung fliessen fol
 
 ### Allgemeine Anforderung (all-or-nothing)
 
-- Voraussetzung für Punkterteilung: Das Programm ist lauffähig. (Kriterium: Vorführung oder Test durch Ihre Dozierenden) Ein nicht lauffähiges Programm erhält 0 Punkte.
+- Voraussetzung für Punkterteilung: Das Programm ist lauffähig. (Kriterium: Vorführung oder Test durch Ihre Dozierenden)
-  Ein lauffähiges Programm wird in den folgenden beiden Bereichen beurteilt. Für Teil- oder Nichterfüllung werden Abzüge in Ansatz gebracht. Das Nichterfüllen einer Unterkategorie kann zum vollständigen Abzug in einem Bereich führen. Es werden keine Negativpunkte vergeben.
+  Ein nicht lauffähiges Programm erhält 0 Punkte. Ein lauffähiges Programm wird in den folgenden beiden Bereichen
-
+  beurteilt. Für Teil- oder Nichterfüllung werden Abzüge in Ansatz gebracht. Das Nichterfüllen einer Unterkategorie kann
+  zum vollständigen Abzug in einem Bereich führen. Es werden keine Negativpunkte vergeben.
 
 ### Bereich Entwicklung
 
 - Ihr Programm besitzt die geforderte Funktionalität. (Vorführung oder Test durch Ihre Dozierenden)
-- Sie halten die Vorgaben hinsichtlich einsetzbarer Konstrukte und Clean Code ein. (Codeanalyse durch Ihre Dozierenden, ggf. Erläuterung)
+- Sie halten die Vorgaben hinsichtlich einsetzbarer Konstrukte und Clean Code ein. (Codeanalyse durch Ihre Dozierenden,
-- Sie haben eine gute Klassenaufteilung gefunden. Das Klassendiagramm ist auf GitHub mit hochzuladen. (Analyse durch Ihre Dozierenden, ggf. Erläuterung)
+  ggf. Erläuterung)
-- Sie haben sinnvolle Test Cases für die Funktion Index definiert, diese in JUnit umgesetzt und erfolgreich ausgeführt. (Dokumentation über Test Cases und erfolgreiche Tests, diese sind auf GitHub mit hochzuladen.)
+- Sie haben eine gute Klassenaufteilung gefunden. Das Klassendiagramm ist auf GitHub mit hochzuladen. (Analyse durch
+  Ihre Dozierenden, ggf. Erläuterung)
+- Sie haben sinnvolle Test Cases für die Funktion Index definiert, diese in JUnit umgesetzt und erfolgreich
+  ausgeführt. (Dokumentation über Test Cases und erfolgreiche Tests, diese sind auf GitHub mit hochzuladen.)
 
 ### Bereich Vorgehen und Dokumentation
 
 - Ihr Code ist mit JavaDoc dokumentiert. (s.a. Hinweis unter "Anforderungen", Analyse durch Ihre Dozierenden)
-- Alle Gruppenmitglieder haben in nennenswertem Umfang Code beigetragen und auf GitHub eingecheckt. (Check durch GitHub Log)
+- Alle Gruppenmitglieder haben in nennenswertem Umfang Code beigetragen und auf GitHub eingecheckt. (Check durch GitHub
+  Log)
 
 ## Beispielcode zum Konsoleneingabe
-Die Eingabe von Text ist im BlueJ-Buch, Kapitel 6 erwähnt und in Kapitel 14.9. genauer beschrieben. Wenn Sie Probleme bei der Anwendung der Texteingabe haben, wenden Sie sich an Ihre Dozierenden. Die Anwendung der Scanner-Klasse sollte nach dem gegebenen Muster jedoch einfach gelingen.
+
+Die Eingabe von Text ist im BlueJ-Buch, Kapitel 6 erwähnt und in Kapitel 14.9. genauer beschrieben. Wenn Sie Probleme
+bei der Anwendung der Texteingabe haben, wenden Sie sich an Ihre Dozierenden. Die Anwendung der Scanner-Klasse sollte
+nach dem gegebenen Muster jedoch einfach gelingen.
 
 In der Grundfunktionalität sieht sie folgendermassen aus:
 
@@ -115,4 +136,6 @@ public class InputReaderMod {
 }
 ```
 
-**Quelle**: Anpassung von InputReader.java (englischsprachige Fassung der im Buch in Kap. 6 erwähnten Klasse EingabeLeser.java) aus dem Unterverzeichnis projects/chapter06/ tech-support-complete im Archiv https://bluej.org/objects-first/resources/projects.zip)
+**Quelle**: Anpassung von InputReader.java (englischsprachige Fassung der im Buch in Kap. 6 erwähnten Klasse
+EingabeLeser.java) aus dem Unterverzeichnis projects/chapter06/ tech-support-complete im
+Archiv https://bluej.org/objects-first/resources/projects.zip)

src/Text.java

@@ -10,11 +10,11 @@ import java.util.Map;
  */
 public class Text {
 
+    private static final String dummyText = "The standard Lorem Ipsum passage, used since the 1500s \"Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo consequat. Duis aute irure dolor in reprehenderit in voluptate velit esse cillum dolore eu fugiat nulla pariatur. Excepteur sint occaecat cupidatat non proident, sunt in culpa qui officia deserunt mollit anim id est laborum.\" Section 1.10.32 of \"de Finibus Bonorum et Malorum\", written by Cicero in 45 BC \"Sed ut perspiciatis unde omnis iste natus error sit voluptatem accusantium doloremque laudantium, totam rem aperiam, eaque ipsa quae ab illo inventore veritatis et quasi architecto beatae vitae dicta sunt explicabo. Nemo enim ipsam voluptatem quia voluptas sit aspernatur aut odit aut fugit, sed quia consequuntur magni dolores eos qui ratione voluptatem sequi nesciunt. Neque porro quisquam est, qui dolorem ipsum quia dolor sit amet, consectetur, adipisci velit, sed quia non numquam eius modi tempora incidunt ut labore et dolore magnam aliquam quaerat voluptatem. Ut enim ad minima veniam, quis nostrum exercitationem ullam corporis suscipit laboriosam, nisi ut aliquid ex ea commodi consequatur? Quis autem vel eum iure reprehenderit qui in ea voluptate velit esse quam nihil molestiae consequatur, vel illum qui dolorem eum fugiat quo voluptas nulla pariatur?";
     /**
      * The DataFields text and dummyText save the objects that are being used in this class.
      */
     private final ArrayList<String> text = new ArrayList<>();
-    private static final String dummyText = "The standard Lorem Ipsum passage, used since the 1500s \"Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo consequat. Duis aute irure dolor in reprehenderit in voluptate velit esse cillum dolore eu fugiat nulla pariatur. Excepteur sint occaecat cupidatat non proident, sunt in culpa qui officia deserunt mollit anim id est laborum.\" Section 1.10.32 of \"de Finibus Bonorum et Malorum\", written by Cicero in 45 BC \"Sed ut perspiciatis unde omnis iste natus error sit voluptatem accusantium doloremque laudantium, totam rem aperiam, eaque ipsa quae ab illo inventore veritatis et quasi architecto beatae vitae dicta sunt explicabo. Nemo enim ipsam voluptatem quia voluptas sit aspernatur aut odit aut fugit, sed quia consequuntur magni dolores eos qui ratione voluptatem sequi nesciunt. Neque porro quisquam est, qui dolorem ipsum quia dolor sit amet, consectetur, adipisci velit, sed quia non numquam eius modi tempora incidunt ut labore et dolore magnam aliquam quaerat voluptatem. Ut enim ad minima veniam, quis nostrum exercitationem ullam corporis suscipit laboriosam, nisi ut aliquid ex ea commodi consequatur? Quis autem vel eum iure reprehenderit qui in ea voluptate velit esse quam nihil molestiae consequatur, vel illum qui dolorem eum fugiat quo voluptas nulla pariatur?";
 
     /**
      * Method to check if a specific paragraph exists.
@@ -174,7 +174,6 @@ public class Text {
 
     /**
      * This method counts all words in text and adds the count together with the paragraph where the word has been used to a Hashmap.
-     *
      */
     private void createWordlist(HashMap<String, ArrayList<Integer>> wordbook) {
         int counter;

src/TextOutput.java

@@ -56,7 +56,6 @@ public class TextOutput {
                     currentLength = 0;
                 }
                 System.out.print(word);
-
                 if (!(currentWordNumber == lastWordNumber)) {
                     System.out.print(" ");
                     currentLength = currentLength + word.length() + 1;

test/TextOutputTest.java

@@ -1,7 +1,6 @@
 import org.junit.jupiter.api.BeforeEach;
 import org.junit.jupiter.api.Test;
 
-
 import java.util.ArrayList;
 
 /**

test/TextTest.java

@@ -1,6 +1,7 @@
 import org.junit.jupiter.api.Assertions;
 import org.junit.jupiter.api.BeforeEach;
 import org.junit.jupiter.api.Test;
+
 import java.util.ArrayList;
 
 /**
@@ -11,12 +12,14 @@ import java.util.ArrayList;
  */
 public class TextTest {
     Text txt;
+    ArrayList<String> stringListe;
 
     /**
      * This method is here as a preparation for the test.
      */
     @BeforeEach
     void setup() {
+        stringListe = new ArrayList<>();
         txt = new Text();
     }
 
@@ -74,31 +77,35 @@ public class TextTest {
 
     /**
      * Test methode for Index method
+     * For TestCase Positiv Testcase One, Three and Four Negativ Testcase Two
      */
     @Test
-    void indexTest() {
+    void indexTestOne() {
-        ArrayList<String> stringListe;
-
-        //Positiv Testcase One, Three and Four Negativ Testcase Two
         txt.add("Word word Test");
         txt.add("Word word etc. !!test zweite... Zeile");
         txt.add("Lorem ipsum lorem ipsum   TEST");
         stringListe = txt.index();
         Assertions.assertEquals("Word    1, 2", stringListe.get(0));
         Assertions.assertEquals("Test    1, 2, 3", stringListe.get(1));
-        //End of Test
+    }
 
-        setup();
+    /**
-
+     * Test methode for Index method
-        //Positiv Testcase Two
+     * For TestCase Positiv Testcase Two
+     */
+    @Test
+    void indexTestTwo() {
         txt.add("Word word Word Test");
         stringListe = txt.index();
         Assertions.assertEquals("Word    1", stringListe.get(0));
-        //End of Test
+    }
 
-        setup();
+    /**
-
+     * Test methode for Index method
-        //Negativ Testcase One
+     * For TestCase Negativ Testcase One
+     */
+    @Test
+    void indexTestThree() {
         stringListe = txt.index();
         Assertions.assertEquals(0, stringListe.size());
     }