4/1/24, 12:16 PM CS213 Spring 2024: Photos Assignment 3 Photos Worth 200 points (20% of course grade) Git/GitHub How-To For this assignment you will build a single-user photo application that allows storage and management of photos in one or more albums. All user interaction must be implemented in Java FX, and all Uls--except for standard Java FX dialogs such as Alert and TextInputDialog--must be designed in FXML. You may use multiple stages to show complex secondary windows, and switch multiple scenes within a stage. You will continue working with your partner. Read the DCS Academic Integrity Policy for Programmming Assignments - you are responsible for this. IMPORTANT: Note that you will be maintaining your code in GitHub, which is a source code repository. Learning how to manage your source code INCREMENTALLY and in COLLABORATION with your project partner is an important skill, and Github is a code repository that allows you to do this effectively. Contents 1. Features 2. Model 3. Complete Implementation 4. Submission/Code Maintenance in GitHub 5. Grading 6. FAQs Features Your application must implement the following features: Date of photo Since we won't examine the contents of a photo file to get the date the photo was taken, we will instead use the last modification date of the photo file (as provided via the Java API to the filesystem) as a proxy. (The user interface will still refer to this as the date the photo was taken.) To store and manipulate dates and times, you have two options: https://www.cs.rutgers.edu/courses/213/classes/spring_2024_venugopal/photos/photos.html 1/7 4/1/24, 12:16 PM • • CS213 Spring 2024: Photos You can use a java.util.Calendar instance. In which case, when you set a date and time on an instance, also make sure you set milliseconds to zero, as in cal.set(Calendar.MILLISECOND, 0), otherwise your equality checks won't work correctly. Alternatively, you may use the classes in the java.time package. Tags Photos can be tagged with pretty much any attribute you think is useful to search on, or group by. Examples are location where photo was taken, and names of people in a photo, so you can search for photos by location and/or names. From the implementation point of view, it may be useful to think of a tag as a combination of tag name and tag value, e.g. ("location", "New Brunswick"), or ("person","susan"). A photo may have multiple tags (name+value pairs), but no two tags for the same photo will have the same name and value combination. Additional details: • You can set up some tag types beforehand for the user to pick from (e.g. location) • • Depending on the tag type, a user can either have a single value for it, or multiple values (e.g. for any photo, location can only have one value, but if there's a person tag, that can have multiple values, one per person that appears in the photo) A user can define their own tag type and add it to the list (so from that point on, that tag type will show up in the preset list of types the user can choose from) Location of Photos - Stock photos and User photos There are two sets of photos, stock photos that come pre-loaded with the application, and user photos that are loaded/imported by a user when they run the application. • Stock photos are photos that you will keep in the application's workspace. You must have no fewer than 5 stock photos, and no more than 10. Create a special username called "stock" (no password, or password="stock") and store the stock photos under this user, in an album named "stock". Leave the photos in the application's workspace so the graders can test your application starting with your stock photos, then load other photos from their computer, see "User photos" below. Try to work with low/medium resolution pictures for the stock photos because they will be on GitHub and downloaded by the graders, and you don't want to bloat your project size. • User photos are photos that your application can allow a user to load from their computer, so they can be housed anywhere on the user's machine. The actual photos must NOT be in your application's workspace. Instead, your application should only store the location of the photo on the user's machine. User photo information must NOT be in the released project in GitHub since each installation of your application on a machine will have its own set of users. Login https://www.cs.rutgers.edu/courses/213/classes/spring_2024_venugopal/photos/photos.html 2/7 4/1/24, 12:16 PM CS213 Spring 2024: Photos When the application starts, a user logs in with username. Password implementation is optional. It makes for a "real" scenario, but is irrelevant to the essence of the project. (There is no credit for the password feature, if you choose to implement it.) Admin Subsystem • There must be a special username admin that will put the application in an administration sub- system. The admin user can then do any of the following: 。 List users 。 Create a new user 。 Delete an existing user Note: you elect to implement passwords for users, make "admin" the password for the admin user, so it's easier to grade. Otherwise we will need to ask you, or look in some README file, etc, which just turns out to be a needless hassle. Non-admin User Subsystem • Once the user logs in successfully, all albums and photo information for this user from a previous session (if any) are loaded from disk. Initially, all the albums belonging to the user should be displayed. For each album, its name, the number of photos in it, and the range of dates (earliest and latest date) on which photos were taken must be displayed. Use your discretion on how to show this additional information. • The user can then do the following: • Create albums 。 Delete albums 。 Rename albums 。 Open an album. Opening an album displays all photos, with their thumbnail images and captions, inside that album. Once an album is open the user can do the following: Add a photo ■ Remove a photo ◉ Caption/recaption a photo Display a photo in a separate display area. The photo display should also show its caption, its date-time of capture (see Date of photo below), and all its tags (see Tags below). ■ Add a tag to a photo ■ Delete a tag from a photo Copy a photo from one album to another (multiple albums may have copies of the same photo) Note: If a photo is in multiple albums, it is the same physical photo, just referenced/contained in multiple albums. This means any changes you make to the photo (caption, tags) will be reflected in all the albums in which the photo appears. ■ Move a photo from one album (source) to another (the photo will be removed from the source album) ■ Go through photos in an album in sequence forward or backward, one at a time, with user interaction (manual slideshow) https://www.cs.rutgers.edu/courses/213/classes/spring_2024_venugopal/photos/photos.html 3/7 4/1/24, 12:16 PM CS213 Spring 2024: Photos 。 Search for photos (Photos that match the search criteria should be displayed in a similar way to how photos in an album are displayed). Under this, you should provide the following specific features: 1. Search for photos by a date range. 2. Search for photos by tag type-value pairs. The following types of tag-based searches should be implemented: ■ A single tag-value pair, e.g person-sesh Conjunctive combination of two tag-value pairs, e.g. person-sesh AND location=prague Disjunctive combination of two tag-value pairs, e.g. person=sesh OR location=prague ■ For conjunctions and disjunctions, if a tag can have multiple values for a photo, it can appear on both arms of the conjunction/disjunction, e.g. person=andre OR person=maya, person=andre AND person=maya You are NOT required to do conjunctions/disjunctions on more than two tag-values pairs. In other words, you are not required to do stuff like t1=v1 and t2=v3 and t3=v3 。 There should be functionality to create an album containing the search results. As mentioned earlier (under Copy a photo from one album to another), a photo can be in multiple albums. Creating an album out of search results means copying these photos to a new album, without deleting them from the current album(s) to which they belong. Note: A single user may not have duplicate album names, but an album name may be (coincidentally) duplicated across users. Logout • The user (whether admin or non-admin) logs out at the end of the session. All updates made by the user are saved to disk. • After a user logs out, the application is still running, allowing another user to log in. Quit Application • There should be a way for the user to quit the application safely at any time, bypassing the logout step (e.g. by killing the main window). Safely means that all updates that were made in the application in the user's session are saved on disk. • Unlike logout, the application stops running. The next user that wants to use the application will need to restart it. Errors • In the application all errors and exceptions should be handled gracefully within the GUI setup. The text console should NOT be used at all: not to report any error, not to read input, not to print output. Model The model should include all data objects, plus code to store and retrieve photos for a user. The collection of classes that comprise the model should be in its own package, separate from the view and controller. https://www.cs.rutgers.edu/courses/213/classes/spring_2024_venugopal/photos/photos.html 4/7 4/1/24, 12:16 PM CS213 Spring 2024: Photos You are required to use the java.io.Serializable interface, and the java.io.ObjectOutputStream/java.io.ObjectInputStream classes to store and retrieve data. See Notes on Serialization and Versioning to know how to implement serialization and deserialization. Note that your application will need to store content for multiple users, so it would be a good idea to separate different user's contents from each other. You need to think about what objects you want to have in your design, with what attributes and operations. It is important to plan this out and come up with a good object-oriented design that clearly separates roles and functions between objects, and can be cleanly extended to add more features for future versions of the application. Implementation Code your application using the standard installation of Java, using for your GUI Java FX and FXML only (No Swing). No external vendor libraries. We will test with standard Java so if you use any external packages, your program will not run, and you will not get credit. Document every class you implement with Javadoc tags, and be sure to include authorship. Submission/Code Maintenance in GitHub Use the Git/GitHub How-To to know how create a repository in GitHub and manage it using Git. There is a comprehensive walk through of all the features you need to know to manage your code collaboratively. In particular, all Git examples are shown on the command line, which is the recommended way to use Git from your computer. This is because it is clear as to what's going on, so it is easy to recover from mistakes, if any. (Using an app/plugin with a GUI generally hides a lot of things under the hood, and if things go awry you may not have enough transparent info to work with and fix things.) Create a new repository and give your grader read access. You can give read access to your grader at any time, there is no requirement that you give access immediately. However, you must give read access by the time the assignment is due, otherwise we will assess a penalty. Since you are going to collaborate with your partner using GitHub, and we are going to get your code from GitHub, there is no requirement of any specific IDE to use since it will be of no consequence for the GitHub codebase. So on your local machine you can use any IDE you want, Eclipse/IntelliJ/VS Code/whatever. Create a Java project, name it PhotosXX, where XX is your two digit group number. Use packages as necessary. Create directories docs and data directly under the project, NOT under src or under any of the packages. • The complete Javadoc HTML documentation should be generated and placed in the docs directory. Stock photos for the stock username should be in the data directory. https://www.cs.rutgers.edu/courses/213/classes/spring_2024_venugopal/photos/photos.html 5/7