diff options
author | Pacien TRAN-GIRARD | 2014-06-05 00:40:36 +0200 |
---|---|---|
committer | Pacien TRAN-GIRARD | 2014-06-05 00:40:36 +0200 |
commit | cf9be831cf6fac6dedb9e7e9216d57fb0f4a642e (patch) | |
tree | 4da6e7c1df18d380cb8ced6fcc8a67f0c0112f2a /report | |
parent | 1ba6c5935bf395cb74dd6d0fe805152f0fb96f8c (diff) | |
download | esieequest-cf9be831cf6fac6dedb9e7e9216d57fb0f4a642e.tar.gz |
Update report
Diffstat (limited to 'report')
-rw-r--r-- | report/document.tex | 12 | ||||
-rw-r--r-- | report/organization.tex | 5 | ||||
-rw-r--r-- | report/packages.tex | 19 | ||||
-rw-r--r-- | report/progression.tex | 255 | ||||
-rw-r--r-- | report/project.tex | 3 | ||||
-rw-r--r-- | report/tools.tex | 3 | ||||
-rw-r--r-- | report/userguide.tex | 61 |
7 files changed, 213 insertions, 145 deletions
diff --git a/report/document.tex b/report/document.tex index c3ec4d1..405cb08 100644 --- a/report/document.tex +++ b/report/document.tex | |||
@@ -16,6 +16,8 @@ | |||
16 | 16 | ||
17 | \input{style/pascience-listings} | 17 | \input{style/pascience-listings} |
18 | 18 | ||
19 | \usepackage{hyperref} | ||
20 | |||
19 | 21 | ||
20 | %%%%%%%%%%%%%%%%%%%% | 22 | %%%%%%%%%%%%%%%%%%%% |
21 | %% DOCUMENT | 23 | %% DOCUMENT |
@@ -41,10 +43,6 @@ | |||
41 | 43 | ||
42 | \cleardoublepage | 44 | \cleardoublepage |
43 | 45 | ||
44 | \input{organization} | ||
45 | |||
46 | \cleardoublepage | ||
47 | |||
48 | \input{packages} | 46 | \input{packages} |
49 | 47 | ||
50 | \cleardoublepage | 48 | \cleardoublepage |
@@ -61,10 +59,10 @@ | |||
61 | \end{appendices} | 59 | \end{appendices} |
62 | 60 | ||
63 | 61 | ||
64 | \cleardoublepage | 62 | %\cleardoublepage |
65 | 63 | ||
66 | \bibliographystyle{unsrt} | 64 | %\bibliographystyle{unsrt} |
67 | \bibliography{bibliography} | 65 | %\bibliography{bibliography} |
68 | 66 | ||
69 | 67 | ||
70 | \end{document} \ No newline at end of file | 68 | \end{document} \ No newline at end of file |
diff --git a/report/organization.tex b/report/organization.tex deleted file mode 100644 index 4ca7bc6..0000000 --- a/report/organization.tex +++ /dev/null | |||
@@ -1,5 +0,0 @@ | |||
1 | \chapter{Work organization} | ||
2 | |||
3 | \section{Schedule} | ||
4 | |||
5 | \section{Task assignments} | ||
diff --git a/report/packages.tex b/report/packages.tex index dde1d0b..e8bec09 100644 --- a/report/packages.tex +++ b/report/packages.tex | |||
@@ -5,23 +5,34 @@ were used in this project. | |||
5 | 5 | ||
6 | \section{StretchIcon} | 6 | \section{StretchIcon} |
7 | 7 | ||
8 | StretchIcon enables the resize of the Room illustration according to the | 8 | StretchIcon enabled the resize of the Room illustration according to the |
9 | window's size in the rich Swing GUI, keeping a correct ratio. | 9 | window's size in the rich Swing GUI, keeping a correct ratio. |
10 | 10 | ||
11 | \section{Guava} | ||
12 | 11 | ||
12 | \section{Guava} | ||
13 | 13 | ||
14 | \section{Intrinsic Map} | 14 | Guava, from Google, contains several collections, caching, primitives support, |
15 | concurrency, annotations and string processing utilities. | ||
15 | 16 | ||
16 | 17 | ||
18 | \section{Lombok} | ||
17 | 19 | ||
18 | \section{Google Web Toolkit} | 20 | Lombok helped avoiding writing dozens of getters and setters by replacing them |
21 | with shorter annotations. | ||
19 | 22 | ||
20 | 23 | ||
24 | \section{Intrinsic Map} | ||
21 | 25 | ||
26 | As Items were already containing there names in a field, HashMap<String, Item> | ||
27 | were redundant. IntrinsicMap<Item> and the Mappable interface were created to | ||
28 | avoid this redundance. | ||
22 | 29 | ||
23 | 30 | ||
31 | \section{Google Web Toolkit} | ||
24 | 32 | ||
33 | The Google Web Toolkit was used to create the web version of the game. | ||
34 | It permitted the compilation of Java sources to Javascript code executable | ||
35 | directly inside a web browser, without requiring the Java Virtual Machine. | ||
25 | 36 | ||
26 | 37 | ||
27 | \section{JSON Simple} | 38 | \section{JSON Simple} |
diff --git a/report/progression.tex b/report/progression.tex index cca0477..cd3f4ec 100644 --- a/report/progression.tex +++ b/report/progression.tex | |||
@@ -4,48 +4,48 @@ | |||
4 | 4 | ||
5 | \subsection{printLocationInfo} | 5 | \subsection{printLocationInfo} |
6 | 6 | ||
7 | e52a34789 - This code duplication has been previously avoided with the | 7 | e52a34789 - Pacien - This code duplication has been previously avoided with the |
8 | printRoomInfo() method. | 8 | printRoomInfo() method. |
9 | It has been renamed to printLocationInfo() to match the exercise. | 9 | It has been renamed to printLocationInfo() to match the exercise. |
10 | 10 | ||
11 | \subsection{getExit} | 11 | \subsection{getExit} |
12 | 12 | ||
13 | 53c427ff3 - The exit attributes have been made private and a getter has been | 13 | 53c427ff3 - Pacien - The exit attributes have been made private and a getter has |
14 | added. | 14 | been added. |
15 | A switch statement has been used instead of multiple if statements. | 15 | A switch statement has been used instead of multiple if statements. |
16 | 16 | ||
17 | \subsection{getExitString} | 17 | \subsection{getExitString} |
18 | 18 | ||
19 | ca65af2e2 - This method, which returns a String containing the informations | 19 | ca65af2e2 - Pacien - This method, which returns a String containing the |
20 | about the Room's exits, has been added. | 20 | informations about the Room's exits, has been added. |
21 | 21 | ||
22 | \subsection{HashMap, setExit} | 22 | \subsection{HashMap, setExit} |
23 | 23 | ||
24 | c9d890b9b - Room exits are now stored in an HashMap. The setExits() method has | 24 | c9d890b9b - Pacien - Room exits are now stored in an HashMap. The setExits() |
25 | been replaced by setExit() which takes advantages of the HashMap. | 25 | method has been replaced by setExit() which takes advantages of the HashMap. |
26 | 26 | ||
27 | \subsection{Vertical direction} | 27 | \subsection{Vertical direction} |
28 | 28 | ||
29 | 4145a5e8c - The getExitString() method has been modified to be able to | 29 | 4145a5e8c - Pacien - The getExitString() method has been modified to be able to |
30 | print the availability of the new exits, used in the stairwell at wing 3. Due | 30 | print the availability of the new exits, used in the stairwell at wing 3. Due |
31 | to the architecture of these rooms, the side exits that were previously settled | 31 | to the architecture of these rooms, the side exits that were previously settled |
32 | to link them have been kept. | 32 | to link them have been kept. |
33 | 33 | ||
34 | \subsection{keySet ?} | 34 | \subsection{keySet ?} |
35 | 35 | ||
36 | The keySet() method of the class HashMap returns a Set of the keys | 36 | Benoît - The keySet() method of the class HashMap returns a Set of the keys |
37 | associated to values stored in the Map. | 37 | associated to values stored in the Map. |
38 | 38 | ||
39 | \subsection{getExitString ?} | 39 | \subsection{getExitString ?} |
40 | 40 | ||
41 | The getExitString() method returns a String listing the Room's exits. | 41 | Benoît - The getExitString() method returns a String listing the Room's exits. |
42 | To achieve that, it iterates through the exits Map's keys, which is a Set of | 42 | To achieve that, it iterates through the exits Map's keys, which is a Set of |
43 | String-s, appending each one to the String that it returns. | 43 | String-s, appending each one to the String that it returns. |
44 | 44 | ||
45 | \subsection{getLongDescription} | 45 | \subsection{getLongDescription} |
46 | 46 | ||
47 | e510b08d0 - The Room class now uses the previously explained getExitString() | 47 | e510b08d0 - Pacien - The Room class now uses the previously explained |
48 | method and includes the getLongDescription() method that returns the full description of | 48 | getExitString() method and includes the getLongDescription() method that returns the full description of |
49 | the room. | 49 | the room. |
50 | 50 | ||
51 | 51 | ||
@@ -53,12 +53,13 @@ the room. | |||
53 | 53 | ||
54 | \subsection{look} | 54 | \subsection{look} |
55 | 55 | ||
56 | 698e3cd25 - The look command, which prints informations about the current Room, | 56 | 698e3cd25 - Benoît - The look command, which prints informations about the |
57 | has been added. | 57 | current Room, has been added. |
58 | 58 | ||
59 | \subsection{eat} | 59 | \subsection{eat} |
60 | 60 | ||
61 | 40b9b4816 - The eat command, that just prints a special message, has been added. | 61 | 40b9b4816 - Benoît - The eat command, that just prints a special message, has |
62 | been added. | ||
62 | This command has then been deleted later in the development since it was | 63 | This command has then been deleted later in the development since it was |
63 | useless in the scenario. | 64 | useless in the scenario. |
64 | 65 | ||
@@ -66,77 +67,79 @@ useless in the scenario. | |||
66 | 67 | ||
67 | \subsection{showAll, showCommands} | 68 | \subsection{showAll, showCommands} |
68 | 69 | ||
69 | 79d33230b - Theses methods have been implemented. | 70 | 79d33230b - Pacien - Theses methods have been implemented. |
70 | 71 | ||
71 | \subsection{Adding commands} | 72 | \subsection{Adding commands} |
72 | 73 | ||
73 | Adding new commands would not require modifying the printHelp() method anymore. | 74 | Benoît - Adding new commands would not require modifying the printHelp() method |
75 | anymore. | ||
74 | However, adding new commands and related functions would still require editing | 76 | However, adding new commands and related functions would still require editing |
75 | the Game class and its processCommand() method. | 77 | the Game class and its processCommand() method. |
76 | 78 | ||
77 | \subsection{getCommandList} | 79 | \subsection{getCommandList} |
78 | 80 | ||
79 | 5f1d0ada2 - The command list is not printed in the CommandWords class anymore. | 81 | 5f1d0ada2 - Benoît - The command list is not printed in the CommandWords class |
82 | anymore. | ||
80 | Instead, this class returns a String, forwarded by the Parser class, that is | 83 | Instead, this class returns a String, forwarded by the Parser class, that is |
81 | then printed in the Game class. | 84 | then printed in the Game class. |
82 | 85 | ||
83 | \subsection{Comparison with reference} | 86 | \subsection{Comparison with reference} |
84 | 87 | ||
85 | 590a932e5 - The printLocationInfo() method, used only twice, has been trimmed | 88 | 590a932e5 - Pacien - The printLocationInfo() method, used only twice, has been |
86 | and has been replaced by a call to the getLongDescription() method of the Room | 89 | trimmed and has been replaced by a call to the getLongDescription() method of the Room |
87 | class. | 90 | class. |
88 | 91 | ||
89 | f84606424 - A missing getter for the Room description has been added. | 92 | f84606424 - Benoît - A missing getter for the Room description has been added. |
90 | 93 | ||
91 | 0c5793abf - The loop building the command list String has been modified to use | 94 | 0c5793abf - Benoît - The loop building the command list String has been modified |
92 | an Iterator. | 95 | to use an Iterator. |
93 | 96 | ||
94 | \subsection{StringBuil |