LocalDynamicSearchableCollectionModel class

Retrieves and retrieves collection data stored in a local database.

The basic usage is to use the search method to search for data.

In order to be searched by search, each document must have a data format stored in the specified way.

Inheritance
Implemented types
Mixed in types
Available Extensions

Properties

canNext bool
Returns True if the following reads are possible
no setterinherited
disposed bool
True if the model is Disposed.
no setterinherited
enableQueryFilter bool
True if filtering by ModelQuery is enabled.
no setterinherited
first LocalDynamicDocumentModel
Returns the first element.
getter/setter pairinherited
hashCode int
The hash code for this object.
no setterinherited
hasListeners bool
Whether any listeners are currently registered.
no setterinherited
isEmpty bool
Returns true if there are no elements in this collection.
no setterinherited
isNotEmpty bool
Returns true if there is at least one element in this collection.
no setterinherited
iterator Iterator<LocalDynamicDocumentModel>
Returns a new Iterator that allows iterating the elements of this Iterable.
no setterinherited
last LocalDynamicDocumentModel
Returns the last element.
getter/setter pairinherited
length int
The number of objects in this list.
getter/setter pairinherited
loaded bool
It becomes true after loadOnce is executed.
no setterinherited
loading Future<void>?
Returns itself after the load finishes.
no setterinherited
notifyOnChangeList bool
If this value is true, Notify changes when there are changes in the list itself using list-specific methods.
no setterinherited
notifyOnChangeValue bool
If this value is true, the change will be notified when value itself is changed.
no setterinherited
notifyOnModified bool
If it is true, the collection itself will be notified if the content of the document has changed.
no setterinherited
parameters Map<String, String>
Parameters of the local database.
finalinherited
path String
Path of the local database.
finalinherited
reversed Iterable<LocalDynamicDocumentModel>
An Iterable of the objects in this list in reverse order.
no setterinherited
runtimeType Type
A representation of the runtime type of the object.
no setterinherited
saving Future<void>?
Returns itself after the save/delete finishes.
no setterinherited
searchValueKey String
The key to perform the search.
no setterinherited
single LocalDynamicDocumentModel
Checks that this iterable has only one element, and returns that element.
no setterinherited
value List<LocalDynamicDocumentModel>
The current value stored in this notifier.
getter/setter pairinherited

Methods

add(LocalDynamicDocumentModel value) → void
Adds value to the end of this list, extending the length by one.
inherited
addAll(Iterable<LocalDynamicDocumentModel> iterable) → void
Appends all objects of iterable to the end of this list.
inherited
addListener(VoidCallback listener) → void
Register a closure to be called when the object changes.
inherited
any(bool test(LocalDynamicDocumentModel element)) bool
Checks whether any element of this iterable satisfies test.
inherited
append(String uid, {LocalDynamicDocumentModel? data}) Future<void>
Add a new document to the current collection based on uid.
inherited
asMap() Map<int, LocalDynamicDocumentModel>
An unmodifiable Map view of this list.
inherited
cast<E>() List<E>
Returns a view of this list as a list of R instances.
inherited
clear() → void
Removes all objects from this list; the length of the list becomes zero.
inherited
contains(Object? element) bool
Whether the collection contains an element equal to element.
inherited
create([String? id]) LocalDynamicDocumentModel
Create a new document.
inherited
createDocument(String path) LocalDynamicDocumentModel
Add a process to create a document object.
override
delete(bool test(LocalDynamicDocumentModel value)) Future<void>
Remove elements in the collection that are true in test.
inherited
dependOn(Listenable listenable, [List<LocalDynamicDocumentModel> filter(List<LocalDynamicDocumentModel> origin)?]) → void
Sends a notification to itself when the target listenable is updated.
inherited
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).
inherited
elementAt(int index) LocalDynamicDocumentModel
Returns the indexth element.
inherited
every(bool test(LocalDynamicDocumentModel element)) bool
Checks whether every element of this iterable satisfies test.
inherited
expand<E>(Iterable<E> f(LocalDynamicDocumentModel element)) Iterable<E>
Expands each element of this Iterable into zero or more elements.
inherited
fetch([bool listen = true]) Future<void>
Provides the best data acquisition method to implement during screen build.
inherited
fillRange(int start, int end, [LocalDynamicDocumentModel? fillValue]) → void
Overwrites a range of elements with fillValue.
inherited
filter(DynamicMap data) bool
Filters the given data.
inherited
firstWhere(bool test(LocalDynamicDocumentModel element), {LocalDynamicDocumentModel orElse()?}) LocalDynamicDocumentModel
Returns the first element that satisfies the given predicate test.
inherited
fold<E>(E initialValue, E combine(E previousValue, LocalDynamicDocumentModel element)) → E
Reduces a collection to a single value by iteratively combining each element of the collection with an existing value
inherited
followedBy(Iterable<LocalDynamicDocumentModel> other) Iterable<LocalDynamicDocumentModel>
Returns the lazy concatenation of this iterable and other.
inherited
forEach(void f(LocalDynamicDocumentModel element)) → void
Applies the function f to each element of this collection in iteration order.
inherited
getRange(int start, int end) Iterable<LocalDynamicDocumentModel>
Creates an Iterable that iterates over a range of elements.
inherited
indexOf(LocalDynamicDocumentModel element, [int start = 0]) int
The first index of element in this list.
inherited
indexWhere(bool test(LocalDynamicDocumentModel element), [int start = 0]) int
The first index in the list that satisfies the provided test.
inherited
initState() → void
The method to be executed when initialization is performed.
inherited
insert(int index, LocalDynamicDocumentModel element) → void
Inserts element at position index in this list.
inherited
insertAll(int index, Iterable<LocalDynamicDocumentModel> iterable) → void
Inserts all objects of iterable at position index in this list.
inherited
join([String separator = ""]) String
Converts each element to a String and concatenates the strings.
inherited
lastIndexOf(LocalDynamicDocumentModel element, [int? start]) int
The last index of element in this list.
inherited
lastIndexWhere(bool test(LocalDynamicDocumentModel element), [int? start]) int
The last index in the list that satisfies the provided test.
inherited
lastWhere(bool test(LocalDynamicDocumentModel element), {LocalDynamicDocumentModel orElse()?}) LocalDynamicDocumentModel
Returns the last element that satisfies the given predicate test.
inherited
load() Future<void>
Retrieves data and updates the data in the model.
inherited
loadOnce() Future<void>
If the data is empty, load is performed only once.
inherited
map<E>(E f(LocalDynamicDocumentModel e)) Iterable<E>
Returns a new lazy Iterable with elements that are created by calling f on each element of this Iterable in iteration order.
inherited
next() Future<void>
Load the data on the next page.
inherited
noSuchMethod(Invocation invocation) → dynamic
Invoked when a nonexistent method or property is accessed.
inherited
notifyListeners() → void
Call all the registered listeners.
inherited
onAppend() Future<void>
Callback before the append has been done.
inherited
onDelete() Future<void>
Callback before the delete has been done.
inherited
onDidAppend() Future<void>
Callback after the append has been done.
inherited
onDidDelete() Future<void>
Callback after the delete has been done.
inherited
onDidLoad() Future<void>
Callback after the load has been done.
inherited
onDidSave() Future<void>
Callback after the save has been done.
inherited
onLoad() Future<void>
Callback before the load has been done.
inherited
onSave() Future<void>
Callback after the load has been done.
inherited
reduce(LocalDynamicDocumentModel combine(LocalDynamicDocumentModel value, LocalDynamicDocumentModel element)) LocalDynamicDocumentModel
Reduces a collection to a single value by iteratively combining elements of the collection using the provided function.
inherited
reload() Future<void>
Reload data and updates the data in the model.
inherited
remove(Object? value) bool
Removes the first occurrence of value from this list.
inherited
removeAt(int index) LocalDynamicDocumentModel
Removes the object at position index from this list.
inherited
removeLast() LocalDynamicDocumentModel
Removes and returns the last object in this list.
inherited
removeListener(VoidCallback listener) → void
Remove a previously registered closure from the list of closures that are notified when the object changes.
inherited
removeRange(int start, int end) → void
Removes a range of elements from the list.
inherited
removeWhere(bool test(LocalDynamicDocumentModel element)) → void
Removes all objects from this list that satisfy test.
inherited
replaceRange(int start, int end, Iterable<LocalDynamicDocumentModel> replacement) → void
Replaces a range of elements with the elements of replacement.
inherited
retainWhere(bool test(LocalDynamicDocumentModel element)) → void
Removes all objects from this list that fail to satisfy test.
inherited
save() Future<void>
Data stored in the model is stored in a database external to the app that is tied to the model.
inherited
Give search to perform a search.
inherited
setAll(int index, Iterable<LocalDynamicDocumentModel> iterable) → void
Overwrites elements with the objects of iterable.
inherited
setNotifyOnModified(bool notify) → void
If notify is set to true, the collection will be notified of changes to the document.
inherited
setRange(int start, int end, Iterable<LocalDynamicDocumentModel> iterable, [int skipCount = 0]) → void
Writes some elements of iterable into a range of this list.
inherited
shuffle([Random? random]) → void
Shuffles the elements of this list randomly.
inherited
singleWhere(bool test(LocalDynamicDocumentModel element), {LocalDynamicDocumentModel orElse()?}) LocalDynamicDocumentModel
Returns the single element that satisfies test.
inherited
skip(int n) Iterable<LocalDynamicDocumentModel>
Returns an Iterable that provides all but the first count elements.
inherited
skipWhile(bool test(LocalDynamicDocumentModel value)) Iterable<LocalDynamicDocumentModel>
Returns an Iterable that skips leading elements while test is satisfied.
inherited
sort([int compare(LocalDynamicDocumentModel a, LocalDynamicDocumentModel b)?]) → void
Sorts this list according to the order specified by the compare function.
inherited
sublist(int start, [int? end]) List<LocalDynamicDocumentModel>
Returns a new list containing the elements between start and end.
inherited
take(int n) Iterable<LocalDynamicDocumentModel>
Returns a lazy iterable of the count first elements of this iterable.
inherited
takeWhile(bool test(LocalDynamicDocumentModel value)) Iterable<LocalDynamicDocumentModel>
Returns a lazy iterable of the leading elements satisfying test.
inherited
toList({bool growable = true}) List<LocalDynamicDocumentModel>
Creates a List containing the elements of this Iterable.
inherited
toNotifier<V>(V converter(List<LocalDynamicDocumentModel> value)) ValueNotifier<V>
Generates a value notifier.
inherited
toSet() Set<LocalDynamicDocumentModel>
Creates a Set containing the same elements as this iterable.
inherited
toString() String
A string representation of this object.
inherited
transaction([String? linkedCollectionPath]) LocalCollectionTransactionBuilder
Generate a Transaction for this collection.
inherited
where(bool test(LocalDynamicDocumentModel element)) Iterable<LocalDynamicDocumentModel>
Returns a new lazy Iterable with all elements that satisfy the predicate test.
inherited
whereType<E>() Iterable<E>
Returns a new lazy Iterable with all elements that have type T.
inherited

Operators

operator +(List<LocalDynamicDocumentModel> other) List<LocalDynamicDocumentModel>
Returns the concatenation of this list and other.
inherited
operator ==(Object other) bool
The equality operator.
inherited
operator [](int index) LocalDynamicDocumentModel
The object at the given index in the list.
inherited
operator []=(int index, LocalDynamicDocumentModel value) → void
Sets the value at the given index in the list to value.
inherited