Relationships - Kotlin SDK

Definir una propiedad de relación uno a uno

A to-one relationship relationship maps one property to a single instance of a RealmObject object type. Nothing prevents multiple parent object instances from referencing the same child instance. If you want to enforce a strict one-to-one relationship, use an embedded object instead.

Para definir una relación de uno a uno entre objetos, defina una propiedad de objeto opcional cuyo tipo sea un objeto RealmObject definido en su modelo de datos. Puede ser un tipo de objeto de Realm diferente o el mismo tipo de objeto de Realm:

// Relationships of Realm objects must be of RealmObject type
class Frog : RealmObject {
    @PrimaryKey
    var _id: ObjectId = ObjectId()
    var name: String = ""
    var age: Int = 0
    // Property of RealmObject type (MUST be null)
    var favoritePond: Pond? = null
    var bestFriend: Frog? = null
}

Define a To-Many Relationship Property

Una relación de uno a muchos asigna una propiedad a cero o más instancias de un RealmObject tipo de objeto. Nada impide que varias instancias de un objeto padre hagan referencia a la misma instancia hija. Si desea aplicar una relación estricta de uno a muchos, utilice un objeto incrustado.

En Realm, las relaciones de varios elementos son colecciones (una RealmList o un RealmSet) de objetos de Realm. Para obtener más información sobre cómo definir colecciones en el modelo de objetos, consulte Definir propiedades de colección.

Para definir una relación de varios objetos, defina una propiedad de objeto cuyo tipo sea RealmList<E> o RealmSet<E>, donde <E> es un tipo de objeto RealmObject definido en su modelo de datos. Este puede ser un tipo de objeto de Realm diferente o el mismo tipo de objeto de Realm:

// Relationships of RealmList<E> or RealmSet<E> must be of RealmObject type
class Forest : RealmObject {
    @PrimaryKey
    var _id: ObjectId = ObjectId()
    var name: String = ""
    // Set of RealmObject type (CANNOT be null)
    var frogsThatLiveHere: RealmSet<Frog> = realmSetOf()
    // List of RealmObject type (CANNOT be null)
    var nearbyPonds: RealmList<Pond> = realmListOf()
}

Definir una relación inversa

An inverse relationship is an automatic backlink relationship between a child RealmObject object and any other parent objects that refer to it. Inverse relationships can link back to child objects in a many-to-one or many-to-many relationship. If you want to enforce a strict one-to-one or one-to-many inverse relationship, use an embedded object instead.

Las definiciones de relación son unidireccionales, por lo que debe definir explícitamente una propiedad en el modelo del objeto como una relación inversa. Por ejemplo, la relación a muchos "El usuario tiene muchas publicaciones" no crea automáticamente la relación inversa "La publicación pertenece al usuario". Sin embargo, puede agregar una propiedad de usuario a la publicación que apunte a su propietario. Esto le permite consultar la relación inversa de la publicación al usuario en lugar de ejecutar una consulta independiente para buscar al usuario al que pertenece la publicación. Dado que las relaciones son de muchos a uno o de muchos a muchos, las siguientes relaciones inversas pueden generar cero, uno o muchos objetos.

Para definir una relación inversa entre objetos, primero defina una propiedad de colección en el objeto principal cuyo tipo sea RealmList<E>, RealmSet<E> o RealmDictionary<E>, donde <E> es un tipo de objeto RealmObject definido en su modelo de datos. Este puede ser un tipo de objeto Realm diferente o el mismo tipo de objeto Realm:

// Parent object must have RealmList<E>, RealmSet<E>, or
// RealmDictionary<K,V> property of child type
class User : RealmObject {
    @PrimaryKey
    var _id: ObjectId = ObjectId()
    var name: String = ""
    // List of child RealmObject type (CANNOT be nullable)
    var posts: RealmList<Post> = realmListOf()
    // Set of child RealmObject type (CANNOT be nullable)
    var favoritePosts: RealmSet<Post> = realmSetOf()
    // Dictionary of child RealmObject type (value MUST be nullable)
    var postByYear: RealmDictionary<Post?> = realmDictionaryOf()
}

Luego, defina una propiedad inmutable vínculos inversos en el objeto hijo de RealmResults<E>, donde <E> es el tipo de objeto Realm principal:

// Backlink of RealmObject must be RealmResults<E> of parent object type
class Post : RealmObject {
    var title: String = ""
    var date: RealmInstant = RealmInstant.now()
    // Backlink to parent RealmObject type (CANNOT be null & MUST be val)
    val user: RealmResults<User> by backlinks(User::posts)
}

Define an Embedded Object

An embedded object is a special type of Realm object that you can use to nest data inside of a single, specific parent object. Embedded objects can be in a one-to-one, one-to-many, or inverse relationship similar to the relationships described in the previous sections, except the relationship is restricted to a one-to relationship between a single parent object and an EmbeddedRealmObject type.

Como los objetos incrustados no pueden existir como objetos Realm independientes, hay restricciones adicionales que tener en cuenta:

• An embedded object has strict ownership by its parent. You cannot share embedded objects between parent objects.

• El objeto incrustado hereda el ciclo de vida de su elemento principal. Por ejemplo, al eliminar el elemento principal, también se elimina el objeto incrustado.

Los objetos incrustados son útiles cuando existe una clara relación de contención o propiedad. Por ejemplo, un objeto Address podría estar incrustado en un objeto User porque solo tiene sentido en la aplicación dentro del contexto de un usuario.

// To-one embedded relationships must be of EmbeddedRealmObject type
class Contact : RealmObject {
    @PrimaryKey
    var _id: ObjectId = ObjectId()
    var name: String = ""
    // Property of EmbeddedRealmObject type (MUST be null)
    var address: EmbeddedAddress? = null
}
class EmbeddedAddress : EmbeddedRealmObject {
    var propertyOwner: Contact? = null
    var street: String? = ""
    // Embed another EmbeddedRealmObject type
    var country: EmbeddedCountry? = null
}
class EmbeddedCountry : EmbeddedRealmObject {
    var name: String = ""
}

// To-many embedded relationships must be a RealmList<E> or
// RealmDictionary<K, V> property of EmbeddedRealmObject type
class Business : RealmObject {
    @PrimaryKey
    var _id: ObjectId = ObjectId()
    var name: String = ""
    // List of EmbeddedRealmObject type (CANNOT be null)
    var addresses: RealmList<EmbeddedAddress> = realmListOf()
    // Dictionary of EmbeddedRealmObject type (value MUST be nullable)
    var addressByYear: RealmDictionary<EmbeddedAddress?> = realmDictionaryOf()
}

// Parent object must have RealmList<E> or RealmDictionary<K, V>
// property of child EmbeddedRealmObject type
class User : RealmObject {
    @PrimaryKey
    var _id: ObjectId = ObjectId()
    var name: String = ""
    // List of child EmbeddedRealmObject type (CANNOT be nullable)
    var posts: RealmList<Post> = realmListOf()
    // Dictionary of child EmbeddedRealmObject type (value MUST be nullable)
    var postByYear: RealmDictionary<Post?> = realmDictionaryOf()
}

// Backlink of EmbeddedRealmObject must be parent object type
class Post : EmbeddedRealmObject {
    var title: String = ""
    var date: RealmInstant = RealmInstant.now()
    // Backlink to parent RealmObject type (CANNOT be null & MUST be val)
    val user: User by backlinks(User::posts)
}