GermaNet Application Programming Interface (API) in JAVA
(Hendrik Niederlich, EML-Research 2005)

Handbuch (Manual)
Stand: 2005-06-03

Das vorliegende Softwarepaket macht die XML-Repraesentation des GermaNet in der JAVA-Umgebung verfuegbar. Es wurde als ein Teil des SIR (Semantic Information Retrieval) -Projektes entwickelt.

Dieses GermaNet API wurde fuer die GermaNet-Version 2.0 (vom 2005-05-12) entwickelt. Mit vorherigen Versionen funktioniert es nicht korrekt. Fuer die aktuelle Version ist Lothar Lemnitzer an der Universitaet Tuebingen der richtige Ansprechpartner. (E-Mail: lothar@sfs.uni-tuebingen.de)


 - Inhalt -

Das Softwarepaket enthaelt folgende Dateien:
- GermaNetApplication.java (Beispielanwendung zur Illustration einiger Funktionen, die dieses Softwarepaket bietet.)

Im Verzeichnis docu:
   - gn_api_handbuch.txt (Dieses Handbuch)
   - snowball_license.html (Die BSD-Lizenz des Snowball-Stemmers)

Im Verzeichnis javadoc:
   - JAVA Documentation

Im Verzeichnis lib:
   - /gn_xml (Leeres Verzeichnis, in das die aktuelle XML-Repraesentation des GermaNet kopiert werden muss.)
   - gn_api.jar (JAVA-Archiv mit allen notwendigen Klassen)

 
 - Verwendung -
 
Um das GermaNet API verwenden zu koennen, muss das lib-Verzeichnis (vor allem das darin enthaltene Verzeichnis gn_xml) in denjenigen Ordner verschoben werden, von dem aus die eigene Anwendung gestartet werden soll. (Das heisst auch, dass Anwendungen, die das GermaNet API benutzen, immer von derjenigen Stelle aus gestartet werden muessen, von der aus man das Verzeichnis lib, mit seinem Unterverzeichnis gn_xml, in einem Schritt erreichen kann.)
Das Verzeichnis gn_xml ist zunaechst leer und muss mit der aktuellen XML-Repraesentation des GermaNets gefuellt werden.

So wird dann kompiliert:
	javac -classpath ./lib/gn_api.jar GermaNetApplication.java

Und die entstandene Klasse wird so gestartet:
	java -classpath .:./lib/gn_api.jar GermaNetApplication


 - Beschreibung -

Um die GermaNet-Daten zu nutzen, muss man zunaechst ein GermaNetObject haben. Man erhaelt ein solches, indem man sich eines GermaNetParsers bedient, den man mit einem parameterlosen Konstruktur erhalten kann.
Das GermNetObject liefert, je nach Methode, ein oder mehrere Synsets oder WordSenses, denen allerhand an Information entnommen werden kann. 
Einige Methoden erfordern die Uebergabe eines pos (part of speech) -Wertes. Die Klasse Constant bietet eine Reihe dieser Wortarten an:
 - Constant.UNDEF_POS (<=> '?')
 - Constant.NOUN (<=> 'n')
 - Constant.VERB (<=> 'v')
 - Constant.ADJECTIVE (<=> 'a')
 - Constant.ANY_POS (<=> 'x')
Alle uebrigen Konstanten dieser Klasse sind fuer dieses Softwarepaket nicht von Belang.

Ein paar Beispiele zur Verwendung dieses Softwarepakets bietet der Quellkode GermaNetApplication.java.
Mit diesem Softwarepaket ist es auch moeglich, Wortstaemme zu erzeugen und zu verwenden. Hierfuer stehen Stemmer und das StemmingGermaNetObject zur Verfuegung. Ein StemmingGermaNetObject kann aus einem herkoemmlichen GermanNetObject und einem Stemmer erzeugt werden. Zwei Stemmer kommen schon mit diesem Paket: Der IdentityStemmer (liefert das urspruengliche Wort als Wortstamm zurueck) und der SnowballStemmer (regelbasiert). Bei Bedarf koennen weitere Stemmer entwickelt werden; sie muessen lediglich die abstrakte Klasse Stemmer implementieren.
Die weitergehende Verwendung der Klassen kann der JAVA Dokumentation im Verzeichnis javadoc entnommen werden.