libraries
Class Vocabulary

java.lang.Object
  |
  +--libraries.Vocabulary

public class Vocabulary
extends java.lang.Object

Vocabulary repräsentiert eine komplette Lektionsdatei. Die Lektionsdatei hat mehrere Lektionen, die ihrerseits wieder mehrere Vokabeln haben.

See Also:
Lesson, Vocable

Field Summary
static java.lang.String INDENT
          Zeileneinschub beim XML-Code.
 
Constructor Summary
Vocabulary()
          ruft initialize() auf.
 
Method Summary
 void add(int index, Lesson les)
          Fügt eine Lektion an der gegebenen Position ein.
 void add(Lesson les)
          Fügt eine Lektion am Ende hinzu.
 void add(Vocabulary vocab)
          Fügt eine komplette Lektionsdatei hinzu.
 void clear()
          Löscht alle Lektionen.
 javax.swing.tree.DefaultMutableTreeNode createTreeNode()
          Erzeugt ein DefaultMutableTreeNode-Objekt und gibt dieses zurück.
 void exchange(int index1, int index2)
          Vertauscht zwei Lektionen in der Liste.
 Lesson find(Vocable voc)
          Findet eine zu einer Vokabel die Lektion, in der die Vokabel ist.
 Lesson get(int index)
          Gibt die Lektion an der gegebenen Position zurück.
 java.lang.String getAuthor()
          Gibt das Autoren-Feld zurück.
 java.lang.String getDate()
          Gibt das Datums-Feld zurück.
 java.lang.String getDescription()
          Gibt die Beschreibung zurück.
 java.lang.String getTitle()
          Gibt den Titel zurück.
 javax.swing.tree.DefaultTreeModel getTreeModel()
          Gibt ein DefaultTreeModel-Objekt zurück, das in einem JTree-Objekt benutzt werden kann.
 javax.swing.tree.DefaultMutableTreeNode getTreeNode()
          Gibt ein DefaultMutableTreeNode-Objekt, das in einem JTree-Objekt benutzt werden kann.
 int indexOf(Lesson les)
          Gibt den Index einer bestimmten Lektion zurück.
 void initialize()
          Initialisiert das Objekt.
 void loadFromFile(java.lang.String filename)
          Lädt eine Lektionsdatei aus einer Datei im XML-Format.
 void parseXML(java.lang.String s)
          Liest die Daten aus einem XML-Code aus.
 void parseXML(StringList sl)
          Liest die Daten aus einem XML-Code aus.
 Lesson remove(int index)
          Entfernt die Lektion an der gegebenen Position.
 boolean remove(Lesson les)
          Entfernt eine bestimmte Lektion.
 void saveToFile(java.lang.String filename)
          Speichert die Lektionsdatei in eine Datei im XML-Format.
 Vocabulary search(Vocable voc)
          Sucht eine besimmte Vokabel in der Lektionsdatei.
 Lesson searchLesson(java.lang.String title)
          Sucht eine Lektion mit dem angegebenen Titel und gibt diese zurück.
 Lesson set(int index, Lesson les)
          Ersetzt die Lektion an der gegebenen Position.
 void setAuthor(java.lang.String s)
          Setzt das Autoren-Feld.
 void setDate(java.lang.String s)
          Setzt das Datums-Feld.
 void setDescription(java.lang.String s)
          Setzt die Beschreibung.
 void setTitle(java.lang.String s)
          Setzt den Titel.
 int size()
          Gibt die Anzahl der Lektionen zurück.
 StringList toHTML()
          Gibt einen HTML-Code zurück (die Daten werden exportiert).
 java.lang.String toString()
          Gibt einen String (sogar mit HTML formatiert) mit dem Titel zurück.
 StringList toText()
          Gibt die Lektionsdatei im Textformat aus (exportiert die Daten).
 StringList toXML()
          Gibt des XML-Code zurück.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Field Detail

INDENT

public static final java.lang.String INDENT
Zeileneinschub beim XML-Code.
Constructor Detail

Vocabulary

public Vocabulary()
ruft initialize() auf.
See Also:
initialize()
Method Detail

initialize

public void initialize()
Initialisiert das Objekt. Stellt alle Variablen auf null bzw. "".

createTreeNode

public javax.swing.tree.DefaultMutableTreeNode createTreeNode()
Erzeugt ein DefaultMutableTreeNode-Objekt und gibt dieses zurück.
Returns:
das TreeNode-Objekt

setTitle

public void setTitle(java.lang.String s)
Setzt den Titel.
Parameters:
s - Titel

getTitle

public java.lang.String getTitle()
Gibt den Titel zurück.
Returns:
Titel

setDescription

public void setDescription(java.lang.String s)
Setzt die Beschreibung.
Parameters:
s - Beschreibung

getDescription

public java.lang.String getDescription()
Gibt die Beschreibung zurück.
Returns:
Beschreibung

setDate

public void setDate(java.lang.String s)
Setzt das Datums-Feld.
Parameters:
s - Datum-String.

getDate

public java.lang.String getDate()
Gibt das Datums-Feld zurück.
Returns:
Datum-String

setAuthor

public void setAuthor(java.lang.String s)
Setzt das Autoren-Feld.
Parameters:
s - Autor

getAuthor

public java.lang.String getAuthor()
Gibt das Autoren-Feld zurück.
Returns:
Autor

add

public void add(int index,
                Lesson les)
Fügt eine Lektion an der gegebenen Position ein.
Parameters:
index - Position
les - Lektion

add

public void add(Lesson les)
Fügt eine Lektion am Ende hinzu.
Parameters:
les - Lektion

clear

public void clear()
Löscht alle Lektionen.

get

public Lesson get(int index)
Gibt die Lektion an der gegebenen Position zurück.
Parameters:
index - Position
Returns:
Lektion

indexOf

public int indexOf(Lesson les)
Gibt den Index einer bestimmten Lektion zurück.
Parameters:
les - Lektion, die gesucht werden soll
Returns:
den index oder -1, wenn die Lektion nicht vorhanden ist

remove

public Lesson remove(int index)
Entfernt die Lektion an der gegebenen Position.
Parameters:
index - Position
Returns:
die gelöschte Lektion

remove

public boolean remove(Lesson les)
Entfernt eine bestimmte Lektion.
Parameters:
les - Lektion, die gelöscht werden soll.
Returns:
true, wenn die Lektion gefunden und gelöscht wurde.

set

public Lesson set(int index,
                  Lesson les)
Ersetzt die Lektion an der gegebenen Position.
Parameters:
index - Position
les - die neue Lektion
Returns:
die alte Lektion

size

public int size()
Gibt die Anzahl der Lektionen zurück.
Returns:
Anzahl

exchange

public void exchange(int index1,
                     int index2)
Vertauscht zwei Lektionen in der Liste.
Parameters:
index1 - die erste Lektion
index2 - die zweite Lektion

add

public void add(Vocabulary vocab)
Fügt eine komplette Lektionsdatei hinzu. Der Titel und so weiter wird nicht übernommen!
Parameters:
vocab - die Lektionsdatei

search

public Vocabulary search(Vocable voc)
Sucht eine besimmte Vokabel in der Lektionsdatei.
Parameters:
voc - Vokabel, die gesucht werden soll
Returns:
eine Lektionsdatei mit Suchergebnissen

searchLesson

public Lesson searchLesson(java.lang.String title)
Sucht eine Lektion mit dem angegebenen Titel und gibt diese zurück.
Returns:
die Lektion oder null wenn nichts gefunden wurde.

toXML

public StringList toXML()
Gibt des XML-Code zurück.
Returns:
StringList mit XML-Code.
See Also:
parseXML(String)

parseXML

public void parseXML(java.lang.String s)
Liest die Daten aus einem XML-Code aus. Die Lektionsdatei wird zuvor neu initialisiert.
Parameters:
s - String mit XML-Code.
See Also:
toXML()

parseXML

public void parseXML(StringList sl)
Liest die Daten aus einem XML-Code aus. Die Lektionsdatei wird zuvor neu initialisiert.
Parameters:
sl - StringList mit XML-Code.
See Also:
parseXML(String)

loadFromFile

public void loadFromFile(java.lang.String filename)
Lädt eine Lektionsdatei aus einer Datei im XML-Format. Die Lektionsdatei wird zuvor neu initialisiert.
Parameters:
filename - Dateiname

saveToFile

public void saveToFile(java.lang.String filename)
Speichert die Lektionsdatei in eine Datei im XML-Format.
Parameters:
filename - Dateiname

toHTML

public StringList toHTML()
Gibt einen HTML-Code zurück (die Daten werden exportiert).
Returns:
StringList mit HTML-Code.

toText

public StringList toText()
Gibt die Lektionsdatei im Textformat aus (exportiert die Daten).
Returns:
StringList mit Textdaten

toString

public java.lang.String toString()
Gibt einen String (sogar mit HTML formatiert) mit dem Titel zurück. Wichtig für JTree....
Overrides:
toString in class java.lang.Object

getTreeModel

public javax.swing.tree.DefaultTreeModel getTreeModel()
Gibt ein DefaultTreeModel-Objekt zurück, das in einem JTree-Objekt benutzt werden kann.
Returns:
ein fertiges DefaultTreeModel-Objekt
See Also:
DefaultTreeModel, javax.swing.JTree

getTreeNode

public javax.swing.tree.DefaultMutableTreeNode getTreeNode()
Gibt ein DefaultMutableTreeNode-Objekt, das in einem JTree-Objekt benutzt werden kann.
Returns:
DefaultMutableTreeNode-Objekt
See Also:
javax.swing.tree.DefaultMutableTreeObjekt, javax.swing.JTree

find

public Lesson find(Vocable voc)
Findet eine zu einer Vokabel die Lektion, in der die Vokabel ist.
Parameters:
voc - die Vokabel, die gesucht wird
Returns:
die Lektion, wenn sie gefunden wurde; null, wenn nichts gefunden wurde.