Row (com.github.susom:database 2.0 API)

All Known Subinterfaces:

Rows
```
public interface Row
```
Interface for reading results from a database query.

Author:

garricko

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method and Description
`BigDecimal`	`getBigDecimalOrNull()` Note this method attempts to correct for "artifical" scale due to the database representation.
`BigDecimal`	`getBigDecimalOrNull(int columnOneBased)`
`BigDecimal`	`getBigDecimalOrNull(String columnName)`
`BigDecimal`	`getBigDecimalOrZero()`
`BigDecimal`	`getBigDecimalOrZero(int columnOneBased)`
`BigDecimal`	`getBigDecimalOrZero(String columnName)`
`byte[]`	`getBlobBytesOrNull()`
`byte[]`	`getBlobBytesOrNull(int columnOneBased)`
`byte[]`	`getBlobBytesOrNull(String columnName)`
`byte[]`	`getBlobBytesOrZeroLen()`
`byte[]`	`getBlobBytesOrZeroLen(int columnOneBased)`
`byte[]`	`getBlobBytesOrZeroLen(String columnName)`
`InputStream`	`getBlobInputStreamOrEmpty()`
`InputStream`	`getBlobInputStreamOrEmpty(int columnOneBased)`
`InputStream`	`getBlobInputStreamOrEmpty(String columnName)`
`InputStream`	`getBlobInputStreamOrNull()`
`InputStream`	`getBlobInputStreamOrNull(int columnOneBased)`
`InputStream`	`getBlobInputStreamOrNull(String columnName)`
`boolean`	`getBooleanOrFalse()` Boolean values are represented as strings `"Y"` or `"N"` in the database, typically in a `CHAR(1)` column.
`boolean`	`getBooleanOrFalse(int columnOneBased)` Boolean values are represented as strings `"Y"` or `"N"` in the database, typically in a `CHAR(1)` column.
`boolean`	`getBooleanOrFalse(String columnName)` Boolean values are represented as strings `"Y"` or `"N"` in the database, typically in a `CHAR(1)` column.
`Boolean`	`getBooleanOrNull()` Boolean values are represented as strings `"Y"` or `"N"` in the database, typically in a `CHAR(1)` column.
`Boolean`	`getBooleanOrNull(int columnOneBased)` Boolean values are represented as strings `"Y"` or `"N"` in the database, typically in a `CHAR(1)` column.
`Boolean`	`getBooleanOrNull(String columnName)` Boolean values are represented as strings `"Y"` or `"N"` in the database, typically in a `CHAR(1)` column.
`boolean`	`getBooleanOrTrue()` Boolean values are represented as strings `"Y"` or `"N"` in the database, typically in a `CHAR(1)` column.
`boolean`	`getBooleanOrTrue(int columnOneBased)` Boolean values are represented as strings `"Y"` or `"N"` in the database, typically in a `CHAR(1)` column.
`boolean`	`getBooleanOrTrue(String columnName)` Boolean values are represented as strings `"Y"` or `"N"` in the database, typically in a `CHAR(1)` column.
`Reader`	`getClobReaderOrEmpty()`
`Reader`	`getClobReaderOrEmpty(int columnOneBased)`
`Reader`	`getClobReaderOrEmpty(String columnName)`
`Reader`	`getClobReaderOrNull()`
`Reader`	`getClobReaderOrNull(int columnOneBased)`
`Reader`	`getClobReaderOrNull(String columnName)`
`String`	`getClobStringOrEmpty()`
`String`	`getClobStringOrEmpty(int columnOneBased)`
`String`	`getClobStringOrEmpty(String columnName)`
`String`	`getClobStringOrNull()`
`String`	`getClobStringOrNull(int columnOneBased)`
`String`	`getClobStringOrNull(String columnName)`
`String[]`	`getColumnLabels()` Obtain the names of the columns in the database.
`Date`	`getDateOrNull()` Return the millisecond precision Date, which should be represented as a TIMESTAMP in the database.
`Date`	`getDateOrNull(int columnOneBased)` Return the millisecond precision Date, which should be represented as a TIMESTAMP in the database.
`Date`	`getDateOrNull(String columnName)`
`Double`	`getDoubleOrNull()`
`Double`	`getDoubleOrNull(int columnOneBased)`
`Double`	`getDoubleOrNull(String columnName)`
`double`	`getDoubleOrZero()`
`double`	`getDoubleOrZero(int columnOneBased)`
`double`	`getDoubleOrZero(String columnName)`
`Float`	`getFloatOrNull()`
`Float`	`getFloatOrNull(int columnOneBased)`
`Float`	`getFloatOrNull(String columnName)`
`float`	`getFloatOrZero()`
`float`	`getFloatOrZero(int columnOneBased)`
`float`	`getFloatOrZero(String columnName)`
`Integer`	`getIntegerOrNull()`
`Integer`	`getIntegerOrNull(int columnOneBased)`
`Integer`	`getIntegerOrNull(String columnName)`
`int`	`getIntegerOrZero()`
`int`	`getIntegerOrZero(int columnOneBased)`
`int`	`getIntegerOrZero(String columnName)`
`Long`	`getLongOrNull()`
`Long`	`getLongOrNull(int columnOneBased)`
`Long`	`getLongOrNull(String columnName)`
`long`	`getLongOrZero()`
`long`	`getLongOrZero(int columnOneBased)`
`long`	`getLongOrZero(String columnName)`
`ResultSetMetaData`	`getMetadata()` Get raw access to the underlying JDBC metadata.
`String`	`getStringOrEmpty()`
`String`	`getStringOrEmpty(int columnOneBased)`
`String`	`getStringOrEmpty(String columnName)`
`String`	`getStringOrNull()`
`String`	`getStringOrNull(int columnOneBased)`
`String`	`getStringOrNull(String columnName)`

- Method Detail
  - getColumnLabels
```
@Nonnull
String[] getColumnLabels()
```
    Obtain the names of the columns in the database. You probably want to avoid this method if possible, as the way column names are handled varies by database and driver. For example, Derby and Oracle normally convert column names to uppercase, while PostgreSQL normally converts column names to lowercase. If you do use this method, you might want to either call toUppercase()/toLowercase() or ensure the SQL explicitly specifies parameters with AS "FOO" (including quotes) to ensure you desired name will be honored.
  - getMetadata
```
@Nonnull
ResultSetMetaData getMetadata()
```
    Get raw access to the underlying JDBC metadata.
  - getBooleanOrNull
```
@Nullable
Boolean getBooleanOrNull()
```
    Boolean values are represented as strings "Y" or "N" in the database, typically in a CHAR(1) column. This reads the value and converts it to Boolean or null as appropriate.
    This is a short-hand method that reads columns in order, starting with the first, and automatically incrementing the column index.
    
    If you call one of the methods using an explicit column index or column name before calling this method, it will pick up at the next column following the explicit one. For example:
```
 getX();  // column 1
 getX(5); // or getX("foo") if foo is column 5
 getX();  // column 6
 
```
    Returns:
    
    true if the value was "Y", false if it was "N", or null
    
    Throws:
    
    DatabaseException - if the value was something other than Y, N, or null
  - getBooleanOrNull
```
@Nullable
Boolean getBooleanOrNull(int columnOneBased)
```
    Boolean values are represented as strings "Y" or "N" in the database, typically in a CHAR(1) column. This reads the value and converts it to Boolean or null as appropriate.
    
    Parameters:
    
    columnOneBased - column number to read (1 is the first column)
    
    Returns:
    
    true if the value was "Y", false if it was "N", or null
    
    Throws:
    
    DatabaseException - if the value was something other than Y, N, or null
  - getBooleanOrNull
```
@Nullable
Boolean getBooleanOrNull(String columnName)
```
    Boolean values are represented as strings "Y" or "N" in the database, typically in a CHAR(1) column. This reads the value and converts it to Boolean or null as appropriate.
    
    Parameters:
    
    columnName - SQL alias of the column to read (use all lowercase)
    
    Returns:
    
    true if the value was "Y", false if it was "N", or null
    
    Throws:
    
    DatabaseException - if the value was something other than Y, N, or null
  - getBooleanOrFalse
```
boolean getBooleanOrFalse()
```
    Boolean values are represented as strings "Y" or "N" in the database, typically in a CHAR(1) column. This reads the value and converts it to a boolean. If the value is null, it will be converted to false.
    This is a short-hand method that reads columns in order, starting with the first, and automatically incrementing the column index.
    
    If you call one of the methods using an explicit column index or column name before calling this method, it will pick up at the next column following the explicit one. For example:
```
 getX();  // column 1
 getX(5); // or getX("foo") if foo is column 5
 getX();  // column 6
 
```
    Returns:
    
    true if the value was "Y", false if it was either "N" or null
    
    Throws:
    
    DatabaseException - if the value was something other than Y, N, or null
  - getBooleanOrFalse
```
boolean getBooleanOrFalse(int columnOneBased)
```
    Boolean values are represented as strings "Y" or "N" in the database, typically in a CHAR(1) column. This reads the value and converts it to a boolean. If the value is null, it will be converted to false.
    This is a short-hand method that reads columns in order, starting with the first, and automatically incrementing the column index.
    
    Parameters:
    
    columnOneBased - column number to read (1 is the first column)
    
    Returns:
    
    true if the value was "Y", false if it was either "N" or null
    
    Throws:
    
    DatabaseException - if the value was something other than Y, N, or null
  - getBooleanOrFalse
```
boolean getBooleanOrFalse(String columnName)
```
    Boolean values are represented as strings "Y" or "N" in the database, typically in a CHAR(1) column. This reads the value and converts it to a boolean. If the value is null, it will be converted to false.
    This is a short-hand method that reads columns in order, starting with the first, and automatically incrementing the column index.
    
    Parameters:
    
    columnName - SQL alias of the column to read (use all lowercase)
    
    Returns:
    
    true if the value was "Y", false if it was either "N" or null
    
    Throws:
    
    DatabaseException - if the value was something other than Y, N, or null
  - getBooleanOrTrue
```
boolean getBooleanOrTrue()
```
    Boolean values are represented as strings "Y" or "N" in the database, typically in a CHAR(1) column. This reads the value and converts it to a boolean. If the value is null, it will be converted to true.
    This is a short-hand method that reads columns in order, starting with the first, and automatically incrementing the column index.
    
    If you call one of the methods using an explicit column index or column name before calling this method, it will pick up at the next column following the explicit one. For example:
```
 getX();  // column 1
 getX(5); // or getX("foo") if foo is column 5
 getX();  // column 6
 
```
    Returns:
    
    true if the value was either "Y" or null, false if it was "N"
    
    Throws:
    
    DatabaseException - if the value was something other than Y, N, or null
  - getBooleanOrTrue
```
boolean getBooleanOrTrue(int columnOneBased)
```
    Boolean values are represented as strings "Y" or "N" in the database, typically in a CHAR(1) column. This reads the value and converts it to a boolean. If the value is null, it will be converted to true.
    This is a short-hand method that reads columns in order, starting with the first, and automatically incrementing the column index.
    
    Parameters:
    
    columnOneBased - column number to read (1 is the first column)
    
    Returns:
    
    true if the value was either "Y" or null, false if it was "N"
    
    Throws:
    
    DatabaseException - if the value was something other than Y, N, or null
  - getBooleanOrTrue
```
boolean getBooleanOrTrue(String columnName)
```
    Boolean values are represented as strings "Y" or "N" in the database, typically in a CHAR(1) column. This reads the value and converts it to a boolean. If the value is null, it will be converted to true.
    This is a short-hand method that reads columns in order, starting with the first, and automatically incrementing the column index.
    
    Parameters:
    
    columnName - SQL alias of the column to read (use all lowercase)
    
    Returns:
    
    true if the value was either "Y" or null, false if it was "N"
    
    Throws:
    
    DatabaseException - if the value was something other than Y, N, or null
  - getIntegerOrNull
```
@Nullable
Integer getIntegerOrNull()
```
  - getIntegerOrNull
```
@Nullable
Integer getIntegerOrNull(int columnOneBased)
```
  - getIntegerOrNull
```
@Nullable
Integer getIntegerOrNull(String columnName)
```
  - getIntegerOrZero
```
int getIntegerOrZero()
```
  - getIntegerOrZero
```
int getIntegerOrZero(int columnOneBased)
```
  - getIntegerOrZero
```
int getIntegerOrZero(String columnName)
```
  - getLongOrNull
```
@Nullable
Long getLongOrNull()
```
  - getLongOrNull
```
@Nullable
Long getLongOrNull(int columnOneBased)
```
  - getLongOrNull
```
@Nullable
Long getLongOrNull(String columnName)
```
  - getLongOrZero
```
long getLongOrZero()
```
  - getLongOrZero
```
long getLongOrZero(int columnOneBased)
```
  - getLongOrZero
```
long getLongOrZero(String columnName)
```
  - getFloatOrNull
```
@Nullable
Float getFloatOrNull()
```
  - getFloatOrNull
```
@Nullable
Float getFloatOrNull(int columnOneBased)
```
  - getFloatOrNull
```
@Nullable
Float getFloatOrNull(String columnName)
```
  - getFloatOrZero
```
float getFloatOrZero()
```
  - getFloatOrZero
```
float getFloatOrZero(int columnOneBased)
```
  - getFloatOrZero
```
float getFloatOrZero(String columnName)
```
  - getDoubleOrNull
```
@Nullable
Double getDoubleOrNull()
```
  - getDoubleOrNull
```
@Nullable
Double getDoubleOrNull(int columnOneBased)
```
  - getDoubleOrNull
```
@Nullable
Double getDoubleOrNull(String columnName)
```
  - getDoubleOrZero
```
double getDoubleOrZero()
```
  - getDoubleOrZero
```
double getDoubleOrZero(int columnOneBased)
```
  - getDoubleOrZero
```
double getDoubleOrZero(String columnName)
```
  - getBigDecimalOrNull
```
@Nullable
BigDecimal getBigDecimalOrNull()
```
    Note this method attempts to correct for "artifical" scale due to the database representation. Some databases will pad the number out to "full precision". This method tries to reduce scale if there is zero padding to the right of the decimal.
  - getBigDecimalOrNull
```
@Nullable
BigDecimal getBigDecimalOrNull(int columnOneBased)
```
  - getBigDecimalOrNull
```
@Nullable
BigDecimal getBigDecimalOrNull(String columnName)
```
  - getBigDecimalOrZero
```
@Nonnull
BigDecimal getBigDecimalOrZero()
```
  - getBigDecimalOrZero
```
@Nonnull
BigDecimal getBigDecimalOrZero(int columnOneBased)
```
  - getBigDecimalOrZero
```
@Nonnull
BigDecimal getBigDecimalOrZero(String columnName)
```
  - getStringOrNull
```
@Nullable
String getStringOrNull()
```
    Returns:
    
    the value, or null if it is SQL null; never returns the empty string
  - getStringOrNull
```
@Nullable
String getStringOrNull(int columnOneBased)
```
    Returns:
    
    the value, or null if it is SQL null; never returns the empty string
  - getStringOrNull
```
@Nullable
String getStringOrNull(String columnName)
```
    Returns:
    
    the value, or null if it is SQL null; never returns the empty string
  - getStringOrEmpty
```
@Nonnull
String getStringOrEmpty()
```
    Returns:
    
    the value, or the empty string if it is SQL null; never returns null
  - getStringOrEmpty
```
@Nonnull
String getStringOrEmpty(int columnOneBased)
```
    Returns:
    
    the value, or the empty string if it is SQL null; never returns null
  - getStringOrEmpty
```
@Nonnull
String getStringOrEmpty(String columnName)
```
    Returns:
    
    the value, or the empty string if it is SQL null; never returns null
  - getClobStringOrNull
```
@Nullable
String getClobStringOrNull()
```
    Returns:
    
    the value, or null if it is SQL null; never returns the empty string
  - getClobStringOrNull
```
@Nullable
String getClobStringOrNull(int columnOneBased)
```
    Returns:
    
    the value, or null if it is SQL null; never returns the empty string
  - getClobStringOrNull
```
@Nullable
String getClobStringOrNull(String columnName)
```
    Returns:
    
    the value, or null if it is SQL null; never returns the empty string
  - getClobStringOrEmpty
```
@Nonnull
String getClobStringOrEmpty()
```
    Returns:
    
    the value, or the empty string if it is SQL null; never returns null
  - getClobStringOrEmpty
```
@Nonnull
String getClobStringOrEmpty(int columnOneBased)
```
    Returns:
    
    the value, or the empty string if it is SQL null; never returns null
  - getClobStringOrEmpty
```
@Nonnull
String getClobStringOrEmpty(String columnName)
```
    Returns:
    
    the value, or the empty string if it is SQL null; never returns null
  - getClobReaderOrNull
```
@Nullable
Reader getClobReaderOrNull()
```
    Returns:
    
    the value, or null if it is SQL null
  - getClobReaderOrNull
```
@Nullable
Reader getClobReaderOrNull(int columnOneBased)
```
    Returns:
    
    the value, or null if it is SQL null
  - getClobReaderOrNull
```
@Nullable
Reader getClobReaderOrNull(String columnName)
```
    Returns:
    
    the value, or null if it is SQL null
  - getClobReaderOrEmpty
```
@Nonnull
Reader getClobReaderOrEmpty()
```
    Returns:
    
    the value, or a StringReader containing the empty string if it is SQL null
  - getClobReaderOrEmpty
```
@Nonnull
Reader getClobReaderOrEmpty(int columnOneBased)
```
    Returns:
    
    the value, or a StringReader containing the empty string if it is SQL null
  - getClobReaderOrEmpty
```
@Nonnull
Reader getClobReaderOrEmpty(String columnName)
```
    Returns:
    
    the value, or a StringReader containing the empty string if it is SQL null
  - getBlobBytesOrNull
```
@Nullable
byte[] getBlobBytesOrNull()
```
  - getBlobBytesOrNull
```
@Nullable
byte[] getBlobBytesOrNull(int columnOneBased)
```
  - getBlobBytesOrNull
```
@Nullable
byte[] getBlobBytesOrNull(String columnName)
```
  - getBlobBytesOrZeroLen
```
@Nonnull
byte[] getBlobBytesOrZeroLen()
```
  - getBlobBytesOrZeroLen
```
@Nonnull
byte[] getBlobBytesOrZeroLen(int columnOneBased)
```
  - getBlobBytesOrZeroLen
```
@Nonnull
byte[] getBlobBytesOrZeroLen(String columnName)
```
  - getBlobInputStreamOrNull
```
@Nullable
InputStream getBlobInputStreamOrNull()
```
  - getBlobInputStreamOrNull
```
@Nullable
InputStream getBlobInputStreamOrNull(int columnOneBased)
```
  - getBlobInputStreamOrNull
```
@Nullable
InputStream getBlobInputStreamOrNull(String columnName)
```
  - getBlobInputStreamOrEmpty
```
@Nonnull
InputStream getBlobInputStreamOrEmpty()
```
  - getBlobInputStreamOrEmpty
```
@Nonnull
InputStream getBlobInputStreamOrEmpty(int columnOneBased)
```
  - getBlobInputStreamOrEmpty
```
@Nonnull
InputStream getBlobInputStreamOrEmpty(String columnName)
```
  - getDateOrNull
```
@Nullable
Date getDateOrNull()
```
    Return the millisecond precision Date, which should be represented as a TIMESTAMP in the database. The nanoseconds are truncated.
  - getDateOrNull
```
@Nullable
Date getDateOrNull(int columnOneBased)
```
    Return the millisecond precision Date, which should be represented as a TIMESTAMP in the database. The nanoseconds are truncated.
  - getDateOrNull
```
@Nullable
Date getDateOrNull(String columnName)
```

Interface Row

Method Summary

Method Detail

getColumnLabels

getMetadata

getBooleanOrNull

getBooleanOrNull

getBooleanOrNull

getBooleanOrFalse

getBooleanOrFalse

getBooleanOrFalse

getBooleanOrTrue

getBooleanOrTrue

getBooleanOrTrue

getIntegerOrNull

getIntegerOrNull

getIntegerOrNull

getIntegerOrZero

getIntegerOrZero

getIntegerOrZero

getLongOrNull

getLongOrNull

getLongOrNull

getLongOrZero

getLongOrZero

getLongOrZero

getFloatOrNull

getFloatOrNull

getFloatOrNull

getFloatOrZero

getFloatOrZero

getFloatOrZero

getDoubleOrNull

getDoubleOrNull

getDoubleOrNull

getDoubleOrZero

getDoubleOrZero

getDoubleOrZero

getBigDecimalOrNull

getBigDecimalOrNull

getBigDecimalOrNull

getBigDecimalOrZero

getBigDecimalOrZero

getBigDecimalOrZero

getStringOrNull

getStringOrNull

getStringOrNull

getStringOrEmpty

getStringOrEmpty

getStringOrEmpty

getClobStringOrNull

getClobStringOrNull

getClobStringOrNull

getClobStringOrEmpty

getClobStringOrEmpty

getClobStringOrEmpty

getClobReaderOrNull

getClobReaderOrNull

getClobReaderOrNull

getClobReaderOrEmpty

getClobReaderOrEmpty

getClobReaderOrEmpty

getBlobBytesOrNull

getBlobBytesOrNull

getBlobBytesOrNull

getBlobBytesOrZeroLen

getBlobBytesOrZeroLen

getBlobBytesOrZeroLen

getBlobInputStreamOrNull

getBlobInputStreamOrNull

getBlobInputStreamOrNull

getBlobInputStreamOrEmpty

getBlobInputStreamOrEmpty

getBlobInputStreamOrEmpty

getDateOrNull

getDateOrNull

getDateOrNull