2 * Copyright (C) 2015 Roland Haeder
\r
4 * This program is free software: you can redistribute it and/or modify
\r
5 * it under the terms of the GNU General Public License as published by
\r
6 * the Free Software Foundation, either version 3 of the License, or
\r
7 * (at your option) any later version.
\r
9 * This program is distributed in the hope that it will be useful,
\r
10 * but WITHOUT ANY WARRANTY; without even the implied warranty of
\r
11 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
\r
12 * GNU General Public License for more details.
\r
14 * You should have received a copy of the GNU General Public License
\r
15 * along with this program. If not, see <http://www.gnu.org/licenses/>.
\r
17 package org.mxchange.addressbook.client.console;
\r
19 import java.text.MessageFormat;
\r
20 import java.util.Arrays;
\r
21 import java.util.Scanner;
\r
22 import org.mxchange.addressbook.UnhandledUserChoiceException;
\r
23 import org.mxchange.addressbook.application.AddressbookApplication;
\r
24 import org.mxchange.addressbook.application.Application;
\r
25 import org.mxchange.addressbook.client.BaseClient;
\r
26 import org.mxchange.addressbook.client.Client;
\r
27 import org.mxchange.addressbook.contact.Contact;
\r
28 import org.mxchange.addressbook.menu.Menu;
\r
29 import org.mxchange.addressbook.menu.MenuTools;
\r
30 import org.mxchange.addressbook.menu.console.ConsoleMenu;
\r
31 import org.mxchange.addressbook.menu.item.SelectableMenuItem;
\r
32 import org.mxchange.addressbook.menu.item.console.ConsoleMenuItem;
\r
35 * A client for the console
\r
37 * @author Roland Haeder
\r
39 public class ConsoleClient extends BaseClient implements Client {
\r
41 * Scanner instance for reading data from console input
\r
43 private final Scanner scanner;
\r
46 * Parameterless constructor
\r
47 * @param application An instance of an Application class
\r
49 public ConsoleClient (final Application application) {
\r
52 // Set application instance
\r
53 this.setApplication(application);
\r
55 // Init contact manager here
\r
56 this.initContactManager(this);
\r
58 // Init scanner instance
\r
59 this.scanner = new Scanner(System.in);
\r
66 * Displays a textual address "box" of given contact
\r
68 * @param contact Contact to show address for
\r
72 public void displayAddressBox (final Contact contact) {
\r
73 // Simple display ...
\r
75 this.outputMessage("Strasse, PLZ Ort, Land: " + contact.getStreet() + "\n" + contact.getZipCode() + " " + contact.getCity() + "\n" + contact.getCountryCode());
\r
79 * Displays a textual name "box" of given contact
\r
81 * @param contact Contact to show name for
\r
84 public void displayNameBox (final Contact contact) {
\r
85 // Get translated gender as the user may want to see "Mr.", "Mrs."
\r
86 String gender = contact.getTranslatedGender();
\r
89 String companyName = contact.getCompanyName();
\r
91 // If it is empty/null, then assume private contact
\r
92 if ((companyName == null) || (companyName.isEmpty())) {
\r
93 // Now put all together: gender, surname, family name
\r
95 this.outputMessage("Anrede, Vorname, Name: " + gender + " " + contact.getSurname() + " " + contact.getFamilyName());
\r
98 this.outputMessage("Firma: " + companyName + "\nAnsprechpartner: " + gender + " " + contact.getSurname() + " " + contact.getFamilyName());
\r
103 * Displays a textual other data "box" of given contact
\r
105 * @param contact Contact to show other data for
\r
108 public void displayOtherDataBox (final Contact contact) {
\r
109 // Cellphone and such ...
\r
110 this.outputMessage("Telefonnumer: " + contact.getPhoneNumber() + "\nFaxnummer: " + contact.getFaxNumber() + "\nHandy: " + contact.getCellphoneNumber() + "\nKommentar:\n" + contact.getComment());
\r
114 public void doUserMenuChoice () throws UnhandledUserChoiceException {
\r
115 // Get all access keys from menu
\r
116 char[] accessKeys = MenuTools.getAccessKeysFromMenuMap(this.getMenus(), this.getCurrentMenu());
\r
118 // Output textural message and ask for a char as input
\r
119 char choice = this.enterChar(accessKeys, "Bitte Auswahl eingeben (0=Programm beenden): ");
\r
121 // @TODO Rewrite this ugly switch() block
\r
123 case '1': // Enter/add own data
\r
124 this.getContactManager().doEnterOwnData();
\r
127 case '2': // Change own data
\r
128 this.getContactManager().changeOwnData();
\r
131 case '3': // Add new addess
\r
132 this.getContactManager().addOtherAddress();
\r
135 case '4': // List contacts
\r
136 this.getContactManager().listContacts();
\r
139 case '5': // Search addresses
\r
140 this.getContactManager().searchContacts();
\r
143 case '6': // Change other addess
\r
144 this.getContactManager().changeOtherAddress();
\r
147 case '7': // Delete other address
\r
148 this.getContactManager().deleteOtherAddress();
\r
151 case '0': // Program exit
\r
152 this.disableIsRunning();
\r
156 // @TODO throw own exception
\r
157 throw new UnhandledUserChoiceException("Choice '" + choice + "' not handled yet.");
\r
162 * Asks the the user to enter a single character which must match validChars
\r
163 * @param validChars Valid chars that are accepted
\r
164 * @param message Message to user
\r
165 * @return Allowed character
\r
168 public char enterChar (final char[] validChars, final String message) {
\r
171 // Sort array, else binarySearch() won't work
\r
172 Arrays.sort(validChars);
\r
174 // Keep asking until valid char has been entered
\r
175 while (Arrays.binarySearch(validChars, input) < 0) {
\r
177 System.out.print(message);
\r
180 input = this.readChar();
\r
183 // Return read char
\r
188 * Reads an integer (int) with a textural message from the user
\r
190 * @param minimum Minimum allowed number
\r
191 * @param maximum Maximum allowed number
\r
192 * @param message Messager to display in console
\r
196 public int enterInt (final int minimum, final int maximum, final String message) {
\r
197 // Minimum should not be below zero
\r
198 assert(minimum >= 0);
\r
199 assert(maximum > minimum);
\r
204 while ((input < minimum) || (input > maximum)) {
\r
206 System.out.print(message);
\r
208 // Read integer from user
\r
209 input = this.readInt();
\r
217 * Reads a string of minimum and maximum length from the user
\r
219 * @param minLength Minimum length of the string to read
\r
220 * @param maxLength Maximum length of the string to read
\r
221 * @param message Message to user
\r
222 * @param allowEmpty Whether to allow empty string
\r
223 * @return Entered string by user or null for empty strings
\r
226 public String enterString (final int minLength, final int maxLength, final String message, final boolean allowEmpty) {
\r
227 // Check on length, e.g. country codes are excactly 2 chars long
\r
228 assert(maxLength >= minLength);
\r
231 String input = null;
\r
233 // Check if it is to short or to long
\r
234 while (((input == null) || ((input.length() < minLength) && (!allowEmpty))) || ((input.length() > 0) && (input.length() < minLength) && (allowEmpty)) || ((input instanceof String) && (input.length() > maxLength))) {
\r
236 System.out.print(message);
\r
239 input = this.readString();
\r
247 * Returns a console menu item
\r
249 * @param accessKey Key to access the menu
\r
250 * @param text Text to show to user
\r
251 * @return A SelectableMenuItem
\r
252 * @todo Make sure the access key is unique
\r
255 public SelectableMenuItem getMenuItem (final char accessKey, final String text) {
\r
256 // Return a new console menu item
\r
257 return new ConsoleMenuItem(accessKey,text);
\r
261 * Displays textural message to the user
\r
265 public void outputMessage (final String message) {
\r
266 System.out.println(message);
\r
270 * Shows textural menu on console
\r
273 public void showCurrentMenu () {
\r
274 this.showMenu(this.getCurrentMenu());
\r
278 * Shows given menu entry to user
\r
280 * @param item Menu entry
\r
283 public void showEntry (final SelectableMenuItem item) {
\r
284 // Access key then text
\r
285 this.outputMessage("[" + item.getAccessKey() + "] " + item.getText());
\r
289 * Shows a textural message to the user
\r
292 public void showWelcome () {
\r
293 this.outputMessage("Welcome to " + AddressbookApplication.APP_TITLE + " v" + AddressbookApplication.APP_VERSION);
\r
294 this.outputMessage("");
\r
295 this.outputMessage("Copyright(c) 2015 by Roland Haeder, this is free software");
\r
298 this.getLogger().debug("Intro shown to user");
\r
302 public void userChooseChangeContactData (final Contact contact) throws UnhandledUserChoiceException {
\r
303 // Ask the user for editing [name], [a]ddress or [other] data
\r
304 char choice = this.enterChar(new char[]{'n', 'a', 'o', 'x'}, "Welchen Daten möchten Sie ändern? (n=Namensdaten, a=Anschriftsdaten, o=Andere, x=Zurück zur Hauptauswahl) ");
\r
306 // @TODO Get rid of this ugly switch block, too
\r
308 case 'n': // Name data
\r
309 this.getContactManager().doChangeNameData(contact, this);
\r
312 case 'a': // Address data
\r
313 this.getContactManager().doChangeAddressData(contact, this);
\r
316 case 'o': // Other data
\r
317 this.getContactManager().doChangeOtherData(contact, this);
\r
320 case 'x': // Exit this menu
\r
321 // Ignored as it should go back
\r
325 // @TODO throw own exception
\r
326 throw new UnhandledUserChoiceException("Choice '" + choice + "' not handled yet.");
\r
331 * Reads one character
\r
333 * @return A single character
\r
335 private char readChar () {
\r
337 String input = this.scanner.nextLine();
\r
339 // This must be only one character
\r
340 if (input.length() != 1) {
\r
345 // Get char from first (and only) position
\r
346 return input.charAt(0);
\r
350 * Reads an integer (int) from user
\r
352 * @return An integer number
\r
354 private int readInt () {
\r
355 // First read a string
\r
356 String input = this.readString();
\r
358 // Init number with invalid value
\r
361 // Parse number, this can be risky
\r
363 num = Integer.parseInt(input);
\r
364 } catch (final NumberFormatException e) {
\r
365 this.outputMessage("Bitte geben Sie nur Zahlen ein!");
\r
366 this.getLogger().warn(MessageFormat.format("No numbers-only entered. input={0},message={1}", input, e.getMessage()));
\r
369 // Return read number
\r
374 * Reads a string from a scanner until RETURN is pressed
\r
376 * @return Read string from scanner
\r
378 private String readString () {
\r
379 return this.scanner.nextLine();
\r
383 * Fills menu map with menu entries
\r
386 protected final void fillMenuMap () {
\r
387 // Initialize first (main) menu
\r
388 Menu menu = new ConsoleMenu("main", this);
\r
391 this.getMenus().put("main", menu);
\r