/ /

/ /

SDK de dispositivos Atlas

SDK de Java

Referencia de API

io.realm

Clase DynamicRealm

Los SDK de dispositivos Atlas están obsoletos. Consulte Página de desuso para más detalles.

io.realm

java.lang.Object

io.realm.BaseRealm

io.realm.DynamicRealm

DynamicRealm es una variante dinámica de io.realm.Realm. Esto significa que todo acceso a datos y/o consultas se realiza mediante nombres de clase basados en cadenas, en lugar de referencias a tipos de clase.

Esto es útil durante las migraciones o cuando se trabaja con datos basados en cadenas, como archivos CSV o XML.

La misma io.realm.RealmConfiguration puede usarse para abrir un archivo Realm tanto en modo dinámico como tipificado, pero modificar el esquema mientras hay una versión tipificada y dinámica abierta no es recomendado y muy probablemente provocará un fallo en el Realm tipificado. Durante las migraciones, solo un DynamicRealm estará abierto.

Los reinos dinámicos no aplican esquemas ni versiones de esquemas y el código RealmMigration no se utiliza incluso si se ha definido en RealmConfiguration.

Esto significa que el esquema no se crea ni se valida hasta que se abre un dominio en modo tipificado. Si un archivo de dominio se abre primero en modo dinámico, no contendrá información sobre clases y campos, y cualquier consulta a las clases definidas por el esquema fallará.

Tip

Resumen de clases anidadas

Modificador y Tipo	Clase y descripción
`public static interface`	DynamicRealm.Transaction
`public abstract static`	DynamicRealm.Devolución de llamada

Resumen del método

Modificador y Tipo	Método y descripción
vacío público	addChangeListener ( io.realm.RealmChangeListener<io.realm.DynamicRealm> listener ) Agrega un detector de cambios al Reino.
público <any>	asFlowable () Devuelve un RxJava Flowable que monitorea los cambios en este Reino.
objeto público de DynamicRealmObject	createEmbeddedObject ( String className, DynamicRealmObject parentObject, String parentProperty ) Crea una instancia y agrega un nuevo objeto incrustado al Reino.
objeto público de DynamicRealmObject	createObject ( String className, Object primaryKeyValue ) Crea un objeto con una clave principal determinada.
objeto público de DynamicRealmObject	createObject ( String className ) Crea una instancia y agrega un nuevo objeto al Reino.
vacío público	delete ( String className ) Elimina todos los objetos de la clase especificada del Reino.
vacío público	executeTransaction ( DynamicRealm.Transaction transaction ) Ejecuta una transacción determinada en el DynamicRealm.
Tarea asincrónica dedominio público	executeTransactionAsync ( DynamicRealm.Transaction transaction, DynamicRealm.Transaction.OnSuccess onSuccess, DynamicRealm.Transaction.OnError onError ) Similar a executeTransactionAsync(Transaction), pero también acepta devoluciones de llamadas OnSuccess y OnError.
Tarea asincrónica dedominio público	executeTransactionAsync ( DynamicRealm.Transaction transaction, DynamicRealm.Transaction.OnError onError ) Similar a executeTransactionAsync(Transaction), pero también acepta una devolución de llamada OnError.
Tarea asincrónica dedominio público	executeTransactionAsync ( DynamicRealm.Transaction transaction, DynamicRealm.Transaction.OnSuccess onSuccess ) Similar a executeTransactionAsync(Transaction), pero también acepta una devolución de llamada OnSuccess.
Tarea asincrónica dedominio público	executeTransactionAsync ( DynamicRealm.Transaction transaction ) Similar a executeTransaction(Transaction) pero se ejecuta de forma asincrónica en un hilo de trabajo.
dominio dinámico público	freeze () Devuelve una instantánea congelada del Reino actual.
DynamicRealm público estático	getInstance ( RealmConfiguration configuration ) Constructor estático de Realm que devuelve una variante dinámica de la instancia de Realm definida por io.realm.RealmConfiguration proporcionado.
Tarea pública estática RealmAsyncTask	getInstanceAsync ( RealmConfiguration configuration, DynamicRealm.Callback callback ) La creación de la primera instancia de Realm por RealmConfiguration en un proceso puede llevar algún tiempo, ya que todo el código de inicialización debe ejecutarse en ese punto (configurar el Realm, validar esquemas y crear datos iniciales).
Esquema de dominio público	getSchema () Devuelve el esquema mutable para este reino.
booleanopúblico	isEmpty () Comprueba si este io.realm.Realm contiene algún objeto.
vacío público	removeAllChangeListeners () Elimina todos los escuchas de cambios definidos por el usuario.
vacío público	removeChangeListener ( io.realm.RealmChangeListener<io.realm.DynamicRealm> listener ) Elimina el detector de cambios especificado.
Consulta de dominio público	where ( String className ) Devuelve un RealmQuery, que se puede utilizar para consultar la clase proporcionada.

Métodos heredados

Métodos heredados de la clase getClasshashCodeequalsclonetoStringnotifynotifyAllwaitwaitwaitjava.lang.Object:,,,,,,,,,, finalize
Methods inherited from class io.realm.BaseRealm: setAutoRefresh , isAutoRefresh , refresh , isInTransaction , addListener , removeListener , asFlowable , removeAllListeners , writeCopyTo , writeEncryptedCopyTo , waitForChange , stopWaitForChange , beginTransaction , commitTransaction , cancelTransaction , freeze , isFrozen , getNumberOfActiveVersions , checkIfValid , checkAllowQueriesOnUiThread , checkAllowWritesOnUiThread , checkIfInTransaction , checkIfValidAndInTransaction , getPath , getConfiguration , getVersion , close , isClosed , isEmpty , getSchema , getSubscriptions , deleteAll , migrateRealm , finalize

Detalle del método

addChangeListener

public void addChangeListener (

io.realm.RealmChangeListener<io.realm.DynamicRealm> listener

)

Agrega un detector de cambios al Reino. Los detectores se ejecutarán cuando este u otro hilo confirmen los cambios.

Las instancias de Realm se almacenan en caché por subproceso. Por eso, es importante recordar eliminar los escuchas de nuevo mediante removeChangeListener(RealmChangeListener) o removeAllChangeListeners(). No hacerlo puede causar fugas de memoria.

Parámetros

listener - el oyente de cambios.

Lanzamientos

IllegalArgumentException: si el detector de cambios null es.

Tip

io.realm.RealmChangeListener
removeChangeListener(RealmChangeListener)
eliminarTodosLosOyentesDeCambio()
refrescar()

como fluido

public <any> asFlowable ()

Devuelve un Flowable de RxJava que monitoriza los cambios en este dominio. Emitirá el estado actual al suscribirse. Los elementos se emitirán continuamente a medida que se actualice el dominio; nunca se llamará a onComplete.

Los elementos emitidos por Realm Flowables están congelados (consulta freeze()). Esto significa que son inmutables y pueden ser leídos en cualquier subproceso.

Los flowables de Realm siempre emiten elementos desde el hilo que contiene el Realm activo. Esto significa que, si necesita realizar más procesamiento, se recomienda observar los valores en un programador de cómputo:

realm.asFlowable()
 .observeOn(Schedulers.computation())
 .map(rxRealm -> doExpensiveWork(rxRealm))
 .observeOn(AndroidSchedulers.mainThread())
 .subscribe( ... );

Si desea que asFlowable() deje de emitir elementos, puede indicarle a RxJava que solo emita el primer elemento utilizando el operador first():

realm.asFlowable().first().subscribe( ... ); // You only get the results once

Devuelve

Observable de RxJava que solo llama a onNext . Nunca llamará a onComplete ni a OnError .

Anulaciones

asFlowable en la clase BaseRealm

crearObjetoIncrustado

public DynamicRealmObject createEmbeddedObject (

String  className,
DynamicRealmObject  parentObject,
String  parentProperty

)

Crea una instancia y agrega un nuevo objeto incrustado al Reino. Este método solo debe usarse para crear objetos de tipos marcados como incrustados.

Parámetros

className - el nombre de la clase del objeto a crear.
parentObject - El objeto principal que debe tener una referencia al objeto incrustado. Si la propiedad principal es una lista, el objeto incrustado se añadirá al final de esa lista.
parentProperty - la propiedad en la clase padre que contiene la referencia.

Devuelve

el objeto incrustado recién creado.

Lanzamientos

IllegalArgumentException: si clazz no es una clase incorporada o si la propiedad en la clase principal no puede contener objetos del tipo apropiado.

Tip

RealmClass.embedded()

createObject

public DynamicRealmObject createObject (

String className,

Object primaryKeyValue

)

Crea un objeto con una clave principal dada. Las clases sin una clave principal definida deben usar createObject(String) } en su lugar.

Devuelve

El nuevo objeto. Todos los campos tendrán valores predeterminados para su tipo, excepto el campo de clave principal, que tendrá el valor proporcionado.

Lanzamientos

RealmException: si no se pudo crear el objeto debido a que la clave principal no es válida.
IllegalStateException: si el modelo clazz no tiene una clave principal definida.
IllegalArgumentException - si el primaryKeyValue no tiene un valor que pueda convertirse al valor esperado.

public DynamicRealmObject createObject ( String className )
Crea una instancia y agrega un nuevo objeto al Reino. Parámetros `className` - el nombre de la clase del objeto a crear. Devuelve el nuevo objeto. Lanzamientos RealmException: si no se pudo crear el objeto.

borrar

public void delete ( String className )
Elimina todos los objetos de la clase especificada del Reino. Parámetros `className` - la clase para la cual se deben eliminar todos los objetos. Lanzamientos IllegalStateException: si el reino está cerrado o se llama desde un hilo incorrecto.

ejecutarTransacción

public void executeTransaction (

DynamicRealm.Transaction transaction

)

Ejecuta una transacción en DynamicRealm. Las operacionesbeginTransaction() y commitTransaction() se invocan automáticamente. Si se lanza una excepción durante la transacción, se invocará cancelTransaction() en lugar de commitTransaction().

Llamar a este método desde el hilo de la interfaz de usuario generará una RealmException. Esto podría provocar la pérdida de fotogramas o incluso ANR. Recomendamos llamar a este método desde un hilo que no sea de la interfaz de usuario o usar executeTransactionAsync(Transaction).

Parámetros

transaction - Transacción a ejecutar.

Lanzamientos

IllegalArgumentException: si transaction nulles.
RealmException: si se llama desde el hilo de UI, a menos que se haya declarado una aceptación explícita en RealmConfiguration.Builder.allowWritesOnUiThread(boolean).

ejecutarTransacciónAsync

public RealmAsyncTask executeTransactionAsync (

DynamicRealm.Transaction  transaction,
DynamicRealm.Transaction.OnSuccess  onSuccess,
DynamicRealm.Transaction.OnError  onError

)

Similar a executeTransactionAsync(Transaction), pero también acepta devoluciones de llamadas OnSuccess y OnError.

Parámetros

transaction - Transacción a ejecutar.
onSuccess - devolución de llamada invocada cuando la transacción tiene éxito.
onError - devolución de llamada invocada cuando falla la transacción.

Devuelve

una RealmAsyncTask que representa una tarea cancelable.

Lanzamientos

IllegalArgumentException: si transaction es null o si el reino se abre desde otro hilo.

public RealmAsyncTask executeTransactionAsync (

DynamicRealm.Transaction transaction,

DynamicRealm.Transaction.OnError onError

)

Similar a executeTransactionAsync(Transaction), pero también acepta una devolución de llamada OnError.

Parámetros

transaction - Transacción a ejecutar.
onError - devolución de llamada invocada cuando falla la transacción.

Devuelve

una RealmAsyncTask que representa una tarea cancelable.

Lanzamientos

IllegalArgumentException: si transaction es null o si el reino se abre desde otro hilo.

public RealmAsyncTask executeTransactionAsync (

DynamicRealm.Transaction transaction,

DynamicRealm.Transaction.OnSuccess onSuccess

)

Similar a executeTransactionAsync(Transaction), pero también acepta una devolución de llamada OnSuccess.

Parámetros

transaction - Transacción a ejecutar.
onSuccess - devolución de llamada invocada cuando la transacción tiene éxito.

Devuelve

una RealmAsyncTask que representa una tarea cancelable.

Lanzamientos

IllegalArgumentException: si transaction es null o si el reino se abre desde otro hilo.

public RealmAsyncTask executeTransactionAsync ( DynamicRealm.Transaction transaction )
Similar a executeTransaction(Transaction) pero se ejecuta de forma asincrónica en un hilo de trabajo. Parámetros `transaction` - Transacción a ejecutar. Devuelve una RealmAsyncTask que representa una tarea cancelable. Lanzamientos IllegalArgumentException: si `transaction` es `null` o si el reino se abre desde otro hilo.

freeze

public DynamicRealm freeze ()

Devuelve una instantánea congelada del dominio actual. Este dominio se puede leer y consultar desde cualquier hilo sin generar una excepción IllegalStateException. Un dominio congelado tiene su propio ciclo de vida y se puede cerrar mediante la función close(); sin embargo, cerrar completamente el dominio que generó la copia congelada también lo cerrará.

Los datos congelados se pueden consultar de forma normal, pero intentar mutarlos de cualquier forma o intentar registrar cualquier oyente arrojará una IllegalStateException.

Nota: Mantener un gran número de Realms con diferentes versiones vivos puede tener un impacto negativo en el tamaño del archivo del Realm. Para evitar una situación así, es posible establecer RealmConfiguration.Builder.maxNumberOfActiveVersions(long) .

Devuelve

una copia congelada de este Reino.

Anulaciones

freeze en la clase BaseRealm

obtenerInstancia

public static DynamicRealm getInstance (

RealmConfiguration configuration

)

Constructor estático de Realm que devuelve una variante dinámica de la instancia de Realm definida por io.realm.RealmConfiguration. Los Realms dinámicos no tienen en cuenta la versión del esquema ni los esquemas, por lo que abrir un Realm dinámico nunca activará una migración.

Devuelve

el DynamicRealm definido por la configuración.

Lanzamientos

RealmFileException: si ocurrió un error al acceder al archivo Realm subyacente.
IllegalArgumentException: si configuration el argumento null es.

Tip

RealmConfiguration para obtener detalles sobre cómo configurar un reino.

obtenerInstanciaAsync

public static RealmAsyncTask getInstanceAsync (

RealmConfiguration configuration,

DynamicRealm.Callback callback

)

La creación de la primera instancia de Realm por cada RealmConfiguration en un proceso puede tardar un tiempo, ya que todo el código de inicialización debe ejecutarse en ese momento (configuración de Realm, validación de esquemas y creación de datos iniciales). Este método coloca el trabajo de inicialización en un subproceso en segundo plano y entrega la instancia de Realm al subproceso de llamada de forma asíncrona una vez finalizada la inicialización.

Parámetros

configuration - RealmConfiguration se utiliza para abrir el Reino.
callback - se invoca para devolver los resultados.

Devuelve

una RealmAsyncTask que representa una tarea cancelable.

Lanzamientos

IllegalArgumentException: si se proporciona una RealmConfiguration nula o una devolución de llamada nula.
IllegalStateException: si se llama desde un hilo que no sea Looper o android.app.IntentService.

Tip

Vuelva a llamar para obtener más detalles.

getSchema

public RealmSchema getSchema ()
Devuelve el esquema mutable para este reino. Devuelve El esquema de reino para este reino. Anulaciones `getSchema` en la clase BaseRealm

isEmpty

public boolean isEmpty ()
Comprueba si este io.realm.Realm contiene algún objeto. Devuelve `true` si está vacío, @{code false} en caso contrario. Anulaciones `isEmpty` en la clase BaseRealm

eliminar todos los oyentes de cambio

public void removeAllChangeListeners ()
Elimina todos los escuchas de cambios definidos por el usuario. Lanzamientos IllegalStateException: si intenta eliminar oyentes de un subproceso que no es Looper. Tip io.realm.RealmChangeListener

removeChangeListener

public void removeChangeListener ( io.realm.RealmChangeListener<io.realm.DynamicRealm> listener )
Elimina el detector de cambios especificado. Parámetros `listener` - el detector de cambios que se eliminará. Lanzamientos IllegalArgumentException: si el detector de cambios `null` es. IllegalStateException: si intenta eliminar un oyente de un subproceso que no es Looper. Tip io.realm.RealmChangeListener

donde

public RealmQuery where ( String className )
Devuelve un RealmQuery, que se puede utilizar para consultar la clase proporcionada. Parámetros `className` - la clase del objeto que se va a consultar. Devuelve una RealmQuery, que se puede utilizar para consultar objetos específicos del tipo proporcionado. Lanzamientos IllegalArgumentException: si la clase no existe. Tip io.realm.RealmQuery

Volver

Devolución de llamada predeterminada CompactOnLaunch

DynamicRealm.Devolución de llamada