関係 - Kotlin SDK

To-1 の関係プロパティの定義

対 1 の関係は、1 つのプロパティをRealmObjectオブジェクトタイプの単一のインスタンスにマッピングします。 複数の親オブジェクト インスタンスが同じ子インスタンスを参照することを妨げるものではありません。 厳密な 1 対 1 の関係を強制する場合は、代わりに埋め込みオブジェクトを使用します。

オブジェクト間の 1 対 1 の関係を定義するには、データモデルで定義されたRealmObjectオブジェクトであるタイプの任意のオブジェクト プロパティを定義します。 これは、異なる Realm オブジェクトタイプまたは同じ 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
}

ToMany 関係プロパティの定義

対多の関係は、1 つのプロパティをRealmObjectオブジェクトタイプの 0 つ以上のインスタンスにマッピングします。 複数の親オブジェクト インスタンスが同じ子インスタンスを参照することを妨げるものではありません。 厳密な 1 対多の関係を強制する場合は、代わりに埋め込みオブジェクトを使用します。

Realm では、対多の関係は Realm オブジェクトのコレクション（ RealmListまたはRealmSet ）です。 オブジェクトモデルでコレクションを定義する方法の詳細については、「コレクションのプロパティの定義 」を参照してください。

オブジェクト間の対多の関係を定義するには、タイプがRealmList<E>またはRealmSet<E>であるオブジェクト プロパティを定義します。ここでは、 <E>はデータモデルで定義されたRealmObjectオブジェクトタイプです。 これは、異なる Realm オブジェクトタイプまたは同じ 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()
}

逆の関係の定義

逆の関係とは、子RealmObjectオブジェクトとそれを参照する他の親オブジェクトとの間の自動バックリンクの関係です。 逆の関係は、多対 1 または多対多の関係で子オブジェクトにリンクすることができます。 厳密な 1 対 1 または 1 対多の逆関係を強制する場合は、代わりに埋め込みオブジェクトを使用します。

関係の定義は一方向であるため、オブジェクトのモデルでプロパティを逆の関係として明示的に定義する必要があります。 たとえば、「ユーザーが多数の投稿を持っている」という対多の関係では、「書き込みはユーザーに属する」の関係が自動的に作成されることはありません。 ただし、書き込みの所有者を示す ユーザー プロパティを書き込みに追加することはできます。 これにより、書き込みが属するユーザーを検索するために別のクエリを実行する代わりに、書き込みからユーザーへの逆の関係でクエリを実行できます。 関係は多対 1 または多対多であるため、逆の関係にすると、ゼロ、1、または多のオブジェクトが生成されます。

オブジェクト間の逆関係を定義するには、まず親オブジェクトで、タイプがRealmList<E> 、 RealmSet<E> 、またはRealmDictionary<E>であるコレクション プロパティを定義します<E>は、データモデルで定義されたRealmObjectオブジェクトタイプです） 。 これは、異なる Realm オブジェクトタイプまたは同じ 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()
}

次に、 RealmResults<E>の子オブジェクトに不変のバックリンクプロパティを定義します。ここでは、 <E>は親オブジェクトタイプです。

// 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)
}

埋め込みオブジェクトの定義

埋め込みオブジェクトは、単一の特定の親オブジェクトの内部にデータをネストするために使用できる特殊なタイプの Realm オブジェクトです。 埋め込みオブジェクトは、前のセクションで説明された関係と同様の 1 対 1、1 対多、または逆の関係にすることができますが、関係は単一の親オブジェクトとEmbeddedRealmObjectの間の 1 対の関係に制限されます。 型。

埋め込みオブジェクトは独立した Realm オブジェクトとして存在できないため、考慮する必要がある追加の制約があります。

• 埋め込みオブジェクトは親による厳密な所有権があります。 親オブジェクト間で埋め込みオブジェクトを共有することはできません。

• 埋め込みオブジェクトは、親のライフサイクルを継承します。 たとえば、親オブジェクトを削除すると、埋め込みオブジェクトも削除されます。

埋め込みオブジェクトは、明確な包含または所有権関係がある場合に便利です。 たとえば、 AddressオブジェクトはUserオブジェクトに埋め込まれます。これは、ユーザーのコンテキスト内のアプリケーションでのみ意味があるためです。

// 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)
}