001: /*
002: * Copyright (c) 2002-2007 JGoodies Karsten Lentzsch. All Rights Reserved.
003: *
004: * Redistribution and use in source and binary forms, with or without
005: * modification, are permitted provided that the following conditions are met:
006: *
007: * o Redistributions of source code must retain the above copyright notice,
008: * this list of conditions and the following disclaimer.
009: *
010: * o Redistributions in binary form must reproduce the above copyright notice,
011: * this list of conditions and the following disclaimer in the documentation
012: * and/or other materials provided with the distribution.
013: *
014: * o Neither the name of JGoodies Karsten Lentzsch nor the names of
015: * its contributors may be used to endorse or promote products derived
016: * from this software without specific prior written permission.
017: *
018: * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
019: * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO,
020: * THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
021: * PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR
022: * CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
023: * EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
024: * PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS;
025: * OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY,
026: * WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE
027: * OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE,
028: * EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
029: */
030:
031: package com.jgoodies.binding.tutorial.manager;
032:
033: import java.util.List;
034:
035: import javax.swing.ListModel;
036:
037: import com.jgoodies.binding.list.ArrayListModel;
038: import com.jgoodies.binding.tutorial.Album;
039:
040: /**
041: * Holds a List of Albums and provides operations to add, delete and
042: * change a Album. Such a manager is often part of the domain layer.<p>
043: *
044: * This manager holds the Albums in an ArrayListModel, so we can
045: * operate on a List and can expose it as a ListModel.
046: * As an alternative, a higher-level presentation model, such as
047: * the AlbumManagerModel could turn the List into a ListModel.
048: * In the latter case, you would then need to fire the required
049: * ListDataEvents.<p>
050: *
051: * The AlbumManagerModel turns the List of Albums and the operations
052: * into a form that can be used in a user interface to display,
053: * select, and edit Albums.<p>
054: *
055: * TODO: Demonstrate how to sort the albums.
056: *
057: * @author Karsten Lentzsch
058: * @version $Revision: 1.9 $
059: *
060: * @see AlbumManagerModel
061: */
062:
063: public final class AlbumManager {
064:
065: /**
066: * Holds the List of Albums. Albums are added and removed from this List.
067: * The ObservableList implements ListModel, and so, we can directly
068: * use this List for the UI and can observe changes.<p>
069: *
070: * In a real world application this List may be kept
071: * in synch with a database.
072: */
073: private final ArrayListModel<Album> managedAlbums;
074:
075: // Instance Creation ******************************************************
076:
077: /**
078: * Constructs a AlbumManager for the given list of Albums.
079: *
080: * @param albums the list of Albums to manage
081: */
082: public AlbumManager(List<Album> albums) {
083: this .managedAlbums = new ArrayListModel<Album>(albums);
084: }
085:
086: // Exposing the ListModel of Albums ****************************************
087:
088: public ListModel getManagedAlbums() {
089: return managedAlbums;
090: }
091:
092: // Managing Albums *********************************************************
093:
094: /**
095: * Creates and return a new Album.
096: *
097: * @return the new Album
098: */
099: public Album createItem() {
100: return new Album();
101: }
102:
103: /**
104: * Adds the given Album to the List of managed Albums
105: * and notifies observers of the managed Albums ListModel
106: * about the change.
107: *
108: * @param albumToAdd the Album to add
109: */
110: public void addItem(Album albumToAdd) {
111: managedAlbums.add(albumToAdd);
112: }
113:
114: /**
115: * Removes the given Album from the List of managed Albums
116: * and notifies observers of the managed Albums ListModel
117: * about the change.
118: *
119: * @param albumToRemove the Album to remove
120: */
121: public void removeItem(Album albumToRemove) {
122: managedAlbums.remove(albumToRemove);
123: }
124:
125: }
|