refactoring: Rename presentation to presentation model (#2291)

* Rename presentation to presentation-model * Rename image * Rename UML diagram * Rename presentation to presentation-model * Rename package to presentationmodel * Rename module reference in pom.xml
2026-05-15 20:59:07 +00:00 · 2022-11-08 18:58:24 +00:00
parent 4388a4ac92
commit 1d5a0b07c1
16 changed files with 15 additions and 15 deletions
@@ -0,0 +1,187 @@
+/*
+ * This project is licensed under the MIT license. Module model-view-viewmodel is using ZK framework licensed under LGPL (see lgpl-3.0.txt).
+ *
+ * The MIT License
+ * Copyright © 2014-2022 Ilkka Seppälä
+ *
+ * Permission is hereby granted, free of charge, to any person obtaining a copy
+ * of this software and associated documentation files (the "Software"), to deal
+ * in the Software without restriction, including without limitation the rights
+ * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+ * copies of the Software, and to permit persons to whom the Software is
+ * furnished to do so, subject to the following conditions:
+ *
+ * The above copyright notice and this permission notice shall be included in
+ * all copies or substantial portions of the Software.
+ *
+ * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+ * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+ * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+ * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+ * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+ * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+ * THE SOFTWARE.
+ */
+package com.iluwatar.presentationmodel;
+
+import lombok.extern.slf4j.Slf4j;
+
+/**
+ * The class between view and albums, it is used to control the data.
+ */
+@Slf4j
+public class PresentationModel {
+  /**
+   * the data of all albums that will be shown.
+   */
+  private final DisplayedAlbums data;
+  /**
+   * the no of selected album.
+   */
+  private int selectedAlbumNumber;
+  /**
+   * the selected album.
+   */
+  private Album selectedAlbum;
+
+  /**
+   * Generates a set of data for testing.
+   *
+   * @return a instance of DsAlbum which store the data.
+   */
+  public static DisplayedAlbums albumDataSet() {
+    var titleList = new String[]{"HQ", "The Rough Dancer and Cyclical Night",
+                                 "The Black Light", "Symphony No.5"};
+    var artistList = new String[]{"Roy Harper", "Astor Piazzola",
+                                  "The Black Light", "CBSO"};
+    var isClassicalList = new boolean[]{false, false, false, true};
+    var composerList = new String[]{null, null, null, "Sibelius"};
+
+    var result = new DisplayedAlbums();
+    for (var i = 1; i <= titleList.length; i++) {
+      result.addAlbums(titleList[i - 1], artistList[i - 1],
+              isClassicalList[i - 1], composerList[i - 1]);
+    }
+    return result;
+  }
+
+  /**
+   * constructor method.
+   *
+   * @param dataOfAlbums the data of all the albums
+   */
+  public PresentationModel(final DisplayedAlbums dataOfAlbums) {
+    this.data = dataOfAlbums;
+    this.selectedAlbumNumber = 1;
+    this.selectedAlbum = this.data.getAlbums().get(0);
+  }
+
+  /**
+   * Changes the value of selectedAlbumNumber.
+   *
+   * @param albumNumber the number of album which is shown on the view.
+   */
+  public void setSelectedAlbumNumber(final int albumNumber) {
+    LOGGER.info("Change select number from {} to {}",
+            this.selectedAlbumNumber, albumNumber);
+    this.selectedAlbumNumber = albumNumber;
+    this.selectedAlbum = data.getAlbums().get(this.selectedAlbumNumber - 1);
+  }
+
+  /**
+   * get the title of selected album.
+   *
+   * @return the tile of selected album.
+   */
+  public String getTitle() {
+    return selectedAlbum.getTitle();
+  }
+
+  /**
+   * set the title of selected album.
+   *
+   * @param value the title which user want to user.
+   */
+  public void setTitle(final String value) {
+    LOGGER.info("Change album title from {} to {}",
+            selectedAlbum.getTitle(), value);
+    selectedAlbum.setTitle(value);
+  }
+
+  /**
+   * get the artist of selected album.
+   *
+   * @return the artist of selected album.
+   */
+  public String getArtist() {
+    return selectedAlbum.getArtist();
+  }
+
+  /**
+   * set the name of artist.
+   *
+   * @param value the name want artist to be.
+   */
+  public void setArtist(final String value) {
+    LOGGER.info("Change album artist from {} to {}",
+            selectedAlbum.getArtist(), value);
+    selectedAlbum.setArtist(value);
+  }
+
+  /**
+   * Gets a boolean value which represents whether the album is classical.
+   *
+   * @return is the album classical.
+   */
+  public boolean getIsClassical() {
+    return selectedAlbum.isClassical();
+  }
+
+  /**
+   * set the isClassical of album.
+   *
+   * @param value is the album classical.
+   */
+  public void setIsClassical(final boolean value) {
+    LOGGER.info("Change album isClassical from {} to {}",
+            selectedAlbum.isClassical(), value);
+    selectedAlbum.setClassical(value);
+  }
+
+  /**
+   * get is classical of the selected album.
+   *
+   * @return is the album classical.
+   */
+  public String getComposer() {
+    return selectedAlbum.isClassical() ? selectedAlbum.getComposer() : "";
+  }
+
+  /**
+   * Sets the name of composer when the album is classical.
+   *
+   * @param value the name of composer.
+   */
+  public void setComposer(final String value) {
+    if (selectedAlbum.isClassical()) {
+      LOGGER.info("Change album composer from {} to {}",
+              selectedAlbum.getComposer(), value);
+      selectedAlbum.setComposer(value);
+    } else {
+      LOGGER.info("Composer can not be changed");
+    }
+  }
+
+  /**
+   * Gets a list of albums.
+   *
+   * @return the names of all the albums.
+   */
+  public String[] getAlbumList() {
+    var result = new String[data.getAlbums().size()];
+    for (var i = 0; i < result.length; i++) {
+      result[i] = data.getAlbums().get(i).getTitle();
+    }
+    return result;
+  }
+}