ResultSetIterator (Nablarch-API)

java.lang.Object
- nablarch.core.db.statement.ResultSetIterator

すべての実装されたインタフェース:: java.lang.Iterable<SqlRow>

public class ResultSetIterator
extends java.lang.Object
implements java.lang.Iterable<SqlRow>

ResultSetのWrapperクラス。

本クラスでは、ResultSetから1行分のデータをSqlRowで取得するインタフェースを提供する。以下に例を示す。


  ResultSetIterator rs = statement.executeQuery();
 // for-each文を使って、１レコード文のデータを取得する。
 for (SqlRow row : rs) {
     // SqlRowから各カラムの値を取得し必要な処理を行う。
 }

関連項目:: ResultSet

コンストラクタのサマリー

コンストラクタ
コンストラクタと説明
`ResultSetIterator(java.sql.ResultSet rs, ResultSetConvertor convertor)` パラメータで指定された`ResultSet`を保持するResultSetIteratorオブジェクトを生成する。

メソッドのサマリー

すべてのメソッドインスタンス・メソッド concreteメソッド
修飾子とタイプ	メソッドと説明
`void`	`close()` `ResultSet.close()`を行う。
`java.math.BigDecimal`	`getBigDecimal(int columnIndex)` カレント行の指定されたカラムの値を`BigDecimal`で取得する。
`java.sql.Blob`	`getBlob(int columnIndex)` カレント行の指定されたカラムの値を`Blob`で取得する。
`byte[]`	`getBytes(int columnIndex)` カレント行の指定されたカラムの値をbyte配列で取得する。
`java.util.Date`	`getDate(int columnIndex)` カレント行の指定されたカラムの値を`Date`で取得する。
`java.lang.Integer`	`getInteger(int columnIndex)` カレント行の指定されたカラムの値を`Integer`で取得する。
`java.lang.Long`	`getLong(int columnIndex)` カレント行の指定されたカラムの値を`Long`で取得する。
`java.sql.ResultSetMetaData`	`getMetaData()` `ResultSetMetaData`を取得する。
`java.lang.Object`	`getObject(int columnIndex)` カレント行の指定されたカラムの値を`Object`で取得する。
`SqlRow`	`getRow()` 現在レコードのデータを取得する。
`java.lang.Short`	`getShort(int columnIndex)` カレント行の指定されたカラムの値を`Short`で取得する。
`SqlStatement`	`getStatement()` Statementを取得する。
`java.lang.String`	`getString(int columnIndex)` カレント行の指定されたカラムの値を`String`で取得する。
`java.sql.Timestamp`	`getTimestamp(int columnIndex)` カレント行の指定されたカラムの値を`Timestamp`で取得する。
`java.util.Iterator<SqlRow>`	`iterator()` 型Tの要素セットの反復子を返す。
`boolean`	`next()` `ResultSet.next()` を行う。
`void`	`setStatement(SqlStatement statement)` 自身を生成した`SqlStatement`を設定する。

クラスから継承されたメソッド java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

インタフェースから継承されたメソッド java.lang.Iterable
forEach, spliterator

- コンストラクタの詳細
  - ResultSetIterator
```
public ResultSetIterator(java.sql.ResultSet rs,
                         ResultSetConvertor convertor)
```
    パラメータで指定されたResultSetを保持するResultSetIteratorオブジェクトを生成する。
    
    パラメータ:
    
    rs - ResultSet
    
    convertor - ResultSetConvertor
- メソッドの詳細
  - setStatement
```
public void setStatement(SqlStatement statement)
```
    自身を生成したSqlStatementを設定する。
    
    パラメータ:
    
    statement - ステートメント
  - getStatement
```
public SqlStatement getStatement()
```
    Statementを取得する。
    
    戻り値:
    
    この結果セットを生成したStatement
  - next
```
@Published
public boolean next()
```
    ResultSet.next() を行う。
    
    戻り値:
    
    次のレコードが存在する場合はtrue、存在しない場合はfalse
    
    例外:
    
    DbAccessException - SQLExceptionが発生した場合
  - getObject
```
@Published
public java.lang.Object getObject(int columnIndex)
```
    カレント行の指定されたカラムの値をObjectで取得する。
    
    パラメータ:
    
    columnIndex - カラムインデックス
    
    戻り値:
    
    カラムの値
    
    例外:
    
    DbAccessException - SQLExceptionが発生した場合
    
    関連項目:
    
    ResultSet.getObject(int)
  - getString
```
@Published
public java.lang.String getString(int columnIndex)
```
    カレント行の指定されたカラムの値をStringで取得する。
    
    パラメータ:
    
    columnIndex - カラムインデックス
    
    戻り値:
    
    カラムの値
    
    例外:
    
    DbAccessException - SQLExceptionが発生した場合
    
    関連項目:
    
    ResultSet.getString(int)
  - getInteger
```
@Published
public java.lang.Integer getInteger(int columnIndex)
```
    カレント行の指定されたカラムの値をIntegerで取得する。
    ResultSet.getInt(int)は、カラムの値がnullの場合は0を返すが、本メソッドではカラムの値がnullの場合はnullを返す。
    カラムの値がIntegerに変換可能な場合は、Integerに変換し返却する。
    変換できない場合は、カラムの値を持つ新しいIntegerインスタンスを返却する。
    
    パラメータ:
    
    columnIndex - カラムインデックス
    
    戻り値:
    
    カラムの値
    
    例外:
    
    java.lang.NumberFormatException - カラムの値をIntegerに変換できなかった場合
    
    関連項目:
    
    getObject(int)
  - getLong
```
@Published
public java.lang.Long getLong(int columnIndex)
```
    カレント行の指定されたカラムの値をLongで取得する。
    ResultSet.getLong(int)は、カラムの値がnullの場合は0を返すが、本メソッドではカラムの値がnullの場合はnullを返す。
    カラムの値がLongに変換可能な場合は、Longに変換し返却する。
    変換できない場合は、カラムの値を持つ新しいLongインスタンスを返却する。
    
    パラメータ:
    
    columnIndex - カラムインデックス
    
    戻り値:
    
    カラムの値
    
    例外:
    
    java.lang.NumberFormatException - カラムの値をLongに変換できなかった場合
    
    関連項目:
    
    getObject(int)
  - getShort
```
@Published
public java.lang.Short getShort(int columnIndex)
```
    カレント行の指定されたカラムの値をShortで取得する。
    ResultSet.getShort(int)は、カラムの値がnullの場合は0を返すが、本メソッドではカラムの値がnullの場合はnullを返す。
    カラムの値がShortに変換可能な場合は、Shortに変換し返却する。
    変換できない場合は、カラムの値を持つ新しいShortインスタンスを返却する。
    
    パラメータ:
    
    columnIndex - カラムインデックス
    
    戻り値:
    
    カラムの値
    
    例外:
    
    java.lang.NumberFormatException - カラムの値をShortに変換できなかった場合
    
    関連項目:
    
    getObject(int)
  - getBigDecimal
```
@Published
public java.math.BigDecimal getBigDecimal(int columnIndex)
```
    カレント行の指定されたカラムの値をBigDecimalで取得する。
    
    パラメータ:
    
    columnIndex - カラムインデックス
    
    戻り値:
    
    カラムの値
    
    例外:
    
    DbAccessException - SQLExceptionが発生した場合
    
    関連項目:
    
    ResultSet.getBigDecimal(int)
  - getDate
```
@Published
public java.util.Date getDate(int columnIndex)
```
    カレント行の指定されたカラムの値をDateで取得する。
    
    パラメータ:
    
    columnIndex - カラムインデックス
    
    戻り値:
    
    カラムの値
    
    例外:
    
    DbAccessException - SQLExceptionが発生した場合
    
    関連項目:
    
    ResultSet.getDate(int)
  - getTimestamp
```
@Published
public java.sql.Timestamp getTimestamp(int columnIndex)
```
    カレント行の指定されたカラムの値をTimestampで取得する。
    
    パラメータ:
    
    columnIndex - カラムインデックス
    
    戻り値:
    
    カラムの値
    
    例外:
    
    DbAccessException - SQLExceptionが発生した場合
    
    関連項目:
    
    ResultSet.getTimestamp(int)
  - getBytes
```
@Published
public byte[] getBytes(int columnIndex)
```
    カレント行の指定されたカラムの値をbyte配列で取得する。
    
    パラメータ:
    
    columnIndex - カラムインデックス
    
    戻り値:
    
    カラムの値
    
    例外:
    
    DbAccessException - SQLExceptionが発生した場合
    
    関連項目:
    
    ResultSet.getBytes(int)
  - getBlob
```
@Published
public java.sql.Blob getBlob(int columnIndex)
```
    カレント行の指定されたカラムの値をBlobで取得する。
    
    パラメータ:
    
    columnIndex - カラムインデックス
    
    戻り値:
    
    カラムの値
    
    例外:
    
    DbAccessException - SQLExceptionが発生した場合
    
    関連項目:
    
    ResultSet.getBlob(int)
  - getRow
```
@Published
public SqlRow getRow()
```
    現在レコードのデータを取得する。
    本メソッドでは、呼び出されるたびにSqlRowを生成する。
    
    戻り値:
    
    現在レコードを保持したSqlRow
    
    例外:
    
    DbAccessException - SQLExceptionが発生した場合
  - close
```
public void close()
```
    ResultSet.close()を行う。
    
    例外:
    
    DbAccessException - SQLExceptionが発生した場合
    
    関連項目:
    
    ResultSet.close()
  - getMetaData
```
public java.sql.ResultSetMetaData getMetaData()
```
    ResultSetMetaDataを取得する。
    
    戻り値:
    
    ResultSetMetaDataオブジェクト
  - iterator
```
@Published
public java.util.Iterator<SqlRow> iterator()
```
    型Tの要素セットの反復子を返す。
    
    定義:
    
    iterator インタフェース内 java.lang.Iterable<SqlRow>
    
    戻り値:
    
    反復子
    
    例外:
    
    java.lang.IllegalArgumentException - 複数のメソッドから呼び出された場合

クラス ResultSetIterator

コンストラクタのサマリー

メソッドのサマリー

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

インタフェースから継承されたメソッド java.lang.Iterable

コンストラクタの詳細

ResultSetIterator

メソッドの詳細

setStatement

getStatement

next

getObject

getString

getInteger

getLong

getShort

getBigDecimal

getDate

getTimestamp

getBytes

getBlob

getRow

close

getMetaData

iterator