クラス RealmObjectSchema

Atlas Device SDK は非推奨です。詳細については、の廃止ページを参照してください。

io.realm

java.lang.Object

io.realm.RealmObjectSchema

指定された RealmObject クラスのスキーマを操作するためのクラス。これにより、特定のクラスのフィールドを検査、追加、削除、変更することが可能になります。このRealmObjectSchemaが不変のRealmSchemaから取得される場合、このRealmObjectSchemaも不変になります。

Tip

以下も参照してください。

io.realm.RealmMigration

ネストされたクラスの概要

修飾子と型	クラスと説明
`public static interface`	RealmObjectSchema.Function

メソッドの概要

修飾子と型	メソッドと説明
public abstract RealmObjectSchema	addField ( String fieldName, java.lang.Class<?> fieldType, io.realm.FieldAttribute[] attributes ) RealmObject クラスに新しい単純フィールドを追加します。
public abstract RealmObjectSchema	addIndex ( String fieldName ) 指定されたフィールドにインデックスを追加します。
public abstract RealmObjectSchema	addPrimaryKey ( String fieldName ) 指定されたフィールドにプライマリキーを追加します。
public abstract RealmObjectSchema	addRealmDictionaryField ( String fieldName, java.lang.Class<?> primitiveType ) プリミティブ値を持つRealmDictionaryを参照する新しいフィールドを追加します。
public abstract RealmObjectSchema	addRealmDictionaryField ( String fieldName, RealmObjectSchema objectSchema ) 他の Realm モデルクラスへの参照を持つRealmDictionaryを含む新しいフィールドを追加します。
public abstract RealmObjectSchema	addRealmListField ( String fieldName, java.lang.Class<?> primitiveType ) プリミティブ値を持つRealmListを参照する新しいフィールドを追加します。
public abstract RealmObjectSchema	addRealmListField ( String fieldName, RealmObjectSchema objectSchema ) 他の Realm モデルクラスへの参照を持つRealmListを含む新しいフィールドを追加します。
public abstract RealmObjectSchema	addRealmObjectField ( String fieldName, RealmObjectSchema objectSchema ) 別のRealmObjectを参照する新しいフィールドを追加します。
public abstract RealmObjectSchema	addRealmSetField ( String fieldName, java.lang.Class<?> primitiveType ) プリミティブ値を持つRealmSetを参照する新しいフィールドを追加します。
public abstract RealmObjectSchema	addRealmSetField ( String fieldName, RealmObjectSchema objectSchema ) 他の Realm モデルクラスへの参照を持つRealmSetを含む新しいフィールドを追加します。
public string	getClassName () このスキーマによって表される RealmObject クラスの名前を返します。
public Set	getFieldNames () このクラスのすべてのフィールドを返します。
public RealmFieldType	getFieldType ( String fieldName ) このフィールドを表すために基礎となるストレージエンジンによって使用される型を返します。
public string	getPrimaryKey () プライマリキーフィールドの名前を返します。
パブリックブール値	hasField ( String fieldName ) クラスに指定された名前で定義されているフィールドがあるかどうかをテストします。
パブリックブール値	hasIndex ( String fieldName ) 特定のフィールドにインデックスが定義されているかどうかを確認します。
パブリックブール値	hasPrimaryKey () クラスにプライマリキーが定義されているかどうかを確認します。
パブリックブール値	isEmbedded () このタイプのオブジェクトが「埋め込み」と見なされる場合は、 `true`を返します。
パブリックブール値	isNullable ( String fieldName ) 特定のフィールドが null 可能かどうか、つまり、 `null`値を含めることができるかどうかを確認します。
パブリックブール値	isPrimaryKey ( String fieldName ) 特定のフィールドがプライマリキーフィールドであるかどうかを確認します。
パブリックブール値	isRequired ( String fieldName ) 特定のフィールドが必須であるかどうか、つまり、 `null`値を含めることができないかどうかを確認します。
public abstract RealmObjectSchema	removeField ( String fieldName ) クラスからフィールドを削除します。
public abstract RealmObjectSchema	removeIndex ( String fieldName ) 指定されたフィールドからインデックスを削除します。
public abstract RealmObjectSchema	removePrimaryKey () このクラスからプライマリキーを削除します。
public abstract RealmObjectSchema	renameField ( String currentFieldName, String newFieldName ) フィールドの名前を、ある名前から別の名前に変更します。
public abstract RealmObjectSchema	setClassName ( String className ) この RealmObject クラスの新しい名前を設定します。
public void	setEmbedded ( boolean embedded ) クラスを埋め込みかどうか変換します。
public abstract RealmObjectSchema	setNullable ( String fieldName, boolean nullable ) フィールドを nullable に設定します。つまり、 `null`値を保持できる必要があります。
public abstract RealmObjectSchema	setRequired ( String fieldName, boolean required ) フィールドを必須に設定します。つまり、 `null`値を保持できないフィールドです。
public abstract RealmObjectSchema	transform ( RealmObjectSchema.Function function ) 現在のクラスの各 RealmObject インスタンスに対して変換関数を実行します。

継承されたメソッド

クラス java.lang.Object から継承されたメソッド :getClass 、hashCode 、equals 、clone 、toString 、notify 、notifyAll 、wait 、wait 、wait 、finalize

メソッドの詳細

addField

public abstract RealmObjectSchema addField (

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

)

RealmObject クラスに新しい単純フィールドを追加します。 Realm でサポートされているタイプである必要があります。サポートされているタイプのリストについては、「 RealmObject 」を参照してください。フィールドでnull 値を許可する必要がある場合は、代わりにボックス型を使用します。例:Integer.class ではなくint.class 。

他の RealmObject または Realmlist を参照するフィールドを追加するには、代わりにaddRealmObjectField( string 、RealmObjectSchema)またはaddRealmListField( string 、RealmObjectSchema)を使用します。

パラメーター

fieldName - 追加するフィールドの名前。
fieldType - 追加するフィールドのタイプ。 RealmObjectの完全なリストについては、「 RealmObject 」を参照してください。
attributes - このフィールドの属性のセット。

戻り値

更新されたスキーマ。

スロー

IllialArgmentException - 型がサポートされていない場合、フィールド名が不正であるか、その名前のフィールドがすでに存在します。
UnsupportedOperationException - この RealmObjectSchema が不変の場合、または同期された Realm のスキーマに FieldAttribute. プライマリ_KEY 属性を持つフィールドを追加する場合は。

addIndex

public abstract RealmObjectSchema addIndex (

String fieldName

)

指定されたフィールドにインデックスを追加します。これはフィールドにio.realm.annotations.Index注釈を追加することと同じです。

パラメーター

fieldName インデックスを追加する - フィールド。

戻り値

更新されたスキーマ。

スロー

IllialArgmentException - フィールド名が存在しない場合、フィールドはインデックスを作成できない、またはすでにインデックスが定義されている場合。
UnsupportedOperationException - この RealmObjectSchema が不変の場合。

addPrimaryKey

public abstract RealmObjectSchema addPrimaryKey (

String fieldName

)

指定されたフィールドにプライマリキーを追加します。これは、フィールドにio.realm.annotations.PrimaryKey注釈を追加するのと同じです。さらに、これによりフィールドにもio.realm.annotations.Index注釈も暗黙的に追加されます。

パラメーター

fieldName - フィールドを使用して、プライマリキーとして設定します。

戻り値

更新されたスキーマ。

スロー

IllialArgmentException - フィールド名が存在しない場合、そのフィールドはプライマリキーになることができず、またはすでにプライマリキーが定義されている。
UnsupportedOperationException - この RealmObjectSchema が不変のまたは同期された Realm の場合。

addRealmDictionaryField

public abstract RealmObjectSchema addRealmDictionaryField (

String fieldName,

java.lang.Class<?> primitiveType

)

プリミティブ値を持つRealmDictionaryを参照する新しいフィールドを追加します。サポートされているタイプのリストについては、「 RealmObject 」を参照してください。

要素の null 可能性は、正しいクラスを使用することで定義されます（例: ではなく、Integer.class int.class）。あるいは、 setRequired( string 、ブール値)を使用することもできます。

例:

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

リストに他のRealmクラスへの参照が含まれている場合は、代わりに addRealmDictionaryField( string 、RealmObjectSchema)を使用します。

パラメーター

fieldName - 追加するフィールドの名前。
primitiveType - 配列内の要素の単純な型。

戻り値

更新されたスキーマ。

スロー

IllialArgmentException - フィールド名が不正な場合、その名前のフィールドが既に存在するか、要素タイプがサポートされていない場合。
UnsupportedOperationException - この RealmObjectSchema が不変の場合。

public abstract RealmObjectSchema addRealmDictionaryField (

String fieldName,

RealmObjectSchema objectSchema

)

他の Realm モデルクラスへの参照を持つRealmDictionaryを含む新しいフィールドを追加します。

辞書にプリミティブ型が含まれている場合は、代わりにaddRealmDictionaryField( string 、クラス)を使用します。

パラメーター

fieldName - 追加するフィールドの名前。
objectSchema - 参照されている Realm タイプのスキーマ。

戻り値

更新されたスキーマ。

スロー

IllialArgmentException - フィールド名が不正な場合、またはその名前のフィールドが既に存在する場合。
UnsupportedOperationException - この RealmObjectSchema が不変の場合。

addRealmListField

public abstract RealmObjectSchema addRealmListField (

String fieldName,

java.lang.Class<?> primitiveType

)

プリミティブ値を持つRealmListを参照する新しいフィールドを追加します。サポートされているタイプのリストについては、「 RealmObject 」を参照してください。

例:

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

リストに他のRealmクラスへの参照が含まれている場合は、代わりに addRealmListField( string 、RealmObjectSchema)を使用します。

パラメーター

fieldName - 追加するフィールドの名前。
primitiveType - 配列内の要素の単純な型。

戻り値

更新されたスキーマ。

スロー

IllialArgmentException - フィールド名が不正な場合、その名前のフィールドが既に存在するか、要素タイプがサポートされていない場合。
UnsupportedOperationException - この RealmObjectSchema が不変の場合。

public abstract RealmObjectSchema addRealmListField (

String fieldName,

RealmObjectSchema objectSchema

)

他の Realm モデルクラスへの参照を持つRealmListを含む新しいフィールドを追加します。

リストにプリミティブ型が含まれている場合は、代わりにaddRealmListField( string 、クラス)を使用します。

パラメーター

fieldName - 追加するフィールドの名前。
objectSchema - 参照されている Realm タイプのスキーマ。

戻り値

更新されたスキーマ。

スロー

IllialArgmentException - フィールド名が不正な場合、またはその名前のフィールドが既に存在する場合。
UnsupportedOperationException - この RealmObjectSchema が不変の場合。

addRealmObjectField

public abstract RealmObjectSchema addRealmObjectField (

String fieldName,

RealmObjectSchema objectSchema

)

別のRealmObjectを参照する新しいフィールドを追加します。

パラメーター

fieldName - 追加するフィールドの名前。
objectSchema - 参照されている Realm タイプのスキーマ。

戻り値

更新されたスキーマ。

スロー

IllialArgmentException - フィールド名が不正であるか、その名前のフィールドがすでに存在する場合。
UnsupportedOperationException - この RealmObjectSchema が不変の場合。

addRealmSetField

public abstract RealmObjectSchema addRealmSetField (

String fieldName,

java.lang.Class<?> primitiveType

)

プリミティブ値を持つRealmSetを参照する新しいフィールドを追加します。サポートされているタイプのリストについては、「 RealmObject 」を参照してください。

例:

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

リストに他のRealmクラスへの参照が含まれている場合は、代わりに addRealmSetField( string 、RealmObjectSchema)を使用します。

パラメーター

fieldName - 追加するフィールドの名前。
primitiveType - 配列内の要素の単純な型。

戻り値

更新されたスキーマ。

スロー

IllialArgmentException - フィールド名が不正な場合、その名前のフィールドが既に存在するか、要素タイプがサポートされていない場合。
UnsupportedOperationException - この RealmObjectSchema が不変の場合。

public abstract RealmObjectSchema addRealmSetField (

String fieldName,

RealmObjectSchema objectSchema

)

他の Realm モデルクラスへの参照を持つRealmSetを含む新しいフィールドを追加します。

セットにプリミティブ型が含まれている場合は、代わりにaddRealmSetField( string 、クラス)を使用します。

パラメーター

fieldName - 追加するフィールドの名前。
objectSchema - 参照されている Realm タイプのスキーマ。

戻り値

更新されたスキーマ。

スロー

IllialArgmentException - フィールド名が不正な場合、またはその名前のフィールドが既に存在する場合。
UnsupportedOperationException - この RealmObjectSchema が不変の場合。

getClassName

public String getClassName ()

このスキーマによって表される RealmObject クラスの名前を返します。

通常のRealmを使用する場合、この名前はRealmObjectクラスと同じになります。
DeploymentRealmを使用する場合、これはクラス名を必要とするすべての API メソッドで使用される名前です。

戻り値

このスキーマによって表される RealmObject クラスの名前。

スロー

IllalStateException - このスキーマ定義が Realm の一部ではなくなった場合。

getFieldNames

public Set getFieldNames ()
このクラスのすべてのフィールドを返します。戻り値このクラス内のすべてのフィールドのリスト。

getFieldType

public RealmFieldType getFieldType ( String fieldName )
このフィールドを表すために基礎となるストレージエンジンによって使用される型を返します。パラメーター `fieldName` - ターゲットフィールドの名前。戻り値このフィールドを表すために Realm で使用される基礎の型。

getPrimaryKey

public String getPrimaryKey ()
プライマリキーフィールドの名前を返します。戻り値プライマリキーフィールドの名前。スロー IllalStateException - クラスにプライマリキーが定義されていない場合。

hasField

public boolean hasField ( String fieldName )
クラスに指定された名前で定義されているフィールドがあるかどうかをテストします。パラメーター `fieldName` - テストするフィールド名。戻り値 `true` フィールドが存在する場合は、そうでない場合は`false`です。

hasIndex

public boolean hasIndex (

String fieldName

)

特定のフィールドにインデックスが定義されているかどうかを確認します。

パラメーター

fieldName - 確認する既存のフィールド名。

戻り値

true フィールドがインデックス付きの場合は、 false 、それ以外の場合はになります。

スロー

IllialArgmentException - フィールド名が存在しない場合。

Tip

以下も参照してください。

io.realm.annotations.Index

hasPrimaryKey

public boolean hasPrimaryKey ()
クラスにプライマリキーが定義されているかどうかを確認します。戻り値 `true` プライマリキーが定義されている場合は、 `false` 、そうでない場合はになります。 Tip 以下も参照してください。 io.realm.annotations.PrimaryKey

is埋め込み

public boolean isEmbedded ()
このタイプのオブジェクトが「埋め込み」と見なされる場合は、 `true`を返します。詳細については、「 RealmClass. embedded()を参照してください。戻り値 `true` このタイプのオブジェクトが埋め込まれている場合はになります。そうでない場合は`false` 。

isNullable

public boolean isNullable (

String fieldName

)

特定のフィールドが null 可能かどうか、つまり、 null値を含めることができるかどうかを確認します。

パラメーター

fieldName - フィールドを確認します。

戻り値

true 必要な場合は、それ以外の場合はfalseです。

スロー

IllialArgmentException - フィールド名が存在しない場合。

Tip

以下も参照してください。

setNullable( string 、ブール値)

isPrimaryKey

public boolean isPrimaryKey (

String fieldName

)

特定のフィールドがプライマリキーフィールドであるかどうかを確認します。

パラメーター

fieldName - フィールドを確認します。

戻り値

true プライマリキーフィールドの場合は、それ以外の場合はfalse 。

スロー

IllialArgmentException - フィールド名が存在しない場合。

Tip

以下も参照してください。

addPrimaryKey( string )

isRequired

public boolean isRequired (

String fieldName

)

特定のフィールドが必須であるかどうか、つまり、 null値を含めることができないかどうかを確認します。

パラメーター

fieldName - フィールドを確認します。

戻り値

true 必要な場合は、それ以外の場合はfalseです。

スロー

IllialArgmentException - フィールド名が存在しない場合。

Tip

以下も参照してください。

setRequired( string 、ブール値)

deleteField

public abstract RealmObjectSchema removeField ( String fieldName )
クラスからフィールドを削除します。パラメーター `fieldName` - 削除するフィールド名。戻り値更新されたスキーマ。スロー IllialArgmentException - フィールド名が存在しない場合。 UnsupportedOperationException - この RealmObjectSchema が不変の場合、または同期された Realm の場合は。

deleteIndex

public abstract RealmObjectSchema removeIndex (

String fieldName

)

指定されたフィールドからインデックスを削除します。これは、フィールドの@Index注釈を削除するのと同じです。

パラメーター

fieldName - フィールドからインデックスを削除します。

戻り値

更新されたスキーマ。

スロー

IllialArgmentException - フィールド名が存在しない場合、またはフィールドにインデックスがない場合。
UnsupportedOperationException - この RealmObjectSchema が不変のまたは同期された Realm の場合。

deletePrimaryKey

public abstract RealmObjectSchema removePrimaryKey ()

このクラスからプライマリキーを削除します。これは、クラスからio.realm.annotations.PrimaryKey注釈を削除するのと同じです。さらに、これによりフィールドからio.realm.annotations.Index注釈も暗黙的に削除されます。

戻り値

更新されたスキーマ。

スロー

IllialArgmentException - クラスにプライマリキーが定義されていない場合。
UnsupportedOperationException - この RealmObjectSchema が不変のまたは同期された Realm の場合。

renameField

public abstract RealmObjectSchema renameField (

String currentFieldName,

String newFieldName

)

フィールドの名前を、ある名前から別の名前に変更します。

パラメーター

currentFieldName - 名前を変更するフィールド名。
newFieldName - 新しいフィールド名。

戻り値

更新されたスキーマ。

スロー

IllialArgmentException - フィールド名が存在しない場合、または新しいフィールド名がすでに存在する場合は。
UnsupportedOperationException - この RealmObjectSchema が不変の場合、または同期された Realm の場合は。

setClassName

public abstract RealmObjectSchema setClassName (

String className

)

この RealmObject クラスの新しい名前を設定します。これは名前を変更することと同じです。

パラメーター

className - このクラスの新しい名前。

スロー

IllialArgmentException - ClassName がnull または空のstring である場合、またはその長さが56 文字を超える場合。
UnsupportedOperationException - この RealmObjectSchema が不変であるか、同期された Realm からの場合。

Tip

以下も参照してください。

RealmSchema.rename( string , string ）

set埋め込み

public void setEmbedded (

boolean embedded

)

クラスを埋め込み可能かどうかに変換します。クラスは、次の不変数を満たす場合にのみ、埋め込みとしてマークできます。

クラスではプライマリキーの定義は許可されていません。
このタイプのすべての既存のオブジェクトには、それをすでに指している親オブジェクトが 1 つと正確に 1 つ必要です。 0または1 以上のオブジェクトが、 IllealStateException でマークされる対象のオブジェクトへの参照を持っている場合はスローされます。

スロー

IllalStateException - 埋め込みオブジェクトの不変数の一部を中断したためにクラスを変換できなかった場合。

Tip

以下も参照してください。

RealmClass. embedded()

setNullable

public abstract RealmObjectSchema setNullable (

String fieldName,

boolean nullable

)

フィールドを nullable に設定します。つまり、 null値を保持できる必要があります。これは、プリミティブ型とそのボックス化バリアント（例: intからInteger ）を切り替えることと同じです。

指定されたフィールドのタイプが値のリスト（ RealmObjectではない）の場合、指定された null 可能性はその要素にのみ影響し、フィールド自体には影響しません。値リスト自体は常に null 以外です。

パラメーター

fieldName - クラス内のフィールドの名前。
nullable - フィールドが null 可能である場合はtrue 、それ以外の場合はfalse 。

戻り値

更新されたスキーマ。

スロー

IllialArgmentException - フィールド名が存在しない場合、またはを null 可能として設定できません。
UnsupportedOperationException - この RealmObjectSchema が不変の場合。

setRequired

public abstract RealmObjectSchema setRequired (

String fieldName,

boolean required

)

フィールドを必須に設定します。つまり、 null値を保持できないフィールドです。これは、ボックス型とそのプリミティブバリアント（例: Integerからint ）を切り替えることと同じです。

パラメーター

fieldName - クラス内のフィールドの名前。
required - フィールドが必須の場合はtrue 、そうでない場合はfalse 。

戻り値

更新されたスキーマ。

スロー

IllialArgmentException - フィールド名が存在しない場合、は必須注釈を使用できません。または、フィールドがすでに必須として設定されている。
UnsupportedOperationException - この RealmObjectSchema が不変の場合。

Tip

以下も参照してください。

必須

transform

public abstract RealmObjectSchema transform (

RealmObjectSchema.Function function

)

現在のクラスの各 RealmObject インスタンスに対して変換関数を実行します。オブジェクトはDescribeRealmObjectとして表されます。

オブジェクトが返される順序は保証されません。

パラメーター

function - 変換関数。

戻り値

このスキーマ。

スロー

UnsupportedOperationException - この RealmObjectSchema が不変の場合。

戻る

RealmObject存在変更リスナー

RealmObjectSchema.Function