Skip to content
Snippets Groups Projects
Commit 8cffe3da authored by Arne Styve's avatar Arne Styve
Browse files

Merge branch 'release/v0.6'

parents 4a2a2425 765df129
No related branches found
Tags v0.6
No related merge requests found
Hide whitespace changes
Inline Side-by-side
Showing
with 771 additions and 44 deletions
.gitignore
+ 1
− 0
View file @ 8cffe3da
......@@ -11,3 +11,4 @@
/doc/
/contacts.log
/addressbook.dat
workspace (Arnes MacBook Pros kopi som er i konflikt 2020-05-04).xml
.idea/checkstyle-idea.xml
+ 3
− 0
View file @ 8cffe3da
......@@ -7,6 +7,9 @@
<entry key="copy-libs" value="false" />
<entry key="location-0" value="BUNDLED:(bundled):Sun Checks" />
<entry key="location-1" value="BUNDLED:(bundled):Google Checks" />
<entry key="location-2" value="PROJECT_RELATIVE:$PROJECT_DIR$/idatx2001_checks.xml:IDATx2001 Checks" />
<entry key="property-2.org.checkstyle.google.suppressionfilter.config" value="" />
<entry key="property-2.org.checkstyle.google.suppressionxpathfilter.config" value="" />
<entry key="scan-before-checkin" value="false" />
<entry key="scanscope" value="JavaOnly" />
<entry key="suppress-errors" value="false" />
......
.idea/codeStyles/codeStyleConfig.xml
+ 1
− 1
View file @ 8cffe3da
<component name="ProjectCodeStyleConfiguration">
<state>
<option name="PREFERRED_PROJECT_CODE_STYLE" value="Default copy" />
<option name="PREFERRED_PROJECT_CODE_STYLE" value="IDATx2001 Checks" />
</state>
</component>
\ No newline at end of file
.idea/libraries/junit_junit_4_13.xml 0 → 100644
+ 11
− 0
View file @ 8cffe3da
<component name="libraryTable">
<library name="junit:junit:4.13" type="repository">
<properties maven-id="junit:junit:4.13" />
<CLASSES>
<root url="jar://$PROJECT_DIR$/lib/junit-4.13.jar!/" />
<root url="jar://$PROJECT_DIR$/lib/hamcrest-core-1.3.jar!/" />
</CLASSES>
<JAVADOC />
<SOURCES />
</library>
</component>
\ No newline at end of file
.idea/libraries/libs.xml → .idea/libraries/lib.xml
+ 10
− 0
View file @ 8cffe3da
<component name="libraryTable">
<library name="libs">
<library name="lib">
<CLASSES>
<root url="file://$PROJECT_DIR$/libs" />
<root url="file://$PROJECT_DIR$/lib" />
</CLASSES>
<JAVADOC />
<SOURCES />
<jarDirectory url="file://$PROJECT_DIR$/libs" recursive="false" />
<jarDirectory url="file://$PROJECT_DIR$/lib" recursive="false" />
</library>
</component>
\ No newline at end of file
.idea/misc.xml
+ 1
− 1
View file @ 8cffe3da
......@@ -4,7 +4,7 @@
<component name="JavadocGenerationManager">
<option name="OUTPUT_DIRECTORY" value="$PROJECT_DIR$/doc" />
</component>
<component name="ProjectRootManager" version="2" languageLevel="JDK_1_8" default="true" project-jdk-name="1.8.0_201" project-jdk-type="JavaSDK">
<component name="ProjectRootManager" version="2" languageLevel="JDK_1_8" default="true" project-jdk-name="1.8" project-jdk-type="JavaSDK">
<output url="file://$PROJECT_DIR$/out" />
</component>
</project>
\ No newline at end of file
Contacts.iml
+ 3
− 1
View file @ 8cffe3da
......@@ -23,9 +23,11 @@
<exclude-output />
<content url="file://$MODULE_DIR$">
<sourceFolder url="file://$MODULE_DIR$/src" isTestSource="false" />
<sourceFolder url="file://$MODULE_DIR$/test" isTestSource="true" />
</content>
<orderEntry type="inheritedJdk" />
<orderEntry type="sourceFolder" forTests="false" />
<orderEntry type="library" name="libs" level="project" />
<orderEntry type="library" name="junit:junit:4.13" level="project" />
<orderEntry type="library" name="lib" level="project" />
</component>
</module>
\ No newline at end of file
README.md
+ 2
− 0
View file @ 8cffe3da
......@@ -12,8 +12,10 @@ The project was developed for use in teaching in the course "IDATx2001 Programme
**Version** | **Description**
--------|------------
v0.6 | Added an alternative JavaFX-GUI based on FXML to give an example of how the project could be solved using FXML and CSS. To run the FXML-version, run the class **ContactsAppFXML**. This class uses the **ContactsMain.fxml**-file to build the GUI, together with the **ContactsAppFXML.css**-file. The controller used with the FXML-version of the GUI, is the **ContactsAppFXMLController**. <br>NOTE: Using "FXML" as part of the class-names is not a recommended practice, and is only done so in this project to make it clear which of the classes/files are linked to the use of the JavaFx FXML-solution. <br>Also, the existing non FXML-controller class **MainController** has been refactored to take the responsibility for the AddressBook instance (previously managed by the view class **ContactsApp**. <br>And there are also some other minor changes/modifications.
v0.5.1 | Some minor adjustments: removed *synchronized* from the iterator()-method of ContactDetails (not needed). Updated the ContactDetails-constructor to make use of the set-methods of the class.
v0.5 | Added support for MySQL-DB at IDI (https://mysql-ait.stud.idi.ntnu.no/phpmyadmin/) through a separate *persistence unit (PU)* in the persistence.xml-file. NOTE: You must set your own **username**, **password** and **database name**. Also support has been added for a locally installed Apache Derby Server.
v0.4.3 | Added support for MySQL-DB at IDI (https://mysql-ait.stud.idi.ntnu.no/phpmyadmin/) through a separate *persistence unit (PU)* in the persistence.xml-file. NOTE: You must set your own **username**, **password** and **database name**. Also support has been added for a locally installed Apache Derby Server.
v0.4.1 | Renamed the class AddressBookDAO to AddressBookDBHandler, since DAO is a general term that also could be used for the AddressBookFileHandler. Also altered slightly the use of EntityManager.
v0.4 | Added Relational Database support, using the embedded Apache Derby server. For details of the changes made, se below.
v0.3 | Adds object serialization of the entire address book.
......
idatx2001_checks.xml 0 → 100644
+ 321
− 0
View file @ 8cffe3da
<?xml version="1.0"?>
<!DOCTYPE module PUBLIC
"-//Checkstyle//DTD Checkstyle Configuration 1.3//EN"
"https://checkstyle.org/dtds/configuration_1_3.dtd">
<!--
Checkstyle configuration based on the Google coding convetions, but with some changes
for the IDATA2001 Programming 2 course at NTNU
Checkstyle configuration that checks the Google coding conventions from Google Java Style
that can be found at https://google.github.io/styleguide/javaguide.html
Checkstyle is very configurable. Be sure to read the documentation at
http://checkstyle.org (or in your downloaded distribution).
To completely disable a check, just comment it out or delete it from the file.
To suppress certain violations please review suppression filters.
Authors: Max Vetrenko, Ruslan Diachenko, Roman Ivanov.
-->
<module name = "Checker">
<property name="charset" value="UTF-8"/>
<property name="severity" value="warning"/>
<property name="fileExtensions" value="java, properties, xml"/>
<!-- Excludes all 'module-info.java' files -->
<!-- See https://checkstyle.org/config_filefilters.html -->
<module name="BeforeExecutionExclusionFileFilter">
<property name="fileNamePattern" value="module\-info\.java$"/>
</module>
<!-- https://checkstyle.org/config_filters.html#SuppressionFilter -->
<module name="SuppressionFilter">
<property name="file" value="${org.checkstyle.google.suppressionfilter.config}"
default="checkstyle-suppressions.xml" />
<property name="optional" value="true"/>
</module>
<!-- Checks for whitespace -->
<!-- See http://checkstyle.org/config_whitespace.html -->
<module name="FileTabCharacter">
<property name="eachLine" value="true"/>
</module>
<module name="LineLength">
<property name="fileExtensions" value="java"/>
<property name="max" value="100"/>
<property name="ignorePattern" value="^package.*|^import.*|a href|href|http://|https://|ftp://"/>
</module>
<module name="TreeWalker">
<module name="OuterTypeFilename"/>
<module name="IllegalTokenText">
<property name="tokens" value="STRING_LITERAL, CHAR_LITERAL"/>
<property name="format"
value="\\u00(09|0(a|A)|0(c|C)|0(d|D)|22|27|5(C|c))|\\(0(10|11|12|14|15|42|47)|134)"/>
<property name="message"
value="Consider using special escape sequence instead of octal value or Unicode escaped value."/>
</module>
<module name="AvoidEscapedUnicodeCharacters">
<property name="allowEscapesForControlCharacters" value="true"/>
<property name="allowByTailComment" value="true"/>
<property name="allowNonPrintableEscapes" value="true"/>
</module>
<module name="AvoidStarImport"/>
<module name="OneTopLevelClass"/>
<module name="NoLineWrap">
<property name="tokens" value="PACKAGE_DEF, IMPORT, STATIC_IMPORT"/>
</module>
<module name="EmptyBlock">
<property name="option" value="TEXT"/>
<property name="tokens"
value="LITERAL_TRY, LITERAL_FINALLY, LITERAL_IF, LITERAL_ELSE, LITERAL_SWITCH"/>
</module>
<module name="NeedBraces">
<property name="tokens"
value="LITERAL_DO, LITERAL_ELSE, LITERAL_FOR, LITERAL_IF, LITERAL_WHILE"/>
</module>
<module name="LeftCurly">
<property name="tokens"
value="ANNOTATION_DEF, CLASS_DEF, CTOR_DEF, ENUM_CONSTANT_DEF, ENUM_DEF,
INTERFACE_DEF, LAMBDA, LITERAL_CASE, LITERAL_CATCH, LITERAL_DEFAULT,
LITERAL_DO, LITERAL_ELSE, LITERAL_FINALLY, LITERAL_FOR, LITERAL_IF,
LITERAL_SWITCH, LITERAL_SYNCHRONIZED, LITERAL_TRY, LITERAL_WHILE, METHOD_DEF,
OBJBLOCK, STATIC_INIT"/>
</module>
<module name="RightCurly">
<property name="id" value="RightCurlySame"/>
<property name="tokens"
value="LITERAL_TRY, LITERAL_CATCH, LITERAL_FINALLY, LITERAL_IF, LITERAL_ELSE,
LITERAL_DO"/>
</module>
<module name="RightCurly">
<property name="id" value="RightCurlyAlone"/>
<property name="option" value="alone"/>
<property name="tokens"
value="CLASS_DEF, METHOD_DEF, CTOR_DEF, LITERAL_FOR, LITERAL_WHILE, STATIC_INIT,
INSTANCE_INIT, ANNOTATION_DEF, ENUM_DEF"/>
</module>
<module name="WhitespaceAround">
<property name="allowEmptyConstructors" value="true"/>
<property name="allowEmptyLambdas" value="true"/>
<property name="allowEmptyMethods" value="true"/>
<property name="allowEmptyTypes" value="true"/>
<property name="allowEmptyLoops" value="true"/>
<property name="tokens"
value="ASSIGN, BAND, BAND_ASSIGN, BOR, BOR_ASSIGN, BSR, BSR_ASSIGN, BXOR,
BXOR_ASSIGN, COLON, DIV, DIV_ASSIGN, DO_WHILE, EQUAL, GE, GT, LAMBDA, LAND,
LCURLY, LE, LITERAL_CATCH, LITERAL_DO, LITERAL_ELSE, LITERAL_FINALLY,
LITERAL_FOR, LITERAL_IF, LITERAL_RETURN, LITERAL_SWITCH, LITERAL_SYNCHRONIZED,
LITERAL_TRY, LITERAL_WHILE, LOR, LT, MINUS, MINUS_ASSIGN, MOD, MOD_ASSIGN,
NOT_EQUAL, PLUS, PLUS_ASSIGN, QUESTION, RCURLY, SL, SLIST, SL_ASSIGN, SR,
SR_ASSIGN, STAR, STAR_ASSIGN, LITERAL_ASSERT, TYPE_EXTENSION_AND"/>
<message key="ws.notFollowed"
value="WhitespaceAround: ''{0}'' is not followed by whitespace. Empty blocks may only be represented as '{}' when not part of a multi-block statement (4.1.3)"/>
<message key="ws.notPreceded"
value="WhitespaceAround: ''{0}'' is not preceded with whitespace."/>
</module>
<module name="OneStatementPerLine"/>
<module name="MultipleVariableDeclarations"/>
<module name="ArrayTypeStyle"/>
<module name="MissingSwitchDefault"/>
<module name="FallThrough"/>
<module name="UpperEll"/>
<module name="ModifierOrder"/>
<module name="EmptyLineSeparator">
<property name="tokens"
value="PACKAGE_DEF, IMPORT, STATIC_IMPORT, CLASS_DEF, INTERFACE_DEF, ENUM_DEF,
STATIC_INIT, INSTANCE_INIT, METHOD_DEF, CTOR_DEF, VARIABLE_DEF"/>
<property name="allowNoEmptyLineBetweenFields" value="true"/>
</module>
<module name="SeparatorWrap">
<property name="id" value="SeparatorWrapDot"/>
<property name="tokens" value="DOT"/>
<property name="option" value="nl"/>
</module>
<module name="SeparatorWrap">
<property name="id" value="SeparatorWrapComma"/>
<property name="tokens" value="COMMA"/>
<property name="option" value="EOL"/>
</module>
<module name="SeparatorWrap">
<!-- ELLIPSIS is EOL until https://github.com/google/styleguide/issues/258 -->
<property name="id" value="SeparatorWrapEllipsis"/>
<property name="tokens" value="ELLIPSIS"/>
<property name="option" value="EOL"/>
</module>
<module name="SeparatorWrap">
<!-- ARRAY_DECLARATOR is EOL until https://github.com/google/styleguide/issues/259 -->
<property name="id" value="SeparatorWrapArrayDeclarator"/>
<property name="tokens" value="ARRAY_DECLARATOR"/>
<property name="option" value="EOL"/>
</module>
<module name="SeparatorWrap">
<property name="id" value="SeparatorWrapMethodRef"/>
<property name="tokens" value="METHOD_REF"/>
<property name="option" value="nl"/>
</module>
<module name="PackageName">
<property name="format" value="^[a-z]+(\.[a-z][a-z0-9]*)*$"/>
<message key="name.invalidPattern"
value="Package name ''{0}'' must match pattern ''{1}''."/>
</module>
<module name="TypeName">
<property name="tokens" value="CLASS_DEF, INTERFACE_DEF, ENUM_DEF, ANNOTATION_DEF"/>
<message key="name.invalidPattern"
value="Type name ''{0}'' must match pattern ''{1}''."/>
</module>
<module name="MemberName">
<property name="format" value="^[a-z][a-z0-9][a-zA-Z0-9]*$"/>
<message key="name.invalidPattern"
value="Member name ''{0}'' must match pattern ''{1}''."/>
</module>
<module name="ParameterName">
<property name="format" value="^[a-z]([a-z0-9][a-zA-Z0-9]*)?$"/>
<message key="name.invalidPattern"
value="Parameter name ''{0}'' must match pattern ''{1}''."/>
</module>
<module name="LambdaParameterName">
<property name="format" value="^[a-z]([a-z0-9][a-zA-Z0-9]*)?$"/>
<message key="name.invalidPattern"
value="Lambda parameter name ''{0}'' must match pattern ''{1}''."/>
</module>
<module name="CatchParameterName">
<property name="format" value="^[a-z]([a-z0-9][a-zA-Z0-9]*)?$"/>
<message key="name.invalidPattern"
value="Catch parameter name ''{0}'' must match pattern ''{1}''."/>
</module>
<module name="LocalVariableName">
<property name="format" value="^[a-z]([a-z0-9][a-zA-Z0-9]*)?$"/>
<message key="name.invalidPattern"
value="Local variable name ''{0}'' must match pattern ''{1}''."/>
</module>
<module name="ClassTypeParameterName">
<property name="format" value="(^[A-Z][0-9]?)$|([A-Z][a-zA-Z0-9]*[T]$)"/>
<message key="name.invalidPattern"
value="Class type name ''{0}'' must match pattern ''{1}''."/>
</module>
<module name="MethodTypeParameterName">
<property name="format" value="(^[A-Z][0-9]?)$|([A-Z][a-zA-Z0-9]*[T]$)"/>
<message key="name.invalidPattern"
value="Method type name ''{0}'' must match pattern ''{1}''."/>
</module>
<module name="InterfaceTypeParameterName">
<property name="format" value="(^[A-Z][0-9]?)$|([A-Z][a-zA-Z0-9]*[T]$)"/>
<message key="name.invalidPattern"
value="Interface type name ''{0}'' must match pattern ''{1}''."/>
</module>
<module name="NoFinalizer"/>
<module name="GenericWhitespace">
<message key="ws.followed"
value="GenericWhitespace ''{0}'' is followed by whitespace."/>
<message key="ws.preceded"
value="GenericWhitespace ''{0}'' is preceded with whitespace."/>
<message key="ws.illegalFollow"
value="GenericWhitespace ''{0}'' should followed by whitespace."/>
<message key="ws.notPreceded"
value="GenericWhitespace ''{0}'' is not preceded with whitespace."/>
</module>
<module name="Indentation">
<property name="basicOffset" value="2"/>
<property name="braceAdjustment" value="0"/>
<property name="caseIndent" value="2"/>
<property name="throwsIndent" value="4"/>
<property name="lineWrappingIndentation" value="4"/>
<property name="arrayInitIndent" value="2"/>
</module>
<module name="AbbreviationAsWordInName">
<property name="ignoreFinal" value="false"/>
<property name="allowedAbbreviationLength" value="1"/>
<property name="tokens"
value="CLASS_DEF, INTERFACE_DEF, ENUM_DEF, ANNOTATION_DEF, ANNOTATION_FIELD_DEF,
PARAMETER_DEF, VARIABLE_DEF, METHOD_DEF"/>
</module>
<module name="OverloadMethodsDeclarationOrder"/>
<module name="VariableDeclarationUsageDistance"/>
<module name="CustomImportOrder">
<property name="sortImportsInGroupAlphabetically" value="true"/>
<property name="separateLineBetweenGroups" value="true"/>
<property name="customImportOrderRules" value="STATIC###THIRD_PARTY_PACKAGE"/>
<property name="tokens" value="IMPORT, STATIC_IMPORT, PACKAGE_DEF"/>
</module>
<module name="MethodParamPad">
<property name="tokens"
value="CTOR_DEF, LITERAL_NEW, METHOD_CALL, METHOD_DEF,
SUPER_CTOR_CALL, ENUM_CONSTANT_DEF"/>
</module>
<module name="NoWhitespaceBefore">
<property name="tokens"
value="COMMA, SEMI, POST_INC, POST_DEC, DOT, ELLIPSIS, METHOD_REF"/>
<property name="allowLineBreaks" value="true"/>
</module>
<module name="ParenPad">
<property name="tokens"
value="ANNOTATION, ANNOTATION_FIELD_DEF, CTOR_CALL, CTOR_DEF, DOT, ENUM_CONSTANT_DEF,
EXPR, LITERAL_CATCH, LITERAL_DO, LITERAL_FOR, LITERAL_IF, LITERAL_NEW,
LITERAL_SWITCH, LITERAL_SYNCHRONIZED, LITERAL_WHILE, METHOD_CALL,
METHOD_DEF, QUESTION, RESOURCE_SPECIFICATION, SUPER_CTOR_CALL, LAMBDA"/>
</module>
<module name="OperatorWrap">
<property name="option" value="NL"/>
<property name="tokens"
value="BAND, BOR, BSR, BXOR, DIV, EQUAL, GE, GT, LAND, LE, LITERAL_INSTANCEOF, LOR,
LT, MINUS, MOD, NOT_EQUAL, PLUS, QUESTION, SL, SR, STAR, METHOD_REF "/>
</module>
<module name="AnnotationLocation">
<property name="id" value="AnnotationLocationMostCases"/>
<property name="tokens"
value="CLASS_DEF, INTERFACE_DEF, ENUM_DEF, METHOD_DEF, CTOR_DEF"/>
</module>
<module name="AnnotationLocation">
<property name="id" value="AnnotationLocationVariables"/>
<property name="tokens" value="VARIABLE_DEF"/>
<property name="allowSamelineMultipleAnnotations" value="true"/>
</module>
<module name="NonEmptyAtclauseDescription"/>
<module name="InvalidJavadocPosition"/>
<module name="JavadocTagContinuationIndentation"/>
<module name="SummaryJavadoc">
<property name="forbiddenSummaryFragments"
value="^@return the *|^This method returns |^A [{]@code [a-zA-Z0-9]+[}]( is a )"/>
</module>
<module name="JavadocParagraph"/>
<module name="AtclauseOrder">
<property name="tagOrder" value="@param, @return, @throws, @deprecated"/>
<property name="target"
value="CLASS_DEF, INTERFACE_DEF, ENUM_DEF, METHOD_DEF, CTOR_DEF, VARIABLE_DEF"/>
</module>
<module name="JavadocMethod">
<property name="scope" value="public"/>
<property name="allowMissingParamTags" value="false"/>
<property name="allowMissingReturnTag" value="false"/>
<property name="allowedAnnotations" value="Override, Test"/>
<property name="tokens" value="METHOD_DEF, CTOR_DEF, ANNOTATION_FIELD_DEF"/>
</module>
<module name="MissingJavadocMethod">
<property name="scope" value="public"/>
<!--property name="minLineCount" value="2"/-->
<property name="allowedAnnotations" value="Override, Test"/>
<property name="tokens" value="METHOD_DEF, CTOR_DEF, ANNOTATION_FIELD_DEF"/>
</module>
<module name="MethodName">
<property name="format" value="^[a-z][a-z0-9][a-zA-Z0-9_]*$"/>
<message key="name.invalidPattern"
value="Method name ''{0}'' must match pattern ''{1}''."/>
</module>
<module name="SingleLineJavadoc">
<property name="ignoreInlineTags" value="false"/>
</module>
<module name="EmptyCatchBlock">
<property name="exceptionVariableName" value="expected"/>
</module>
<module name="CommentsIndentation">
<property name="tokens" value="SINGLE_LINE_COMMENT, BLOCK_COMMENT_BEGIN"/>
</module>
<!-- https://checkstyle.org/config_filters.html#SuppressionXpathFilter -->
<module name="SuppressionXpathFilter">
<property name="file" value="${org.checkstyle.google.suppressionxpathfilter.config}"
default="checkstyle-xpath-suppressions.xml" />
<property name="optional" value="true"/>
</module>
</module>
</module>
libs/derby.jar → lib/derby.jar
+ 0
− 0
View file @ 8cffe3da
File moved
libs/derbyclient.jar → lib/derbyclient.jar
+ 0
− 0
View file @ 8cffe3da
File moved
libs/eclipselink.jar → lib/eclipselink.jar
+ 0
− 0
View file @ 8cffe3da
File moved
lib/hamcrest-core-1.3.jar 0 → 100644
+ 0
− 0
View file @ 8cffe3da
File added
libs/jakarta.persistence_2.2.3.jar → lib/jakarta.persistence_2.2.3.jar
+ 0
− 0
View file @ 8cffe3da
File moved
lib/junit-4.13.jar 0 → 100644
+ 0
− 0
View file @ 8cffe3da
File added
src/no/ntnu/idata2001/contacts/AppVersion.java 0 → 100644
+ 17
− 0
View file @ 8cffe3da
package no.ntnu.idata2001.contacts;
/**
* A simple class to hold the version of the application.
*
* <p>Using the "final" keyword on a class prevents the class to
* be subclassed (inherited from), which makes sence in this case.
* The field is also being set to final to indicate that there are to be
* no changes to the field (i.e. a constant). Setting the field to
* static creates a "class field", i.e. a field that exsists without having to
* create an instance of the class.
* To access the VERSION-constant, use:
* <code>AppVersion.VERSION</code>
*/
public final class AppVersion {
public static final String VERSION = "0.6";
}
src/no/ntnu/idata2001/contacts/controllers/ContactsAppFXMLController.java 0 → 100644
+ 342
− 0
View file @ 8cffe3da
package no.ntnu.idata2001.contacts.controllers;
import java.io.File;
import java.io.IOException;
import java.util.Optional;
import java.util.logging.Level;
import java.util.logging.Logger;
import javafx.application.Platform;
import javafx.collections.FXCollections;
import javafx.collections.ObservableList;
import javafx.event.ActionEvent;
import javafx.fxml.FXML;
import javafx.geometry.Insets;
import javafx.scene.Node;
import javafx.scene.control.Alert;
import javafx.scene.control.ButtonBar;
import javafx.scene.control.ButtonType;
import javafx.scene.control.Dialog;
import javafx.scene.control.Label;
import javafx.scene.control.PasswordField;
import javafx.scene.control.TableView;
import javafx.scene.control.TextField;
import javafx.scene.layout.GridPane;
import javafx.stage.FileChooser;
import javafx.util.Pair;
import no.ntnu.idata2001.contacts.AppVersion;
import no.ntnu.idata2001.contacts.model.AddressBook;
import no.ntnu.idata2001.contacts.model.AddressBookDBHandler;
import no.ntnu.idata2001.contacts.model.AddressBookFileHandler;
import no.ntnu.idata2001.contacts.model.AddressBookPlain;
import no.ntnu.idata2001.contacts.model.ContactDetails;
import no.ntnu.idata2001.contacts.views.ContactDetailsDialog;
/**
* The controller class mapped to the FXML main class.
*
* <p>A few words on the @FXML-annotation:
* The @FXML annotation is used to enable initialization of fields performed
* by the FXML-loader. For example, in the code below, there is a field
* for the TableView. The instance to be created, will be created by the FXML loader,
* hence you should NEVER create this instance here in the controller.
*
* <p>Now, if the field (like contactDetailsTableView) is public, you do not need to
* use the annotation @FXML on the field for it to be initialized. BUT if you set it
* to private (which you should, according to good practice), you MUST add the @FXML
* annotation for the field to be initialized by the FXML loader.
* See: https://stackoverflow.com/questions/30210170/is-fxml-needed-for-every-declaration
*/
public class ContactsAppFXMLController {
private final Logger logger = Logger.getLogger(getClass().toString());
@FXML
private TableView<ContactDetails> contactDetailsTableView;
// The observable list to be used with the TableView
ObservableList<ContactDetails> observableContactsList;
// The address book to be used to store the contact details in.
private AddressBook addressBook;
/**
* This method will be called by the FXML-loader after having loaded
* all the GUI-components and initialized them.
*/
@FXML
private void initialize() {
this.observableContactsList = FXCollections.observableArrayList();
this.addressBook = new AddressBookDBHandler();
//this.addressBook = new AddressBookPlain();
this.observableContactsList.setAll(this.addressBook.getAllContacts());
this.contactDetailsTableView.setItems(observableContactsList);
}
/**
* Updates the ObservableArray wrapper with the current content in the
* Literature register. Call this method whenever changes are made to the
* underlying LiteratureRegister.
*
* @param addressBook the address book to use for updating the observable list
*/
public void updateObservableList(AddressBook addressBook) {
this.observableContactsList.setAll(addressBook.getAllContacts());
}
/**
* Display the input dialog to get input to create a new Contact.
* If the user confirms creating a new contact, a new instance
* of ContactDetails is created and added to the AddressBook provided.
*
* @param actionEvent the actionevent triggering this call
*/
public void addContact(ActionEvent actionEvent) {
ContactDetailsDialog contactsDialog = new ContactDetailsDialog();
Optional<ContactDetails> result = contactsDialog.showAndWait();
if (result.isPresent()) {
ContactDetails newContactDetails = result.get();
this.addressBook.addContact(newContactDetails);
this.updateObservableList(this.addressBook);
}
}
/**
* Import contacts from a .CSV-file chosen by the user.
*
* @param actionEvent the actionevent triggering this call
*/
public void importFromCSV(ActionEvent actionEvent) {
FileChooser fileChooser = new FileChooser();
// Set extension filter for .csv-file
FileChooser.ExtensionFilter extFilter =
new FileChooser.ExtensionFilter("CSV files (*.csv)", "*.csv");
fileChooser.getExtensionFilters().add(extFilter);
// Show save open dialog
File file = fileChooser.showOpenDialog(null);
if (file != null) {
try {
AddressBookFileHandler.importFromCsv(this.addressBook, file);
this.updateObservableList(this.addressBook);
} catch (IOException ioe) {
Alert alert = new Alert(Alert.AlertType.ERROR);
alert.setTitle("File Import Error");
alert.setHeaderText("Error during CSV-import.");
alert.setContentText("Details: " + ioe.getMessage());
alert.showAndWait();
}
}
}
/**
* Export all contacts in the address book to a CSV-file specified by the user.
*
* @param actionEvent the actionevent triggering this call
*/
public void exportToCSV(ActionEvent actionEvent) {
FileChooser fileChooser = new FileChooser();
// Set extension filter for .csv-file
FileChooser.ExtensionFilter extFilter =
new FileChooser.ExtensionFilter("CSV files (*.csv)", "*.csv");
fileChooser.getExtensionFilters().add(extFilter);
// Show save file dialog
File file = fileChooser.showSaveDialog(null);
if (file != null) {
try {
AddressBookFileHandler.exportToCsv(this.addressBook, file);
} catch (IOException ioe) {
Alert alert = new Alert(Alert.AlertType.ERROR);
alert.setTitle("File Export Error");
alert.setHeaderText("Error during CSV-export.");
alert.setContentText("Details: " + ioe.getMessage());
alert.showAndWait();
}
}
}
/**
* Exit the application. Displays a confirmation dialog.
*
* @param actionEvent the actionevent triggering this call
*/
public void exitApplication(ActionEvent actionEvent) {
Alert alert = new Alert(Alert.AlertType.CONFIRMATION);
alert.setTitle("Confirmation Dialog");
alert.setHeaderText("Exit Application ?");
alert.setContentText("Are you sure you want to exit this application?");
Optional<ButtonType> result = alert.showAndWait();
if (result.isPresent() && (result.get() == ButtonType.OK)) {
// ... user choose OK
Platform.exit();
}
}
/**
* Removes the Contact selected in the table. If no Contact is
* selected, nothing is deleted, and the user is informed that he/she must
* select which Contact to delete.
*
* @param actionEvent the actionevent triggering this call
*/
public void removeContact(ActionEvent actionEvent) {
ContactDetails selectedContact = this.contactDetailsTableView
.getSelectionModel()
.getSelectedItem();
if (selectedContact == null) {
showPleaseSelectItemDialog();
} else {
if (showDeleteConfirmationDialog()) {
this.addressBook.removeContact(selectedContact.getPhone());
this.updateObservableList(this.addressBook);
}
}
}
/**
* Edit the selected item.
*
* @param actionEvent the actionevent triggering this call
*/
public void editContact(ActionEvent actionEvent) {
ContactDetails selectedContact = this.contactDetailsTableView
.getSelectionModel()
.getSelectedItem();
if (selectedContact == null) {
showPleaseSelectItemDialog();
} else {
ContactDetailsDialog contactDialog = new ContactDetailsDialog(selectedContact, true);
contactDialog.showAndWait();
// The selectedContact now contains the updates. If the address book is
// stored in memory (implemented using one of the collection classes in the JDK
// or similar), we do not need to tell the address book that this instance
// has been changed. But if a DB is being used, the updated details
// must be stored/updeted in the DB too. Hence lets treat this change
// independent upon the address book being "in memory" or in a DB by
// calling the update()-method of the address book
this.addressBook.updateContact(selectedContact);
this.updateObservableList(this.addressBook);
}
}
/**
* Displays an example of an alert (info) dialog. In this case an "about"
* type of dialog.
*
* @param actionEvent the actionevent triggering this call
*/
public void showAboutDialog(ActionEvent actionEvent) {
Alert alert = new Alert(Alert.AlertType.INFORMATION);
alert.setTitle("Information Dialog - About");
alert.setHeaderText("Contacts Register\nv" + AppVersion.VERSION);
alert.setContentText("A brilliant application created by\n"
+ "(C)Arne Styve\n"
+ "2020-03-16");
alert.showAndWait();
}
/**
* Displays a login dialog using a custom dialog.
* Just to demonstrate the {@link javafx.scene.control.PasswordField}-control.
*
* @param actionEvent the actionevent triggering this call
*/
public void showLoginDialog(ActionEvent actionEvent) {
// Create the custom dialog.
Dialog<Pair<String, String>> dialog = new Dialog<>();
dialog.setTitle("Login Dialog");
dialog.setHeaderText("Look, a Custom Login Dialog");
// Set the button types.
ButtonType loginButtonType = new ButtonType("Login", ButtonBar.ButtonData.OK_DONE);
dialog.getDialogPane().getButtonTypes().addAll(loginButtonType, ButtonType.CANCEL);
// Create the username and password labels and fields.
GridPane grid = new GridPane();
grid.setHgap(10);
grid.setVgap(10);
grid.setPadding(new Insets(20, 150, 10, 10));
TextField username = new TextField();
username.setPromptText("Username");
PasswordField password = new PasswordField();
password.setPromptText("Password");
grid.add(new Label("Username:"), 0, 0);
grid.add(username, 1, 0);
grid.add(new Label("Password:"), 0, 1);
grid.add(password, 1, 1);
// Enable/Disable login button depending on whether a username was entered.
Node loginButton = dialog.getDialogPane().lookupButton(loginButtonType);
loginButton.setDisable(true);
// Do some validation .
username.textProperty().addListener((observable, oldValue, newValue) ->
loginButton.setDisable(newValue.trim().isEmpty()));
dialog.getDialogPane().setContent(grid);
// Request focus on the username field by default.
Platform.runLater(username::requestFocus);
// Convert the result to a username-password-pair when the login button is clicked.
dialog.setResultConverter(
dialogButton -> {
if (dialogButton == loginButtonType) {
return new Pair<>(username.getText(), password.getText());
}
return null;
});
Optional<Pair<String, String>> result = dialog.showAndWait();
result.ifPresent(
usernamePassword -> logger.log(Level.INFO, () -> "Username=" + usernamePassword.getKey()
+ ", Password=" + usernamePassword.getValue()));
}
/**
* Displays a warning informing the user that an item must be selected from
* the table.
*/
public void showPleaseSelectItemDialog() {
Alert alert = new Alert(Alert.AlertType.WARNING);
alert.setTitle("Information");
alert.setHeaderText("No items selected");
alert.setContentText("No item is selected from the table.\n"
+ "Please select an item from the table.");
alert.showAndWait();
}
/**
* Displays a delete confirmation dialog. If the user confirms the delete,
* <code>true</code> is returned.
*
* @return <code>true</code> if the user confirms the delete
*/
public boolean showDeleteConfirmationDialog() {
boolean deleteConfirmed = false;
Alert alert = new Alert(Alert.AlertType.CONFIRMATION);
alert.setTitle("Delete confirmation");
alert.setHeaderText("Delete confirmation");
alert.setContentText("Are you sure you want to delete this item?");
Optional<ButtonType> result = alert.showAndWait();
if (result.isPresent()) {
deleteConfirmed = (result.get() == ButtonType.OK);
}
return deleteConfirmed;
}
}
src/no/ntnu/idata2001/contacts/controllers/MainController.java
+ 52
− 41
View file @ 8cffe3da
......@@ -6,6 +6,7 @@ import java.util.Optional;
import java.util.logging.Level;
import java.util.logging.Logger;
import javafx.application.Platform;
import javafx.event.ActionEvent;
import javafx.geometry.Insets;
import javafx.scene.Node;
import javafx.scene.control.Alert;
......@@ -18,9 +19,11 @@ import javafx.scene.control.TextField;
import javafx.scene.layout.GridPane;
import javafx.stage.FileChooser;
import javafx.util.Pair;
import no.ntnu.idata2001.contacts.AppVersion;
import no.ntnu.idata2001.contacts.model.AddressBook;
import no.ntnu.idata2001.contacts.model.AddressBookDBHandler;
import no.ntnu.idata2001.contacts.model.AddressBookFileHandler;
import no.ntnu.idata2001.contacts.model.AddressBookPlain;
import no.ntnu.idata2001.contacts.model.ContactDetails;
import no.ntnu.idata2001.contacts.views.ContactDetailsDialog;
import no.ntnu.idata2001.contacts.views.ContactsApp;
......@@ -38,6 +41,8 @@ import no.ntnu.idata2001.contacts.views.ContactsApp;
*/
public class MainController {
private final Logger logger;
private AddressBook addressBook;
private ContactsApp parentView; // The parent View (GUI) class using this controller
// File used for object serialization. Used by the methods
// saveAddressBookToFile() and loadAddressBookFromFile()
......@@ -46,22 +51,41 @@ public class MainController {
/**
* Creates an instance of the MainController class, initialising
* the logger.
*
* @param parentView the view object using this instance as the controller
* in the MVC-pattern.
*/
public MainController() {
public MainController(ContactsApp parentView) {
this.logger = Logger.getLogger(getClass().toString());
this.parentView = parentView;
}
/**
* Initializes the controller. Called by the GUI-component after the GUI
* has been created.
*/
public void initialize() {
// Use the AddressBookDBHandler as AddressBook implementation
this.addressBook = new AddressBookDBHandler();
//this.addressBook = new AddressBookPlain();
}
/**
* Returns the address book.
* @return the address book.
*/
public AddressBook getAddressBook() {
return this.addressBook;
}
/**
* Display the input dialog to get input to create a new Contact.
* If the user confirms creating a new contact, a new instance
* of ContactDetails is created and added to the AddressBook provided.
*
* @param addressBook the address book to add the new contact to.
* @param parent the parent calling this method. Use this parameter to access public methods
* in the parent, like updateObservableList().
* @param actionEvent the actionevent triggering this call
*/
public void addContact(AddressBook addressBook, ContactsApp parent) {
public void addContact(ActionEvent actionEvent) {
ContactDetailsDialog contactsDialog = new ContactDetailsDialog();
......@@ -69,8 +93,8 @@ public class MainController {
if (result.isPresent()) {
ContactDetails newContactDetails = result.get();
addressBook.addContact(newContactDetails);
parent.updateObservableList();
this.addressBook.addContact(newContactDetails);
this.parentView.updateObservableList(this.addressBook);
}
}
......@@ -88,7 +112,16 @@ public class MainController {
ContactDetailsDialog contactDialog = new ContactDetailsDialog(selectedContact, true);
contactDialog.showAndWait();
parent.updateObservableList();
// The selectedContact now contains the updates. If the address book is
// stored in memory (implemented using one of the collection classes in the JDK
// or similar), we do not need to tell the address book that this instance
// has been changed. But if a DB is being used, the updated details
// must be stored/updeted in the DB too. Hence lets treat this change
// independent upon the address book being "in memory" or in a DB by
// calling the update()-method of the address book
this.addressBook.updateContact(selectedContact);
parent.updateObservableList(this.addressBook);
}
}
......@@ -99,31 +132,22 @@ public class MainController {
*
* @param selectedContact the Contact to delete. If no Contact has been selected,
* this parameter will be <code>null</code>
* @param addressBook the contact register to delete the selectedContact from
* @param parent the parent view making the call.
*/
public void deleteContact(ContactDetails selectedContact,
AddressBook addressBook,
ContactsApp parent) {
public void deleteContact(ContactDetails selectedContact) {
if (selectedContact == null) {
showPleaseSelectItemDialog();
} else {
if (showDeleteConfirmationDialog()) {
addressBook.removeContact(selectedContact.getPhone());
parent.updateObservableList();
this.addressBook.removeContact(selectedContact.getPhone());
this.parentView.updateObservableList(this.addressBook);
}
}
}
/**
* Import contacts from a .CSV-file chosen by the user.
*
* @param addressBook the address book to import the read contacts into
* @param parent the parent making the call to this method. Used for refreshing the
* Observable list used by the TableView.
*/
public void importFromCsv(AddressBook addressBook, ContactsApp parent) {
public void importFromCsv() {
FileChooser fileChooser = new FileChooser();
// Set extension filter for .csv-file
......@@ -135,8 +159,8 @@ public class MainController {
File file = fileChooser.showOpenDialog(null);
if (file != null) {
try {
AddressBookFileHandler.importFromCsv(addressBook, file);
parent.updateObservableList();
AddressBookFileHandler.importFromCsv(this.addressBook, file);
this.parentView.updateObservableList(this.addressBook);
} catch (IOException ioe) {
Alert alert = new Alert(Alert.AlertType.ERROR);
alert.setTitle("File Import Error");
......@@ -149,10 +173,8 @@ public class MainController {
/**
* Export all contacts in the address book to a CSV-file specified by the user.
*
* @param addressBook the address book to export contacts from.
*/
public void exportToCsv(AddressBook addressBook) {
public void exportToCsv() {
FileChooser fileChooser = new FileChooser();
// Set extension filter for .csv-file
......@@ -164,7 +186,7 @@ public class MainController {
File file = fileChooser.showSaveDialog(null);
if (file != null) {
try {
AddressBookFileHandler.exportToCsv(addressBook, file);
AddressBookFileHandler.exportToCsv(this.addressBook, file);
} catch (IOException ioe) {
Alert alert = new Alert(Alert.AlertType.ERROR);
alert.setTitle("File Export Error");
......@@ -206,15 +228,6 @@ public class MainController {
return AddressBookFileHandler.loadFromFile(inFile);
}
/**
* Loads an entire AddressBook from a database.
*
* @return an address book populated by contact details loaded from the database.
*/
public AddressBook loadAddressBookFromDB() {
return new AddressBookDBHandler();
}
/**
* Exit the application. Displays a confirmation dialog.
*/
......@@ -236,13 +249,11 @@ public class MainController {
/**
* Displays an example of an alert (info) dialog. In this case an "about"
* type of dialog.
*
* @param version the version of the application, to be displayed in the dialog.
*/
public void showAboutDialog(String version) {
public void showAboutDialog() {
Alert alert = new Alert(Alert.AlertType.INFORMATION);
alert.setTitle("Information Dialog - About");
alert.setHeaderText("Contacts Register\nv" + version);
alert.setHeaderText("Contacts Register\nv" + AppVersion.VERSION);
alert.setContentText("A brilliant application created by\n"
+ "(C)Arne Styve\n"
+ "2020-03-16");
......@@ -306,7 +317,7 @@ public class MainController {
Optional<Pair<String, String>> result = dialog.showAndWait();
result.ifPresent(
usernamePassword -> logger.log(Level.INFO, "Username=" + usernamePassword.getKey()
usernamePassword -> logger.log(Level.INFO, () -> "Username=" + usernamePassword.getKey()
+ ", Password=" + usernamePassword.getValue()));
}
......
src/no/ntnu/idata2001/contacts/model/AddressBook.java
+ 7
− 0
View file @ 8cffe3da
......@@ -25,6 +25,13 @@ public interface AddressBook extends Serializable, Iterable<ContactDetails> {
*/
void removeContact(String phoneNumber);
/**
* Update the contact info for the given contact.
*
* @param contactDetails the contact details to update.
*/
void updateContact(ContactDetails contactDetails);
/**
* Returns all the contacts as a collection.
*
......
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment