Definir um modelo de objeto de domínio - SDK Kotlin

Objetos reais

Os objetos de Realm são instâncias nomeadas exclusivamente de classes Kotlin com as quais você pode trabalhar como faria com qualquer outra instância de classe .

Cada classe de objeto representa um tipo de objeto. Objetos do mesmo tipo compartilham um esquema de objetos, que define as propriedades e relacionamentos para objetos desse tipo. O SDK garante que todos os objetos em um Realm estejam em conformidade com o esquema do seu tipo de objeto e valida os objetos sempre que eles são criados, modificados ou excluídos.

No entanto, observe que os objetos de Realm têm as seguintes restrições:

• Objeto de Realm devem herdar da classe RealmObject ou de suas subclasses: EmbeddedRealmObject ou AsymmetricRealmObject. O Kotlin SDK não suporta herança de classes de base personalizadas.

• O Kotlin SDK exige que os objetos de Realm tenham um construtor vazio. Consulte oexemplo de solução observado na próxima seção.

• Os nomes das classes têm um limite máximo de 57 caracteres UTF-8.

Além disso, o Kotlin SDK não suporta o uso de classes de dados do Kotlin{ para modelar dados. Isso ocorre porque as classes de dados normalmente são usadas para dados imutáveis, o que vai contra a forma como o Realm Kotlin SDK modela os dados.

Definir um novo tipo de objeto

Para definir um novo tipo de objeto , você deve criar uma classe Kotlin nomeada exclusivamente que implemente a interface RealmObject, EmbeddedRealmObject ou AsymmetricRealmObject .

Em seguida, você especifica as propriedades do seu objeto, incluindo:

• O tipo de dados para cada propriedade. O Kotlin SDK suporta os seguintes tipos de dados:

  • Tipos primitivos do Kotlin

  • um subconjunto limitado de BSON tipos

  • Tipos específicos do domínio, que você pode usar para identificadores exclusivos, registros de data/hora, contadores e coleções

• Quaisquer anotações de propriedade, que adicionam funcionalidade às propriedades em seus objetos de Realm . Você pode usar anotações para:

  • Designar uma propriedade como chave primária

  • Marcar uma propriedade como indexável

  • Ignorar uma propriedade

  • Mapear uma propriedade ou nome de classe para outro nome

• Quaisquer relacionamentos com outros objetos do Realm .

Depois de definir seu modelo de Objeto de Realm , você pode passar o conjunto de classes de objeto para a configuração do realm quando abrir um Realm e, em seguida, trabalhar com esses objetos no Realm.

class Person(var name: String, var age: Int): RealmObject {
   constructor(): this("", 0) // Empty constructor required by Realm
}

// Implements the `RealmObject` interface
class Frog : RealmObject { // Empty constructor required by Realm
    @PrimaryKey
    var _id: ObjectId = ObjectId()
    var name: String = ""
    var age: Int = 0
    var species: String? = null
    var owner: String? = null
}

// Implements `EmbeddedRealmObject` interface
class EmbeddedAddress : EmbeddedRealmObject {
    // CANNOT have primary key
    var street: String? = null
    var city: String? = null
    var state: String? = null
    var postalCode: String? = null
    var propertyOwner: Contact? = null
}

// Implements the `AsymmetricRealmObject` interface
class WeatherSensor : AsymmetricRealmObject {
    @PersistedName("_id")
    @PrimaryKey
    var id: ObjectId = ObjectId()
    var deviceId: String = ""
    var temperatureInFarenheit: Float = 0.0F
    var barometricPressureInHg: Float = 0.0F
    var windSpeedInMph: Int = 0
}

Definir propriedades da coleção

Uma coleção é um objeto que contém zero ou mais instâncias de um tipo de dados suportado. As coleções Realm são homogêneas (todos os objetos em uma coleção são do mesmo tipo) e são apoiadas por suas classes Kotlin incorporadas correspondentes. Para obter mais informações sobre os tipos de coleção usados no Kotlin SDK e seus tipos de dados suportados, consulte Tipos de coleção.

O Kotlin SDK oferece vários tipos de coleção que você pode usar como propriedades em seu modelo de dados: RealmList, RealmSet e RealmDictionary.

As coleções também permitem definir relacionamentos entre objetos de Realm . Consulte Relacionamentos - Kotlin SDK para obter mais informações.

// RealmList<E> can be any supported primitive
// or BSON type, a RealmObject, or an EmbeddedRealmObject
class Frog : RealmObject {
    var _id: ObjectId = ObjectId()
    var name: String = ""
    // List of RealmObject type (CANNOT be nullable)
    var favoritePonds: RealmList<Pond> = realmListOf()
    // List of EmbeddedRealmObject type (CANNOT be nullable)
    var favoriteForests: RealmList<EmbeddedForest> = realmListOf()
    // List of primitive type (can be nullable)
    var favoriteWeather: RealmList<String?> = realmListOf()
}
class Pond : RealmObject {
    var _id: ObjectId = ObjectId()
    var name: String = ""
}

// RealmSet<E> can be any supported primitive or
// BSON type or a RealmObject
class Frog : RealmObject {
    var _id: ObjectId = ObjectId()
    var name: String = ""
    // Set of RealmObject type (CANNOT be nullable)
    var favoriteSnacks: RealmSet<Snack> = realmSetOf()
    // Set of primitive type (can be nullable)
    var favoriteWeather: RealmSet<String?> = realmSetOf()
}
class Snack : RealmObject {
    var _id: ObjectId = ObjectId()
    var name: String = ""
}

// RealmDictionary<K, V> can be any supported
// primitive or BSON types, a RealmObject, or
// an EmbeddedRealmObject
class Frog : RealmObject {
    var _id: ObjectId = ObjectId()
    var name: String = ""
    // Dictionary of RealmObject type (value MUST be nullable)
    var favoriteFriendsByPond: RealmDictionary<Frog?> = realmDictionaryOf()
    // Dictionary of EmbeddedRealmObject type (value MUST be nullable)
    var favoriteTreesInForest: RealmDictionary<EmbeddedForest?> = realmDictionaryOf()
    // Dictionary of primitive type (value can be nullable)
    var favoritePondsByForest: RealmDictionary<String?> = realmDictionaryOf()
}

// Percent encode . or $ characters to use them in map keys
val mapKey = "Hundred Acre Wood.Northeast"
val encodedMapKey = "Hundred Acre Wood%2ENortheast"

Definir dados não estruturados

A partir da versão 2.0.0 do Kotlin SDK , você pode armazenar collections de dados mistos dentro de uma propriedade RealmAny . Você pode usar esse recurso para modelar estruturas de dados complexas, como documentos JSON ou MongoDB , sem precisar definir um modelo de dados rigoroso.

Dados não estruturados são dados que não estão em conformidade com facilmente um esquema esperado, tornando difícil ou impraticável modelar classes de dados individuais. Por exemplo, seu aplicativo pode ter dados altamente variáveis ou dados dinâmicos cuja estrutura é desconhecida no tempo de execução.

O armazenamento de coleções em uma propriedade mista oferece flexibilidade sem sacrificar a funcionalidade, incluindo sincronização de desempenho ao usar o Device Sync. E você pode trabalhar com eles da mesma forma que faria com uma collection não mista:

• Você pode aninhar collections mistas em até 100 níveis.

• Você pode consultar e React a alterações em coleções mistas.

• Você pode localizar e atualizar elementos individuais de coleção mista.

No entanto, armazenar dados em coleções mistas é menos eficiente do que usar um esquema estruturado ou serializar blobs JSON em uma única propriedade de string.

Para modelar dados não estruturados em seu aplicativo, defina as propriedades apropriadas em seu esquema como tipos RealmAny . Você pode então definir essas propriedades RealmAny como uma coleção RealmList ou RealmDictionary de RealmAny elementos. Observe que RealmAny não pode representar um RealmSet ou um objeto incorporado.