SqlXmlHandler (Spring Framework 5.1.8.RELEASE API)

すべての既知のサブインターフェース:
SqlXmlObjectMappingHandler
すべての既知の実装クラス:
Jdbc4SqlXmlHandler
```
public interface SqlXmlHandler
```
特定のデータベースで XML フィールドを処理するための抽象化。その主な目的は、データベースに格納されている XML のデータベース固有の処理を分離することです。
JDBC 4.0 は新しいデータ型 java.sql.SQLXML を導入しますが、ほとんどのデータベースとそのドライバーは現在データベース固有のデータ型と機能に依存しています。
XML フィールドにアクセサーメソッドを提供し、SqlXmlValue インスタンスのファクトリとして機能します。
導入:
2.5.5
作成者:
Thomas Risberg
関連事項:
Jdbc4SqlXmlHandler, SQLXMLSE, ResultSet.getSQLXML(int)SE, PreparedStatement.setSQLXML(int, java.sql.SQLXML)SE

メソッドのサマリー

すべてのメソッドインスタンスメソッド抽象メソッド
修飾子と型	メソッドと説明
`InputStreamSE`	`getXmlAsBinaryStream(ResultSetSE rs, int columnIndex)` 指定された ResultSet から、指定された列をバイナリストリームとして取得します。
`InputStreamSE`	`getXmlAsBinaryStream(ResultSetSE rs, StringSE columnName)` 指定された ResultSet から、指定された列をバイナリストリームとして取得します。
`ReaderSE`	`getXmlAsCharacterStream(ResultSetSE rs, int columnIndex)` 指定された ResultSet から、指定された列を文字ストリームとして取得します。
`ReaderSE`	`getXmlAsCharacterStream(ResultSetSE rs, StringSE columnName)` 指定された ResultSet から、指定された列を文字ストリームとして取得します。
`SourceSE`	`getXmlAsSource(ResultSetSE rs, int columnIndex, ClassSE<? extends SourceSE> sourceClass)` 指定された ResultSet から、指定されたソースクラスを使用して実装されたソースとして指定された列を取得します。
`SourceSE`	`getXmlAsSource(ResultSetSE rs, StringSE columnName, ClassSE<? extends SourceSE> sourceClass)` 指定された ResultSet から、指定されたソースクラスを使用して実装されたソースとして指定された列を取得します。
`StringSE`	`getXmlAsString(ResultSetSE rs, int columnIndex)` 指定された ResultSet から指定された列を文字列として取得します。
`StringSE`	`getXmlAsString(ResultSetSE rs, StringSE columnName)` 指定された ResultSet から指定された列を文字列として取得します。
`SqlXmlValue`	`newSqlXmlValue(ClassSE<? extends ResultSE> resultClass, XmlResultProvider provider)` 基盤となる JDBC ドライバーでサポートされているように、指定された XML データの `SqlXmlValue` インスタンスを作成します。
`SqlXmlValue`	`newSqlXmlValue(DocumentSE doc)` 基盤となる JDBC ドライバーでサポートされているように、指定された XML データの `SqlXmlValue` インスタンスを作成します。
`SqlXmlValue`	`newSqlXmlValue(StringSE value)` 基盤となる JDBC ドライバーでサポートされているように、指定された XML データの `SqlXmlValue` インスタンスを作成します。
`SqlXmlValue`	`newSqlXmlValue(XmlBinaryStreamProvider provider)` 基盤となる JDBC ドライバーでサポートされているように、指定された XML データの `SqlXmlValue` インスタンスを作成します。
`SqlXmlValue`	`newSqlXmlValue(XmlCharacterStreamProvider provider)` 基盤となる JDBC ドライバーでサポートされているように、指定された XML データの `SqlXmlValue` インスタンスを作成します。

- メソッドの詳細
  - getXmlAsString
```
@Nullable
StringSE getXmlAsString(ResultSetSE rs,
                                StringSE columnName)
                         throws SQLExceptionSE
```
    指定された ResultSet から指定された列を文字列として取得します。
    データベースとドライバに応じて、ResultSet.getString を呼び出すか、SQLXML またはデータベース固有のクラスを操作するだけです。
    パラメーター:
    rs - コンテンツを取得する ResultSet
    columnName - 使用する列名
    戻り値:
    文字列としてのコンテンツ、または SQL NULL の場合は null
    例外:
    SQLExceptionSE - JDBC メソッドによってスローされた場合
    関連事項:
    ResultSet.getString(int)SE, ResultSet.getSQLXML(int)SE
  - getXmlAsString
```
@Nullable
StringSE getXmlAsString(ResultSetSE rs,
                                int columnIndex)
                         throws SQLExceptionSE
```
    指定された ResultSet から指定された列を文字列として取得します。
    データベースとドライバに応じて、ResultSet.getString を呼び出すか、SQLXML またはデータベース固有のクラスを操作するだけです。
    パラメーター:
    rs - コンテンツを取得する ResultSet
    columnIndex - 使用する列インデックス
    戻り値:
    文字列としてのコンテンツ、または SQL NULL の場合は null
    例外:
    SQLExceptionSE - JDBC メソッドによってスローされた場合
    関連事項:
    ResultSet.getString(int)SE, ResultSet.getSQLXML(int)SE
  - getXmlAsBinaryStream
```
@Nullable
InputStreamSE getXmlAsBinaryStream(ResultSetSE rs,
                                           StringSE columnName)
                                    throws SQLExceptionSE
```
    指定された ResultSet から、指定された列をバイナリストリームとして取得します。
    データベースとドライバに応じて、ResultSet.getAsciiStream を呼び出すか、SQLXML またはデータベース固有のクラスを操作するだけです。
    パラメーター:
    rs - コンテンツを取得する ResultSet
    columnName - 使用する列名
    戻り値:
    バイナリストリームとしてのコンテンツ、または SQL NULL の場合は null
    例外:
    SQLExceptionSE - JDBC メソッドによってスローされた場合
    関連事項:
    ResultSet.getSQLXML(int)SE, SQLXML.getBinaryStream()SE
  - getXmlAsBinaryStream
```
@Nullable
InputStreamSE getXmlAsBinaryStream(ResultSetSE rs,
                                           int columnIndex)
                                    throws SQLExceptionSE
```
    指定された ResultSet から、指定された列をバイナリストリームとして取得します。
    データベースとドライバに応じて、ResultSet.getAsciiStream を呼び出すか、SQLXML またはデータベース固有のクラスを操作するだけです。
    パラメーター:
    rs - コンテンツを取得する ResultSet
    columnIndex - 使用する列インデックス
    戻り値:
    バイナリストリームとしてのコンテンツ、または SQL NULL の場合は null
    例外:
    SQLExceptionSE - JDBC メソッドによってスローされた場合
    関連事項:
    ResultSet.getSQLXML(int)SE, SQLXML.getBinaryStream()SE
  - getXmlAsCharacterStream
```
@Nullable
ReaderSE getXmlAsCharacterStream(ResultSetSE rs,
                                         StringSE columnName)
                                  throws SQLExceptionSE
```
    指定された ResultSet から、指定された列を文字ストリームとして取得します。
    データベースとドライバに応じて、ResultSet.getCharacterStream を呼び出すか、SQLXML またはデータベース固有のクラスを操作するだけです。
    パラメーター:
    rs - コンテンツを取得する ResultSet
    columnName - 使用する列名
    戻り値:
    文字ストリームとしてのコンテンツ、または SQL NULL の場合は null
    例外:
    SQLExceptionSE - JDBC メソッドによってスローされた場合
    関連事項:
    ResultSet.getSQLXML(int)SE, SQLXML.getCharacterStream()SE
  - getXmlAsCharacterStream
```
@Nullable
ReaderSE getXmlAsCharacterStream(ResultSetSE rs,
                                         int columnIndex)
                                  throws SQLExceptionSE
```
    指定された ResultSet から、指定された列を文字ストリームとして取得します。
    データベースとドライバに応じて、ResultSet.getCharacterStream を呼び出すか、SQLXML またはデータベース固有のクラスを操作するだけです。
    パラメーター:
    rs - コンテンツを取得する ResultSet
    columnIndex - 使用する列インデックス
    戻り値:
    文字ストリームとしてのコンテンツ、または SQL NULL の場合は null
    例外:
    SQLExceptionSE - JDBC メソッドによってスローされた場合
    関連事項:
    ResultSet.getSQLXML(int)SE, SQLXML.getCharacterStream()SE
  - getXmlAsSource
```
@Nullable
SourceSE getXmlAsSource(ResultSetSE rs,
                                StringSE columnName,
                                @Nullable
                                ClassSE<? extends SourceSE> sourceClass)
                         throws SQLExceptionSE
```
    指定された ResultSet から、指定されたソースクラスを使用して実装されたソースとして指定された列を取得します。
    データベースとドライバーに応じて、SQLXML またはデータベース固有のクラスで機能する場合があります。
    パラメーター:
    rs - コンテンツを取得する ResultSet
    columnName - 使用する列名
    sourceClass - 使用する実装クラス
    戻り値:
    文字ストリームとしてのコンテンツ、または SQL NULL の場合は null
    例外:
    SQLExceptionSE - JDBC メソッドによってスローされた場合
    関連事項:
    ResultSet.getSQLXML(int)SE, SQLXML.getSource(java.lang.Class<T>)SE
  - getXmlAsSource
```
@Nullable
SourceSE getXmlAsSource(ResultSetSE rs,
                                int columnIndex,
                                @Nullable
                                ClassSE<? extends SourceSE> sourceClass)
                         throws SQLExceptionSE
```
    指定された ResultSet から、指定されたソースクラスを使用して実装されたソースとして指定された列を取得します。
    データベースとドライバーに応じて、SQLXML またはデータベース固有のクラスで機能する場合があります。
    パラメーター:
    rs - コンテンツを取得する ResultSet
    columnIndex - 使用する列インデックス
    sourceClass - 使用する実装クラス
    戻り値:
    文字ストリームとしてのコンテンツ、または SQL NULL の場合は null
    例外:
    SQLExceptionSE - JDBC メソッドによってスローされた場合
    関連事項:
    ResultSet.getSQLXML(int)SE, SQLXML.getSource(java.lang.Class<T>)SE
  - newSqlXmlValue
```
SqlXmlValue newSqlXmlValue(StringSE value)
```
    基盤となる JDBC ドライバーでサポートされているように、指定された XML データの SqlXmlValue インスタンスを作成します。
    パラメーター:
    value - XML データを提供する XML 文字列値
    戻り値:
    実装固有のインスタンス
    関連事項:
    SqlXmlValue, SQLXML.setString(String)SE
  - newSqlXmlValue
```
SqlXmlValue newSqlXmlValue(XmlBinaryStreamProvider provider)
```
    基盤となる JDBC ドライバーでサポートされているように、指定された XML データの SqlXmlValue インスタンスを作成します。
    パラメーター:
    provider - XML データを提供する XmlBinaryStreamProvider
    戻り値:
    実装固有のインスタンス
    関連事項:
    SqlXmlValue, SQLXML.setBinaryStream()SE
  - newSqlXmlValue
```
SqlXmlValue newSqlXmlValue(XmlCharacterStreamProvider provider)
```
    基盤となる JDBC ドライバーでサポートされているように、指定された XML データの SqlXmlValue インスタンスを作成します。
    パラメーター:
    provider - XML データを提供する XmlCharacterStreamProvider
    戻り値:
    実装固有のインスタンス
    関連事項:
    SqlXmlValue, SQLXML.setCharacterStream()SE
  - newSqlXmlValue
```
SqlXmlValue newSqlXmlValue(ClassSE<? extends ResultSE> resultClass,
                           XmlResultProvider provider)
```
    基盤となる JDBC ドライバーでサポートされているように、指定された XML データの SqlXmlValue インスタンスを作成します。
    パラメーター:
    resultClass - 使用される Result 実装クラス
    provider - XML データを提供する XmlResultProvider
    戻り値:
    実装固有のインスタンス
    関連事項:
    SqlXmlValue, SQLXML.setResult(Class)SE
  - newSqlXmlValue
```
SqlXmlValue newSqlXmlValue(DocumentSE doc)
```
    基盤となる JDBC ドライバーでサポートされているように、指定された XML データの SqlXmlValue インスタンスを作成します。
    パラメーター:
    doc - 使用する XML ドキュメント
    戻り値:
    実装固有のインスタンス
    関連事項:
    SqlXmlValue

インターフェース SqlXmlHandler

メソッドのサマリー

メソッドの詳細

getXmlAsString

getXmlAsString

getXmlAsBinaryStream

getXmlAsBinaryStream

getXmlAsCharacterStream

getXmlAsCharacterStream

getXmlAsSource

getXmlAsSource

newSqlXmlValue

newSqlXmlValue

newSqlXmlValue

newSqlXmlValue

newSqlXmlValue