Merge pull request #613 from JuliaRobotics/maint/20Q3/docs_and_cleanup

Fix docs and cleanup deprecated

Author: Affie

test/DataStoreTests.jl renamed to attic/DataStoreTests.jl

@@ -79,7 +79,3 @@ sleep(0.1)
 #TODO
     #listStoreEntries(ds)
 end
-
-1320*4
-
-3600+2200

docs/src/func_ref.md

@@ -133,18 +133,16 @@ Modules = [CloudGraphsDFGs]
 
 
 
-## Big Data
+## Data Entries and Blobs
 
 ```@autodocs
 Modules = [DistributedFactorGraphs]
 
-Pages = ["entities/AbstractBigDataEntries.jl",
-        "entities/AbstractDataStore.jl",
-        "entities/FileDataStore.jl",
-        "entities/InMemoryDataStore.jl",
-        "services/AbstractBigDataEntries.jl",
-        "services/AbstractDataStore.jl",
-        "services/FileDataStore.jl",
-        "services/InMemoryDataStore.jl"]
+Pages = ["entities/AbstractDataEntries.jl",
+        "services/AbstractDataEntries.jl",
+        "services/BlobStores.jl",
+        "services/DataEntryBlob.jl",
+        "services/FileDataEntryBlob.jl",
+        "services/InMemoryDataEntryBlob.jl"]
 
 ```

src/DataBlobs/DataBlobs.jl

@@ -15,7 +15,6 @@ include("services/InMemoryDataEntryBlob.jl")
 
 
 export AbstractDataEntry, GeneralDataEntry, MongodbDataEntry, FileDataEntry
-export InMemoryDataStore, FileDataStore
 
 export getData, addData!, updateData!, deleteData!, listStoreEntries
 export getDataBlob, addDataBlob!, updateDataBlob!, deleteDataBlob!, listDataBlobs

src/DataBlobs/services/AbstractDataEntries.jl

@@ -26,7 +26,7 @@ buildSourceString(dfg::AbstractDFG, label::Symbol) =
 
 """
     $(SIGNATURES)
-Get big data entry
+Get data entry
 """
 function getDataEntry(var::AbstractDFGVariable, key::Symbol)
     !hasDataEntry(var, key) && error("Data entry $(key) does not exist in variable")
@@ -39,7 +39,7 @@ end
 
 """
     $(SIGNATURES)
-Add Big Data Entry to a DFG variable
+Add Data Entry to a DFG variable
 """
 function addDataEntry!(var::AbstractDFGVariable, bde::AbstractDataEntry)
     haskey(var.dataDict, bde.label) && error("Data entry $(bde.label) already exists in variable")
@@ -50,7 +50,7 @@ end
 
 """
     $(SIGNATURES)
-Add Big Data Entry to distributed factor graph.
+Add Data Entry to distributed factor graph.
 Should be extended if DFG variable is not returned by reference.
 """
 function addDataEntry!(dfg::AbstractDFG, label::Symbol, bde::AbstractDataEntry)
@@ -60,7 +60,7 @@ end
 
 """
     $(SIGNATURES)
-Update big data entry
+Update data entry
 
 DevNote
 - DF, unclear if `update` verb is applicable in this case, see #404
@@ -77,23 +77,23 @@ end
 
 """
     $(SIGNATURES)
-Delete big data entry from the factor graph.
+Delete data entry from the factor graph.
 Note this doesn't remove it from any data stores.
 
 Notes:
-- users responsibility to delete big data in db before deleting entry
+- users responsibility to delete data in db before deleting entry
 """
 function deleteDataEntry!(var::AbstractDFGVariable, key::Symbol)
     return pop!(var.dataDict, key)
 end
 function deleteDataEntry!(dfg::AbstractDFG, label::Symbol, key::Symbol)
-    #users responsibility to delete big data in db before deleting entry
+    #users responsibility to delete data in db before deleting entry
     # !isVariable(dfg, label) && return nothing
     return deleteDataEntry!(getVariable(dfg, label), key)
 end
 
 function deleteDataEntry!(var::AbstractDFGVariable, entry::AbstractDataEntry)
-    #users responsibility to delete big data in db before deleting entry
+    #users responsibility to delete data in db before deleting entry
     return deleteDataEntry!(var, entry.label)
 end
 
@@ -111,7 +111,7 @@ hasDataEntry(var::DFGVariable, key::Symbol) = haskey(var.dataDict, key)
 
 """
     $(SIGNATURES)
-Get big data entries, Vector{AbstractDataEntry}
+Get data entries, Vector{AbstractDataEntry}
 """
 function getDataEntries(var::AbstractDFGVariable)
     #or should we return the iterator, Base.ValueIterator{Dict{Symbol,AbstractDataEntry}}?

src/DataBlobs/services/DataEntryBlob.jl

@@ -65,15 +65,15 @@ function addData! end
     $(SIGNATURES)
 Update a data entry or blob to the blob store or dfg.
 Related
-[`updateDataEntry`](@ref)
+[`updateDataEntry!`](@ref)
 """
 function updateData! end
 
 """
     $(SIGNATURES)
 Delete a data entry and blob from the blob store or dfg.
 Related
-[`deleteDataEntry`](@ref)
+[`deleteDataEntry!`](@ref)
 """
 function deleteData! end
 

src/Deprecated.jl

@@ -20,6 +20,8 @@ abstract type AbstractDataStore end
 struct GeneralDataEntry <: AbstractDataEntry end
 GeneralDataEntry(args...; kwargs...) = error("`GeneralDataEntry` is deprecated, use `BlobStoreEntry`")
 
+export InMemoryDataStore, FileDataStore
+
 struct FileDataStore <: AbstractDataStore end
 FileDataStore(args...; kwargs...) = error("`FileDataStore` is deprecated, use `FolderStore`")
 
@@ -35,92 +37,32 @@ deleteDataBlob!(store::AbstractDataStore, entry::AbstractDataEntry) = error("Abs
 listDataBlobs(store::AbstractDataStore) = error("AbstractDataStore $(typeof(store)) is deprecated.")
 
 
+addData!(dfg::AbstractDFG,
+         lbl::Symbol,
+         datastore::Union{FileDataStore, InMemoryDataStore},
+         descr::Symbol,
+         mimeType::AbstractString,
+         data::Vector{UInt8} ) = error("This API, FileDataStore and in MemoryDataStore is deprecated use new api parameter order and FolderStore")
 
-"""
-$(SIGNATURES)
-Add Big Data Entry to distributed factor graph.
-Should be extended if DFG variable is not returned by reference.
-
-Example
-
-See docs for `getDataEntryElement`.
-
-Related
-
-addData!, getDataEntryElement, fetchData
-"""
-function addData!(dfg::AbstractDFG,
-                  lbl::Symbol,
-                  datastore::Union{FileDataStore, InMemoryDataStore},
-                  descr::Symbol,
-                  mimeType::AbstractString,
-                  data::Vector{UInt8} )
-  #
-  node = isVariable(dfg, lbl) ? getVariable(dfg, lbl) : getFactor(dfg, lbl)
-  # Make a big data entry in the graph - use JSON2 to just write this
-  entry = GeneralDataEntry(dfg, node, descr, mimeType=mimeType)
-  # Set it in the store
-  addDataBlob!(datastore, entry, data)
-  # Add the entry to the graph
-  addDataEntry!(node, entry)
-end
-# const addDataEntry! = addData!
-
-
-
-"""
-$SIGNATURES
-Get both the entry and raw data element from datastore returning as a tuple.
-
-Notes:
-- This is the counterpart to `addDataEntry!`.
-- Data is identified by the node in the DFG object `dfglabel::Symbol` as well as `datalabel::Symbol`.
-- The data should have been stored along with a `entry.mimeType::String` which describes the format of the data.
-- ImageMagick.jl is useful for storing images in png or jpg compressed format.
-
-Example
-
-```julia
-# some dfg object
-fg = initfg()
-addVariable!(fg, :x0, IIF.ContinuousScalar) # using IncrementalInference
-# FileDataStore (as example)
-datastore = FileDataStore(joinLogPath(fg,"datastore"))
+export addDataElement!
+addDataElement!(dfg::AbstractDFG,
+                lbl::Symbol,
+                datastore::Union{FileDataStore, InMemoryDataStore},
+                descr::Symbol,
+                mimeType::AbstractString,
+                data::Vector{UInt8} ) = error("This API, FileDataStore and in MemoryDataStore is deprecated use addData! and FolderStore")
 
-# now some data comes in
-mydata = Dict(:soundBite => randn(Float32, 10000), :meta => "something about lazy foxes and fences.")
 
-# store the data
-addDataEntry!( fg, :x0, datastore, :SOUND_DATA, "application/json", Vector{UInt8}(JSON2.write( mydata ))  )
 
-# get/fetch the data
-entry, rawData = fetchData(fg, :x0, datastore, :SOUND_DATA)
+export getDataEntryBlob
+getDataEntryBlob(dfg::AbstractDFG,
+                 dfglabel::Symbol,
+                 datastore::Union{FileDataStore, InMemoryDataStore},
+                 datalabel::Symbol) = error("This API, FileDataStore and in MemoryDataStore is deprecated use getData and FolderStore")
 
-# unpack data to original format (this must be done by the user)
-@show entry.mimeType # "applicatio/json"
-userFormat = JSON2.read(IOBuffer(rawData))
-```
-
-Related
-
-addDataEntry!, addData!, fetchData, fetchDataEntryElement
-"""
-function getDataEntryBlob(dfg::AbstractDFG,
-                          dfglabel::Symbol,
-                          datastore::Union{FileDataStore, InMemoryDataStore},
-                          datalabel::Symbol)
-  #
-  vari = getVariable(dfg, dfglabel)
-  if !hasDataEntry(vari, datalabel)
-      # current standards is to fail hard
-    error("missing data entry $datalabel in $dfglabel")
-    # return nothing, nothing
-  end
-  entry = getDataEntry(vari, datalabel)
-  element = getDataBlob(datastore, entry)
-  return entry, element
-end
+export fetchDataEntryElement
 const fetchDataEntryElement = getDataEntryBlob
+export fetchData
 const fetchData = getDataEntryBlob
 
 #

src/DistributedFactorGraphs.jl

@@ -179,10 +179,9 @@ export copyGraph!, deepcopyGraph, deepcopyGraph!, buildSubgraph, mergeGraph!
 ##------------------------------------------------------------------------------
 export addDataEntry!, getDataEntry, updateDataEntry!, deleteDataEntry!, getDataEntries, listDataEntries, hasDataEntry, hasDataEntry
 # convenience wrappers
-export addDataEntry!, getDataEntryBlob
+export addDataEntry!
 # aliases
-export addData!, fetchData, fetchDataEntryBlob
-
+export addData!
 
 ##------------------------------------------------------------------------------
 # Factors

test/runtests.jl

@@ -59,7 +59,6 @@ end
 end
 
 @testset "Data Store Tests" begin
-    #include("DataStoreTests.jl")
     include("consol_DataEntryBlobTests.jl")
 end