JSBS_XML_Base – Basisklasse für das allgemeine Verarbeiten einer XML-Struktur

Inhaltsverzeichnis

Code 
Erklärungen und Anwendungsbeispiele 
Verwandte Dokumentation 

Code

package js_base.xml;
/*
 * de:
 * Package mit den Klassen für das Öffnen und Einlesen von Dateien.
 * en:
 * Package with the classes to open and read files. */
import java.io.*;
/*
 * de:
 * Package mit den JavaScout BasisSystem-Klassen für das Verarbeiten von GUI-Elemente.
 * en:
 * Package with the JavaScout BaseSystem-classes to process GUI-Elements. */
import js_base.frame.*;
/*
 * de:
 * Package mit den Klassen für das Bearbeiten von XML-Strukturen.
 * en:
 * Package with the classes to process XML-structures. */
import org.jdom.*;
import org.jdom.input.*;
/**
 *
 * @author kurt[at]javascout(dot)biz
 * @date 2006-05-19
 *
 * @description
 *  de:
 *  Klasse mit einem kompletten XML-Dokument (enthalten in der Variable RootElement)
 *  und einer Methode zum Einlesen der Datei, die die XML-Struktur enthält.
 *  Diese Klasse kann von anderen Klassen geerbt werden um Daten aus einer XML-Struktur zu lesen.
 *  en:
 *  Class with a complete XML-document (represented by the RootElement)
 *  and a method to read a file containing a XML-structure.
 *  This class can be inherited by other classes to read data out of a XML-structure.
 *
 * @change-log
 * when         who               why
 * --------------------------------------------------------
 * 2010-05-12   KG     Constructor with JSBS_StartFrame as Parameter
 *
 */
public class JSBS_XML_Base implements JSBS_XML_Constants {
/*
 * de: Start-Frame (CommandCenter) um Zugriff auf die Struktur mit den Parametern zu bekommen.
 * en: Start-frame (CommandCenter) to get access to the structure with the parameters. */
    public JSBS_StartFrame frmCC;
/*
 * de: RootElement als Einstieg in die XML-Struktur.
 * en: RootElement as entry-point to the XML-structure. */
    public Element XML_RootElement;
/*
 * de:
 * Status-Code um Ergebnisse (definiert in der Interface JSBS_XM_Constants)
 * an die aufrufenden Methoden weiterzugeben.
 * en:
 * Status code to signal results (see interface JSBS_XML_Constants)
 * of methods to the caller. */
    public int StatusCode = CONST_UNKNOWN_ERROR;
/*
 * -------------------------------
 * CONSTRUCTOR der Klasse / CONSTRUCTOR of the class */
    public JSBS_XML_Base(JSBS_StartFrame parmJSBS_StartFrame) {
/*
 * de: Start-Frame (CommandCenter) in die Variable dieser Klasse übernehmen.
 * en: Transfer Start-frame (CommandCenter) to the variable of this class. */
     frmCC = parmJSBS_StartFrame;
    }
/*
 * ************************************************** */
/*
 * de:
 * Methode zum Lesen einer Datei und Erstellen des XML-Dokuments im Speicher.
 * en:
 * Method to read a file and create the CML-document within the memory. */
    protected void readXMLFile(String parmFileName) {
/*
 * de:
 * Übertragen des Parameter-Werts in eine lokale Variable für spätere Verwendung.
 * en:
 * Transfer the parameter-value to a local variable for further usage. */
        String strFileName = parmFileName.trim();
        try {
/*
 * de:
 * Vorbemerkung:
 * In verschiedenen Beispielen wird folgender Code zum Öffnen einer Datei und Einlesen der
 * XML-Struktur verwendet:
 *
 * Document document = parser.build(strFileName);
 *
 * DAS FUNKTIONIERT ABER NICHT FÜR DATEIEN IM WINDOWS-STIL (mit '\' als Trenner zwischen Verzeichnissen).
 *
 * Deswegen muss der 'Umweg' über das Erstellen eines Objekts der Klasse 'File' gegangen werden.
 *
 * en:
 * Preface:
 * In some examples, the following code to open a file and read the XML-structure into the
 * Root-Element is given:
 *
 * Document documant = parser.build(strFileName);
 *
 * THIS DOES NOT WORK FOR WINDOWS-STYLE-FILES (with '\' as separator).
 *
 * Therefore the 'detour' over creating a file has to be gone. */
          File f = new File(strFileName);
/* 
 * de: SAX-Methode zum Auslesen der XML-STruktur aus der Datei benutzen.
 * en: Use the SAX-method to read the XML-structure out of the file. */
          SAXBuilder parser = new SAXBuilder();
/* 
 * de: Die Datei in ein Document (das dem Document Object Model / DOM entspricht) parsen.
 * en: Parse the file into a document according to the Document Object Model (DOM). */
          Document document = parser.build(f);
/* 
 * de: root-Element aus dem DOM-document holen.
 * en: Retrieve the root-element from the DOM-document. */
          XML_RootElement = document.getRootElement();
/* 
 * de: Datei ohne Fehler gelesen und parsed – das im Status widerspiegeln.
 * en: File read and parsed without an error - reflect this in the status. */
          StatusCode = CONST_OK;
        }
        catch (JDOMException e) {
          System.out.println("JDOMException when reading XML-file: " + strFileName);
          System.out.println(e.getMessage());
          StatusCode = CONST_NOT_WELL_FORMED;
        }
        catch (Exception e) {
          System.out.println("General Exception when reading XML-file: " + strFileName);
          System.out.println(e.getMessage());
          StatusCode = CONST_UNKNOWN_ERROR;
        }
    }
}

▲ zum Inhaltsverzeichnis

Erklärungen und Anwendungsbeispiele

xxx

▲ zum Inhaltsverzeichnis

Verwandte Dokumentation

▲ zum Inhaltsverzeichnis