Generierte Dokumentation der praktischen Arbeit von Simon Tiffert

main.ausgabe.Ausgabe Klassenreferenz

Zusammengehörigkeiten von main.ausgabe.Ausgabe:

[Legende]Aufstellung aller Elemente

---

Ausführliche Beschreibung

Die Klasse formatiert den Inhalt der Matrix für die grafische Ausgabe und gibt diese auf den angegebenen Ausgabestrom aus.

Dabei wird sowohl die initiale Matrix, sowie die Matrix mit dem gesuchten Wert ausgegeben.

Version:

Revision

1.15

Autor:

Simon Tiffert

Definiert in Zeile 35 der Datei Ausgabe.java.

Öffentliche Methoden
	Ausgabe (Matrix matrix, BufferedWriter bw) throws IOException
	Konstruktor, der die Ausgabe erzeugt.
Private Methoden
void	keinWegGefundenAusgabe (BufferedWriter bw) throws IOException
	Funktion, die ausgibt, dass keine Sprungfolge gefunden wurde.
void	ausgabe (BufferedWriter bw, boolean zustand) throws IOException
	Diese Funktion gibt die Matrix grafisch auf dem angegebenen Ausgabestrom aus.
Private Attribute
Matrix	matrix
	Die zentrale Datenstruktur mit der Matrix.

---

Beschreibung der Konstruktoren und Destruktoren

main.ausgabe.Ausgabe.Ausgabe (  Matrix  matrix, BufferedWriter  bw )  throws IOException

Konstruktor, der die Ausgabe erzeugt. Übergeben werden die Matrix und der BufferedWriter der Ausgabedatei. Erzeugt wird dann einmal die Eingabe in Matrixansicht, sowie die durch Verarbeitung gewonnene Matrix mit Wegdaten. Parameter: matrix  Zentrale Datenstruktur mit Matrix bw  BufferedWriter der Ausgabedatei Ausnahmebehandlung: IOException  Ausgabedatei konnte nicht geschrieben werden Definiert in Zeile 52 der Datei Ausgabe.java. Benutzt main.ausgabe.Ausgabe.matrix. { // setze das Attribut matrix this.matrix = matrix; // Matrix im Anfangszustand ausgeben; Zustand 'false' this.ausgabe(bw, false); // wenn ein Weg gefunden wurde, dann wird die Matrix im Endzustand // ausgegeben; Zustand 'true' if (matrix.isWegGefunden()) { this.ausgabe(bw, true); } // ansonsten erfolgt die Ausgabe, dass kein Weg gefunden wurde else { this.keinWegGefundenAusgabe(bw); } }

---

Dokumentation der Elementfunktionen

void main.ausgabe.Ausgabe.ausgabe (  BufferedWriter  bw, boolean  zustand )  throws IOException [private]

Diese Funktion gibt die Matrix grafisch auf dem angegebenen Ausgabestrom aus. Dabei gibt es zwei Zustände, einmal den Anfangszustand der Matrix, der aus den Eingabedaten erzeugt wird, sowie den Endzustand, der einen gefundenen Weg ausgibt. Parameter: bw  BufferedWriter für die Ausgabedatei zustand  false: Anfangszustand, true: Endzustand Ausnahmebehandlung: IOException  Fehler beim Schreiben auf Datei Definiert in Zeile 107 der Datei Ausgabe.java. Benutzt main.ausgabe.Ausgabe.matrix. { // Hier wird die Ausgabe zusammengebaut StringBuffer ausgabeString = new StringBuffer(); // Zeilenumbruch nach Betriebssystem anpassen String lineEnd = System.getProperty("line.separator"); // Falls dies scheitert, setze Standard Zeilenumbruch if (lineEnd == null) { lineEnd = "\n"; } // Tabulator String tabulator = " "; // Matrixdimensionen lesen int y = matrix.getYDimension(); int x = matrix.getXDimension(); // Trennzeichen für formatierte Ausgabe ermitteln String trennzeichen = "+"; for( int i=0; i<x; i++ ) { trennzeichen+=" -- +"; } // Gib noch einen Header nach Zustand aus if (zustand) { ausgabeString.append( lineEnd + lineEnd + tabulator + "Ausgabedatei: " + lineEnd); ausgabeString.append(tabulator + "*************" + lineEnd); } else { ausgabeString.append( lineEnd + tabulator + "Eingabedaten: " + lineEnd); ausgabeString.append(tabulator + "*************" + lineEnd); } // Ausgabe in einer zweifach-geschachtelten for-Schleife // y-Werte durchlaufen for (int i = 0; i < y; i++) { // erste Zeile der Matrix ausgeben ausgabeString.append(lineEnd + tabulator); ausgabeString.append(trennzeichen); ausgabeString.append(lineEnd + tabulator); // x-Werte durchlaufen for (int j = 0; j < x; j++) { // Zeichen an aktueller Matrixposition lesen // und entsprechend formatieren String zeichen = " "; int wert = matrix.getWert(i, j); switch (wert) { // Gesperrte Felder case -1 : zeichen = "X"; break; // Leere Felder case 0 : zeichen = matrix.isStartpunkt(i,j) ? "1" : " "; break; // Startpunkt case 1 : zeichen = "1"; break; // Nummern der Sprungfolge default : if (zustand) zeichen = "" + wert; else zeichen = " "; } // Zeichen ausgeben ausgabeString.append( "| " + (zeichen.length() < 2 ? " " : "") + zeichen + " "); } ausgabeString.append("|"); } // letzte Formatierungszeile ausgeben ausgabeString.append(lineEnd + tabulator); ausgabeString.append(trennzeichen); ausgabeString.append(lineEnd); // ist der Debugmodus gesetzt, dann gib die Fehlermeldung // zusätzlich auf dem Bildschirm aus if (Main.debug) { System.out.println(ausgabeString); } // schreibe in die Ausgabedatei bw.write(ausgabeString.toString()); }

void main.ausgabe.Ausgabe.keinWegGefundenAusgabe (  BufferedWriter  bw  )  throws IOException [private]

Funktion, die ausgibt, dass keine Sprungfolge gefunden wurde. Parameter: bw  BufferedWriter der Ausgabedatei Ausnahmebehandlung: IOException  Fehler beim Schreiben auf Datei Definiert in Zeile 79 der Datei Ausgabe.java. { String s = " Keine Sprungfolge gefunden - Aufgabe unlösbar"; // gib im Debugmodus die Information auch auf dem Bildschirm aus if (Main.debug) { System.out.println(s); } // schreibe die Meldung in die Ausgabedatei bw.write(System.getProperty("line.separator")); bw.write(s); }

---

Dokumentation der Datenelemente

Matrix main.ausgabe.Ausgabe.matrix [private]

Die zentrale Datenstruktur mit der Matrix. Definiert in Zeile 38 der Datei Ausgabe.java. Wird benutzt von main.ausgabe.Ausgabe.ausgabe() und main.ausgabe.Ausgabe.Ausgabe().

---

Die Dokumentation für diese Klasse wurde erzeugt aufgrund der Datei:

• Ausgabe.java

Documentation created with Doxygen 1.3.6	Fri May 14 11:15:36 2004