ImmoTool HelloWorld-Addon

Aus OpenEstate-Wiki

Das HelloWorld-Addon ist eine Erweiterung für das ImmoTool, welche die grundlegenden Konzepte des Plugin-Frameworks veranschaulichen soll. Das Addon stellt keine Funktionen mit konkretem Nutzen zur Verfügung, sondern gibt an verschiedenen Stellen nur ein Hello World aus. Java-Entwickler können auf dieser Grundlage eigene Addons für das ImmoTool entwickeln.

Dokumentation für ImmoTool 1.0

• Diese Dokumentation bezieht sich auf ImmoTool 1.0!
• ImmoTool 1.0 wurde noch nicht final veröffentlicht und kann vorab als Beta-Version getestet werden.

Allgemeines

Um mit den Quelltexten arbeiten zu können, muss vorab eine Programmierumgebung (bestehend aus dem JDK, Apache Maven und ggf. Netbeans/Eclipse/etc.) eingerichtet werden.

Lizenzhinweis

Das HelloWorld-Addon kann unter den Bedingungen der MIT-Lizenz verwendet werden. Mit dem Download der Dateien akzeptieren Sie die Lizenzbedingungen.

Download

• Aktuelle Version herunterladen
• Versionshistorie öffnen

Verzeichnisse

Nachdem das Archiv auf dem Entwicklungsrechner entpackt wurde, finden Sie folgende Verzeichnisse vor:

• src
  Eingabeverzeichnis
  • main
    Quelltexte des Addons
    • java
      Java-Quelltexte
    • jpf
      Dateien, die in das ImmoTool-Addon übernommen werden
    • resources
      Übersetzungsdateien, Bilder, etc.
  • test
    Quelltexte zum Test des Addons
    • java
      Java-Quelltexte der JUnit-Tests
• target
  Das Ausgabeverzeichnis wird erst erzeugt, nachdem das Addon erstmals erzeugt wurde.
  • plugin
    In diesem Verzeichnis werden die erzeugten Plugins hinterlegt.
    • OpenEstate-Tool-HelloWorld
      Das erzeugte Addon als Verzeichnis zur Verwendung im ImmoTool.

Wichtige Dateien

Wichtige Dateien im Downloadpaket:

• pom.xml
  Die Datei definiert das Project Object Model (POM) des Addons. Hier sind alle relevanten Informationen hinterlegt, um das Addon mit Maven erzeugen zu können.
• assembly.xml
  In dieser Datei wird die Zusammenstellung des Projektes als ImmoTool-Addon definiert. Das Addon wird bei der Erzeugung im Verzeichnis target/plugins als ZIP-Datei & Verzeichnis hinterlegt.
• src/main/jpf/plugin.xml
  Diese XML-Datei definiert die Eigenschaften, Funktionen & Abhängigkeiten des Addons gemäß den Vorgaben des Java Plugin Frameworks. Hier werden z.B. Extensions eingebunden oder Extensions-Points definiert.
• target/OpenEstate-Tool-HelloWorld-1.0-SNAPSHOT.jar
  Das erzeugte Addon als alleinstehende JAR-Bibliothek.
• target/plugin/OpenEstate-Tool-HelloWorld.zip
  Das erzeugte Addon als ZIP-Archiv zur Verwendung im ImmoTool.

Addon erzeugen

Mit Hilfe von Apache Maven wird aus dem heruntergeladenen Quelltext ein ausführbares ImmoTool-Addon erzeugt.

• Die zur Erstellung benötigten Bibliotheken werden bei der ersten Erzeugung automatisch aus dem Internet heruntergeladen. Deshalb dauert die erste Erzeugung des Addons mehrere Minuten.
• Während der Erzeugung sollte ein neues Verzeichnis target angelegt werden. Dort werden die verschiedenen erzeugten Dateien gespeichert.
  • Die Datei OpenEstate-Tool-HelloWorld-1.0-SNAPSHOT.jar enthält den (aus dem src-Verzeichnis) erzeugten Programmcode das Addons.
  • Im Verzeichnis plugin wird das Addon zur Verwendung im ImmoTool zusammengestellt - einmal als Verzeichnis und einmal als ZIP-Archiv.

Addon mit Maven erzeugen

Addon wurde erfolgreich erzeugt

Öffnen Sie eine Eingabeaufforderung / Konsole und wechseln Sie in das Verzeichnis des Addons (in dem sich die pom.xml befindet).

z.B. unter Windows

cd C:\OpenEstate-Tool-HelloWorld

z.B. unter Linux

cd /home/user/Desktop/OpenEstate-Tool-HelloWorld

Folgender Befehl startet die Erzeugung des Addons aus dem Quelltext mit Maven:

unter Windows

mvn.bat clean install

unter Linux

mvn clean install

Wenn Maven nicht in der Pfadumgebung des Betriebssystem registriert wurde, muss eventuell der vollständige Pfad angegeben werden.

z.B. unter Windows

C:\apache-maven-3.0.3\bin\mvn.bat clean install

z.B. unter Linux

/opt/maven-3.0.3/bin/mvn clean install

Addon mit Netbeans erzeugen

Das Maven-Projekt kann direkt in der Entwicklungsumgebung Netbeans geöffnet, bearbeitet & erzeugt werden. Auf diesem Wege muss für die Erzeugung keine Eingabeaufforderung / Konsole geöffnet werden. Dabei ist zu beachten, dass ein JDK sowie Maven in Netbeans konfiguriert sein müssen.

Screenshots

Projekt in Netbeans öffnen (1)	Projekt in Netbeans öffnen (2)
Das geöffnete Projekt erzeugen	Erzeugung erfolgreich durchgeführt

Addon verwenden

• Beim Erzeugungsvorgang wird im Verzeichnis target/plugin das Addon als ZIP-Datei und Verzeichnis gespeichert.
• Kopieren Sie entweder die ZIP-Datei oder das Verzeichnis in das plugins Verzeichnis des ImmoTools.
• Beim nächsten Start des ImmoTools steht das Addon zur Verfügung.
• Sollte bereits ein Projekt verwendet werden, muss das neue Addon ggf. noch im Programm aktiviert werden (via Hauptmenü » Extras » Add-Ons).

Screenshots

Addon im Projekt aktivieren (1)	Addon im Projekt aktivieren (2)
Erweiterungen des Addons (1)	Erweiterungen des Addons (2)