Merge pull request #27 from aminya/mutability

Mutability

Author: aminya

README.md

@@ -34,21 +34,21 @@ Use `@aml` macro to define a Julia type, and then the package automatically crea
 ### Document Defnition
 * Use `xd""` or `hd""` to define a XML or HTML document:
 ```julia
-@aml struct Doc xd""
+@aml mutable struct Doc xd""
   # add fields (elements) here
 end
 ```
 
 ### Nodes (Elements) Defnition
 * Specify the html/xml struct name as a string after the struct name after a space
 ```julia
-@aml struct Person "person"
+@aml mutable struct Person "person"
   # add fields (elements) here
 end
 ```
 * If the html/xml name is the same as struct name, you can use `"~"` instead
 ```julia
-@aml struct person "~"
+@aml mutable struct person "~"
   # add fields (elements) here
 end
 ```
@@ -98,7 +98,7 @@ GPA::Float64, "~", GPAcheck
 
 * To define any restrictions for multiple values of a struct, define a function that gets all the variables and checks a criteria and returns Bool, and put its name after a `,` after the struct name:
 ```julia
-@aml struct Person "person", courseCheck
+@aml mutable struct Person "person", courseCheck
 # ...
 end
 ```
@@ -129,22 +129,23 @@ using AcuteML
 # Types definition
 
 # Person Type
-@aml struct Person "person", courseCheck
-    age::UInt, "~"
+@aml mutable struct Person "person", courseCheck
+    age::UInt64, "~"
     field, "study-field"
     GPA::Float64 = 4.5, "~", GPAcheck
     courses::Vector{String}, "taken-courses"
     id::Int64, a"~"
 end
 
-@aml struct University "university"
+@aml mutable struct University "university"
     name, a"university-name"
     people::Vector{Person}, "person"
 end
 
-@aml struct Doc xd""
+@aml mutable struct Doc xd""
     university::University, "~"
 end
+
 ```
 
 ```julia
@@ -173,6 +174,8 @@ end
 P1 = Person(age=24, field="Mechanical Engineering", courses=["Artificial Intelligence", "Robotics"], id = 1)
 P2 = Person(age=18, field="Computer Engineering", GPA=4, courses=["Julia"], id = 2)
 
+P2.GPA=4.2 # mutability support
+
 U = University(name="Julia University", people=[P1, P2])
 
 D = Doc(university = U)
@@ -207,7 +210,7 @@ julia> print(U.aml)
   <person id="2">
     <age>18</age>
     <study-field>Computer Engineering</study-field>
-    <GPA>4</GPA>
+    <GPA>4.2</GPA>
     <taken-courses>Julia</taken-courses>
   </person>
 </university>
@@ -225,12 +228,11 @@ julia> print(D.aml)
   <person id="2">
     <age>18</age>
     <study-field>Computer Engineering</study-field>
-    <GPA>4</GPA>
+    <GPA>4.2</GPA>
     <taken-courses>Julia</taken-courses>
   </person>
 </university>
 ```
-
 -------------------------------------------------------
 
 # Example - Extractor

docs/src/index.md

@@ -31,21 +31,21 @@ Use `@aml` macro to define a Julia type, and then the package automatically crea
 ### Document Defnition
 * Use `xd""` or `hd""` to define a XML or HTML document:
 ```julia
-@aml struct Doc xd""
+@aml mutable struct Doc xd""
   # add fields (elements) here
 end
 ```
 
 ### Nodes (Elements) Defnition
 * Specify the html/xml struct name as a string after the struct name after a space
 ```julia
-@aml struct Person "person"
+@aml mutable struct Person "person"
   # add fields (elements) here
 end
 ```
 * If the html/xml name is the same as struct name, you can use `"~"` instead
 ```julia
-@aml struct person "~"
+@aml mutable struct person "~"
   # add fields (elements) here
 end
 ```
@@ -95,7 +95,7 @@ GPA::Float64, "~", GPAcheck
 
 * To define any restrictions for multiple values of a struct, define a function that gets all the variables and checks a criteria and returns Bool, and put its name after a `,` after the struct name:
 ```julia
-@aml struct Person "person", courseCheck
+@aml mutable struct Person "person", courseCheck
 # ...
 end
 ```

examples/constructor.jl

@@ -1,20 +1,21 @@
 using AcuteML
 
 # Type Definition
-@aml struct Person "person", courseCheck
-    age::UInt, "~"
+
+@aml mutable struct Person "person", courseCheck
+    age::UInt64, "~"
     field, "study-field"
     GPA::Float64 = 4.5, "~", GPAcheck
     courses::Vector{String}, "taken-courses"
     id::Int64, a"~"
 end
 
-@aml struct University "university"
+@aml mutable struct University "university"
     name, a"university-name"
     people::Vector{Person}, "person"
 end
 
-@aml struct Doc xd""
+@aml mutable struct Doc xd""
     university::University, "~"
 end
 
@@ -38,18 +39,25 @@ end
 # Constructor
 
 P1 = Person(age=24, field="Mechanical Engineering", courses=["Artificial Intelligence", "Robotics"], id = 1)
-P2 = Person(age=18, field="Computer Engineering", GPA=4, courses=["Julia"], id = 2)
 
-U = University(name="Julia University", people=[P1, P2])
+P2 = Person(age=18, field="Computer Engineering", GPA=4, courses=["Julia"], id = 2)
 
-D = Doc(university = U)
+P2.GPA=4.2 # mutability support
 
-# An example that doesn't meet the critertia function for GPA because GPA is more than 4.5
+# Two examples that doesn't meet the critertia function for GPA because GPA is more than 4.5
 #=
 P3 = Person(age=99, field="Macro Wizard", GPA=10, courses=["Julia Magic"], id = 3)
-#GPA doesn't meet criteria function
+# GPA doesn't meet criteria function
+
+P1.GPA=5.0
+# GPA doesn't meet criteria function
 =#
 
+U = University(name="Julia University", people=[P1, P2])
+
+D = Doc(university = U)
+
+
 print(P1.aml)
 #=
 <person id="1">
@@ -66,7 +74,7 @@ print(P2.aml)
 <person id="2">
   <age>18</age>
   <study-field>Computer Engineering</study-field>
-  <GPA>4</GPA>
+  <GPA>4.2</GPA>
   <taken-courses>Julia</taken-courses>
 </person>
 =#
@@ -84,7 +92,7 @@ print(U.aml)
   <person id="2">
     <age>18</age>
     <study-field>Computer Engineering</study-field>
-    <GPA>4</GPA>
+    <GPA>4.2</GPA>
     <taken-courses>Julia</taken-courses>
   </person>
 </university>
@@ -104,7 +112,7 @@ print(D.aml)
   <person id="2">
     <age>18</age>
     <study-field>Computer Engineering</study-field>
-    <GPA>4</GPA>
+    <GPA>4.2</GPA>
     <taken-courses>Julia</taken-courses>
   </person>
 </university>

examples/extractor.jl

@@ -1,23 +1,24 @@
 using AcuteML
 
 # Type Definition
-@aml struct Person "person", courseCheck
-    age::UInt, "~"
+@aml mutable struct Person "person", courseCheck
+    age::UInt64, "~"
     field, "study-field"
     GPA::Float64 = 4.5, "~", GPAcheck
     courses::Vector{String}, "taken-courses"
     id::Int64, a"~"
 end
 
-@aml struct University "university"
+@aml mutable struct University "university"
     name, a"university-name"
     people::Vector{Person}, "person"
 end
 
-@aml struct Doc xd""
+@aml mutable struct Doc xd""
     university::University, "~"
 end
 
+
 # Value Checking Functions
 GPAcheck(x) = x <= 4.5 && x >= 0