Jukebox JavaFX Tutorial

Working with Data Models

Data models are the foundation of your application's data. They represent the information your application works with, independent of how that information is displayed or manipulated in the UI. In the Jukebox project, the model classes form a hierarchy of data that represents albums, songs, users, and genres.

The Model Classes

The Jukebox project has several model classes that work together to represent the application's data:

The Album Class

Album.java is a model class that represents a music album. Let's examine it in detail:

package jukebox.model;

import java.util.ArrayList;
import java.util.List;

public class Album {
    
    public String name = "";
    public String artist = "";
    public Genre genre = Genre.UNKNOWN;
    public List<Song> songs = new ArrayList<>();
    
    public String toString() {
        return name + " by " + artist;
    }
}

The Song Class

Song.java represents an individual song/track:

package jukebox.model;

public class Song {
    
    public String title = "";
    public int lengthSeconds = 0;
    
    public String toString() {
        return title;
    }
}

The Genre Enum

Genre.java defines a fixed set of music genres using a Java enum:

package jukebox.model;

public enum Genre {
    ROCK,
    HIP_HOP,
    COUNTRY,
    UNKNOWN
}

The User Class

User.java represents the application user:

package jukebox.model;

public class User {
    public String username = "";
}

The Database Class

Database.java is the main container that holds all application data. It also handles persistence (saving and loading):

package jukebox.model;

import com.google.gson.Gson;
import java.io.*;
import java.util.ArrayList;
import java.util.List;

public class Database {
    
    public User user = new User();
    public List<Album> albums = new ArrayList<>();
    
    // Persistence methods
    public void saveData() { ... }
    public void loadData() { ... }
}

Model Relationships

The model classes have the following relationships:

┌─────────────────┐
│     Database     │
│─────────────────│
│ + user: User    │
│ + albums: List   │
│   <Album>     │
└────────┬────────┘
         │
         ▼
┌─────────────────┐     ┌─────────────────┐
│      Album       │     │       User       │
│─────────────────│     │─────────────────│
│ + name: String   │     │ + username:      │
│ + artist: String │     │   String        │
│ + genre: Genre   │     └─────────────────┘
│ + songs: List    │
│   <Song>       │
└────────┬────────┘
         │
         ▼
┌─────────────────┐
│       Song       │
│─────────────────│
│ + title: String  │
│ + lengthSeconds:│
│   int           │
└─────────────────┘

toString() Method Importance

Notice that both Album and Song override the toString() method. This is important because:

Example: In AdminPanelController, the albums ListView uses Album.toString() by default:

// In AdminPanelController.java
public void initialize() {
    albums = FXCollections.observableArrayList(Jukebox.database.albums);
    albumsList.setItems(albums);
    // ListView will display each Album using its toString() method
}

Matching FXML:

<ListView fx:id="albumsList" prefHeight="200" prefWidth="300" />

Result: Each album appears as "Album Name by Artist Name" in the ListView.

Public Fields vs Private with Getters/Setters

The Jukebox project uses public fields for simplicity. This makes the code easier to follow for beginners. However, for production code, there are good reasons to use private fields with getters and setters:

Example with Getters/Setters:

public class Album {
    private String name;
    private String artist;
    private Genre genre;
    private List<Song> songs = new ArrayList<>();
    
    // Getters
    public String getName() { return name; }
    public String getArtist() { return artist; }
    public Genre getGenre() { return genre; }
    public List<Song> getSongs() { return songs; }
    
    // Setters
    public void setName(String name) { this.name = name; }
    public void setArtist(String artist) { this.artist = artist; }
    public void setGenre(Genre genre) { this.genre = genre; }
    public void setSongs(List<Song> songs) { this.songs = songs; }
}

Using Model Classes in Controllers

Let's look at how the model classes are used in the controllers:

1. Creating New Objects

In AdminPanelController.onAddAlbumClicked():

Album newAlbum = new Album();
newAlbum.name = "New Album";
newAlbum.artist = "Unknown Artist";
newAlbum.genre = Genre.UNKNOWN;

Jukebox.database.albums.add(newAlbum);
albums.add(newAlbum);

2. Accessing Data

In AdminPanelController.setupSelectionListeners():

albumsList.getSelectionModel().selectedItemProperty().addListener(
    (obs, oldSelection, newSelection) -> {
        if (newSelection != null) {
            // Access album fields directly
            albumNameField.setText(newSelection.name);
            albumArtistField.setText(newSelection.artist);
            genreComboBox.getSelectionModel().select(newSelection.genre);
            
            // Access album's songs list
            songs.setAll(newSelection.songs);
        }
    }
);

3. Modifying Objects

In AdminPanelController.setupSelectionListeners() - auto-update:

albumNameField.textProperty().addListener((obs, oldVal, newVal) -> {
    if (selectedAlbum != null) {
        selectedAlbum.name = newVal;  // Direct field modification
        albumsList.refresh();
    }
});

Creating Your Own Model Classes

Let's create a simple model hierarchy similar to Jukebox:

package myapp.model;

public enum Status {
    ACTIVE,
    INACTIVE,
    PENDING
}

package myapp.model;

public class Task {
    public String title = "";
    public String description = "";
    public Status status = Status.PENDING;
    
    @Override
    public String toString() {
        return title + " [" + status + "]";
    }
}

package myapp.model;

import java.util.ArrayList;
import java.util.List;

public class Project {
    public String name = "";
    public List<Task> tasks = new ArrayList<>();
    
    @Override
    public String toString() {
        return name + " (" + tasks.size() + " tasks)";
    }
}

package myapp.model;

import java.util.ArrayList;
import java.util.List;

public class AppDatabase {
    public List<Project> projects = new ArrayList<>();
    
    // Methods to add, remove, find projects
    public void addProject(Project project) {
        projects.add(project);
    }
    
    public void removeProject(Project project) {
        projects.remove(project);
    }
}

Common Pitfalls

Key Takeaways

• Model classes represent your application's data
• Keep model classes simple and independent of JavaFX
• Use composition to build complex models from simple ones
• Override toString() for better display in UI controls
• Use enums for fixed sets of values (like Genre)
• Initialize collections to avoid NullPointerException
• The Database class acts as a central data store
• Public fields are used in Jukebox for simplicity, but consider private fields with getters/setters for production

Related Cookbook Sections