xsdexlipsexsdTransformerother projects

xsdeclipse - Eclipse Interface for xsdTransformer

Generiert Code basierend auf XML Schema

Joerg Moebius

Die Beschreibung ist einsetzbar. Sie wird laufend ergänzt. Die Übersetzung ist in Arbeit. Noch nicht übersetzte Texte werden in englischer Sprache ausgegeben.

Copyright © 2006 joerg.moebius@hamburg.de

Software und Dokumentation werden unter den Regeln der GNU LGPL LIzenz unter Ausschluss jeglicher Garantien und Gewährleistungen veröffentlicht.

2006-03-23

Revision History

Table of Contents

Zweck
Schnellstart
Ansatz
Leistungsumfang
Software besorgen, installieren, deinstallieren, reinstallieren
Benutzung
Beispiele
Logging (Protokollierung)
Was noch zu beachten ist
Rechtlicher Rahmen
Powered by

xsdeclipse

xsdeclipse ist die eclipse Benutzerschnittstelle für xsdTransformer. xsdTransformer generiert aus XML Schemata anderen Code bzw. Codebestandteile (z.B. in xhml sites eingebettete XForms forms, in JavaServer Pages eingebettete jsf forms usw.). Alle xsdeclipse downloads sind für sich allein intallierbar und ablauffähig. Für den reinen Betrieb von xsdeclipse wird xsdTransformer nicht benötigt.

Dieses Dokument bezieht sich auf xsdeclipse xsdeclipse, die eclipse Benutzerschnittstelle für xsdTransformer. Nähere Informationen zu xsdTransformer erhalten sie in der Beschreibung vom xsdTransformersee xsdTransformer xsdTransformer:

Im xsdeclipse download sind alle Dateien und Bibliotheken enthalten, die benötigt werden. Damit die generierten xhtml Dateien zur Bearbeitung geöffnet werden können, muss ein xml Editor installiert sein. xsdeclipse läuft auf eclipse 3.1.x und java 5.x.

Mit eclipseProgramRoot ist Ihr individuelles eclipse Installationsverzeichnis gemeint.

führen Sie folgende Schritte aus:

Wählen Sie einfach eine XML Schema Datei im eclipse Navigator, Package Explorer oder einem anderen geeigneten eclipse Viewer. Wählen Sie im Kontextmenu (rechte Maustaste) eine folgenden Aktionen aus:

xsdeclipse bietet zwei Befehle im Kontextmenü an:

Der erste der beiden bietet die Möglichkeit, die Programmparameter vor dem Start der Generierung zu ändern. Der zweite Befehl startet die Generierung sofort und verwendet dabei die unter preferences hinterlegten Vorgabewerte. Die beiden Menüpunkte werden nur für Dateien mit der Endung 'xsd' angeboten.

xsdeclipse ist auf möglichst schnelle und einfache Bedienung ausgelegt. Sie starten die Generierung einfach aus dem Kontextmenu einer XML Schema Datei. Sie erhalten dann als Ergebnis eine xhtml Datei, die eine XForms Form enthält. Diese Datei wird bei der ersten Befehlsvariante ('Generate xforms site...') automatisch in einen geeigneten Editor geladen.

Auch die Programmparameter müssen Sie nur einmal pflegen. Sie legen in preferences die Vorgabewerte fest, die dann anschließend für als Vorgabewerte ('Generate xforms site...') bzw. als Programmparameter ('Generate xforms site') verwendet werden.

Wie bereits oben erwähnt handelt es sich bei xsdeclipse um die eclipse Benutzerschnittstelle für xsdTransformer. Deshalb beschränkt sich diese Beschreibung auch auf diese Schnittstelle::

xsdeclipsexsdeclipse - die eclipse Benutzerschnittstelle von xsdTransformer.

Wenn Sie mehr über die Arbeitsweise, insbesondere die Transformationsregeln von xsdTransformer wissen wollen, lesen Sie bitte die Beschreibung zu xsdTransformer::

xsdTransformersee xsdTransformer

Im Folgenden bedeutet

eclipseProgramRoot Ihr individuelles eclipse Programmverzeichnis,

eclipseWorkspaceRoot Ihr individuelles Projektwurzelverzeichnis (workspace). Wenn Sie mit mehr als einem workspace arbeiten, sind die im Folgenden beschriebenen Arbeiten für jeden workspace durchzuführen.

xsdeclipse muss (neben den normalen plugin Resourcen) Zugriff auf auf Apache log4j (1.2. Subversion 9 oder eine höhere Subversion) und Apche Xerces (Version 2.7.0 oder höher) haben. The Dateien dieser Bibliotheken sind bereits im xsdeclipse download enthalten und müssen deshalb nicht separat beschafft werden. Gerne können Sie den Zugriff auf diese Bibliotheken nach Ihren Vorstellungen anderweitig konfigurieren.

xsdeclipse ist in folgender Umgebung entwickelt worden eclispe 3.1.1, java 5 auf Windows XP. Der Einsatz von Java 5 ist zwingend. xsdeclipse läuft (wahrscheinlich) auf allen 3.1.x Versionen und allen Betriebssystemplattformen auf denen eclipse einsetzbar ist..

xsdeclipse ist für alle Plattformen zu beziehen unter xsdeclipse downloads

Die dort angebotenen Downloads sind komplett und damit so wie sie sind installierbar und einsatzbereit. Wenn Sie nur xsdeclipse einsetzen wollen, benötigen Sie keinen Download von xsdtrans.

Führen Sie folgende Schritte aus

Führen Sie folgende Schritte aus

Führen Sie folgende Schritte aus

Dieser Befehl transformiert die ausgewählte Datei (Eingabedatei) in eine XHTML Datei und speichert die neue Datei in das Verzeichnis, in dem sich die Eingabedatei befindet. Die neue Datei erhält den Namen der Eingabedatei mit der Endung 'xhtml'.

menu items

Menupunkte, die für Dateien mit der Endung 'xsd' gezeigt werden.

'Generate xForms Site' ist der Sofortstart. Mit diesem Befehl starten Sie die Transformation basierend auf den Standardprogrammparametern. 'Generate xForms Site...' ist der Start, mit der Möglichkeit, die Programmparameter zu verändern. For dem eigentlichen Programmstart werden die Standardprogrammparameter abänderbar angezeigt.

xsdexclipse Wizard

1

Root Element - Das Wurzelelement ist der Einstiegspunkt für die Transformation. Alle Elemente der ersten Ebene werden hier angeboten, damit Sie ein Element als Startpunkt für die Transformation auszuwählen.

2

Language Die Sprache für die Generierung der Feldbezeichnungen, -validierungsmeldung, -tipps und -hilfetext. Die Transformationen holt bzw. generiet die Texte gemäß der hier eingestellten Sprache.

3

Min. Entries for 'minimum' AppearanceDas 'Minimum für der voll-Darstellung' bezieht sich auf die Menge der Restriktionselemente zu einem Select control. Erreicht diese Menge das hier angegebene Minimum wird die Dastellung von 'full' (enspr. in html der Radiobutton-Darstellung) auf 'minimal' (enspricht in html der List-Darstellung) Übersteigt die Menge das Anzahl the restriction entries of an xforms select1 control can be rendered either as group of radio control buttons (appearance 'full') or in case of a larger number of entries as a selection list (appearance 'minimal').

4

Generate absent xxxx Feldbezeichnungen, -validierungsmeldung, -tipps und -hilfetext können für jedes Element im XML Schema individuell formuliert gespeichert werden. Mit diesen Parametern können Sie den Generator anweisen, die Texte zu generieren, für die keine Werte im XML Schema gespeichert wurden.

5

Container in dem die Ausgabedatei gespeichert werden soll.

6

Filename Der Name der Ausgabedatei.

xsdeclipse kommt mit drei wichtigen Steuerungsdateien:

Sie können diese Dateien in dem Installationsverzeichnis (Zielverzeichnis für die Dekomprimierung) finden. Wenn das Plugin nach der Installation das allererste Mail benutzt wirde, werden diese drei Dateien in die state location des Plugins im dem workspace kopiert, das Sie gerade nutzen (eclipseWorkspaceRoot/.plugin/net.sourceforge/xsdeclipse).

Normalerweise müssen die Dateien xsdTrans.xml und xsd2xf.xml nicht geändert werden. Aber in der Datei log4j.xml können (und sollten) Sie Ihr individuelles Verzeichnis für Protokolldateien hinterlegen.

Wichtig

Wenn Sie eine dieser drei Dateien ändern müssen (oder wollen), arbeiten Sie bitte mit dem Exemplar in der state location, weil ansonsten Ihre Änderungen keinen Effekt auf das Verhalten des Plugins hat.

xsdeclipse preferences

Auf der xsdeclipse 'preferences' Seite werden die Standardprogrammparameter gepflegt.

Die Werte der Standardprogrammparameter werden beim Sofortstart als Programmparameter genutzt und beim Start mit Änderung der Programmparameter als Vorgabewerte herangezogen.

todo

xsdeclipse setzt log4j für das Logging . Nach der Installation ist log4j so eingestellt, dass es drei Log-Dateien anlegt:

Tabelle 1. Log-Dateien und ihr Inhalt

Log-DateiInhalt
xsdeclipse.logenthält gewöhnliche Informationsmeldungen, Warnungen und Fehlermeldungen.
xsdeclipse.errorenthält ausschließlich Fehlermeldungen.
xsdeclipse.debugenthält alle Programmmeldungen und zusätzlich noch Debugmeldungen.

Wichtig

At installation state the location parameter of these log files consists of only the file name. This results in a location at the root of eclipse installation. Nach der Installation die Speicherortparameter enthalten nur den Dateinamen. Das führt dazu, dass die Log-Dateien in dem eclipse Programmverzeichnis abgelegt werden.

Sie sollten die Speicherorte nach Ihrem Bedarf einstellen: 

  <appender name="debugFile" class="org.apache.log4j.FileAppender">
    <param name="File" value="xsdeclipse.debug"  />1
    <param name="Append" value="false" />
    <layout class="org.apache.log4j.PatternLayout"> 
      <param name="ConversionPattern" value="%d{hh:mm:ss} %p %C.%M(%L): %m%n"/>
    </layout> 
  </appender>
  <appender name="logFile" class="org.apache.log4j.FileAppender">
    <param name="Threshold" value="info" />
    <param name="File" value="xsdeclipse.log" />2 
    <param name="Append" value="true" />
    <layout class="org.apache.log4j.PatternLayout"> 
      <param name="ConversionPattern" value="%d{hh:mm:ss} %p: %m%n"/>
    </layout> 
  </appender>
  <appender name="errorFile" class="org.apache.log4j.FileAppender">
    <param name="Threshold" value="error" />
    <param name="File" value="xsdeclipse.error" />3
    <param name="Append" value="true" />
    <layout class="org.apache.log4j.PatternLayout"> 
      <param name="ConversionPattern" value="%d{hh:mm:ss} %p %C.%M(%L): %m%n"/>
    </layout>
  </appender>

Logfiles

231

Datei Lokationen sollten an Ihre Anforderungen angepasst werden.

1

xsdeclipse.debug enthält alle Programmmeldungen und zusätzlich noch Debugmeldungen.

2

xsdeclipse.log enthält gewöhnliche Informationsmeldungen, Warnungen und Fehlermeldungen.

3

xsdeclipse.error enthält ausschließlich Fehlermeldungen.

todo

Software und Dokumentation werden unter den Regeln der GNU LGPL LIzenz veröffentlicht. Jegliche Gewährlesitung wird ausdrücklich ausgeschlossen.

Copyright © 2006 joerg.moebius@hamburg.de

sourceforge logo

sourceforge logo

sourceforge logo