/ /

/ /

SDK de dispositivos Atlas

SDK de Java

Referencia de API

io.realm

Clase RealmObjectSchema

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

io.realm

java.lang.Object

io.realm.RealmObjectSchema

Clase para interactuar con el esquema de una clase RealmObject dada. Esto permite inspeccionar, añadir, eliminar o modificar los campos de la clase dada. Si este RealmObjectSchema se recupera de un RealmSchema inmutable, este también lo será.

Tip

io.realm.RealmMigration

Resumen de clases anidadas

Modificador y Tipo	Clase y descripción
`public static interface`	Esquema de objeto de reino.Función

Resumen del método

Modificador y Tipo	Método y descripción
Esquema de objeto realpúblico abstracto	addField ( String fieldName, java.lang.Class<?> fieldType, io.realm.FieldAttribute[] attributes ) Agrega un nuevo campo simple a la clase RealmObject.
Esquema de objeto realpúblico abstracto	addIndex ( String fieldName ) Agrega un índice a un campo determinado.
Esquema de objeto realpúblico abstracto	addPrimaryKey ( String fieldName ) Agrega una clave principal a un campo determinado.
Esquema de objeto realpúblico abstracto	addRealmDictionaryField ( String fieldName, java.lang.Class<?> primitiveType ) Agrega un nuevo campo que hace referencia a un RealmDictionary con valores primitivos.
Esquema de objeto realpúblico abstracto	addRealmDictionaryField ( String fieldName, RealmObjectSchema objectSchema ) Agrega un nuevo campo que contiene un RealmDictionary con referencias a otras clases de modelo Realm.
Esquema de objeto realpúblico abstracto	addRealmListField ( String fieldName, java.lang.Class<?> primitiveType ) Agrega un nuevo campo que hace referencia a una RealmList con valores primitivos.
Esquema de objeto realpúblico abstracto	addRealmListField ( String fieldName, RealmObjectSchema objectSchema ) Agrega un nuevo campo que contiene una RealmList con referencias a otras clases de modelo Realm.
Esquema de objeto realpúblico abstracto	addRealmObjectField ( String fieldName, RealmObjectSchema objectSchema ) Agrega un nuevo campo que hace referencia a otro RealmObject.
Esquema de objeto realpúblico abstracto	addRealmSetField ( String fieldName, java.lang.Class<?> primitiveType ) Agrega un nuevo campo que hace referencia a un RealmSet con valores primitivos.
Esquema de objeto realpúblico abstracto	addRealmSetField ( String fieldName, RealmObjectSchema objectSchema ) Agrega un nuevo campo que contiene un RealmSet con referencias a otras clases de modelo Realm.
cadena pública	getClassName () Devuelve el nombre de la clase RealmObject representada por este esquema.
conjunto público	getFieldNames () Devuelve todos los campos de esta clase.
public RealmFieldType	getFieldType ( String fieldName ) Devuelve el tipo utilizado por el motor de almacenamiento subyacente para representar este campo.
cadena pública	getPrimaryKey () Devuelve el nombre del campo de clave principal.
booleanopúblico	hasField ( String fieldName ) Prueba si la clase tiene un campo definido con el nombre dado.
booleanopúblico	hasIndex ( String fieldName ) Comprueba si un campo determinado tiene un índice definido.
booleanopúblico	hasPrimaryKey () Comprueba si la clase tiene una clave principal definida.
booleanopúblico	isEmbedded () Devuelve `true` si los objetos de este tipo se consideran "incrustados".
booleanopúblico	isNullable ( String fieldName ) Comprueba si un campo determinado es nulo, es decir, si puede contener valores `null`.
booleanopúblico	isPrimaryKey ( String fieldName ) Comprueba si un campo determinado es el campo de clave principal.
booleanopúblico	isRequired ( String fieldName ) Comprueba si un campo determinado es obligatorio, es decir, no puede contener valores `null`.
Esquema de objeto realpúblico abstracto	removeField ( String fieldName ) Elimina un campo de la clase.
Esquema de objeto realpúblico abstracto	removeIndex ( String fieldName ) Elimina un índice de un campo determinado.
Esquema de objeto realpúblico abstracto	removePrimaryKey () Elimina la clave principal de esta clase.
Esquema de objeto realpúblico abstracto	renameField ( String currentFieldName, String newFieldName ) Cambia el nombre de un campo de un nombre a otro.
Esquema de objeto realpúblico abstracto	setClassName ( String className ) Establece un nuevo nombre para esta clase RealmObject.
vacío público	setEmbedded ( boolean embedded ) Convierte la clase para que sea embebida o no.
Esquema de objeto realpúblico abstracto	setNullable ( String fieldName, boolean nullable ) Establece un campo para que admita valores nulos, es decir, debe poder contener valores `null`.
Esquema de objeto realpúblico abstracto	setRequired ( String fieldName, boolean required ) Establece un campo como obligatorio, es decir, no se permite que contenga valores `null`.
Esquema de objeto realpúblico abstracto	transform ( RealmObjectSchema.Function function ) Ejecuta una función de transformación en cada instancia RealmObject de la clase actual.

Métodos heredados

Métodos heredados de la clase getClasshashCodeequalsclonetoStringnotifynotifyAllwaitwaitwaitjava.lang.Object:,,,,,,,,,, finalize

Detalle del método

añadirCampo

public abstract RealmObjectSchema addField (

String  fieldName,
java.lang.Class<?>  fieldType,
io.realm.FieldAttribute[]  attributes

)

Añade un nuevo campo simple a la clase RealmObject. El tipo debe ser compatible con Realm. Consulta RealmObject para ver la lista de tipos compatibles. Si el campo debe admitir null valores, utiliza el tipo en caja; por ejemplo, Integer.class en lugar int.class de.

Para agregar campos que hagan referencia a otros RealmObjects o RealmLists, utilice addRealmObjectField(String, RealmObjectSchema) o addRealmListField(String, RealmObjectSchema) en su lugar.

Parámetros

fieldName - nombre del campo a agregar.
fieldType - Tipo de campo a agregar. Consulte RealmObject para ver la lista completa.
attributes - conjunto de atributos para este campo.

Devuelve

El esquema actualizado.

Lanzamientos

IllegalArgumentException: si el tipo no es compatible, el nombre del campo no es válido o ya existe un campo con ese nombre.
UnsupportedOperationException: si este RealmObjectSchema es inmutable o si se agrega un campo con el atributo FieldAttribute.PRIMARY_KEY a un esquema de un Realm sincronizado.

addIndex

public abstract RealmObjectSchema addIndex (

String fieldName

)

Añade un índice a un campo determinado. Esto equivale a añadir la anotación io.realm.annotations.Index al campo.

Parámetros

fieldName - campo al que agregar índice.

Devuelve

El esquema actualizado.

Lanzamientos

IllegalArgumentException: si el nombre del campo no existe, el campo no se puede indexar o ya tiene un índice definido.
UnsupportedOperationException: si este RealmObjectSchema es inmutable.

agregarClavePrimaria

public abstract RealmObjectSchema addPrimaryKey (

String fieldName

)

Añade una clave principal a un campo determinado. Esto equivale a añadir la anotación io.realm.annotations.PrimaryKey al campo. Además, esto también añade implícitamente la anotación io.realm.annotations.Index al campo.

Parámetros

fieldName - campo a establecer como clave principal.

Devuelve

El esquema actualizado.

Lanzamientos

IllegalArgumentException: si el nombre del campo no existe, el campo no puede ser una clave principal o ya tiene una clave principal definida.
UnsupportedOperationException: si este RealmObjectSchema es inmutable o de un Realm sincronizado.

añadirCampoDiccionarioRealm

public abstract RealmObjectSchema addRealmDictionaryField (

String fieldName,

java.lang.Class<?> primitiveType

)

Añade un nuevo campo que hace referencia a un RealmDictionary con valores primitivos. Consulta RealmObject para ver la lista de tipos admitidos.

La nulabilidad de los elementos se define usando la clase correcta, Integer.class por ejemplo, en lugar int.class de. Alternativamente, se puede usar setRequired(String, boolean).

Ejemplo:

// Defines the dictionary of Strings as being non null.
RealmObjectSchema schema = schema.create("Person")
    .addRealmDictionaryField("parentAndChild", String.class)
    .setRequired("parentAndChild", true)

Si la lista contiene referencias a otras clases de Realm, utilice addRealmDictionaryField(String, RealmObjectSchema) en su lugar.

Parámetros

fieldName - nombre del campo a agregar.
primitiveType - tipo sencillo de elementos en el arreglo.

Devuelve

El esquema actualizado.

Lanzamientos

IllegalArgumentException: si el nombre del campo no es válido, ya existe un campo con ese nombre o el tipo de elemento no es compatible.
UnsupportedOperationException: si este RealmObjectSchema es inmutable.

public abstract RealmObjectSchema addRealmDictionaryField (

String fieldName,

RealmObjectSchema objectSchema

)

Agrega un nuevo campo que contiene un RealmDictionary con referencias a otras clases de modelo Realm.

Si el diccionario contiene tipos primitivos, utilice addRealmDictionaryField(String, Class) en su lugar.

Parámetros

fieldName - nombre del campo a agregar.
objectSchema - esquema para el tipo de Reino al que se hace referencia.

Devuelve

El esquema actualizado.

Lanzamientos

IllegalArgumentException: si el nombre del campo no es válido o ya existe un campo con ese nombre.
UnsupportedOperationException: si este RealmObjectSchema es inmutable.

añadirCampoListaRealm

public abstract RealmObjectSchema addRealmListField (

String fieldName,

java.lang.Class<?> primitiveType

)

Añade un nuevo campo que hace referencia a una RealmList con valores primitivos. Consulta RealmObject para ver la lista de tipos admitidos.

La nulabilidad de los elementos se define usando la clase correcta, Integer.class por ejemplo, en lugar int.class de. Alternativamente, se puede usar setRequired(String, boolean).

Ejemplo:

// Defines the list of Strings as being non null.
RealmObjectSchema schema = schema.create("Person")
    .addRealmListField("children", String.class)
    .setRequired("children", true)

Si la lista contiene referencias a otras clases de Realm, utilice addRealmListField(String, RealmObjectSchema) en su lugar.

Parámetros

fieldName - nombre del campo a agregar.
primitiveType - tipo sencillo de elementos en el arreglo.

Devuelve

El esquema actualizado.

Lanzamientos

IllegalArgumentException: si el nombre del campo no es válido, ya existe un campo con ese nombre o el tipo de elemento no es compatible.
UnsupportedOperationException: si este RealmObjectSchema es inmutable.

public abstract RealmObjectSchema addRealmListField (

String fieldName,

RealmObjectSchema objectSchema

)

Agrega un nuevo campo que contiene una RealmList con referencias a otras clases de modelo Realm.

Si la lista contiene tipos primitivos, usa addRealmListField(String, clase) en su lugar.

Parámetros

fieldName - nombre del campo a agregar.
objectSchema - esquema para el tipo de Reino al que se hace referencia.

Devuelve

El esquema actualizado.

Lanzamientos

IllegalArgumentException: si el nombre del campo no es válido o ya existe un campo con ese nombre.
UnsupportedOperationException: si este RealmObjectSchema es inmutable.

addRealmObjectField

public abstract RealmObjectSchema addRealmObjectField (

String fieldName,

RealmObjectSchema objectSchema

)

Agrega un nuevo campo que hace referencia a otro RealmObject.

Parámetros

fieldName - nombre del campo a agregar.
objectSchema - esquema para el tipo de Reino al que se hace referencia.

Devuelve

El esquema actualizado.

Lanzamientos

IllegalArgumentException: si el nombre del campo no es válido o ya existe un campo con ese nombre.
UnsupportedOperationException: si este RealmObjectSchema es inmutable.

añadirCampoConjuntoReino

public abstract RealmObjectSchema addRealmSetField (

String fieldName,

java.lang.Class<?> primitiveType

)

Añade un nuevo campo que hace referencia a un RealmSet con valores primitivos. Consulta RealmObject para ver la lista de tipos admitidos.

La nulabilidad de los elementos se define usando la clase correcta, Integer.class por ejemplo, en lugar int.class de. Alternativamente, se puede usar setRequired(String, boolean).

Ejemplo:

// Defines the set of Strings as being non null.
RealmObjectSchema schema = schema.create("Person")
    .addRealmSetField("children", String.class)
    .setRequired("children", true)

Si la lista contiene referencias a otras clases de Realm, utilice addRealmSetField(String, RealmObjectSchema) en su lugar.

Parámetros

fieldName - nombre del campo a agregar.
primitiveType - tipo sencillo de elementos en el arreglo.

Devuelve

El esquema actualizado.

Lanzamientos

IllegalArgumentException: si el nombre del campo no es válido, ya existe un campo con ese nombre o el tipo de elemento no es compatible.
UnsupportedOperationException: si este RealmObjectSchema es inmutable.

public abstract RealmObjectSchema addRealmSetField (

String fieldName,

RealmObjectSchema objectSchema

)

Agrega un nuevo campo que contiene un RealmSet con referencias a otras clases de modelo Realm.

Si el conjunto contiene tipos primitivos, utilice addRealmSetField(String, Class) en su lugar.

Parámetros

fieldName - nombre del campo a agregar.
objectSchema - esquema para el tipo de Reino al que se hace referencia.

Devuelve

El esquema actualizado.

Lanzamientos

IllegalArgumentException: si el nombre del campo no es válido o ya existe un campo con ese nombre.
UnsupportedOperationException: si este RealmObjectSchema es inmutable.

obtenerNombreDeClase

public String getClassName ()

Devuelve el nombre de la clase RealmObject representada por este esquema.

Cuando se utiliza un reino normal, este nombre es el mismo que el de la clase RealmObject.
Cuando se utiliza un DynamicRealm, este es el nombre que se utiliza en todos los métodos de API que requieren un nombre de clase.

Devuelve

el nombre de la clase RealmObject representada por este esquema.

Lanzamientos

IllegalStateException: si esta definición de esquema ya no es parte del reino.

obtenerNombresDeCampo

public Set getFieldNames ()
Devuelve todos los campos de esta clase. Devuelve una lista de todos los campos de esta clase.

getFieldType

public RealmFieldType getFieldType ( String fieldName )
Devuelve el tipo utilizado por el motor de almacenamiento subyacente para representar este campo. Parámetros `fieldName` - nombre del campo objetivo. Devuelve el tipo subyacente utilizado por Realm para representar este campo.

obtenerClavePrimaria

public String getPrimaryKey ()
Devuelve el nombre del campo de clave principal. Devuelve el nombre del campo de clave principal. Lanzamientos IllegalStateException: si la clase no tiene una clave principal definida.

tieneCampo

public boolean hasField ( String fieldName )
Prueba si la clase tiene un campo definido con el nombre dado. Parámetros `fieldName` - nombre del campo a probar. Devuelve `true` si el campo existe, `false` en caso contrario.

hasIndex

public boolean hasIndex ( String fieldName )
Comprueba si un campo determinado tiene un índice definido. Parámetros `fieldName` - nombre del campo existente para comprobar. Devuelve `true` si el campo está indexado, `false` en caso contrario. Lanzamientos IllegalArgumentException: si el nombre del campo no existe. Tip io.realm.annotations.Índice

tiene clave primaria

public boolean hasPrimaryKey ()
Comprueba si la clase tiene una clave principal definida. Devuelve `true` si se define una clave principal, `false` en caso contrario. Tip io.realm.anotaciones.Clave primaria

está incrustado

public boolean isEmbedded ()
Devuelve `true` si los objetos de este tipo se consideran "incrustados". Consulte RealmClass.embedded() para obtener más información. Devuelve `true` si están incrustados objetos de este tipo. `false` si no.

es nulo

public boolean isNullable ( String fieldName )
Comprueba si un campo determinado es nulo, es decir, si puede contener valores `null`. Parámetros `fieldName` - campo a comprobar. Devuelve `true` si es necesario, `false` en caso contrario. Lanzamientos IllegalArgumentException: si el nombre del campo no existe. Tip setNullable(Cadena, booleano)

isPrimaryKey

public boolean isPrimaryKey ( String fieldName )
Comprueba si un campo determinado es el campo de clave principal. Parámetros `fieldName` - campo a comprobar. Devuelve `true` si es el campo de clave principal, `false` en caso contrario. Lanzamientos IllegalArgumentException: si el nombre del campo no existe. Tip addPrimaryKey(Cadena)

se requiere

public boolean isRequired ( String fieldName )
Comprueba si un campo determinado es obligatorio, es decir, no puede contener valores `null`. Parámetros `fieldName` - campo a comprobar. Devuelve `true` si es necesario, `false` en caso contrario. Lanzamientos IllegalArgumentException: si el nombre del campo no existe. Tip setRequired(Cadena, booleano)

eliminarCampo

public abstract RealmObjectSchema removeField ( String fieldName )
Elimina un campo de la clase. Parámetros `fieldName` - nombre del campo a eliminar. Devuelve El esquema actualizado. Lanzamientos IllegalArgumentException: si el nombre del campo no existe. UnsupportedOperationException: si este RealmObjectSchema es inmutable o para un Realm sincronizado.

eliminarÍndice

public abstract RealmObjectSchema removeIndex (

String fieldName

)

Elimina un índice de un campo determinado. Esto equivale a eliminar la anotación @Index del campo.

Parámetros

fieldName - campo del cual eliminar el índice.

Devuelve

El esquema actualizado.

Lanzamientos

IllegalArgumentException - si el nombre del campo no existe o el campo no tiene un índice.
UnsupportedOperationException: si este RealmObjectSchema es inmutable o de un Realm sincronizado.

eliminarClavePrincipal

public abstract RealmObjectSchema removePrimaryKey ()

Elimina la clave principal de esta clase. Esto equivale a eliminar la anotación io.realm.annotations.PrimaryKey de la clase. Además, esto también elimina implícitamente la anotación io.realm.annotations.Index del campo.

Devuelve

El esquema actualizado.

Lanzamientos

IllegalArgumentException: si la clase no tiene una clave principal definida.
UnsupportedOperationException: si este RealmObjectSchema es inmutable o de un Realm sincronizado.

renombrarCampo

public abstract RealmObjectSchema renameField (

String currentFieldName,

String newFieldName

)

Cambia el nombre de un campo de un nombre a otro.

Parámetros

currentFieldName - nombre del campo a renombrar.
newFieldName - el nuevo nombre del campo.

Devuelve

El esquema actualizado.

Lanzamientos

IllegalArgumentException: si el nombre de campo no existe o si el nuevo nombre de campo ya existe.
UnsupportedOperationException: si este RealmObjectSchema es inmutable o para un Realm sincronizado.

establecerNombreDeClase

public abstract RealmObjectSchema setClassName (

String className

)

Establece un nuevo nombre para esta clase RealmObject. Esto equivale a cambiarle el nombre.

Parámetros

className - el nuevo nombre para esta clase.

Lanzamientos

IllegalArgumentException: si className es null o una cadena vacía, o su longitud excede 56 caracteres.
UnsupportedOperationException: si este RealmObjectSchema es inmutable o pertenece a un Realm sincronizado.

Tip

RealmSchema.rename(Cadena, Cadena)

conjunto incrustado

public void setEmbedded (

boolean embedded

)

Convierte la clase para que esté incrustada o no. Una clase solo se puede marcar como incrustada si se cumplen las siguientes invariantes:

No se permite que la clase tenga una clave principal definida.
Todos los objetos existentes de este tipo deben tener un solo objeto padre apuntando a ellos. Si 0 o más de 1 objetos tienen una referencia a un objeto que se va a marcar como incrustado, se lanzará una excepción IllegalStateException.

Lanzamientos

IllegalStateException - si la clase no pudo convertirse porque rompió algunas de las invariantes de los objetos incrustados.

Tip

RealmClass.embedded()

setNullable

public abstract RealmObjectSchema setNullable (

String fieldName,

boolean nullable

)

Establece que un campo admita valores nulos, es decir, que pueda contener valores null. Esto equivale a alternar entre tipos primitivos y su variante en caja, por ejemplo, de int a Integer .

Si el tipo de campo designado es una lista de valores (no RealmObjects), la nulabilidad especificada solo afecta a sus elementos, no al campo en sí. La lista de valores en sí siempre es no nula.

Parámetros

fieldName - nombre del campo en la clase.
nullable - true si el campo debe ser nulo, false en caso contrario.

Devuelve

El esquema actualizado.

Lanzamientos

IllegalArgumentException: si el nombre del campo no existe o no se puede configurar como nulo.
UnsupportedOperationException: si este RealmObjectSchema es inmutable.

conjuntoRequerido

public abstract RealmObjectSchema setRequired (

String fieldName,

boolean required

)

Establece un campo como obligatorio, es decir, no se permite que contenga valores null. Esto equivale a alternar entre tipos en caja y su variante primitiva, por ejemplo, de Integer a int .

Si el tipo de campo designado es una lista de valores (no RealmObjects), la nulabilidad especificada solo afecta a sus elementos, no al campo en sí. La lista de valores en sí siempre es no nula.

Parámetros

fieldName - nombre del campo en la clase.
required - true si el campo debe ser obligatorio, false en caso contrario.

Devuelve

El esquema actualizado.

Lanzamientos

IllegalArgumentException: si el nombre del campo no existe, no puede tener la anotación Requerida o el campo ya se ha configurado como obligatorio.
UnsupportedOperationException: si este RealmObjectSchema es inmutable.

Tip

Requerido

transformar

public abstract RealmObjectSchema transform ( RealmObjectSchema.Function function )
Ejecuta una función de transformación en cada instancia de RealmObject de la clase actual. El objeto se representará como DynamicRealmObject. No hay garantías en el orden en que se devuelven los objetos. Parámetros `function` - función de transformación. Devuelve este esquema. Lanzamientos UnsupportedOperationException: si este RealmObjectSchema es inmutable.

Volver

RealmObjectChangeListener

Esquema de objeto de reino.Función