Minor cleanup

Author: GearsAD

src/BigData/BigData.jl

@@ -4,6 +4,7 @@ include("entities/InMemoryDataStore.jl")
 include("entities/FileDataStore.jl")
 
 include("services/AbstractDataStore.jl")
+include("services/AbstractBigDataEntries.jl")
 include("services/InMemoryDataStore.jl")
 include("services/FileDataStore.jl")
 

src/BigData/entities/AbstractBigDataEntries.jl

@@ -1,54 +1,35 @@
-import Base: ==
-
 """
     $(TYPEDEF)
 GeneralBigDataEntry is a generic multipurpose data entry that creates a unique
 reproducible key using userId_robotId_sessionId_variableId_key.
 """
 mutable struct GeneralBigDataEntry <: AbstractBigDataEntry
     key::Symbol
-    storeKey::Symbol # Could swap this to string, but using it as an index later, it's better as a symbol I believe.
+    storeKey::Symbol # Could swap this to string, but using it as an index later, so better as a symbol I believe.
     createdTimestamp::DateTime
     lastUpdatedTimestamp::DateTime
     mimeType::String
 end
 
-## TODO: Move this
-function ==(a::GeneralBigDataEntry, b::GeneralBigDataEntry)
-    return a.key == b.key &&
-        a.storeKey == b.storeKey &&
-        a.mimeType == b.mimeType &&
-        Dates.value(a.createdTimestamp - b.createdTimestamp) < 1000 &&
-        Dates.value(a.lastUpdatedTimestamp - b.lastUpdatedTimestamp) < 1000 #1 second
-end
-
-
-# Clean up and move this.
 """
     $(SIGNATURES)
-Generates a unique key for the entry - userId_robotId_sessionId_variable_key.
+Internal function to generate a unique key for the entry - userId_robotId_sessionId_variable_key.
 Simple symbol.
 """
-function uniqueKey(dfg::G, v::V, key::Symbol)::Symbol where {G <: AbstractDFG, V <: AbstractDFGVariable}
+function _uniqueKey(dfg::G, v::V, key::Symbol)::Symbol where {G <: AbstractDFG, V <: AbstractDFGVariable}
     key = join(String.([dfg.userId, dfg.robotId, dfg.sessionId, label(v), String(key)]), "_")
     return Symbol(key)
 end
 
-GeneralBigDataEntry(key::Symbol,
-                    storeKey::Symbol;
+GeneralBigDataEntry(key::Symbol, storeKey::Symbol;
                     mimeType::String="application/octet-stream") =
-                        GeneralBigDataEntry(key, storeKey, now(), now(), mimeType)
+                    GeneralBigDataEntry(key, storeKey, now(), now(), mimeType)
 
-function GeneralBigDataEntry(dfg::G,
-                             var::V,
-                             key::Symbol;
+function GeneralBigDataEntry(dfg::G, var::V, key::Symbol;
                              mimeType::String="application/octet-stream") where {G <: AbstractDFG, V <: AbstractDFGVariable}
-    return GeneralBigDataEntry(key,
-                               uniqueKey(dfg, var, key),
-                               mimeType=mimeType)
+    return GeneralBigDataEntry(key, _uniqueKey(dfg, var, key), mimeType=mimeType)
 end
 
-# Types <: AbstractBigDataEntry
 """
     $(TYPEDEF)
 BigDataEntry in MongoDB.
@@ -61,7 +42,6 @@ struct MongodbBigDataEntry <: AbstractBigDataEntry
     #MIMEType::Symbol
 end
 
-
 """
     $(TYPEDEF)
 BigDataEntry in a file.

src/BigData/entities/FileDataStore.jl

@@ -7,19 +7,8 @@ struct FileDataStore <: AbstractDataStore{UInt8}
     FileDataStore(folder::String) = begin
         if !isdir(folder)
             @warn "Folder '$folder' doesn't exist - creating."
-             mkpath(folder)
+            mkpath(folder)
         end
         return new(folder)
     end
 end
-#
-# """
-#     $(SIGNATURES)
-# Create a file data store using a specific data type.
-# """
-# function FileDataStore(folder::String)
-#     if !isdir(folder)
-#         @warn "Folder '$folder' doesn't exist - creating."
-#     end
-#     return FileDataStore(folder)
-# end

src/BigData/services/AbstractBigDataEntries.jl

@@ -0,0 +1,17 @@
+import Base: ==
+
+function ==(a::GeneralBigDataEntry, b::GeneralBigDataEntry)
+    return a.key == b.key &&
+        a.storeKey == b.storeKey &&
+        a.mimeType == b.mimeType &&
+        Dates.value(a.createdTimestamp - b.createdTimestamp) < 1000 &&
+        Dates.value(a.lastUpdatedTimestamp - b.lastUpdatedTimestamp) < 1000 #1 second
+end
+
+function ==(a::MongodbBigDataEntry, b::MongodbBigDataEntry)
+    return a.key == b.key && a.oid == b.oid
+end
+
+function ==(a::FileBigDataEntry, b::FileBigDataEntry)
+    return a.key == b.key && a.filename == b.filename
+end