Recent changes to Programmer documentation

Programmer documentation modified by Máté Kovács

Máté Kovács — Sun, 11 Jan 2015 15:11:51 -0000

--- v11
+++ v12
@@ -30,7 +30,7 @@
 During the development of the classes I wrote unit tests. Those unit tests are part of the project, with *DEBUG_MODE* predefinition a copy of the program can be built with those unit tests.

 ###### 2. case of test ######
-After creating the *Handler* class as well I tested the methods with incorrect values and types.
+After creating the *Handler* class as well I tested the methods with incorrect values and types. I tested the system with values at the limits. I made a lot of test to make sure of the system's stability.

 ###### 3. case of tests ######
 1. After creating the *Handler* class as well I tested the program with these commands.

Programmer documentation modified by Máté Kovács

Máté Kovács — Sun, 11 Jan 2015 15:10:02 -0000

--- v10
+++ v11
@@ -23,7 +23,7 @@

 You can't add conditions to the **ROW LIST** and **ROW DELETE** commands which tries to find rows that have *NULL* as value. It's because you don't have to indicate *string* type, so NULL in a condition is handled like a string value such as "NULL". And you should avoid making conditions which have '<', '>' or '=' characters in the search value (these are not tested).

-Header elements of *Table*s can't contain '<', '>' or '=' characters, because when you want to give a condition, you don't have to indicate which part of the command is the header name, the operator and the search value. This case is not built into the program, so you can give name such as "this>is=wrong" to a header element, but when you want to list rows which match the condition "this>is=wrong=apple", then the program'll throw an exception (can't find a header with the given name "this").
+*Header* elements of *Table*s can't contain '<', '>' or '=' characters, because when you want to give a condition, you don't have to indicate which part of the command is the header name, the operator and the search value. This case is not built into the program, so you can give name such as "this>is=wrong" to a header element, but when you want to list rows which match the condition "this>is=wrong=apple", then the program'll throw an exception (can't find a header with the given name "this").

 ### Testing of the system ###
 ###### 1. case of tests ######

Programmer documentation modified by Máté Kovács

Máté Kovács — Sun, 11 Jan 2015 15:09:31 -0000

--- v9
+++ v10
@@ -17,16 +17,23 @@

 ### Implementation ###
 Nearly every class uses only one other class from the project. It's like a linear line of the classes
-(***main program <- Handler <- Database <- Table <- HeaderElement and Row <- ValueElement***). But there is structure which can contain every type of a value field, this is RowElement. And there are two enumeration types, those and RowElement are used in every classes, so they are in a special header file (*header.h*).
+(***main program <- Handler <- Database <- Table <- HeaderElement and Row <- ValueElement***). But there is structure which can contain every type of a value field, this is *RowElement*. And there are two enumeration types, those and *RowElement* are used in every classes, so they are in a special header file (*header.h*).

-Table class has a private variable **actualPosition**, this variable counts the actual position in a row (when you add new element to a row). So when you use *Table* class without *Database*, you can make mistakes if you don't add enough (or you add too many) row elements to a row. When you use *Database* class, this part of *Table* is safe, because *Database* class handles the exceptions and tries to add the exact number of elements to tha *Table*.
+*Table* class has a private variable **actualPosition**, this variable counts the actual position in a row (when you add new element to a row). So when you use *Table* class without *Database*, you can make mistakes if you don't add enough (or you add too many) row elements to a row. When you use *Database* class, this part of *Table* is safe, because *Database* class handles the exceptions and tries to add the exact number of elements to tha *Table*.
+
+You can't add conditions to the **ROW LIST** and **ROW DELETE** commands which tries to find rows that have *NULL* as value. It's because you don't have to indicate *string* type, so NULL in a condition is handled like a string value such as "NULL". And you should avoid making conditions which have '<', '>' or '=' characters in the search value (these are not tested).
+
+Header elements of *Table*s can't contain '<', '>' or '=' characters, because when you want to give a condition, you don't have to indicate which part of the command is the header name, the operator and the search value. This case is not built into the program, so you can give name such as "this>is=wrong" to a header element, but when you want to list rows which match the condition "this>is=wrong=apple", then the program'll throw an exception (can't find a header with the given name "this").

 ### Testing of the system ###
 ###### 1. case of tests ######
-During the development of the classes I wrote unit tests. Those unit tests are part of the project, with DEBUG_MODE predefinition a copy of the program can be built with those unit tests.
+During the development of the classes I wrote unit tests. Those unit tests are part of the project, with *DEBUG_MODE* predefinition a copy of the program can be built with those unit tests.

-###### 2. case of tests ######
-1. After creating the Handler class as well I tested the program with these commands.
+###### 2. case of test ######
+After creating the *Handler* class as well I tested the methods with incorrect values and types.
+
+###### 3. case of tests ######
+1. After creating the *Handler* class as well I tested the program with these commands.
 + DATABASE CREATE test
 + DATABASE CREATE test
 Error: already exists

Programmer documentation modified by Máté Kovács

Máté Kovács — Sun, 11 Jan 2015 14:58:58 -0000

--- v8
+++ v9
@@ -16,7 +16,10 @@
 + 2015/01/11 User documentation /support/ - 1 day before due date

 ### Implementation ###
+Nearly every class uses only one other class from the project. It's like a linear line of the classes
+(***main program <- Handler <- Database <- Table <- HeaderElement and Row <- ValueElement***). But there is structure which can contain every type of a value field, this is RowElement. And there are two enumeration types, those and RowElement are used in every classes, so they are in a special header file (*header.h*).

+Table class has a private variable **actualPosition**, this variable counts the actual position in a row (when you add new element to a row). So when you use *Table* class without *Database*, you can make mistakes if you don't add enough (or you add too many) row elements to a row. When you use *Database* class, this part of *Table* is safe, because *Database* class handles the exceptions and tries to add the exact number of elements to tha *Table*.

 ### Testing of the system ###
 ###### 1. case of tests ######

Programmer documentation modified by Máté Kovács

Máté Kovács — Sat, 10 Jan 2015 16:55:27 -0000

Programmer documentation modified by Máté Kovács

Máté Kovács — Sat, 10 Jan 2015 15:56:42 -0000

--- v6
+++ v7
@@ -16,6 +16,7 @@
 + 2015/01/11 User documentation /support/ - 1 day before due date

 ### Implementation ###
+

 ### Testing of the system ###
 ###### 1. case of tests ######
@@ -72,7 +73,7 @@
 + ROW LIST t1
 + ROW LIST t1 WHERE avg=2.2
 + ROW LIST t1 WHERE avg=3.45
-+ ROW ADD [3,Marosi Marta,4.5,FALSE,TRUE] TO t1
++ ROW ADD \[3,Marosi Marta,4.5,FALSE,TRUE\] TO t1
 + ROW DELETE t1 WHERE avg>3.5
 + ROW LIST t1
 + DATABASE CLOSE

Programmer documentation modified by Máté Kovács

Máté Kovács — Sat, 10 Jan 2015 15:54:49 -0000

--- v5
+++ v6
@@ -72,6 +72,9 @@
 + ROW LIST t1
 + ROW LIST t1 WHERE avg=2.2
 + ROW LIST t1 WHERE avg=3.45
++ ROW ADD [3,Marosi Marta,4.5,FALSE,TRUE] TO t1
++ ROW DELETE t1 WHERE avg>3.5
++ ROW LIST t1
 + DATABASE CLOSE
 + DATABASE OPEN test2
 + DATABASE REMOVE test3

Programmer documentation modified by Máté Kovács

Máté Kovács — Sat, 10 Jan 2015 15:45:04 -0000

--- v4
+++ v5
@@ -42,12 +42,12 @@
 + TABLE CREATE t1 WITH \[pid:0:INT\]
 Error: already exists
 + TABLE CREATE t2 WITH \[pid:0:INT\]
-+ ROW ADD [1] TO t2
-+ ROW ADD [2] TO t2
++ ROW ADD \[1\] TO t2
++ ROW ADD \[2\] TO t2
 + ROW LIST t2
 + TABLE EMPTY t2
 + ROW LIST t2
-+ ROW ADD [1] TO t2
++ ROW ADD \[1\] TO t2
 + ROW LIST t2
 + TABLE DELETE t2
 + TABLE DELETE t2

Programmer documentation modified by Máté Kovács

Máté Kovács — Sat, 10 Jan 2015 15:44:39 -0000

--- v3
+++ v4
@@ -39,9 +39,9 @@
 Error: format is bad
 + TABLE ADD valami:1:DOBLE TO t1
 Error: format is bad
-+ TABLE CREATE t1 WITH [pid:0:INT]
++ TABLE CREATE t1 WITH \[pid:0:INT\]
 Error: already exists
-+ TABLE CREATE t2 WITH [pid:0:INT]
++ TABLE CREATE t2 WITH \[pid:0:INT\]
 + ROW ADD [1] TO t2
 + ROW ADD [2] TO t2
 + ROW LIST t2
@@ -53,13 +53,13 @@
 + TABLE DELETE t2
 Error: no table 't2'
 + ROW LIST t1
-+ ROW ADD [1,Kovacs Mate,NULL,TRUE,TRUE] TO t1
-+ ROW ADD [1,Kovacs Mate,NULL,NULL,TRUE] TO t1
++ ROW ADD \[1,Kovacs Mate,NULL,TRUE,TRUE\] TO t1
++ ROW ADD \[1,Kovacs Mate,NULL,NULL,TRUE\] TO t1
 Error: format is bad
-+ ROW ADD [1,Kovacs Mate,NULL,TRUE,NULL] TO t1
-+ ROW ADD [2,Horvath Adam,3.45,TRUE,FALSE] TO t1
-+ ROW ADD [3,Csaba Gyula,2.2,FALSE,NULL] TO t1
-+ ROW ADD [4,Tirpak Zoltan,5.0,FALSE,TRUE] TO t1
++ ROW ADD \[1,Kovacs Mate,NULL,TRUE,NULL\] TO t1
++ ROW ADD \[2,Horvath Adam,3.45,TRUE,FALSE\] TO t1
++ ROW ADD \[3,Csaba Gyula,2.2,FALSE,NULL\] TO t1
++ ROW ADD \[4,Tirpak Zoltan,5.0,FALSE,TRUE\] TO t1
 + ROW LIST t1
 + ROW LIST t1 WHERE tarokk2=valami
 Error: header is missing

Programmer documentation modified by Máté Kovács

Máté Kovács — Sat, 10 Jan 2015 15:43:40 -0000

--- v2
+++ v3
@@ -14,3 +14,66 @@
 + 2015/01/10 The working program /implementation, testing, release/ - 3 weeks delay
 + 2015/01/10 Developer documentation /support/ - 3 weeks delay
 + 2015/01/11 User documentation /support/ - 1 day before due date
+
+### Implementation ###
+
+### Testing of the system ###
+###### 1. case of tests ######
+During the development of the classes I wrote unit tests. Those unit tests are part of the project, with DEBUG_MODE predefinition a copy of the program can be built with those unit tests.
+
+###### 2. case of tests ######
+1. After creating the Handler class as well I tested the program with these commands.
++ DATABASE CREATE test
++ DATABASE CREATE test
+Error: already exists
++ DATABASE CREATE test2
++ DATABASE OPEN test
++ DATABASE OPEN test
+Error: already opened database
++ TABLE CREATE t1 WITH \[id:0:INT,name:0:STRING,avg:1:DOUBLE,bentlako:0:BOOL\]
++ TABLE ADD tarokk:1:BOOL TO t1
++ ROW LIST t1
++ TABLE ADD tarokk:0:DOUBLE TO t1
+Error: already exists
++ TABLE ADD valami:2:DOUBLE TO t1
+Error: format is bad
++ TABLE ADD valami:1:DOBLE TO t1
+Error: format is bad
++ TABLE CREATE t1 WITH [pid:0:INT]
+Error: already exists
++ TABLE CREATE t2 WITH [pid:0:INT]
++ ROW ADD [1] TO t2
++ ROW ADD [2] TO t2
++ ROW LIST t2
++ TABLE EMPTY t2
++ ROW LIST t2
++ ROW ADD [1] TO t2
++ ROW LIST t2
++ TABLE DELETE t2
++ TABLE DELETE t2
+Error: no table 't2'
++ ROW LIST t1
++ ROW ADD [1,Kovacs Mate,NULL,TRUE,TRUE] TO t1
++ ROW ADD [1,Kovacs Mate,NULL,NULL,TRUE] TO t1
+Error: format is bad
++ ROW ADD [1,Kovacs Mate,NULL,TRUE,NULL] TO t1
++ ROW ADD [2,Horvath Adam,3.45,TRUE,FALSE] TO t1
++ ROW ADD [3,Csaba Gyula,2.2,FALSE,NULL] TO t1
++ ROW ADD [4,Tirpak Zoltan,5.0,FALSE,TRUE] TO t1
++ ROW LIST t1
++ ROW LIST t1 WHERE tarokk2=valami
+Error: header is missing
++ ROW LIST t1 WHERE tarokk=4
+Error: header is missing
++ ROW LIST t1 WHERE tarokk=TRUE
++ ROW DELETE t1 WHERE tarokk=TRUE
++ ROW LIST t1
++ ROW DELETE t1 WHERE name=Csaba Gyula
++ ROW LIST t1
++ ROW LIST t1 WHERE avg=2.2
++ ROW LIST t1 WHERE avg=3.45
++ DATABASE CLOSE
++ DATABASE OPEN test2
++ DATABASE REMOVE test3
+Error: no database
++ DATABASE REMOVE test2