LocalDocumentModel<T> class abstract

Base class for holding and manipulating data from a local database as a document of T.

The load() method retrieves the value from the local database and the save() method saves the value to the local database.

The local database is a Json database. Specify a path to specify the location of the contents.

In addition, since it can be used as Map, it is possible to operate the content as it is.

Inheritance
Implemented types
Implementers

Constructors

LocalDocumentModel(String path, T initialValue)
Base class for holding and manipulating data from a local database as a document of T.

Properties

future → Future<void>?
Returns itself after the load/save finishes.
no setteroverride
hashCode → int
The hash code for this object.
no setteroverride
hasListeners → bool
Whether any listeners are currently registered.
no setterinherited
initialMock → T?
Initial value of mock.
final
isEmpty → bool
Return true if data is empty.
no setterinherited
isNotEmpty → bool
Return true if data is not empty.
no setterinherited
loaded ↔ bool
It becomes true after loadOnce is executed.
getter/setter pairoverride-getter
localeValueKey → String
Key for locale values.
final
notifyOnChangeValue → bool
If this value is true, the change will be notified when value itself is changed.
no setterinherited
path → String
Path of the local database.
final
runtimeType → Type
A representation of the runtime type of the object.
no setterinherited
timeValueKey → String
Key for time values.
final
uidValueKey → String
Key for UID values.
final
value ↔ T
The current value stored in this notifier.
getter/setter pairinherited-getteroverride-setter

Methods

addListener(VoidCallback listener) → void
Register a closure to be called when the object changes.
inherited
delete() → Future<void>
Deletes the document.
dispose() → void
Discards any resources used by the object. After this is called, the object is not in a usable state and should be discarded (calls to addListener and removeListener will throw after the object is disposed).
override
filterOnLoad(dynamic loaded) → dynamic
You can filter the loaded content when it is loaded.
filterOnSave(dynamic save) → dynamic
You can filter the saving content when it is saving.
fromMap(dynamic map) → T
Creates a specific object from a given map.
inherited
initState() → void
The method to be executed when initialization is performed.
override
load() → Future<LocalDocumentModel<T>>
Retrieves data and updates the data in the model.
override
loadOnce() → Future<LocalDocumentModel<T>>
If the data is empty, load is performed only once.
override
mock(T mockData) → LocalDocumentModel<T>
Register the data for the mock.
override
noSuchMethod(Invocation invocation) → dynamic
Invoked when a nonexistent method or property is accessed.
inherited
notifyListeners() → void
Call all the registered listeners.
inherited
onDelete() → Future<void>
Callback before the delete has been done.
onDidDelete() → Future<void>
Callback after the delete has been done.
onDidLoad() → Future<void>
Callback after the load has been done.
override
onDidSave() → Future<void>
Callback after the save has been done.
override
onLoad() → Future<void>
Callback before the load has been done.
override
onSave() → Future<void>
Callback before the save has been done.
override
reload() → Future<LocalDocumentModel<T>>
Reload data and updates the data in the model.
override
removeListener(VoidCallback listener) → void
Remove a previously registered closure from the list of closures that are notified when the object changes.
inherited
save() → Future<LocalDocumentModel<T>>
Data stored in the model is stored in a database external to the app that is tied to the model.
override
toMap(T value) → dynamic
Creates a DynamicMap from its own value.
inherited
toNotifier<V>(V converter(T value)) → ValueNotifier<V>
Generates a value notifier.
inherited
toString() → String
A string representation of this object.
inherited

Operators

operator ==(Object other) → bool
The equality operator.
override