Tutorial: Entwicklung eines TvDataService: Unterschied zwischen den Versionen

Aus TV-Browser Wiki
Wechseln zu: Navigation⧼comma-separator⧽Suche
Bananeweizen⧼word-separator⧽⧼parentheses⧽
Bodo⧼word-separator⧽⧼parentheses⧽
⧼parentheses⧽
Zeile 1: Zeile 1:
 +
= Allgemeines =
 +
 
Die TV-Daten werden in TV-Browser über spezielle Plugins - wir nennen sie DataServices - geladen. Auf diese Weise läßt sich TV-Browser beliebig um weitere Sender erweitern (vorausgesetzt, jemand verfügt über die TV-Daten und schreibt ein DataService dazu).
 
Die TV-Daten werden in TV-Browser über spezielle Plugins - wir nennen sie DataServices - geladen. Auf diese Weise läßt sich TV-Browser beliebig um weitere Sender erweitern (vorausgesetzt, jemand verfügt über die TV-Daten und schreibt ein DataService dazu).
  
 
Dieses Tutorial beschreibt die Entwicklung eines DataServices in den Grundzügen. Als weitere Hilfen empfehle ich das [http://tvbrowser.org/downloads/starterkit/index_de.html ''TvDataStarterKit''], einen Blick in die [[Für Entwickler|JavaDoc-Dokumentation]] von TV-Browser bzw. den Quellcode der existierenden DataServices.
 
Dieses Tutorial beschreibt die Entwicklung eines DataServices in den Grundzügen. Als weitere Hilfen empfehle ich das [http://tvbrowser.org/downloads/starterkit/index_de.html ''TvDataStarterKit''], einen Blick in die [[Für Entwickler|JavaDoc-Dokumentation]] von TV-Browser bzw. den Quellcode der existierenden DataServices.
  
 +
= Entwicklungsumgebung einrichten =
  
== Entwicklungsumgebung einrichten ==
+
Siehe [[TV-Browser_Build-Anleitung]].
  
Erweitere den Java-Klassenpfad um die Jar-Datei <code>tvbrowser.jar</code> (zu finden im Verzeichnis der TV-Browser-Installation).
+
= Implementieren =
 
 
 
 
== Implementieren ==
 
  
 
Entwickle eine Klasse, die das Interface <code>tvdataservice.TvDataService</code> implementiert.
 
Entwickle eine Klasse, die das Interface <code>tvdataservice.TvDataService</code> implementiert.
  
 
Anmerkungen:
 
Anmerkungen:
* Um TvDataServices vor der TV-Browser-Version 0.9.7 weiterhin verwenden zu können, müssen diese die von der abstrakten Klasse AbstractOldTvDataServiceBridge erben (bzw. das neue Interface implementieren).
 
 
* Statt das Interface TvDataService direkt zu implementieren, kann auch die Klasse <code>util.tvdataservice.AbstractTvDataService</code> verwendet werden.
 
* Statt das Interface TvDataService direkt zu implementieren, kann auch die Klasse <code>util.tvdataservice.AbstractTvDataService</code> verwendet werden.
 
* Sämtliche Methoden dieser Klasse werden von der Host-Applikation (also dem TV-Browser) aufgerufen und sind somit die Einstiegspunkte des Plugins.
 
* Sämtliche Methoden dieser Klasse werden von der Host-Applikation (also dem TV-Browser) aufgerufen und sind somit die Einstiegspunkte des Plugins.
* Die Klasse muß in einem Package liegen, das den selben Namen wie die Klasse selbst hat, allerdings in Kleinbuchstaben.
+
* Die Klasse muss in einem Package liegen, das den selben Namen wie die Klasse selbst hat, allerdings in Kleinbuchstaben. Beispiel : ''mytvdataservice.MyTVDataService''
  
 
+
=Jar-Datei erstellen=
==Jar-Datei erstellen==
 
  
 
Als nächstes müssen wir das DataService in eine einzige Datei zusammenpacken, damit man es leicht installieren und anderen Leuten anbieten kann.
 
Als nächstes müssen wir das DataService in eine einzige Datei zusammenpacken, damit man es leicht installieren und anderen Leuten anbieten kann.
Zeile 30: Zeile 28:
 
</pre>
 
</pre>
  
'''Wichtig:''' Der Dateiname der Jar-Datei muß dabei mit dem Namen der oben erstellten Klasse identisch sein (Auch Groß-/Kleinschreibung beachten!).
+
'''Wichtig:''' Der Dateiname der Jar-Datei muss dabei mit dem Namen der oben erstellten Klasse identisch sein (Auch Groß-/Kleinschreibung beachten!).
 
 
  
==Installation==
+
=Installation=
  
Kopiere die eben erstellte Jar-Datei in das Verzeichnis ''dataservice'' deiner TV-Browser-Installation. Jetzt musst du nur noch TV-Browser neu starten und schon kannst du dein DataService benutzen, indem du im Menü ''TV-Daten'' auf ''Aktualisieren'' klickst.
+
Kopiere die eben erstellte Jar-Datei in das Verzeichnis ''plugins'' deiner TV-Browser-Installation. Jetzt musst du nur noch TV-Browser neu starten und schon kannst du dein DataService benutzen, indem du in der Senderkonfiguration die Senderliste aktualisierst.
  
 
[[Kategorie:Entwicklung]]
 
[[Kategorie:Entwicklung]]

Version vom 31. Dezember 2007, 13:10 Uhr

Allgemeines

Die TV-Daten werden in TV-Browser über spezielle Plugins - wir nennen sie DataServices - geladen. Auf diese Weise läßt sich TV-Browser beliebig um weitere Sender erweitern (vorausgesetzt, jemand verfügt über die TV-Daten und schreibt ein DataService dazu).

Dieses Tutorial beschreibt die Entwicklung eines DataServices in den Grundzügen. Als weitere Hilfen empfehle ich das TvDataStarterKit, einen Blick in die JavaDoc-Dokumentation von TV-Browser bzw. den Quellcode der existierenden DataServices.

Entwicklungsumgebung einrichten

Siehe TV-Browser_Build-Anleitung.

Implementieren

Entwickle eine Klasse, die das Interface tvdataservice.TvDataService implementiert.

Anmerkungen:

  • Statt das Interface TvDataService direkt zu implementieren, kann auch die Klasse util.tvdataservice.AbstractTvDataService verwendet werden.
  • Sämtliche Methoden dieser Klasse werden von der Host-Applikation (also dem TV-Browser) aufgerufen und sind somit die Einstiegspunkte des Plugins.
  • Die Klasse muss in einem Package liegen, das den selben Namen wie die Klasse selbst hat, allerdings in Kleinbuchstaben. Beispiel : mytvdataservice.MyTVDataService

Jar-Datei erstellen

Als nächstes müssen wir das DataService in eine einzige Datei zusammenpacken, damit man es leicht installieren und anderen Leuten anbieten kann.

Mit folgendem Befehl wird nun die Jar-Datei erstellt:

jar cvf MyTVDataService.jar mytvdataservice

Wichtig: Der Dateiname der Jar-Datei muss dabei mit dem Namen der oben erstellten Klasse identisch sein (Auch Groß-/Kleinschreibung beachten!).

Installation

Kopiere die eben erstellte Jar-Datei in das Verzeichnis plugins deiner TV-Browser-Installation. Jetzt musst du nur noch TV-Browser neu starten und schon kannst du dein DataService benutzen, indem du in der Senderkonfiguration die Senderliste aktualisierst.