フィールドの詳細

• DEFAULT_ENCODING

  public static final java.lang.String DEFAULT_ENCODING

  関連事項:

  定数フィールド値

• DEFAULT_XML_VERSION

  public static final java.lang.String DEFAULT_XML_VERSION

  関連事項:

  定数フィールド値

• DEFAULT_STANDALONE_DOCUMENT

  public static final java.lang.Boolean DEFAULT_STANDALONE_DOCUMENT

• DEFAULT_ROOT_TAG_NAME

  public static final java.lang.String DEFAULT_ROOT_TAG_NAME

  関連事項:

  定数フィールド値

コンストラクターの詳細

• StaxEventItemWriter

  public StaxEventItemWriter()

メソッドの詳細

• setResource

  public void setResource(org.springframework.core.io.Resource resource)

  出力ファイルを設定します。

  次で指定:

  インターフェース ResourceAwareItemWriterItemStream<T> の setResource 

  パラメーター:

  resource - 出力ファイル

• setMarshaller

  public void setMarshaller(org.springframework.oxm.Marshaller marshaller)

  Object を XML マーシャラーに設定します。

  パラメーター:

  marshaller - Object to XML マーシャラー

• setHeaderCallback

  public void setHeaderCallback(StaxWriterCallback headerCallback)

  headerCallback は、項目を書き込む前に呼び出されます。

  パラメーター:

  headerCallback - 項目を書き込む前に呼び出される StaxWriterCallback

• setFooterCallback

  public void setFooterCallback(StaxWriterCallback footerCallback)

  footerCallback は、すべてのアイテムを書き込んだ後、ファイルを閉じる前に呼び出されます。

  パラメーター:

  footerCallback - 項目を書き込んだ後に呼び出される StaxWriterCallback

• setTransactional

  public void setTransactional(boolean transactional)

  書き込みが存在する場合、トランザクションの最後まで延期する必要があることを示すフラグ。デフォルトは true です。

  パラメーター:

  transactional - 設定するフラグ

• setForceSync

  public void setForceSync(boolean forceSync)

  フラッシュ時に変更を強制的にディスクに同期する必要があることを示すフラグ。デフォルトは false です。これは、書き込みとキャッシュフラッシュの間に OS がクラッシュすると、ローカルディスクの変更が失われる可能性があることを意味します。true に設定すると、多くの頻繁な書き込みを伴う使用パターンのパフォーマンスが低下する場合があります。

  パラメーター:

  forceSync - 設定するフラグ値

• setShouldDeleteIfEmpty

  public void setShouldDeleteIfEmpty(boolean shouldDeleteIfEmpty)

  クローズ時に項目が書き込まれていない場合（ヘッダーとフッターを除く）、ターゲットファイルを削除することを示すフラグ。デフォルトは false です。

  パラメーター:

  shouldDeleteIfEmpty - 設定するフラグ値

• getEncoding

  public java.lang.String getEncoding()

  使用されているエンコーディングを取得します。

  戻り値:

  使用されるエンコーディング

• setEncoding

  public void setEncoding(java.lang.String encoding)

  出力ファイルに使用されるエンコーディングを設定します。

  パラメーター:

  encoding - 使用されるエンコーディング

• getVersion

  public java.lang.String getVersion()

  XML バージョンを取得します。

  戻り値:

  使用される XML バージョン

• setVersion

  public void setVersion(java.lang.String version)

  出力 XML に使用する XML バージョンを設定します。

  パラメーター:

  version - 使用される XML バージョン

• getStandalone

  public java.lang.Boolean getStandalone()

  スタンドアロンのドキュメント宣言を使用します。

  戻り値:

  使用されるスタンドアロンドキュメント宣言

  導入:

  4.3

• setStandalone

  public void setStandalone(java.lang.Boolean standalone)

  出力 XML に使用されるスタンドアロンのドキュメント宣言を設定します。設定されていない場合、スタンドアロンのドキュメント宣言は省略されます。

  パラメーター:

  standalone - 使用する XML スタンドアロンドキュメント宣言

  導入:

  4.3

• getRootTagName

  public java.lang.String getRootTagName()

  ルート要素のタグ名を取得します。

  戻り値:

  ルート要素タグ名

• setRootTagName

  public void setRootTagName(java.lang.String rootTagName)

  ルート要素のタグ名を設定します。設定されていない場合、デフォルト名が使用されます（「ルート」）。表記法を使用して、名前空間 URI とプレフィックスもオプションで設定できます。

   {uri}prefix:root
   

  プレフィックスはオプションです（デフォルトは空です）が、指定する場合は uri を指定する必要があります。さらに、root attributes を使用して他の名前空間を宣言することもできます。

  パラメーター:

  rootTagName - ルート要素に使用されるタグ名

• getRootTagNamespacePrefix

  public java.lang.String getRootTagNamespacePrefix()

  ルート要素の名前空間プレフィックスを取得します。デフォルトでは空です。

  戻り値:

  rootTagNamespacePrefix

• getRootTagNamespace

  public java.lang.String getRootTagNamespace()

  ルート要素の名前空間を取得します。

  戻り値:

  rootTagNamespace

• getRootElementAttributes

  public java.util.Map<java.lang.String,java.lang.String> getRootElementAttributes()

  ルート要素の属性を取得します。

  戻り値:

  ルート要素の属性

• setRootElementAttributes

  public void setRootElementAttributes(java.util.Map<java.lang.String,java.lang.String> rootElementAttributes)

  書き込まれるルート要素の属性を設定します。キー名のいずれかが "xmlns:" で始まる場合、名前空間宣言として扱われます。

  パラメーター:

  rootElementAttributes - ルート要素の属性

• setOverwriteOutput

  public void setOverwriteOutput(boolean overwriteOutput)

  出力ファイルに「上書き」フラグを設定します。出力ファイルの処理が再開されると、フラグは無視されます。

  パラメーター:

  overwriteOutput - true に設定すると、出力ファイルは上書きされます（処理が再開される場合、このフラグは無視されます）。

• setSaveState

  public void setSaveState(boolean saveState)

• afterPropertiesSet

  public void afterPropertiesSet()
                          throws java.lang.Exception

  次で指定:

  インターフェース org.springframework.beans.factory.InitializingBean の afterPropertiesSet 

  例外:

  java.lang.Exception - エラーが発生した場合にスローされます

  関連事項:

  InitializingBean.afterPropertiesSet()

• open

  public void open(ExecutionContext executionContext)

  出力ソースを開く

  次で指定:

  インターフェース ItemStream の open 

  オーバーライド:

  クラス ItemStreamSupport の open 

  パラメーター:

  executionContext - バッチコンテキスト。

  関連事項:

  ItemStream.open(ExecutionContext)

• createXmlEventWriter

  protected javax.xml.stream.XMLEventWriter createXmlEventWriter(javax.xml.stream.XMLOutputFactory outputFactory,
                                                                 java.io.Writer writer)
                                                          throws javax.xml.stream.XMLStreamException

  サブクラスはオーバーライドしてライターをカスタマイズできます。

  パラメーター:

  outputFactory - XMLEventWriter の作成に使用されるファクトリ。

  writer - XMLEventWriter が文字ストリームへの書き込みに使用する Writer 

  戻り値:

  XML ライター

  例外:

  javax.xml.stream.XMLStreamException - XMLEventWriter の作成中にエラーが発生した場合にスローされます。

• createXmlOutputFactory

  protected javax.xml.stream.XMLOutputFactory createXmlOutputFactory()
                                                              throws javax.xml.stream.FactoryConfigurationError

  サブクラスは、ファクトリをカスタマイズするためにオーバーライドできます。

  戻り値:

  xml 出力のファクトリ

  例外:

  javax.xml.stream.FactoryConfigurationError - このファクトリのインスタンスをロードできない場合にスローされます。

• createXmlEventFactory

  protected javax.xml.stream.XMLEventFactory createXmlEventFactory()
                                                            throws javax.xml.stream.FactoryConfigurationError

  サブクラスは、イベントファクトリをカスタマイズするためにオーバーライドできます。

  戻り値:

  xml イベントのファクトリ

  例外:

  javax.xml.stream.FactoryConfigurationError - このファクトリのインスタンスをロードできない場合にスローされます。

• createStaxResult

  protected javax.xml.transform.Result createStaxResult()

  サブクラスはオーバーライドして、STAX の結果をカスタマイズできます。

  戻り値:

  書き込み結果

• initNamespaceContext

  protected void initNamespaceContext(javax.xml.stream.XMLEventWriter writer)
                               throws javax.xml.stream.XMLStreamException

  XMLEventWriter の名前空間コンテキストを初期化します。

  • rootTagName の rootTagNamespacePrefix
  • ルート要素属性のその他の xmlns 名前空間接頭辞宣言

  パラメーター:

  writer - XML イベントライター

  例外:

  javax.xml.stream.XMLStreamException - 接頭辞またはデフォルトの名前空間の設定中にエラーが発生した場合にスローされます。

• startDocument

  protected void startDocument(javax.xml.stream.XMLEventWriter writer)
                        throws javax.xml.stream.XMLStreamException

  以下を含む単純な XML ヘッダーを書き込みます。

  • xml 宣言 - エンコーディングと XML バージョンを定義します
  • ルート要素とその属性の開始タグ

  これでは不十分な場合は、このメソッドをオーバーライドしてください。エンコーディング、バージョン、ルートタグ名は、対応する getter で取得できます。

  パラメーター:

  writer - XML イベントライター

  例外:

  javax.xml.stream.XMLStreamException - エラーが発生した場合にスローされます。

• endDocument

  protected void endDocument(javax.xml.stream.XMLEventWriter writer)
                      throws javax.xml.stream.XMLStreamException

  EndDocument タグを手動で書き込みます。

  パラメーター:

  writer - XML イベントライター

  例外:

  javax.xml.stream.XMLStreamException - エラーが発生した場合にスローされます。

• close

  public void close()

  出力ソースをフラッシュして閉じます。

  次で指定:

  インターフェース ItemStream の close 

  オーバーライド:

  クラス ItemStreamSupport の close 

  関連事項:

  ItemStream.close()

• write

  public void write(java.util.List<? extends T> items)
             throws org.springframework.oxm.XmlMappingException,
                    java.io.IOException

  値オブジェクトを書き込み、ファイルにフラッシュします。

  次で指定:

  インターフェース ItemWriter<T> の write 

  パラメーター:

  items - 値オブジェクト

  例外:

  java.io.IOException - 一般的なエラーが発生した場合にスローされます。

  org.springframework.oxm.XmlMappingException - XML マッピング中にエラーが発生した場合にスローされます。

• update

  public void update(ExecutionContext executionContext)

  再起動データを取得します。

  次で指定:

  インターフェース ItemStream の update 

  オーバーライド:

  クラス ItemStreamSupport の update 

  パラメーター:

  executionContext - バッチコンテキスト。

  関連事項:

  ItemStream.update(ExecutionContext)