Klassendiagramm für i2bpro.playlist.PlayList:

Zusammengehörigkeiten von i2bpro.playlist.PlayList:

Öffentliche Methoden
int	getRowCount ()
int	getColumnCount ()
Object	getValueAt (int rowIndex, int columnIndex)
String	getColumnName (int columnIndex)
Class	getColumnClass (int columnIndex)
boolean	isCellEditable (int rowIndex, int columnIndex)
void	setValueAt (Object aValue, int rowIndex, int columnIndex)
void	setPlayList (String file) throws PlayListException, FileNotFoundException, IOException, CannotReadException, TagException, ReadOnlyFileException, InvalidAudioFrameException
HashMap< Integer, HashMap < String, String > >	getPlayList ()
String	getMeta (int id, String key)
String	getType ()
String	getFileName ()
void	PlayListSave (String filename) throws PlayListException, IOException
void	InsertMedia (File[] selectedFiles) throws CannotReadException, IOException, TagException, ReadOnlyFileException, InvalidAudioFrameException
void	DeleteMedia (int del_id)
void	getAlbumInfo () throws CannotReadException, IOException, TagException, ReadOnlyFileException, InvalidAudioFrameException, PlayListException, NoPlayerException, InterruptedException
void	setAlbumInfos (String album) throws MalformedURLException, IOException, CannotReadException, TagException, ReadOnlyFileException, InvalidAudioFrameException, CannotWriteException, PlayListException
void	controllerUpdate (ControllerEvent ce)
void	changeSequence (int old_id, int new_id)
void	changePlayList (HashMap< Integer, HashMap< String, String >> playlist)
Öffentliche, statische Methoden
static PlayList	getInstance ()

Ausführliche Beschreibung

Projektarbeit Informatik IIb - Audioplayer
Klasse: PlayList

Die Klasse PlayList stellt die Wiedergabeliste des Audioplayers dar und ist von AbstractTableModel abgeleitet. Somit kann die Klasse auch als TableModel für die Tabelle des CenterPanels dienen, welche die Wiedergabeliste anzeigt und dem Anwender zugänglich macht.

Version:: 1.0.0

Datum:: 02.01.2010

Autor:: Jürgen Döffinger

Warnung:: Vor dem Aufruf der Methoden dieser Klasse muss mit der Methode setPlayList eine Wiedergabeliste geladen werden.

Definiert in Zeile 60 der Datei PlayList.java.

Dokumentation der Elementfunktionen

void i2bpro.playlist.PlayList.changePlayList ( HashMap< Integer, HashMap< String, String >> playlist )

Mit der MEthode changePlayList ist es möglich eine Wiedergabeliste direkt auszutauschen.

Parameter:

playlist zu tauschende Wiedergabeliste

Definiert in Zeile 758 der Datei PlayList.java.

void i2bpro.playlist.PlayList.changeSequence	(	int	old_id,
		int	new_id
	)

Mit der Methode changeSequence können zwei Audiotitel innerhalb der Wiedergabeliste getauscht werden, also die Position.

Parameter:

old_id	Identifikationsnummer des Audiotitels vor dem Wechseln
new_id	Identifikationsnummer des Audiotitels nach dem Wechseln

Definiert in Zeile 739 der Datei PlayList.java.

void i2bpro.playlist.PlayList.controllerUpdate ( ControllerEvent ce )

Die Methode controllerUpdate reagiert auf Events des Players. Wird dabei festgestellt das es sich um einen PrefetchedCompleteEvent handelt so wird notPrefetched auf true gesetzt.

Parameter:

ce	ControllerEvent

Definiert in Zeile 723 der Datei PlayList.java.

void i2bpro.playlist.PlayList.DeleteMedia ( int del_id )

Die Methode DeleteMedia entfernt einen Audiotitel aus der Wiedergabeliste.

Parameter:

id	Identifikationsnummer des zu entfernenden Audiotitels

Definiert in Zeile 489 der Datei PlayList.java.

void i2bpro.playlist.PlayList.getAlbumInfo ( ) throws CannotReadException, IOException, TagException, ReadOnlyFileException, InvalidAudioFrameException, PlayListException, NoPlayerException, InterruptedException

Mit der Methode getAlbumInfo wird versucht aus der Datenbank von freedb.org Alben zur Wiedergabeliste zu finden. Dazu ist es notwendig das die Wiedergabeliste nur aus Titeln des Albums selber besteht und diese auch in der Reihenfolge, wie sie auf dem Album vorkommen in der Wiedergabeliste gespeichert sind.

Ausnahmebehandlung:

CannotReadException
IOException
TagException
ReadOnlyFileException
InvalidAudioFrameException
PlayListException
NoPlayerException
InterruptedException

Definiert in Zeile 529 der Datei PlayList.java.

Class i2bpro.playlist.PlayList.getColumnClass ( int columnIndex )

Die Methode getColumnClass gibt den Klassenbezeichner der Klasse der mit columnIndex angegebenen Spalte zurück. Im Fall des Audioplayers wird immer String als Klasse zurückgegeben.

Parameter:

columnIndex Index der Spalte

Rückgabe:: Klassenbezeichner der Spalte

Definiert in Zeile 214 der Datei PlayList.java.

int i2bpro.playlist.PlayList.getColumnCount ( )

Die MEthode getColumnCount gibt die Anzahl Spalten zurück.

Rückgabe:: Anzahl Spalten

Definiert in Zeile 148 der Datei PlayList.java.

String i2bpro.playlist.PlayList.getColumnName ( int columnIndex )

Die Methode getColumnName gibt den Namen der mit columnIndex angegebenen Spalte zurück.

Parameter:

columnIndex Index der Spalte

Rückgabe:: Name der Spalte

Definiert in Zeile 185 der Datei PlayList.java.

String i2bpro.playlist.PlayList.getFileName ( )

Die Methode getFileName gibt den Pfad zur Wiedergabeliste zurück.

Rückgabe:: Pfad zur Wiedergabeliste

Definiert in Zeile 407 der Datei PlayList.java.

static PlayList i2bpro.playlist.PlayList.getInstance ( ) [static]

Mit der MEthode getInstance wird die einzigste Instanz der Klasse PlayList zurückgegeben.

Rückgabe:: einzigste Instanz der Klasse PlayList

Definiert in Zeile 126 der Datei PlayList.java.

String i2bpro.playlist.PlayList.getMeta	(	int	id,
		String	key
	)

Die Methode getMedia gibt Metadaten zurück. Mithilfe der Paramter id und key wird bestimmt, welches Metadatum zurückgegeben werden soll.

Parameter:

id Identifikationsnummer des Audiotracks.

key Schlüsselwort für das jeweilige Metadatum. Folgende Schlüsselwörter sind möglich:

media = Speicherort des Audiotracks
album = Albumtitel des Audiotracks
album-artist = Künstlername der das Album bestimmt
amazon-id = Identifikationsnummer für Amazon
artist = Name des Interpreten
bpm = Angabe der Geschwindigkeit des Audiotracks in Beat per Minutes
comment = Kommentare
genre_id = Identifikationsnummer des Genres nach ID3.org (http://id3.org/id3v2.4.0-frames)
genre = Bezeichnung des Genre
titel = Titel des Audiotracks

Rückgabe:: Das Metadatum als String. Ist die Information nicht verfügbar, wird ein NullString zzurückgegeben.

Definiert in Zeile 377 der Datei PlayList.java.

HashMap<Integer, HashMap<String, String> > i2bpro.playlist.PlayList.getPlayList ( )

Die Methode getPlayList gibt die komplette Wiedergabeliste (playlist) zurück.

Rückgabe:: vollständige Wiedergabeliste

Definiert in Zeile 345 der Datei PlayList.java.

int i2bpro.playlist.PlayList.getRowCount ( )

Die Methode getRowCount gibt die Anzahl der Zeilen zurück.

Rückgabe:: Anzahl Zeilen (Anzahl der Audiotitel in der Wiedergabeliste)

Definiert in Zeile 137 der Datei PlayList.java.

String i2bpro.playlist.PlayList.getType ( )

Die Methode getType gibt den Typ der Wiedergabeliste zurück.

Rückgabe:: Typ der Wiedergabeliste

m3u_1 - einfache M3U-Wiedergabeliste
m3u_2 - erweiterte M3U-Wiedergabeliste cue - cuesheet

Definiert in Zeile 397 der Datei PlayList.java.

Object i2bpro.playlist.PlayList.getValueAt	(	int	rowIndex,
		int	columnIndex
	)

Die MEthode getValueAt gibt das Object der Zelle in der Zeile rowIndex und Spalte columnIndex zurück. Dabei werden nur die Spalten mit Metadaten zum Audiotitel berücksichtigt.

Parameter:

rowIndex	Index der Zeile
columnIndex	Index der Spalte

Rückgabe:: Object der Zelle die mit rowIndex und columnIndex angegeben wird.

Definiert in Zeile 164 der Datei PlayList.java.

void i2bpro.playlist.PlayList.InsertMedia ( File[] selectedFiles ) throws CannotReadException, IOException, TagException, ReadOnlyFileException, InvalidAudioFrameException

Mit der Methode InsertMedia können Audiodateien der Wiedergabeliste hinzugefügt werden.

Parameter:

selectedFiles Liste der Audiodateien

Ausnahmebehandlung:

CannotReadException
IOException
TagException
ReadOnlyFileException
InvalidAudioFrameException

Definiert in Zeile 457 der Datei PlayList.java.

boolean i2bpro.playlist.PlayList.isCellEditable	(	int	rowIndex,
		int	columnIndex
	)

Mit der Methode isCellEditable kann erfragt werden, ob die mit rowIndex und columnIndex angegebenen Zelle editierbar ist.

Parameter:

rowIndex	Index der Zeile
columnIndex	Index der Spalte

Rückgabe:: booleascher Ausdruck über die Editierbarkeit der mit rowIndex und columnIndex angegebenen Zelle

Definiert in Zeile 233 der Datei PlayList.java.

void i2bpro.playlist.PlayList.PlayListSave ( String filename ) throws PlayListException, IOException

Mit der Methode PlayListSave wird die Wiedergabeliste gespeichert.

Parameter:

filename Pfad an der die Wiedergabeliste gespeichert werden soll.

Ausnahmebehandlung:

PlayListException
IOException

Definiert in Zeile 421 der Datei PlayList.java.

void i2bpro.playlist.PlayList.setAlbumInfos ( String album ) throws MalformedURLException, IOException, CannotReadException, TagException, ReadOnlyFileException, InvalidAudioFrameException, CannotWriteException, PlayListException

Mit der MEthode setAlbumInfos werden die Albuminformationen von der freedb.org geladen und entsprechend in der Wiedergabeliste gespeichert. Dies erfolgt nachdem mit der Methode getAlbumInfos mögliche Alben von freedb.org ermittelt wurden und der Anwender ein Album über den AlbumAuswahlDialog ausgewählt hat.

Um die Daten auszulesen, werden Sie von der Datenbank der freedb.org geladen und mit regulären Ausdrücken ausgelesen.

Parameter:

album Album welches zum auslesen der Informationen verwendet werden soll

Ausnahmebehandlung:

MalformedURLException
IOException
CannotReadException
TagException
ReadOnlyFileException
InvalidAudioFrameException
CannotWriteException
PlayListException

Definiert in Zeile 637 der Datei PlayList.java.

void i2bpro.playlist.PlayList.setPlayList ( String file ) throws PlayListException, FileNotFoundException, IOException, CannotReadException, TagException, ReadOnlyFileException, InvalidAudioFrameException

Die Methode setPlayList initialisiert die mit dem Parameter file übergebene Wiedergabeliste. Dabei gibt file den Pfad zur Wiedergabeliste an. Die Methode muss feststellen, um welchen Type von Wiedergabeliste es sich handelt und mit der entsprechenden Instanz einer von basePlayList abgeleiteten Klasse die Daten auslesen.

Parameter:

file	Pfadangabe zur Wiedergabeliste

Noch zu erledigen:: Derzeit können keine cue-Wiedergablisten ausgelesen werden. Dafür ist noch eine entsprechende Klasse zu schreiben.

Definiert in Zeile 289 der Datei PlayList.java.

void i2bpro.playlist.PlayList.setValueAt	(	Object	aValue,
		int	rowIndex,
		int	columnIndex
	)

Mit der Methode setValueAt kann der Inhalt einer mit rowIndex und columnIndex angegebenen Zelle geändert werden. Dabei wird auch der Eintrag in der Wiedergabeliste (playlist) geändert. Es können nur Zellen überschrieben werden, welche auch editierbar sind, also nur Zellen welche Metadaten des Audiotitels enthalten.

Parameter:

aValue	Object mit dem die Zelle überschrieben werden soll
rowIndex	Index der Zeile
columnIndex	Index der Spalte

Definiert in Zeile 257 der Datei PlayList.java.

Die Dokumentation für diese Klasse wurde erzeugt aufgrund der Datei:

C:/Projekte/I2BPro/src/i2bpro/playlist/PlayList.java

i2bpro.playlist.PlayList Klassenreferenz

Öffentliche Methoden

Öffentliche, statische Methoden

Ausführliche Beschreibung

Dokumentation der Elementfunktionen