DatumEntity class abstract

The base abstract class for all entities managed by Datum without built-in relationship handling.

Concrete entity classes should typically extend this class if they do not manage relations to other Datum entities.

Inheritance
Mixed-in types
Implementers

Constructors

DatumEntity()
const

Properties

createdAt → DateTime
The timestamp of when this entity was first created.
no setterinherited
hashCode → int
The hash code for this object.
no setterinherited
id → String
A unique identifier for the entity.
no setterinherited
isDeleted → bool
A flag indicating if this entity has been locally marked for deletion.
no setterinherited
isRelational → bool
Indicates whether this entity supports relationships. Always false for this mixin.
no setterinherited
modifiedAt → DateTime
The timestamp of the last time this entity was modified.
no setterinherited
props → List<Object?>
Provides the list of properties to be used by the Equatable mixin for value equality checks.
no setterinherited
runtimeType → Type
A representation of the runtime type of the object.
no setterinherited
stringify → bool?
If set to true, the toString method will be overridden to output this instance's props.
no setterinherited
userId → String
The ID of the user who owns or created this entity.
no setterinherited
vectorClock → VectorClock?
A vector clock for tracking causality across multiple devices.
no setterinherited
version → int
A sequential integer used for optimistic concurrency and tracking changes.
no setterinherited

Methods

diff(covariant DatumEntityInterface oldVersion) → Map<String, dynamic>?
Creates a new instance of the entity with updated values. Computes the difference between the current entity state and an oldVersion of the entity.
inherited
incrementClock(String replicaId) → DatumEntityInterface
Returns a new instance with the vector clock incremented for replicaId.
inherited
merge(covariant DatumEntityInterface other) → DatumEntityInterface
Merges this entity with other.
inherited
noSuchMethod(Invocation invocation) → dynamic
Invoked when a nonexistent method or property is accessed.
inherited
toDatumMap({MapTarget target = MapTarget.local}) → Map<String, dynamic>
Converts the entity to a Map<String, dynamic> for persistence.
inherited
toString() → String
A string representation of this object.
inherited

Operators

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