SqlRow (Nablarch-API)

java.lang.Object
- java.util.AbstractMap<K,V>
- - nablarch.core.util.map.MapWrapper<java.lang.String,V>
  - - nablarch.core.util.map.MultipleKeyCaseMap<java.lang.Object>
    - - nablarch.core.db.statement.SqlRow

すべての実装されたインタフェース:

java.util.Map<java.lang.String,java.lang.Object>
```
@Published
public class SqlRow
extends MultipleKeyCaseMap<java.lang.Object>
```
簡易取得結果1行分のデータを保持するクラス。
各カラムの内容は、そのデータ型に対応したgetメソッドにより取得できる。この際、カラム名の大文字/小文字の違い、アンダースコアの有無は区別せず、同一のカラム名とみなされる。
例:
- USER_NAMEとuser_nameは同一のカラム名とみなされる。(大文字小文字の区別はしないため)
- USER_NAMEとuserNameは同一のカラム名とみなされる。(アンダースコアの有無は区別しないため)

ネストされたクラスのサマリー
- クラスから継承されたネストされたクラス/インタフェース java.util.AbstractMap
  java.util.AbstractMap.SimpleEntry<K,V>, java.util.AbstractMap.SimpleImmutableEntry<K,V>
- インタフェースから継承されたネストされたクラス/インタフェース java.util.Map
  java.util.Map.Entry<K,V>

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

コンストラクタ
修飾子	コンストラクタと説明
	`SqlRow(java.util.Map<java.lang.String,java.lang.Object> row, java.util.Map<java.lang.String,java.lang.Integer> colType)` 指定されたMapを元にオブジェクトを構築する。
	`SqlRow(java.util.Map<java.lang.String,java.lang.Object> row, java.util.Map<java.lang.String,java.lang.Integer> colType, java.util.Map<java.lang.String,java.lang.String> ignored)` 指定されたMapを元にオブジェクトを構築する。
`protected`	`SqlRow(SqlRow orig)` コピー元となる`SqlRow`からオブジェクトを構築する。

メソッドのサマリー

すべてのメソッドインスタンス・メソッド concreteメソッド
修飾子とタイプ	メソッドと説明
`java.math.BigDecimal`	`getBigDecimal(java.lang.String colName)` 指定されたカラムの情報を`BigDecimal`として取得する。
`java.lang.Boolean`	`getBoolean(java.lang.String colName)` 指定されたカラムの情報を`Boolean`として取得する。
`byte[]`	`getBytes(java.lang.String colName)` 指定されたカラムの情報をbyte配列として取得する。
`protected int`	`getColType(java.lang.String colName)` 指定されたカラム名のカラムタイプ(`Types`)を取得する。
`java.util.Date`	`getDate(java.lang.String colName)` 指定されたカラムの情報を`Date`として取得する。
`java.lang.Integer`	`getInteger(java.lang.String colName)` 指定されたカラムの情報を`Integer`として取得する。
`java.lang.Long`	`getLong(java.lang.String colName)` 指定されたカラムの情報を`Long`として取得する。
`java.lang.String`	`getString(java.lang.String colName)` 指定されたカラムの情報を文字列で取得する。
`java.sql.Timestamp`	`getTimestamp(java.lang.String colName)` 指定されたカラムの情報を`Timestamp`として取得する。

クラスから継承されたメソッド nablarch.core.util.map.MultipleKeyCaseMap
addKeyConversion, containsKey, copyValueOf, get, getActualDataKey, getDelegateMap, put, putAll

クラスから継承されたメソッド nablarch.core.util.map.MapWrapper
clear, containsValue, entrySet, equals, getDelegateMapOfType, hashCode, isEmpty, keySet, remove, size, toString, values

クラスから継承されたメソッド java.util.AbstractMap
clone

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

インタフェースから継承されたメソッド java.util.Map
compute, computeIfAbsent, computeIfPresent, forEach, getOrDefault, merge, putIfAbsent, remove, replace, replace, replaceAll

- コンストラクタの詳細
  - SqlRow
```
public SqlRow(java.util.Map<java.lang.String,java.lang.Object> row,
              java.util.Map<java.lang.String,java.lang.Integer> colType)
```
    指定されたMapを元にオブジェクトを構築する。
    
    パラメータ:
    
    row - 1行分のデータを持つMap
    
    colType - カラムタイプ
  - SqlRow
```
public SqlRow(java.util.Map<java.lang.String,java.lang.Object> row,
              java.util.Map<java.lang.String,java.lang.Integer> colType,
              java.util.Map<java.lang.String,java.lang.String> ignored)
```
    指定されたMapを元にオブジェクトを構築する。
    
    パラメータ:
    
    row - 1行分のデータを持つMap
    
    colType - カラムタイプ
    
    ignored - カラム名の紐付け情報(本引数は使用しない)
  - SqlRow
```
protected SqlRow(SqlRow orig)
```
    コピー元となるSqlRowからオブジェクトを構築する。
    
    パラメータ:
    
    orig - コピー元となるインスタンス
- メソッドの詳細
  - getString
```
public final java.lang.String getString(java.lang.String colName)
```
    指定されたカラムの情報を文字列で取得する。
    
    パラメータ:
    
    colName - カラム名
    
    戻り値:
    
    指定されたカラム名に対応するString型データ(toString()した結果を返却する)。データベースの検索結果がnullの場合には、nullを返却する
    
    例外:
    
    java.lang.IllegalArgumentException - 指定されたカラム名が存在しない場合
  - getInteger
```
public final java.lang.Integer getInteger(java.lang.String colName)
```
    指定されたカラムの情報をIntegerとして取得する。
    データベースから取得したデータがInteger型である場合、その値をそのまま返却する。
    それ以外の型の場合、そのデータの文字列表現(toString()した結果)を、 Integer.valueOf(String)を使用してInteger型に変換し返却する。
    データベースから取得したデータがどのような文字列表現を返却するかは、使用するRDBMSのJDBCドライバに依存する。
    以下に例を示す。
```
 | 文字列表現 | 結果                  |
 |------------+-----------------------|
 | "1"        |                     1 |
 | "-1"       |                    -1 |
 |"2147483648"| NumberFormatException |
 | "1.0"      | NumberFormatException |
 | "ABC"      | NumberFormatException |
 
```
    パラメータ:
    
    colName - カラム名
    
    戻り値:
    
    指定されたカラム名に対応するInteger型データ。データベースの検索結果がnullの場合には、nullを返却する
    
    例外:
    
    java.lang.NumberFormatException - データベースから取得したデータの文字列表現が、Integer型として解釈できない場合
    
    java.lang.IllegalArgumentException - 指定されたカラム名が存在しない場合
  - getLong
```
public final java.lang.Long getLong(java.lang.String colName)
```
    指定されたカラムの情報をLongとして取得する。
    データベースから取得したデータがLong型である場合、その値をそのまま返却する。
    それ以外の型の場合、そのデータの文字列表現(toString()した結果)を、 Long.valueOf(String)を使用してLong型に変換し返却する。
    データベースから取得したデータがどのような文字列表現を返却するかは、使用するRDBMSのJDBCドライバに依存する。
    以下に例を示す。
```
 | 文字列表現 | 結果                  |
 |------------+-----------------------|
 | "1"        |                     1 |
 | "-1"       |                    -1 |
 |"2147483648"|            2147483648 |
 | "1.0"      | NumberFormatException |
 | "ABC"      | NumberFormatException |
 
```
    パラメータ:
    
    colName - カラム名
    
    戻り値:
    
    指定されたカラム名に対応するLong型データ。データベースの検索結果がnullの場合には、nullを返却する
    
    例外:
    
    java.lang.NumberFormatException - データベースから取得したデータの文字列表現が、Long型として解釈できない場合
    
    java.lang.IllegalArgumentException - 指定されたカラム名が存在しない場合
  - getBoolean
```
public java.lang.Boolean getBoolean(java.lang.String colName)
```
    指定されたカラムの情報をBooleanとして取得する。
    以下の値の場合、Boolean.TRUEを返却し、それ以外は全てBoolean.FALSEを返却する。
    - booleanのtrueの場合
    - Stringの場合で"1" or "on" or "true"の場合(大文字、小文字の区別はしない)
    - 数値型で0以外の場合
    データベースから取得したデータのデータタイプが下記に該当しない場合は、IllegalStateExceptionを送出する。
    - Boolean
    - String
    - Numberのサブクラス
    パラメータ:
    
    colName - カラム名
    
    戻り値:
    
    true or falseを返却する。データベースの検索結果がnullの場合には、nullを返却する
    
    例外:
    
    java.lang.IllegalArgumentException - 指定されたカラム名が存在しない場合
  - getBigDecimal
```
public final java.math.BigDecimal getBigDecimal(java.lang.String colName)
```
    指定されたカラムの情報をBigDecimalとして取得する。
    
    パラメータ:
    
    colName - カラム名
    
    戻り値:
    
    指定されたカラム名に対応するBigDecimal型データ。データベースの検索結果がnullの場合には、nullを返却する
    
    例外:
    
    java.lang.NumberFormatException - データベースから取得したデータの文字列表現(toString()した結果)が、BigDecimal型として解釈できない場合
    
    java.lang.IllegalArgumentException - 指定されたカラム名が存在しない場合
  - getDate
```
public java.util.Date getDate(java.lang.String colName)
```
    指定されたカラムの情報をDateとして取得する。
    データベースから取得したデータのデータタイプが下記のデータの場合、java.util.Dateとして取得する下記に該当しない場合は、IllegalStateExceptionを送出する。
    - Date
    - Timestamp
    パラメータ:
    
    colName - カラム名
    
    戻り値:
    
    指定されたカラム名に対応するjava.util.Date型データ。データベースの検索結果がnullの場合には、nullを返却する
    
    例外:
    
    java.lang.IllegalArgumentException - 指定されたカラム名が存在しない場合
  - getTimestamp
```
public java.sql.Timestamp getTimestamp(java.lang.String colName)
```
    指定されたカラムの情報をTimestampとして取得する。
    データベースから取得したデータのデータタイプが下記のデータの場合、Timestampとして取得する。下記に該当しない場合は、IllegalStateExceptionを送出する。
    - Timestamp
    パラメータ:
    
    colName - カラム名
    
    戻り値:
    
    指定されたカラム名に対応するjava.sql.Timestamp型データ
    
    例外:
    
    java.lang.IllegalArgumentException - 指定されたカラム名が存在しない場合
  - getBytes
```
public byte[] getBytes(java.lang.String colName)
```
    指定されたカラムの情報をbyte配列として取得する。
    データベースから取得したデータのデータタイプが下記のデータの場合、byte配列として取得する。
    下記に該当しない場合は、IllegalStateExceptionを送出する。
    - Types.BLOB
    - Types.BINARY
    - Types.VARBINARY
    - Types.LONGVARBINARY
    パラメータ:
    
    colName - カラム名
    
    戻り値:
    
    指定されたカラム名に対応するbyte配列データ。データベースの検索結果がnullの場合には、nullを返却する
    
    例外:
    
    java.lang.IllegalArgumentException - 指定されたカラム名が存在しない場合
    
    DbAccessException - データタイプがBLOB型である場合で、データの読み込みに失敗した場合
  - getColType
```
protected int getColType(java.lang.String colName)
```
    指定されたカラム名のカラムタイプ(Types)を取得する。
    
    パラメータ:
    
    colName - カラム名
    
    戻り値:
    
    カラムタイプ

クラス SqlRow

ネストされたクラスのサマリー

クラスから継承されたネストされたクラス/インタフェース java.util.AbstractMap

インタフェースから継承されたネストされたクラス/インタフェース java.util.Map

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

メソッドのサマリー

クラスから継承されたメソッド nablarch.core.util.map.MultipleKeyCaseMap

クラスから継承されたメソッド nablarch.core.util.map.MapWrapper

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

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

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

コンストラクタの詳細

SqlRow

SqlRow

SqlRow

メソッドの詳細

getString

getInteger

getLong

getBoolean

getBigDecimal

getDate

getTimestamp

getBytes

getColType