XPathMessageSplitter (Spring Integration API)

java.lang.ObjectSE
- org.springframework.integration.context.IntegrationObjectSupport
- - org.springframework.integration.handler.MessageHandlerSupport
  - - org.springframework.integration.handler.AbstractMessageHandler
    - - org.springframework.integration.handler.AbstractMessageProducingHandler
      - org.springframework.integration.handler.AbstractReplyProducingMessageHandler
        
        org.springframework.integration.splitter.AbstractMessageSplitter
        
        org.springframework.integration.xml.splitter.XPathMessageSplitter

実装されているすべてのインターフェース:
org.reactivestreams.Subscriber<Message<?>>, Aware, BeanClassLoaderAware, BeanFactoryAware, BeanNameAware, DisposableBean, InitializingBean, ApplicationContextAware, Ordered, ExpressionCapable, Orderable, MessageProducer, DiscardingMessageHandler, HeaderPropagationAware, IntegrationPattern, NamedComponent, IntegrationManagement, TrackableComponent, MessageHandler, reactor.core.CoreSubscriber<Message<?>>
```
public class XPathMessageSplitter
extends AbstractMessageSplitter
```
XPathExpression を使用して DocumentSE、FileSE、StringSE ペイロードを NodeListSE に分割するメッセージスプリッター。戻り値は、受信したペイロード型に応じて文字列または NodeSE になります。また、'createDocuments' プロパティが true に設定されている場合、ノード型はドキュメントに変換されます。
作成者:
Jonas Partner, Mark Fisher, Artem Bilan, Gary Russell

ネストされたクラスの要約
- クラス org.springframework.integration.handler.AbstractReplyProducingMessageHandler から継承されたネストクラス / インターフェース
  AbstractReplyProducingMessageHandler.RequestHandler
- インターフェース org.springframework.integration.support.management.IntegrationManagement から継承されたネストクラス / インターフェース
  IntegrationManagement.ManagementOverrides

フィールドのサマリー
- クラス org.springframework.integration.handler.AbstractMessageProducingHandler から継承されたフィールド
  messagingTemplate
- クラス org.springframework.integration.context.IntegrationObjectSupport から継承されたフィールド
  EXPRESSION_PARSER, logger
- インターフェース org.springframework.core.Ordered から継承されたフィールド
  HIGHEST_PRECEDENCE, LOWEST_PRECEDENCE
- インターフェース org.springframework.integration.support.management.IntegrationManagement から継承されたフィールド
  METER_PREFIX, RECEIVE_COUNTER_NAME, SEND_TIMER_NAME

コンストラクターの概要

コンストラクター
コンストラクターと説明
`XPathMessageSplitter(StringSE expression)`
`XPathMessageSplitter(StringSE expression, MapSE<StringSE, StringSE> namespaces)`
`XPathMessageSplitter(StringSE expression, MapSE<StringSE, StringSE> namespaces, TransformerFactorySE transformerFactory)` 提供された xpath 式、名前空間、`TransformerFactory`SE に基づいてインスタンスを構築します。
`XPathMessageSplitter(StringSE expression, TransformerFactorySE transformerFactory)` 提供された xpath 式と `TransformerFactory`SE に基づいてインスタンスを構築します。
`XPathMessageSplitter(XPathExpression xpathExpression)`
`XPathMessageSplitter(XPathExpression xpathExpression, TransformerFactorySE transformerFactory)` 提供された xpath 式と `TransformerFactory`SE に基づいてインスタンスを構築します。

メソッドのサマリー

すべてのメソッドインスタンスメソッド具象メソッド
修飾子と型	メソッドと説明
`protected void`	`doInit()`
`StringSE`	`getComponentType()` サブクラスはこのメソッドを実装して、コンポーネント型情報を提供できます。
`protected int`	`obtainSizeIfPossible(IteratorSE<?> iterator)` 付属の `Iterator`SE のサイズを取得します。
`void`	`setCreateDocuments(boolean createDocuments)`
`void`	`setDocumentBuilder(DocumentBuilderFactorySE documentBuilderFactory)`
`void`	`setIterator(boolean iterator)` `iterator` モード: `true` （デフォルト）は `payload` を分割するための `Iterator`SE を返し、`false` は `List`SE を返します。
`void`	`setOutputProperties(PropertiesSE outputProperties)` 変換に影響する同じプロパティのいずれかをオーバーライドするために使用される出力プロパティのセット。
`void`	`setXmlPayloadConverter(XmlPayloadConverter xmlPayloadConverter)`
`protected ObjectSE`	`splitMessage(Message<?> message)` 受信したメッセージを分割するには、サブクラスでこのメソッドをオーバーライドする必要があります。

クラス org.springframework.integration.splitter.AbstractMessageSplitter から継承されたメソッド
addHeaders, getDiscardChannel, getIntegrationPatternType, handleRequestMessage, obtainSizeIfPossible, produceOutput, setApplySequence, setDiscardChannel, setDiscardChannelName, shouldCopyRequestHeaders, willAddHeaders

クラス org.springframework.integration.handler.AbstractReplyProducingMessageHandler から継承されたメソッド
doInvokeAdvisedRequestHandler, getBeanClassLoader, getRequiresReply, handleMessageInternal, hasAdviceChain, onInit, setAdviceChain, setBeanClassLoader, setRequiresReply

クラス org.springframework.integration.handler.AbstractMessageProducingHandler から継承されたメソッド
addNotPropagatedHeaders, createOutputMessage, getNotPropagatedHeaders, getOutputChannel, isAsync, messageBuilderForReply, resolveErrorChannel, sendErrorMessage, sendOutput, sendOutputs, setAsync, setNotPropagatedHeaders, setOutputChannel, setOutputChannelName, setSendTimeout, shouldSplitOutput, updateNotPropagatedHeaders

クラス org.springframework.integration.handler.AbstractMessageHandler から継承されたメソッド
handleMessage, onComplete, onError, onNext, onSubscribe

クラス org.springframework.integration.handler.MessageHandlerSupport から継承されたメソッド
buildSendTimer, destroy, getManagedName, getManagedType, getMetricsCaptor, getOrder, getOverrides, isLoggingEnabled, registerMetricsCaptor, sendTimer, setLoggingEnabled, setManagedName, setManagedType, setOrder, setShouldTrack, shouldTrack

クラス org.springframework.integration.context.IntegrationObjectSupport から継承されたメソッド
afterPropertiesSet, extractTypeIfPossible, generateId, getApplicationContext, getApplicationContextId, getBeanDescription, getBeanFactory, getBeanName, getChannelResolver, getComponentName, getConversionService, getExpression, getIntegrationProperties, getIntegrationProperty, getMessageBuilderFactory, getTaskScheduler, isInitialized, setApplicationContext, setBeanFactory, setBeanName, setChannelResolver, setComponentName, setConversionService, setMessageBuilderFactory, setPrimaryExpression, setTaskScheduler, toString

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

インターフェース org.springframework.messaging.MessageHandler から継承されたメソッド
handleMessage

インターフェース reactor.core.CoreSubscriber から継承されたメソッド
currentContext

インターフェース org.springframework.integration.support.management.IntegrationManagement から継承されたメソッド
getThisAs

インターフェース org.springframework.integration.support.context.NamedComponent から継承されたメソッド
getBeanName, getComponentName

- コンストラクターの詳細
  - XPathMessageSplitter
```
public XPathMessageSplitter(StringSE expression)
```
  - XPathMessageSplitter
```
public XPathMessageSplitter(StringSE expression,
                            TransformerFactorySE transformerFactory)
```
    提供された xpath 式と TransformerFactorySE に基づいてインスタンスを構築します。
    パラメーター:
    expression - 分割用の xpath 式。
    transformerFactory - ドキュメントの解析と構築のための TransformerFactorySE。
    導入:
    4.3.19
  - XPathMessageSplitter
```
public XPathMessageSplitter(StringSE expression,
                            MapSE<StringSE,StringSE> namespaces)
```
  - XPathMessageSplitter
```
public XPathMessageSplitter(StringSE expression,
                            MapSE<StringSE,StringSE> namespaces,
                            TransformerFactorySE transformerFactory)
```
    提供された xpath 式、名前空間、TransformerFactorySE に基づいてインスタンスを構築します。
    パラメーター:
    expression - 分割用の xpath 式。
    namespaces - 解析用の XML 名前空間。
    transformerFactory - ドキュメントの解析と構築のための TransformerFactorySE。
    導入:
    4.3.19
  - XPathMessageSplitter
```
public XPathMessageSplitter(XPathExpression xpathExpression)
```
  - XPathMessageSplitter
```
public XPathMessageSplitter(XPathExpression xpathExpression,
                            TransformerFactorySE transformerFactory)
```
    提供された xpath 式と TransformerFactorySE に基づいてインスタンスを構築します。
    パラメーター:
    xpathExpression - 分割用の xpath 式。
    transformerFactory - ドキュメントの解析と構築のための TransformerFactorySE。
    導入:
    4.3.19
- メソッドの詳細
  - setCreateDocuments
```
public void setCreateDocuments(boolean createDocuments)
```
  - getComponentType
```
public StringSE getComponentType()
```
    クラスからコピーされた説明: IntegrationObjectSupport
    サブクラスはこのメソッドを実装して、コンポーネント型情報を提供できます。
    次で指定:
    インターフェース NamedComponent の getComponentType
    オーバーライド:
    クラス AbstractMessageSplitter の getComponentType
  - setDocumentBuilder
```
public void setDocumentBuilder(DocumentBuilderFactorySE documentBuilderFactory)
```
  - setXmlPayloadConverter
```
public void setXmlPayloadConverter(XmlPayloadConverter xmlPayloadConverter)
```
  - setIterator
```
public void setIterator(boolean iterator)
```
    iterator モード: true （デフォルト）は payload を分割するための IteratorSE を返し、false は ListSE を返します。
    パラメーター:
    iterator - イテレータモードの boolean フラグ。デフォルトは true です。
    導入:
    4.2
  - setOutputProperties
```
public void setOutputProperties(PropertiesSE outputProperties)
```
    変換に影響する同じプロパティのいずれかをオーバーライドするために使用される出力プロパティのセット。
    パラメーター:
    outputProperties - TransformerSE 出力プロパティ。
    導入:
    4.2
    関連事項:
    Transformer.setOutputProperties(Properties)SE
  - doInit
```
protected void doInit()
```
    オーバーライド:
    クラス AbstractMessageSplitter の doInit
  - splitMessage
```
protected ObjectSE splitMessage(Message<?> message)
```
    クラスからコピーされた説明: AbstractMessageSplitter
    受信したメッセージを分割するには、サブクラスでこのメソッドをオーバーライドする必要があります。戻り値は、コレクションまたは配列です。個々の要素はメッセージの場合がありますが、必須ではありません。要素がメッセージではない場合、それぞれがメッセージのペイロードとして提供されます。単一のオブジェクトまたはメッセージを返すことも可能です。その場合、単一の応答メッセージが作成されます。
    次で指定:
    クラス AbstractMessageSplitter の splitMessage
    パラメーター:
    message - メッセージ。
    戻り値:
    メッセージを分割した結果。
  - obtainSizeIfPossible
```
protected int obtainSizeIfPossible(IteratorSE<?> iterator)
```
    クラスからコピーされた説明: AbstractMessageSplitter
    付属の IteratorSE のサイズを取得します。デフォルトの実装は 0 を返します。
    オーバーライド:
    クラス AbstractMessageSplitter の obtainSizeIfPossible
    パラメーター:
    iterator - サイズを取得するための IteratorSE
    戻り値:
    IteratorSE のサイズ

クラス XPathMessageSplitter

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

クラス org.springframework.integration.handler.AbstractReplyProducingMessageHandler から継承されたネストクラス / インターフェース

インターフェース org.springframework.integration.support.management.IntegrationManagement から継承されたネストクラス / インターフェース

フィールドのサマリー

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

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

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

インターフェース org.springframework.integration.support.management.IntegrationManagement から継承されたフィールド

コンストラクターの概要

メソッドのサマリー

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

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

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

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

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

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

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

インターフェース org.springframework.messaging.MessageHandler から継承されたメソッド

インターフェース reactor.core.CoreSubscriber から継承されたメソッド

インターフェース org.springframework.integration.support.management.IntegrationManagement から継承されたメソッド

インターフェース org.springframework.integration.support.context.NamedComponent から継承されたメソッド

コンストラクターの詳細

XPathMessageSplitter

XPathMessageSplitter

XPathMessageSplitter

XPathMessageSplitter

XPathMessageSplitter

XPathMessageSplitter

メソッドの詳細

setCreateDocuments

getComponentType

setDocumentBuilder

setXmlPayloadConverter

setIterator

setOutputProperties

doInit

splitMessage

obtainSizeIfPossible