Address book. Presenting the Java assignment about an Address Book v

Transcription

1 Address book Presenting the Java assignment about an Address Book v

2 Description Make an address book Text interface (command line) Stores contacts between runs

3 Topics and skills covered error handling (exceptions) - exceptions are thrown and we have a global exception handler in the main method inheritance - Contact extends Object and overrides equals, hashcode and tostring access modifiers - generally keeping instance variables private and only some of the instance methods public implementing an interface anonymous inner class for MenuActions instance variables and methods - saving constructor parameters in instance variables, calling instance methods static variables and methods (including constants) textutils class offers a static method constructors - completing the constructor of the Contact class, writing a constructor in the SimpleApplication class from specification test cases are provided with the source code the students get packages/imports - There are a few packages in the application, which means both package declarations and import statements - also, understanding how to compile the application and running it requires understanding of class path and packages implementing a class from a design - both completing existing code and (optionally) writing the SimpleApplication class from scratch collections (using) - The SimpleAddressBook maintains an internal List<Contact> generics (using) - The SimpleMutableList interface is generic and the SimpleAddressBook uses <Contact> as type parameter

4 You don t have to write everything from scratch! We provide you with: Source code to build upon (almost complete classes) Test scripts which shows you your progress Example code for the TextUtils and the Menu system JavaDoc and UML - describes the classes A lot of specifications - you need to read the assignment text carfully!

5 Source code layout. -- bin -- doc (javadoc here!) `-- src `-- org `-- addressbook -- main -- SimpleApplication.java `-- SimpleMain.java -- storage -- Contact.java -- SimpleAddressBook.java `-- SimpleMutableList.java -- tests -- TestContact.java `-- TestSimpleAddressBook.java -- textutils -- TextUtilsExample.java `-- TextUtils.java `-- ui `-- cli `-- menu -- MenuAction.java -- MenuExample.java `-- Menu.java

6 Some useful scripts are provided./build.sh compiles all Java files./run.sh runs the main class./run_test_contact.sh tests the Contact class./run_test_simple_address_book.sh tests the address book class./clean.sh deletes.class files We encourage you to try to compile and run manually too, in order to understand and/or learn about paths and packages.

7 There are example codes provided - use them Read the source code Run the example programs The Menu system has an example program The TextUtils class has an example program src/org/addressbook/ui/cli/menu/menuexample.java src/org/addressbook/textutils/textutilsexample.java

8 Running the Menu example

9 Running the TextUtilsExample (User answered Blue and Whale on the questions)

10 Tasks in the assignment (challenge - only do this when you are done with the above, and have sent in your solution)

11 Functional requirements for passing Functional requirements: List menu item should work Add menu item should work (and the new contact should be saved) The SimpleAddressBook class has a load() and a save() method already implemented, using a file in the user s home directory. Needless to say, all submitted code should compile. Finally, the code should pass the tests provided with the source code./run_test_contact.sh./run_test_simple_address_book.sh For a pass grade, all functional requirements must be satisfied.

12 Code and style requirements for passing All code written by the student should be indented in a style consistent with the provided code. The directory structure with a division between source code in the src branch and class files in the bin branch should be followed. The naming of the classes which the students write from scratch must follow the instructions, so that the teachers can compile and run the application $ java -cp bin/ org.addressbook.main.simplemain The above should launch the application and display the menu. The student must submit a zip file created by the verification script.

13 You don t have to do the optional tasks In particular, you don t have to do the tasks under Optional - refactoring the AddressBook and under Optional task 2 - Generating documentation for the project Do the tasks 1-4. If you want to do the optional tasks, don t send it in. We won t correct them, and you wan t get credits for them anyway ;-) They are there for those students who think the mandatory stuff was too simple and want to continue working.

14 Guidelines Read each task in full before starting to code. You must understand all of the task i order to accomplish it. Read and try the examples if there are any (e.g. MenuExample and TextUtilsExample). They show you how to accomplish some sub tasks. When working with the Contact class, save and compile often, and run the test script between each sub task. Same goes for SimpleAddressBook.

15 Application overview You will write a class with a main method, which will create an instance of SimpleApplication, and run its start() instance method. That s all that main does (plus later on, some error handling). The SimpleApplication has one public method: start(). It initializes the application, reads the contacts from disk, sets up the menu system and starts the menu. SimpleApplication has two instance variables: a SimpleAddressBook called list and a Menu called menu. A SimpleAddressBook has methods for listing, loading, saving and adding Contacts.

16 Application overview, continued Main -> Creates a SimpleApplication and runs its method start() SimpleApplication -> Has a SimpleAddressBook which stores Contact:s, and it also has a Menu wich interacts with the user. Has the start() method. SimpleAddressBook -> is basically a list of Contacts but it has some nice methods, like load() (loads the contacts from file), save() (saves the contacts to file), addentry() (adds a new Contact to the list), listentries() (prints the contacts to the standard out). Contact -> Represents a contact entry in the address book. Has name, , phone and is comparable.