MappingPdxSerializer (Spring Data for Pivotal GemFire 2.2.13.RELEASE API)

java.lang.ObjectSE
- org.springframework.data.gemfire.mapping.MappingPdxSerializer

実装済みのインターフェース一覧:
org.apache.geode.pdx.PdxSerializer, Aware, ApplicationContextAware
```
public class MappingPdxSerializer
extends ObjectSE
implements org.apache.geode.pdx.PdxSerializer, ApplicationContextAware
```
Spring Data for Apache Geode GemfireMappingContext を使用して、PDX からエンティティを読み取り (デシリアライズ)、PDX にエンティティを書き込む (シリアライズ) ための PdxSerializer 実装。
導入:
1.2.0
作成者:
Oliver Gierke, David Turanski, John Blum
関連事項:
PdxReader、PdxSerializer、PdxWriter, ApplicationContext, ApplicationContextAware, ConversionService, Filter, PersistentEntity, PersistentProperty, PersistentPropertyAccessor, PropertyHandler, ConvertingPropertyAccessor, EntityInstantiator, EntityInstantiators, PersistentEntityParameterValueProvider

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

ネストされたクラス
修飾子と型	クラスと説明
`static interface`	`MappingPdxSerializer.PdxSerializerResolver`
`static class`	`MappingPdxSerializer.PdxSerializerResolvers`
`static class`	`MappingPdxSerializer.TypeFilters`

フィールド概要

フィールド
修飾子と型	フィールドと説明
`protected static StringSE`	`COM_GEMSTONE_GEMFIRE_PACKAGE_NAME`
`protected static StringSE`	`JAVA_PACKAGE_NAME`
`protected static StringSE`	`ORG_APACHE_GEODE_PACKAGE_NAME`
`protected static StringSE`	`ORG_SPRINGFRAMEWORK_PACKAGE_NAME`

コンストラクター概要

コンストラクター
コンストラクターと説明
`MappingPdxSerializer()` デフォルトの `GemfireMappingContext` と `DefaultConversionService` を使用して `MappingPdxSerializer` の新しいインスタンスを構築します。
`MappingPdxSerializer(GemfireMappingContext mappingContext, ConversionService conversionService)` 指定された `GemfireMappingContext` と `ConversionService` で初期化された `MappingPdxSerializer` の新しいインスタンスを構築します。

方法の概要

すべてのメソッド静的メソッドインスタンスメソッド具象メソッド
修飾子と型	メソッドと説明
`static MappingPdxSerializer`	`create(ConversionService conversionService)` 指定された `ConversionService` と提供された `GemfireMappingContext` で初期化された `MappingPdxSerializer` の新しいインスタンスを構築するために使用されるファクトリメソッド。
`static MappingPdxSerializer`	`create(GemfireMappingContext mappingContext)` 指定されたデフォルトの `ConversionService` を使用して、エンティティマッピングメタデータを提供する指定された `mapping context` で初期化された `MappingPdxSerializer` の新しいインスタンスを構築するために使用されるファクトリメソッド。
`static MappingPdxSerializer`	`create(GemfireMappingContext mappingContext, ConversionService conversionService)` 指定された `mapping context` および `conversion service` で初期化された `MappingPdxSerializer` の新しいインスタンスを構築するために使用されるファクトリメソッド。
`ObjectSE`	`fromData(ClassSE<?> type, org.apache.geode.pdx.PdxReader pdxReader)` `PdxReader` を使用して、PDX から `Object`SE または `type`SE をデシリアライズ (読み取り) します。
`protected ConversionService`	`getConversionService()` データストア型をアプリケーションドメインオブジェクト型に変換するために使用される構成済みの `ConversionService` への参照を返します。
`protected MapSE<?,org.apache.geode.pdx.PdxSerializer>`	`getCustomPdxSerializers()` 特定のアプリケーション `domain types`SE の直列化をカスタマイズするために使用されるカスタム `PDX serializers` に、アプリケーション `domain types`SE の `mapping`SE を返します。
`protected EntityInstantiators`	`getEntityInstantiators()` Pivotal GemFire 永続エンティティに対して構成された `EntityInstantiators` 処理インスタンスを返します。
`protected org.slf4j.Logger`	`getLogger()` この `PdxSerializer` の機能に関する `messages`SE をログに記録するために使用される構成された `Logger` への参照を返します。
`protected GemfireMappingContext`	`getMappingContext()` Pivotal GemFire 永続エンティティとアプリケーションドメインオブジェクト `types`SE 間のマッピングロジックを処理するために使用される構成済みの `mapping context` への参照を返します。
`protected GemfirePersistentEntity<?>`	`getPersistentEntity(ClassSE<?> entityType)` 指定されたエンティティ `Class`SE 型の `PersistentEntity` メタデータを検索して返します。
`protected GemfirePersistentEntity<?>`	`getPersistentEntity(ObjectSE entity)` 指定されたエンティティオブジェクトの `PersistentEntity` メタデータを検索して返します。
`protected PredicateSE<ClassSE<?>>`	`getTypeFilters()` この `PdxSerializer` によって直列化可能な `types`SE をフィルタリングするために使用される `type filters`SE を返します。
`static MappingPdxSerializer`	`newMappingPdxSerializer()` 提供された `GemfireMappingContext` とデフォルトの `ConversionService` で初期化された `MappingPdxSerializer` の新しいインスタンスを構築するために使用されるファクトリメソッド。
`void`	`register(MappingPdxSerializer.PdxSerializerResolver pdxSerializerResolver)` 指定された `MappingPdxSerializer.PdxSerializerResolver` を登録します。これは、エンティティプロパティのカスタム `PdxSerializer` を解決するために使用されます。
`protected org.apache.geode.pdx.PdxSerializer`	`resolveCustomPdxSerializer(PersistentProperty<?> property)` 指定された `PersistentEntity` `PersistentProperty` のカスタム `PdxSerializer` を返します。
`protected EntityInstantiator`	`resolveEntityInstantiator(PersistentEntity entity)` 指定された `PersistentEntity` (メタデータ) によって定義されたオブジェクトのインスタンスを構築および初期化するために使用される登録済みの `EntityInstantiator` を検索して返します。
`void`	`setApplicationContext(ApplicationContext applicationContext)` Spring `ApplicationContext` への参照を設定します。
`void`	`setCustomPdxSerializers(MapSE<?,org.apache.geode.pdx.PdxSerializer> customPdxSerializers)` 特定のアプリケーション `domain types`SE の直列化をカスタマイズするために使用されるカスタム `PDX serializers` を構成します。
`void`	`setEntityInstantiators(EntityInstantiators entityInstantiators)` この `PdxSerializer` によって読み取られるインスタンスを作成するために使用される `EntityInstantiators` を構成します。
`void`	`setEntityInstantiators(MapSE<ClassSE<?>,EntityInstantiator> gemfireInstantiators)` この `PdxSerializer` によって読み取られるインスタンスを作成するために使用される `EntityInstantiators` を構成します。
`void`	`setExcludeTypeFilters(PredicateSE<ClassSE<?>> excludeTypeFilters)` この `PDX serializer` によって直列化可能な `types`SE を除外 (フィルターとも言う) するために使用される `type filters`SE を設定します。
`void`	`setIncludeTypeFilters(PredicateSE<ClassSE<?>> includeTypeFilters)` この `PDX serializer` によって直列化可能な `types`SE を含めるために使用される `type filters`SE を設定します。
`boolean`	`toData(ObjectSE value, org.apache.geode.pdx.PdxWriter pdxWriter)` 指定された `Object`SE を PDX に直列化 (書き込み) します。

クラス java.lang.ObjectSE から継承されたメソッド
cloneSE, equalsSE, finalizeSE, getClassSE, hashCodeSE, notifySE, notifyAllSE, toStringSE, waitSE, waitSE, waitSE

- フィールドの詳細
  - JAVA_PACKAGE_NAME
```
protected static final StringSE JAVA_PACKAGE_NAME
```
    関連事項:
    定数フィールド値
  - COM_GEMSTONE_GEMFIRE_PACKAGE_NAME
```
protected static final StringSE COM_GEMSTONE_GEMFIRE_PACKAGE_NAME
```
    関連事項:
    定数フィールド値
  - ORG_APACHE_GEODE_PACKAGE_NAME
```
protected static final StringSE ORG_APACHE_GEODE_PACKAGE_NAME
```
    関連事項:
    定数フィールド値
  - ORG_SPRINGFRAMEWORK_PACKAGE_NAME
```
protected static final StringSE ORG_SPRINGFRAMEWORK_PACKAGE_NAME
```
    関連事項:
    定数フィールド値
- コンストラクターの詳細
  - MappingPdxSerializer
```
public MappingPdxSerializer()
```
    デフォルトの GemfireMappingContext と DefaultConversionService を使用して MappingPdxSerializer の新しいインスタンスを構築します。
    関連事項:
    newConversionService(), newMappingContext(), DefaultConversionService, GemfireMappingContext
  - MappingPdxSerializer
```
public MappingPdxSerializer(GemfireMappingContext mappingContext,
                            ConversionService conversionService)
```
    指定された GemfireMappingContext と ConversionService で初期化された MappingPdxSerializer の新しいインスタンスを構築します。
    パラメーター:
    mappingContext - GemfireMappingContext は、エンティティマッピングメタデータに基づいて、アプリケーションドメインオブジェクト型と PDX 直列化バイト間のマッピングを行うために MappingPdxSerializer によって使用されます。
    conversionService - ConversionService は、PDX 直列化データをアプリケーションオブジェクトプロパティ型に変換するために MappingPdxSerializer によって使用されます。
    例外:
    IllegalArgumentExceptionSE - GemfireMappingContext または ConversionService のいずれかが null の場合。
- メソッドの詳細
  - newMappingPdxSerializer
```
@NonNull
public static MappingPdxSerializer newMappingPdxSerializer()
```
    提供された GemfireMappingContext とデフォルトの ConversionService で初期化された MappingPdxSerializer の新しいインスタンスを構築するために使用されるファクトリメソッド。
    戻り値:
    MappingPdxSerializer の新しいインスタンス。
    関連事項:
    create(GemfireMappingContext, ConversionService), newMappingContext(), newConversionService()
  - create
```
@NonNull
public static MappingPdxSerializer create(@Nullable
                                                   ConversionService conversionService)
```
    指定された ConversionService と提供された GemfireMappingContext で初期化された MappingPdxSerializer の新しいインスタンスを構築するために使用されるファクトリメソッド。
    パラメーター:
    conversionService - ConversionService は永続的な値をエンティティプロパティに変換するために使用されます。
    戻り値:
    指定された ConversionService で初期化された MappingPdxSerializer の新しいインスタンス。
    関連事項:
    ConversionService, create(GemfireMappingContext, ConversionService), newMappingContext()
  - create
```
@NonNull
public static MappingPdxSerializer create(@Nullable
                                                   GemfireMappingContext mappingContext)
```
    指定されたデフォルトの ConversionService を使用して、エンティティマッピングメタデータを提供する指定された mapping context で初期化された MappingPdxSerializer の新しいインスタンスを構築するために使用されるファクトリメソッド。
    パラメーター:
    mappingContext - GemfireMappingContext はエンティティマッピングメタデータを提供するために使用されます。
    戻り値:
    指定された mapping context で初期化された MappingPdxSerializer の新しいインスタンス。
    関連事項:
    GemfireMappingContext, create(GemfireMappingContext, ConversionService), newConversionService()
  - create
```
@NonNull
public static MappingPdxSerializer create(@Nullable
                                                   GemfireMappingContext mappingContext,
                                                   @Nullable
                                                   ConversionService conversionService)
```
    指定された mapping context および conversion service で初期化された MappingPdxSerializer の新しいインスタンスを構築するために使用されるファクトリメソッド。mapping context または conversion service のいずれかが null の場合、このファクトリメソッドはそれぞれにデフォルトのインスタンスを提供します。
    パラメーター:
    mappingContext - GemfireMappingContext は、エンティティのマッピングメタデータに基づいて、アプリケーションドメインモデルオブジェクト型と PDX 直列化バイト間のマッピングに使用されます。
    conversionService - ConversionService は永続的な値をエンティティプロパティに変換するために使用されます。
    戻り値:
    MappingPdxSerializer の初期化されたインスタンス。
    関連事項:
    ConversionService, MappingPdxSerializer
  - setApplicationContext
```
public void setApplicationContext(ApplicationContext applicationContext)
                           throws BeansException
```
    Spring ApplicationContext への参照を設定します。
    次で指定:
    インターフェース ApplicationContextAware 内の setApplicationContext
    パラメーター:
    applicationContext - Spring ApplicationContext への参照。
    例外:
    BeansException
    関連事項:
    ApplicationContext
  - getConversionService
```
@NonNull
protected ConversionService getConversionService()
```
    データストア型をアプリケーションドメインオブジェクト型に変換するために使用される構成済みの ConversionService への参照を返します。
    戻り値:
    構成された ConversionService への参照。
    関連事項:
    ConversionService
  - setCustomPdxSerializers
```
public void setCustomPdxSerializers(MapSE<?,org.apache.geode.pdx.PdxSerializer> customPdxSerializers)
```
    特定のアプリケーション domain typesSE の直列化をカスタマイズするために使用されるカスタム PDX serializers を構成します。
    パラメーター:
    customPdxSerializers - 特定のアプリケーション domain typesSE の直列化をカスタマイズするために使用されるカスタム PDX serializers を含む mappingSE。
    例外:
    IllegalArgumentExceptionSE - custom PDX serializer mappingSE が null の場合。
    関連事項:
    PdxSerializer, MapSE
  - getCustomPdxSerializers
```
@NonNull
protected MapSE<?,org.apache.geode.pdx.PdxSerializer> getCustomPdxSerializers()
```
    特定のアプリケーション domain typesSE の直列化をカスタマイズするために使用されるカスタム PDX serializers に、アプリケーション domain typesSE の mappingSE を返します。
    戻り値:
    アプリケーション domain typesSE の mappingSE をカスタム PDX serializers に適用します。
    関連事項:
    PdxSerializer, MapSE
  - setEntityInstantiators
```
public void setEntityInstantiators(@NonNull
                                   EntityInstantiators entityInstantiators)
```
    この PdxSerializer によって読み取られるインスタンスを作成するために使用される EntityInstantiators を構成します。
    パラメーター:
    entityInstantiators - この PdxSerializer によって読み取られるインスタンスを作成するために使用される EntityInstantiators。null であってはなりません。
    関連事項:
    EntityInstantiator
  - setEntityInstantiators
```
public void setEntityInstantiators(@NonNull
                                   MapSE<ClassSE<?>,EntityInstantiator> gemfireInstantiators)
```
    この PdxSerializer によって読み取られるインスタンスを作成するために使用される EntityInstantiators を構成します。
    パラメーター:
    gemfireInstantiators - typesSE から EntityInstantiator オブジェクトへのマッピング。null であってはなりません。
    関連事項:
    EntityInstantiator, MapSE
  - getEntityInstantiators
```
protected EntityInstantiators getEntityInstantiators()
```
    Pivotal GemFire 永続エンティティに対して構成された EntityInstantiators 処理インスタンスを返します。
    戻り値:
    GemFire 永続エンティティのインスタンス化を処理する構成された EntityInstantiators。
    関連事項:
    EntityInstantiators
  - getLogger
```
@NonNull
protected org.slf4j.Logger getLogger()
```
    この PdxSerializer の機能に関する messagesSE をログに記録するために使用される構成された Logger への参照を返します。
    戻り値:
    構成された Logger への参照。
    関連事項:
    Logger
  - getMappingContext
```
@NonNull
protected GemfireMappingContext getMappingContext()
```
    Pivotal GemFire 永続エンティティとアプリケーションドメインオブジェクト typesSE 間のマッピングロジックを処理するために使用される構成済みの mapping context への参照を返します。
    戻り値:
    Pivotal GemFire 用に構成された mapping context への参照。
    関連事項:
    GemfireMappingContext
  - getPersistentEntity
```
protected GemfirePersistentEntity<?> getPersistentEntity(@NonNull
                                                         ObjectSE entity)
```
    指定されたエンティティオブジェクトの PersistentEntity メタデータを検索して返します。
    パラメーター:
    entity - 実際の永続エンティティ、アプリケーションドメインオブジェクト。
    戻り値:
    指定されたエンティティオブジェクトの PersistentEntity メタデータ。
    関連事項:
    GemfirePersistentEntity, getPersistentEntity(Class)
  - getPersistentEntity
```
protected GemfirePersistentEntity<?> getPersistentEntity(@NonNull
                                                         ClassSE<?> entityType)
```
    指定されたエンティティ ClassSE 型の PersistentEntity メタデータを検索して返します。
    パラメーター:
    entityType - 実際の永続エンティティの ClassSE 型、アプリケーションドメインオブジェクト ClassSE。
    戻り値:
    指定されたエンティティ ClassSE 型の PersistentEntity メタデータ。
    関連事項:
    GemfirePersistentEntity, getMappingContext()
  - setExcludeTypeFilters
```
public void setExcludeTypeFilters(@Nullable
                                  PredicateSE<ClassSE<?>> excludeTypeFilters)
```
    この PDX serializer によって直列化可能な typesSE を除外 (フィルター) するために使用される type filtersSE を設定します。この操作は null セーフであり、既存の excluded type filtersSE を上書きするのではなく、この設定操作は指定された exclude type filtersSE と既存の excluded type filtersSE を and で結合して組み合わせます。
    パラメーター:
    excludeTypeFilters - type filtersSE は、この PDX serializer によって直列化可能な typesSE を除外 / フィルタリングするために使用されます。
    関連事項:
    PredicateSE
  - setIncludeTypeFilters
```
public void setIncludeTypeFilters(@Nullable
                                  PredicateSE<ClassSE<?>> includeTypeFilters)
```
    この PDX serializer によって直列化可能な typesSE を含めるために使用される type filtersSE を設定します。この操作は null セーフであり、既存の included type filtersSE を上書きするのではなく、この設定操作は指定された include type filtersSE と、または結合された既存の included type filtersSE を組み合わせます。
    パラメーター:
    includeTypeFilters - type filtersSE には、この PDX serializer によって直列化可能な typesSE が含まれていました。
    関連事項:
    PredicateSE
  - getTypeFilters
```
protected PredicateSE<ClassSE<?>> getTypeFilters()
```
    この PdxSerializer によって直列化可能な typesSE をフィルタリングするために使用される type filtersSE を返します。
    戻り値:
    解決された type filterSE。
    関連事項:
    PredicateSE
  - register
```
public void register(@NonNull
                     MappingPdxSerializer.PdxSerializerResolver pdxSerializerResolver)
```
    指定された MappingPdxSerializer.PdxSerializerResolver を登録します。これは、エンティティプロパティのカスタム PdxSerializer を解決するために使用されます。カスタム PdxSerializer を解決するために使用される戦略または条件は、個々の解決によって異なり、プロパティ型や完全修飾プロパティ名などに基づくことができます。
    パラメーター:
    pdxSerializerResolver - MappingPdxSerializer.PdxSerializerResolver は、エンティティプロパティのカスタム PdxSerializer を解決するために使用されます。
  - fromData
```
public ObjectSE fromData(@NonNull
                       ClassSE<?> type,
                       @NonNull
                       org.apache.geode.pdx.PdxReader pdxReader)
```
    PdxReader を使用して、PDX から ObjectSE または typeSE をデシリアライズ (読み取り) します。
    次で指定:
    インターフェース org.apache.geode.pdx.PdxSerializer 内の fromData
    パラメーター:
    type - ObjectSE の必要な ClassSE 型。null であってはなりません。
    pdxReader - PdxReader は、PDX バイトを目的の ClassSE 型の ObjectSE に逆直列化するために使用されます。null にすることはできません。
    戻り値:
    PDX から逆直列化された ClassSE 型の ObjectSE、または PDX から逆直列化できない ClassSE 型の ObjectSE の場合は null。
    関連事項:
    PdxReader, doFromData(Class, PdxReader), getTypeFilters(), ClassSE, ObjectSE
  - toData
```
public boolean toData(@Nullable
                      ObjectSE value,
                      @NonNull
                      org.apache.geode.pdx.PdxWriter pdxWriter)
```
    指定された ObjectSE を PDX に直列化 (書き込み) します。
    次で指定:
    インターフェース org.apache.geode.pdx.PdxSerializer 内の toData
    パラメーター:
    value - ObjectSE を直列化します。
    pdxWriter - PdxWriter は、指定された ObjectSE を PDX に直列化するために使用されます。
    戻り値:
    この PdxSerializer が指定された ObjectSE を PDX に直列化できたかどうかを示すブール値。
    関連事項:
    PdxWriter, doToData(Object, PdxWriter), getTypeFilters(), ObjectSE
  - resolveCustomPdxSerializer
```
@Nullable
protected org.apache.geode.pdx.PdxSerializer resolveCustomPdxSerializer(@NonNull
                                                                                  PersistentProperty<?> property)
```
    指定された PersistentEntity PersistentProperty のカスタム PdxSerializer を返します。
    パラメーター:
    property - カスタム PdxSerializer を解決するために使用されるエンティティの PersistentProperty。
    戻り値:
    指定された PersistentEntity PersistentProperty のカスタム PdxSerializer。カスタム PdxSerializer が見つからなかった場合は null。
    関連事項:
    PersistentProperty, PdxSerializer, getCustomPdxSerializers()
  - resolveEntityInstantiator
```
protected EntityInstantiator resolveEntityInstantiator(@NonNull
                                                       PersistentEntity entity)
```
    指定された PersistentEntity (メタデータ) によって定義されたオブジェクトのインスタンスを構築および初期化するために使用される登録済みの EntityInstantiator を検索して返します。
    パラメーター:
    entity - エンティティのカスタム登録済み EntityInstantiator を検索するために使用される PersistentEntity オブジェクト。
    戻り値:
    指定された PersistentEntity の EntityInstantiator。
    関連事項:
    EntityInstantiator, PersistentEntity

クラス MappingPdxSerializer

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

フィールド概要

コンストラクター概要

方法の概要

クラス java.lang.ObjectSE から継承されたメソッド

フィールドの詳細

JAVA_PACKAGE_NAME

COM_GEMSTONE_GEMFIRE_PACKAGE_NAME

ORG_APACHE_GEODE_PACKAGE_NAME

ORG_SPRINGFRAMEWORK_PACKAGE_NAME

コンストラクターの詳細

MappingPdxSerializer

MappingPdxSerializer

メソッドの詳細

newMappingPdxSerializer

create

create

create

setApplicationContext

getConversionService

setCustomPdxSerializers

getCustomPdxSerializers

setEntityInstantiators

setEntityInstantiators

getEntityInstantiators

getLogger

getMappingContext

getPersistentEntity

getPersistentEntity

setExcludeTypeFilters

setIncludeTypeFilters

getTypeFilters

register

fromData

toData

resolveCustomPdxSerializer

resolveEntityInstantiator