JpaRetrievingOutboundGatewaySpec (Spring Integration API)

java.lang.ObjectSE
- org.springframework.beans.factory.config.AbstractFactoryBean<T>
- - org.springframework.integration.dsl.IntegrationComponentSpec<S,H>
  - - org.springframework.integration.dsl.MessageHandlerSpec<S,JpaOutboundGateway>
    - - org.springframework.integration.jpa.dsl.JpaBaseOutboundEndpointSpec<JpaRetrievingOutboundGatewaySpec>
      - org.springframework.integration.jpa.dsl.JpaRetrievingOutboundGatewaySpec

実装されているすべてのインターフェース:
Aware, BeanClassLoaderAware, BeanFactoryAware, DisposableBean, FactoryBean<JpaOutboundGateway>, InitializingBean, Lifecycle, Phased, SmartLifecycle, ComponentsRegistration
```
public class JpaRetrievingOutboundGatewaySpec
extends JpaBaseOutboundEndpointSpec<JpaRetrievingOutboundGatewaySpec>
```
OutboundGatewayType.RETRIEVING モードの JpaOutboundGateway 用の JpaBaseOutboundEndpointSpec 拡張。
導入:
5.0
作成者:
Artem Bilan

フィールドのサマリー
- クラス org.springframework.integration.jpa.dsl.JpaBaseOutboundEndpointSpec から継承されたフィールド
  jpaExecutor
- クラス org.springframework.integration.dsl.IntegrationComponentSpec から継承されたフィールド
  PARSER, target
- クラス org.springframework.beans.factory.config.AbstractFactoryBean から継承されたフィールド
  logger
- インターフェース org.springframework.context.SmartLifecycle から継承されたフィールド
  DEFAULT_PHASE
- インターフェース org.springframework.beans.factory.FactoryBean から継承されたフィールド
  OBJECT_TYPE_ATTRIBUTE

コンストラクターの概要
コンストラクター
修飾子コンストラクターと説明
protected JpaRetrievingOutboundGatewaySpec(JpaExecutor jpaExecutor)

コンストラクター
修飾子	コンストラクターと説明
`protected`	`JpaRetrievingOutboundGatewaySpec(JpaExecutor jpaExecutor)`

メソッドのサマリー

すべてのメソッドインスタンスメソッド具象メソッド
修飾子と型	メソッドと説明
`JpaRetrievingOutboundGatewaySpec`	`deleteAfterPoll(boolean deleteAfterPoll)` `true` に設定されている場合、取得されたオブジェクトは、ポーリング時にデータベースから削除されます。
`JpaRetrievingOutboundGatewaySpec`	`deleteInBatch(boolean deleteInBatch)` 設定されていない場合、このプロパティのデフォルトは `false` です。つまり、エンティティのコレクションが削除されている場合、オブジェクトごとに削除が行われます。
`JpaRetrievingOutboundGatewaySpec`	`expectSingleResult(boolean expectSingleResult)` このパラメーターは、実行された JPA 操作からの結果として 1 つの結果オブジェクトのみが返されることを示します。
`JpaRetrievingOutboundGatewaySpec`	`firstResult(int firstResult)` 実行されるクエリの最初の結果を指定します。
`JpaRetrievingOutboundGatewaySpec`	`firstResultExpression(Expression firstResultExpression)` 実行されたクエリの最初の結果を取得するために評価される SpEL 式を指定します。
`JpaRetrievingOutboundGatewaySpec`	`firstResultExpression(StringSE firstResultExpression)` 実行されたクエリの最初の結果を取得するために評価される SpEL 式を指定します。
`JpaRetrievingOutboundGatewaySpec`	`flushAfterDelete(boolean flush)` `true` に設定されている場合、`EntityManager.flush()`SE は永続化操作の後に呼び出されます。
`JpaRetrievingOutboundGatewaySpec`	`idExpression(Expression idExpression)` `EntityManager.find(Class, Object)`SE の `primaryKey` を取得するために評価される SpEL 式を指定します
`JpaRetrievingOutboundGatewaySpec`	`idExpression(StringSE idExpression)` `EntityManager.find(Class, Object)`SE の `primaryKey` を取得するために評価される SpEL 式を指定します
`JpaRetrievingOutboundGatewaySpec`	`maxResults(int maxResults)` 結果式の最大数を設定します。
`JpaRetrievingOutboundGatewaySpec`	`maxResultsExpression(Expression maxResultsExpression)` 結果式の最大数には SpEL 式を指定します。
`JpaRetrievingOutboundGatewaySpec`	`maxResultsExpression(StringSE maxResultsExpression)` 結果式の最大数には SpEL 式を指定します。

クラス org.springframework.integration.jpa.dsl.JpaBaseOutboundEndpointSpec から継承されたメソッド
entityClass, getComponentsToRegister, jpaQuery, namedQuery, nativeQuery, parameter, parameter, parameter, parameterExpression, parameterExpression, parameterSourceFactory, usePayloadAsParameterSource

クラス org.springframework.integration.dsl.IntegrationComponentSpec から継承されたメソッド
_this, createInstance, destroyInstance, doGet, get, getId, getObjectType, getPhase, id, isAutoStartup, isRunning, start, stop, stop

クラス org.springframework.beans.factory.config.AbstractFactoryBean から継承されたメソッド
afterPropertiesSet, destroy, getBeanFactory, getBeanTypeConverter, getEarlySingletonInterfaces, getObject, isSingleton, setBeanClassLoader, setBeanFactory, setSingleton

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

- コンストラクターの詳細
  - JpaRetrievingOutboundGatewaySpec
```
protected JpaRetrievingOutboundGatewaySpec(JpaExecutor jpaExecutor)
```
- メソッドの詳細
  - expectSingleResult
```
public JpaRetrievingOutboundGatewaySpec expectSingleResult(boolean expectSingleResult)
```
    このパラメーターは、実行された JPA 操作からの結果として 1 つの結果オブジェクトのみが返されることを示します。true に設定し、JPA オペレーションの結果リストに含まれる要素が 1 つだけの場合、その 1 つの要素が抽出され、ペイロードとして返されます。
    パラメーター:
    expectSingleResult - 単一のオブジェクトが期待される場合は true。
    戻り値:
    スペック
  - firstResult
```
public JpaRetrievingOutboundGatewaySpec firstResult(int firstResult)
```
    実行されるクエリの最初の結果を指定します。
    パラメーター:
    firstResult - 使用する最初の結果。
    戻り値:
    スペック
  - firstResultExpression
```
public JpaRetrievingOutboundGatewaySpec firstResultExpression(StringSE firstResultExpression)
```
    実行されたクエリの最初の結果を取得するために評価される SpEL 式を指定します。
    パラメーター:
    firstResultExpression - 最初の結果式。
    戻り値:
    スペック
  - firstResultExpression
```
public JpaRetrievingOutboundGatewaySpec firstResultExpression(Expression firstResultExpression)
```
    実行されたクエリの最初の結果を取得するために評価される SpEL 式を指定します。
    パラメーター:
    firstResultExpression - 最初の結果式。
    戻り値:
    スペック
  - idExpression
```
public JpaRetrievingOutboundGatewaySpec idExpression(StringSE idExpression)
```
    EntityManager.find(Class, Object)SE の primaryKey を取得するために評価される SpEL 式を指定します
    パラメーター:
    idExpression - エンティティ primaryKey の SpEL 式。
    戻り値:
    スペック
  - idExpression
```
public JpaRetrievingOutboundGatewaySpec idExpression(Expression idExpression)
```
    EntityManager.find(Class, Object)SE の primaryKey を取得するために評価される SpEL 式を指定します
    パラメーター:
    idExpression - エンティティ primaryKey の SpEL 式。
    戻り値:
    スペック
  - maxResults
```
public JpaRetrievingOutboundGatewaySpec maxResults(int maxResults)
```
    結果式の最大数を設定します。null 以外の値になっています。設定しないと、デフォルトですべてのレコードをフェッチする動作になります
    パラメーター:
    maxResults - 取得する結果の最大数
    戻り値:
    スペック
  - maxResultsExpression
```
public JpaRetrievingOutboundGatewaySpec maxResultsExpression(StringSE maxResultsExpression)
```
    結果式の最大数には SpEL 式を指定します。設定しないと、デフォルトですべてのレコードをフェッチする動作になります
    パラメーター:
    maxResultsExpression - 結果の最大式。
    戻り値:
    スペック
  - maxResultsExpression
```
public JpaRetrievingOutboundGatewaySpec maxResultsExpression(Expression maxResultsExpression)
```
    結果式の最大数には SpEL 式を指定します。設定しないと、デフォルトですべてのレコードをフェッチする動作になります
    パラメーター:
    maxResultsExpression - 結果の最大式。
    戻り値:
    スペック
  - deleteAfterPoll
```
public JpaRetrievingOutboundGatewaySpec deleteAfterPoll(boolean deleteAfterPoll)
```
    true に設定されている場合、取得されたオブジェクトは、ポーリング時にデータベースから削除されます。すべての状況で機能するとは限りません。ネイティブ SQL クエリの場合。
    パラメーター:
    deleteAfterPoll - デフォルトは false です。
    戻り値:
    スペック
  - deleteInBatch
```
public JpaRetrievingOutboundGatewaySpec deleteInBatch(boolean deleteInBatch)
```
    設定されていない場合、このプロパティのデフォルトは false です。つまり、エンティティのコレクションが削除されている場合、オブジェクトごとに削除が行われます。
    "true" に設定すると、ペイロードの要素がバッチ操作として削除されます。これにより、カスケード削除に関して問題が発生することに注意してください。
    仕様「JSR317:Java Persistence API、バージョン 2.0」は、バッチ操作でのカスケード削除をサポートしていません。仕様は 4.10 章に次のように述べています。
    「削除操作は、指定されたクラスとそのサブクラスのエンティティにのみ適用されます。関連するエンティティにはカスケードされません。」
    パラメーター:
    deleteInBatch - 設定されていない場合、デフォルトは "false" です。
    戻り値:
    スペック
  - flushAfterDelete
```
public JpaRetrievingOutboundGatewaySpec flushAfterDelete(boolean flush)
```
    true に設定されている場合、EntityManager.flush()SE は永続化操作の後に呼び出されます。flushSize が 1 に指定されている場合、同じ効果があります。永続化するために提供されたエンティティが IterableSE のインスタンスではない場合の便宜上。
    パラメーター:
    flush - デフォルトは "false" です。
    戻り値:
    スペック

クラス JpaRetrievingOutboundGatewaySpec

フィールドのサマリー

クラス org.springframework.integration.jpa.dsl.JpaBaseOutboundEndpointSpec から継承されたフィールド

クラス org.springframework.integration.dsl.IntegrationComponentSpec から継承されたフィールド

クラス org.springframework.beans.factory.config.AbstractFactoryBean から継承されたフィールド

インターフェース org.springframework.context.SmartLifecycle から継承されたフィールド

インターフェース org.springframework.beans.factory.FactoryBean から継承されたフィールド

コンストラクターの概要

メソッドのサマリー

クラス org.springframework.integration.jpa.dsl.JpaBaseOutboundEndpointSpec から継承されたメソッド

クラス org.springframework.integration.dsl.IntegrationComponentSpec から継承されたメソッド

クラス org.springframework.beans.factory.config.AbstractFactoryBean から継承されたメソッド

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

コンストラクターの詳細

JpaRetrievingOutboundGatewaySpec

メソッドの詳細

expectSingleResult

firstResult

firstResultExpression

firstResultExpression

idExpression

idExpression

maxResults

maxResultsExpression

maxResultsExpression

deleteAfterPoll

deleteInBatch

flushAfterDelete