IsarLinks<OBJ> class abstract

Establishes a 1:n relationship with the same or another collection. The target collection is specified by the generic type argument.

Implemented types
Available Extensions

Constructors

Create an empty, unattached link. Make sure to provide the correct generic argument.
factory

Properties

first → OBJ
The first element.
no setterinherited
hashCode int
The hash code for this object.
no setterinherited
isAttached bool
Is the containing object managed by Isar?
no setterinherited
isChanged bool
Have the contents been changed? If not, .save() is a no-op.
no setterinherited
isEmpty bool
Whether this collection has no elements.
no setterinherited
isLoaded bool
Has this link been loaded?
no setterinherited
isNotEmpty bool
Whether this collection has at least one element.
no setterinherited
iterator Iterator<OBJ>
An iterator that iterates over the elements of this set.
no setterinherited
last → OBJ
The last element.
no setterinherited
length int
The number of elements in this.
no setterinherited
runtimeType Type
A representation of the runtime type of the object.
no setterinherited
single → OBJ
Checks that this iterable has only one element, and returns that element.
no setterinherited

Methods

add(OBJ value) bool
Adds value to the set.
inherited
addAll(Iterable<OBJ> elements) → void
Adds all elements to this set.
inherited
any(bool test(OBJ element)) bool
Checks whether any element of this iterable satisfies test.
inherited
cast<R>() Set<R>
Provides a view of this set as a set of R instances.
inherited
clear() → void
Removes all elements from the set.
inherited
contains(Object? value) bool
Whether value is in the set.
inherited
containsAll(Iterable<Object?> other) bool
Whether this set contains all the elements of other.
inherited
count() Future<int>
Counts the linked objects in the database.
countSync() int
Counts the linked objects in the database.
difference(Set<Object?> other) Set<OBJ>
Creates a new set with the elements of this that are not in other.
inherited
elementAt(int index) → OBJ
Returns the indexth element.
inherited
every(bool test(OBJ element)) bool
Checks whether every element of this iterable satisfies test.
inherited
expand<T>(Iterable<T> toElements(OBJ element)) Iterable<T>
Expands each element of this Iterable into zero or more elements.
inherited
filter() QueryBuilder<OBJ, OBJ, QAfterFilterCondition>
Starty a query for linked objects.
firstWhere(bool test(OBJ element), {OBJ orElse()?}) → OBJ
The first element that satisfies the given predicate test.
inherited
fold<T>(T initialValue, T combine(T previousValue, OBJ element)) → T
Reduces a collection to a single value by iteratively combining each element of the collection with an existing value
inherited
followedBy(Iterable<OBJ> other) Iterable<OBJ>
Creates the lazy concatenation of this iterable and other.
inherited
forEach(void action(OBJ element)) → void
Invokes action on each element of this iterable in iteration order.
inherited
intersection(Set<Object?> other) Set<OBJ>
Creates a new set which is the intersection between this set and other.
inherited
join([String separator = ""]) String
Converts each element to a String and concatenates the strings.
inherited
lastWhere(bool test(OBJ element), {OBJ orElse()?}) → OBJ
The last element that satisfies the given predicate test.
inherited
load({bool overrideChanges = true}) Future<void>
Loads the linked object(s) from the databse
loadSync({bool overrideChanges = true}) → void
Loads the linked object(s) from the databse
lookup(Object? object) → OBJ?
If an object equal to object is in the set, return it.
inherited
map<T>(T toElement(OBJ e)) Iterable<T>
The current elements of this iterable modified by toElement.
inherited
noSuchMethod(Invocation invocation) → dynamic
Invoked when a nonexistent method or property is accessed.
inherited
reduce(OBJ combine(OBJ value, OBJ element)) → OBJ
Reduces a collection to a single value by iteratively combining elements of the collection using the provided function.
inherited
remove(Object? value) bool
Removes value from the set.
inherited
removeAll(Iterable<Object?> elements) → void
Removes each element of elements from this set.
inherited
removeWhere(bool test(OBJ element)) → void
Removes all elements of this set that satisfy test.
inherited
reset() Future<void>
Unlinks all linked object(s).
inherited
resetSync() → void
Unlinks all linked object(s).
inherited
retainAll(Iterable<Object?> elements) → void
Removes all elements of this set that are not elements in elements.
inherited
retainWhere(bool test(OBJ element)) → void
Removes all elements of this set that fail to satisfy test.
inherited
save() Future<void>
Saves the linked object(s) to the databse if there are changes.
inherited
saveSync() → void
Saves the linked object(s) to the databse if there are changes.
inherited
singleWhere(bool test(OBJ element), {OBJ orElse()?}) → OBJ
The single element that satisfies test.
inherited
skip(int count) Iterable<OBJ>
Creates an Iterable that provides all but the first count elements.
inherited
skipWhile(bool test(OBJ value)) Iterable<OBJ>
Creates an Iterable that skips leading elements while test is satisfied.
inherited
take(int count) Iterable<OBJ>
Creates a lazy iterable of the count first elements of this iterable.
inherited
takeWhile(bool test(OBJ value)) Iterable<OBJ>
Creates a lazy iterable of the leading elements satisfying test.
inherited
toList({bool growable = true}) List<OBJ>
Creates a List containing the elements of this Iterable.
inherited
toSet() Set<OBJ>
Creates a Set with the same elements and behavior as this Set.
inherited
toString() String
A string representation of this object.
inherited
union(Set<OBJ> other) Set<OBJ>
Creates a new set which contains all the elements of this set and other.
inherited
update({List<OBJ> link = const [], List<OBJ> unlink = const []}) Future<void>
Creates and removes the specified links in the database.
updateSync({List<OBJ> link = const [], List<OBJ> unlink = const []}) → void
Creates and removes the specified links in the database.
where(bool test(OBJ element)) Iterable<OBJ>
Creates a new lazy Iterable with all elements that satisfy the predicate test.
inherited
whereType<T>() Iterable<T>
Creates a new lazy Iterable with all elements that have type T.
inherited

Operators

operator ==(Object other) bool
The equality operator.
inherited