FrameworkModel Class Reference

Provides a basic JSON-backed record model. More...

#include <FrameworkModel.h>

Inheritance diagram for FrameworkModel:

Collaboration diagram for FrameworkModel:

Public Member Functions
	FrameworkModel (const std::string &path)
	Constructor.
bool	load ()
	Loads the JSON collection from storage.
bool	save ()
	Saves the current collection to storage.
std::vector< nlohmann::json >	all () const
	Returns all items in the collection.
std::optional< nlohmann::json >	find (const std::string &id) const
	Finds an item by ID.
bool	create (const nlohmann::json &item)
	Adds a new item to the collection.
bool	update (const std::string &id, const nlohmann::json &updatedItem)
	Updates an item by ID.
bool	remove (const std::string &id)
	Removes an item by ID.
nlohmann::json	toJson () const
	Returns the full collection as a JSON array object.
nlohmann::json	findAsJson (const std::string &id) const
	Finds a single item by ID and returns it as JSON or null.
bool	save (const std::string &id, const json &data)
	Saves a single item by ID and JSON object.
bool	createFromJson (const nlohmann::json &obj)
bool	updateFromJson (const std::string &id, const nlohmann::json &updates)
nlohmann::json	deleteAsJson (const std::string &id)
bool	saveAll ()
template<typename T >
T	getValue (const std::string &key, const T &defaultValue=T())
	Reads a single top-level key from the model file.
template<typename T >
void	setValue (const std::string &key, const T &value)
	Sets a single top-level key in the model file.

Protected Member Functions
virtual std::string	getIdField () const
	Returns the JSON key used as the record ID.

Protected Attributes
nlohmann::json	collection = nlohmann::json::array()
	In-memory array of records.

Private Attributes
JsonService *	jsonService = nullptr
	Underlying JSON persistence layer
std::string	storagePath
	File path for this model.

Detailed Description

FrameworkModel abstracts away JSON loading/saving and record manipulation. Subclass it to represent specific collections, optionally overriding getIdField() if the record ID is not "id".

Definition at line 36 of file FrameworkModel.h.

Constructor & Destructor Documentation

FrameworkModel()

FrameworkModel::FrameworkModel

(

const std::string &

path

)

Constructor.

Parameters

storage	Pointer to a StorageManager (e.g. SD, flash).
path	Path to the backing JSON file.

Parameters

storage	Pointer to a StorageManager (e.g. SD, flash).
path	Path to the backing JSON file.

Definition at line 26 of file FrameworkModel.cpp.

    : storagePath(path) {}

Member Function Documentation

all()

std::vector< nlohmann::json > FrameworkModel::all

(

)

const

Returns all items in the collection.

Definition at line 67 of file FrameworkModel.cpp.

{
    if (collection.empty())
    {
        return {};
    }
    std::vector<nlohmann::json> items;
    for (const auto &item : collection)
    {
        TRACE("[FrameworkModel::all] Item: %s\n", item.dump(4).c_str());
        items.push_back(item);
    }
    return items;
}

References collection, and TRACE.

create()

bool FrameworkModel::create

(

const nlohmann::json &

item

)

Adds a new item to the collection.

Parameters

item	JSON object to insert.

Returns

true if added successfully; false if missing ID or already exists.

Parameters

item	JSON object to insert.

Returns

true if added successfully; false if missing ID or already exists.

Definition at line 97 of file FrameworkModel.cpp.

{
    std::string idField = getIdField();
    if (!item.contains(idField))
        return false;
    std::string id = item[idField];
    if (find(id))
        return false;
    collection.push_back(item);
    return true;
}

References collection, find(), and getIdField().

Here is the call graph for this function:

createFromJson()

bool FrameworkModel::createFromJson

(

const nlohmann::json &

obj

)

Definition at line 166 of file FrameworkModel.cpp.

{
    std::string idField = getIdField();
    if (!obj.contains(idField))
        return false;
    return save(obj[idField], obj);
}

References getIdField(), and save().

Here is the call graph for this function:

deleteAsJson()

nlohmann::json FrameworkModel::deleteAsJson

(

const std::string &

id

)

Definition at line 193 of file FrameworkModel.cpp.

{
    std::string idField = getIdField();
    for (auto it = collection.begin(); it != collection.end(); ++it)
    {
        if (it->contains(idField) && (*it)[idField] == id)
        {
            nlohmann::json removed = *it;
            collection.erase(it);
            return saveAll() ? removed : nullptr;
        }
    }
    return nullptr;
}

References collection, getIdField(), and saveAll().

Here is the call graph for this function:

find()

std::optional< nlohmann::json > FrameworkModel::find

(

const std::string &

id

)

const

Finds an item by ID.

Parameters

id	The value of the ID field to match.

Returns

The matching JSON object, or nullopt if not found.

Parameters

id	The value of the ID field to match.

Returns

The matching JSON object, or nullopt if not found.

Definition at line 83 of file FrameworkModel.cpp.

{
    std::string idField = getIdField();
    for (const auto &item : collection)
    {
        if (item.contains(idField) && item[idField] == id)
        {
            return item;
        }
    }
    return std::nullopt;
}

References collection, and getIdField().

Referenced by create(), and findAsJson().

Here is the call graph for this function:

Here is the caller graph for this function:

findAsJson()

nlohmann::json FrameworkModel::findAsJson

(

const std::string &

id

)

const

Finds a single item by ID and returns it as JSON or null.

Definition at line 140 of file FrameworkModel.cpp.

{
    auto result = find(id);
    return result ? *result : nlohmann::json(nullptr);
}

References find().

Here is the call graph for this function:

getIdField()

virtual std::string FrameworkModel::getIdField ( ) const

inlineprotectedvirtual

Defaults to "id", but can be overridden by subclasses.

Definition at line 172 of file FrameworkModel.h.

{ return "id"; }

Referenced by create(), createFromJson(), deleteAsJson(), find(), remove(), save(), update(), and updateFromJson().

Here is the caller graph for this function:

getValue()

template<typename T >

T FrameworkModel::getValue ( const std::string &  key, const T &  defaultValue = T()  )

inline

This is separate from array-style records and useful for persistent app state.

Template Parameters

T	Expected return type

Parameters

key	JSON key name
defaultValue	Returned if key is not present

Returns

Value from JSON or default

Definition at line 129 of file FrameworkModel.h.

    {
        jsonService = AppContext::get<JsonService>();
        if(!jsonService)
        {
            printf("[FrameworkModel] JsonService not available\n");
            return defaultValue;
        }
        const auto &data = jsonService->data();
        if (data.contains(key))
        {
            return data[key].get<T>();
        }
        return defaultValue;
    }

References JsonService::data(), AppContext::getTypeKey(), and jsonService.

Referenced by PicoModel::onNetworkReady(), and PicoModel::restoreState().

Here is the call graph for this function:

Here is the caller graph for this function:

load()

bool FrameworkModel::load

(

)

Loads the JSON collection from storage.

Returns

true if successful.

Returns

true if successful.

Definition at line 30 of file FrameworkModel.cpp.

{
    auto jsonService = AppContext::get<JsonService>();
    if(!jsonService)
    {
        printf("Failed to get JsonService\n");
        return false;
    }
    if(storagePath.empty())
    {
        printf("[FrameworkModel] No storage path set, cannot load data\n");
        return false;
    }
    TRACE("[FrameworkModel] Loading data from %s\n", storagePath.c_str());
    if (!jsonService->load(storagePath))
        return false;
    collection = jsonService->data().value("items", nlohmann::json::array());
    if (collection.empty())
    {
        TRACE("No items found in %s\n", storagePath.c_str());
        return false;
    }
    else{
        TRACE("collection: %s\n", collection.dump(4).c_str());
    }
    return true;
}

References collection, JsonService::data(), AppContext::getTypeKey(), jsonService, JsonService::load(), storagePath, and TRACE.

Referenced by PicoModel::restoreState().

Here is the call graph for this function:

Here is the caller graph for this function:

remove()

bool FrameworkModel::remove

(

const std::string &

id

)

Removes an item by ID.

Parameters

id	The ID of the item to remove.

Returns

true if removed; false if not found.

Parameters

id	The ID of the item to remove.

Returns

true if removed; false if not found.

Definition at line 125 of file FrameworkModel.cpp.

{
    std::string idField = getIdField();
    for (auto it = collection.begin(); it != collection.end(); ++it)
    {
        if (it->contains(idField) && (*it)[idField] == id)
        {
            collection.erase(it);
            return true;
        }
    }
    return false;
}

References collection, and getIdField().

Here is the call graph for this function:

save() [1/2]

bool FrameworkModel::save

(

)

Saves the current collection to storage.

Returns

true if successful.

Returns

true if successful.

Definition at line 59 of file FrameworkModel.cpp.

{
    auto jsonService = AppContext::get<JsonService>();
    jsonService->data()["items"] = collection;
    return jsonService->save(storagePath);
}

References collection, JsonService::data(), AppContext::getTypeKey(), jsonService, JsonService::save(), and storagePath.

Referenced by createFromJson(), save(), PicoModel::saveState(), and updateFromJson().

Here is the call graph for this function:

Here is the caller graph for this function:

save() [2/2]

bool FrameworkModel::save	(	const std::string &	id,
		const json &	data
	)

Saves the current collection to storage. (single record)

Returns

true if successful.

(single record)

Definition at line 147 of file FrameworkModel.cpp.

{
    std::string idField = getIdField();
 
    for (auto &item : collection)
    {
        if (item.contains(idField) && item[idField] == id)
        {
            item = data;
            return save();
        }
    }
 
    // If not found, append
    collection.push_back(data);
    return save();
}

References collection, getIdField(), and save().

Here is the call graph for this function:

saveAll()

bool FrameworkModel::saveAll

(

)

Definition at line 209 of file FrameworkModel.cpp.

{
    auto jsonService = AppContext::get<JsonService>();
    jsonService->data()["items"] = collection;
    return jsonService->save(storagePath);
}

References collection, JsonService::data(), AppContext::getTypeKey(), jsonService, JsonService::save(), and storagePath.

Referenced by deleteAsJson().

Here is the call graph for this function:

Here is the caller graph for this function:

setValue()

template<typename T >

void FrameworkModel::setValue ( const std::string &  key, const T &  value  )

inline

This does not affect the array-style record collection.

Template Parameters

T	Type of value to store

Parameters

key	JSON key
value	Value to assign

Definition at line 154 of file FrameworkModel.h.

    {
        jsonService = AppContext::get<JsonService>();
        if(!jsonService)
        {
            printf("[FrameworkModel] JsonService not available\n");
            return;
        }
        jsonService->data()[key] = value;
    }

References JsonService::data(), AppContext::getTypeKey(), and jsonService.

Referenced by PicoModel::saveState(), and PicoModel::setLedState().

Here is the call graph for this function:

Here is the caller graph for this function:

toJson()

nlohmann::json FrameworkModel::toJson ( ) const

inline

Definition at line 100 of file FrameworkModel.h.

    {
        return nlohmann::json(collection);
    }

References collection.

update()

bool FrameworkModel::update	(	const std::string &	id,
		const nlohmann::json &	updatedItem
	)

Updates an item by ID.

Parameters

id	The ID of the item to update.
updatedItem	The new item JSON to replace the old one.

Returns

true if update succeeded; false if not found.

Parameters

id	The ID of the item to update.
updatedItem	The new item JSON to replace the old one.

Returns

true if update succeeded; false if not found.

Definition at line 110 of file FrameworkModel.cpp.

{
    std::string idField = getIdField();
    for (auto &item : collection)
    {
        if (item.contains(idField) && item[idField] == id)
        {
            item = updatedItem;
            return true;
        }
    }
    return false;
}

References collection, and getIdField().

Here is the call graph for this function:

updateFromJson()

bool FrameworkModel::updateFromJson	(	const std::string &	id,
		const nlohmann::json &	updates
	)

Definition at line 175 of file FrameworkModel.cpp.

{
    std::string idField = getIdField();
    for (auto &item : collection)
    {
        if (item.contains(idField) && item[idField] == id)
        {
            for (auto &el : updates.items())
            {
                item[el.key()] = el.value(); // Patch keys
            }
            return save(id, item);
        }
    }
    return false;
}

References collection, getIdField(), and save().

Here is the call graph for this function:

Member Data Documentation

collection

nlohmann::json FrameworkModel::collection = nlohmann::json::array()

protected

Definition at line 174 of file FrameworkModel.h.

Referenced by all(), create(), deleteAsJson(), find(), load(), remove(), save(), save(), saveAll(), toJson(), update(), and updateFromJson().

jsonService

JsonService* FrameworkModel::jsonService = nullptr

private

Definition at line 177 of file FrameworkModel.h.

Referenced by getValue(), load(), save(), saveAll(), and setValue().

storagePath

std::string FrameworkModel::storagePath

private

Definition at line 178 of file FrameworkModel.h.

Referenced by load(), save(), and saveAll().

---

The documentation for this class was generated from the following files:

• FrameworkModel.h
• FrameworkModel.cpp