com.helger.db.jdbc.executor

Class DBResultRow

java.lang.Object

com.helger.db.jdbc.executor.DBResultRow

All Implemented Interfaces:

com.helger.commons.lang.ICloneable<DBResultRow>, Serializable

@NotThreadSafe
public class DBResultRow
extends Object
implements com.helger.commons.lang.ICloneable<DBResultRow>, Serializable

Represents a single DB query result row.

Author:

Philip Helger

See Also:

Serialized Form

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	DBResultRow(DBResultRow aOther) Copy constructor
	DBResultRow(int nCols) Create an empty result row with the specified number of colums.

Method Summary

Modifier and Type	Method and Description
DBResultField	get(int nIndex) Get the result field at the specified index
BigDecimal	getAsBigDecimal(int nIndex)
BigInteger	getAsBigInteger(int nIndex)
Blob	getAsBlob(int nIndex)
boolean	getAsBoolean(int nIndex)
boolean	getAsBoolean(int nIndex, boolean bDefault)
Boolean	getAsBooleanObj(int nIndex)
byte	getAsByte(int nIndex)
byte	getAsByte(int nIndex, byte nDefault)
byte[]	getAsByteArray(int nIndex)
Byte	getAsByteObj(int nIndex)
char	getAsChar(int nIndex)
char	getAsChar(int nIndex, char cDefault)
Character	getAsCharObj(int nIndex)
Clob	getAsClob(int nIndex)
Date	getAsDate(int nIndex)
double	getAsDouble(int nIndex)
double	getAsDouble(int nIndex, double dDefault)
Double	getAsDoubleObj(int nIndex)
float	getAsFloat(int nIndex)
float	getAsFloat(int nIndex, float fDefault)
Float	getAsFloatObj(int nIndex)
int	getAsInt(int nIndex)
int	getAsInt(int nIndex, int nDefault)
Integer	getAsIntObj(int nIndex)
LocalDate	getAsLocalDate(int nIndex)
LocalDateTime	getAsLocalDateTime(int nIndex)
LocalTime	getAsLocalTime(int nIndex)
long	getAsLong(int nIndex)
long	getAsLong(int nIndex, long nDefault)
Long	getAsLongObj(int nIndex)
NClob	getAsNClob(int nIndex)
OffsetDateTime	getAsOffsetDateTime(int nIndex)
RowId	getAsRowId(int nIndex)
short	getAsShort(int nIndex)
short	getAsShort(int nIndex, short nDefault)
Short	getAsShortObj(int nIndex)
String	getAsString(int nIndex)
Time	getAsTime(int nIndex)
Timestamp	getAsTimestamp(int nIndex)
DBResultRow	getClone()
int	getColumnCount()
String	getColumnName(int nIndex) Get the column name of the column at the specified index.
com.helger.commons.collection.impl.ICommonsMap<String,Integer>	getColumnNameToIndexMap()
int	getColumnType(int nIndex) Get the column type of the column at the specified index.
String	getColumnTypeName(int nIndex) Get the column type name of the column at the specified index.
int	getUsedColumnIndex()
Object	getValue(int nIndex)
protected void	internalAdd(DBResultField aResultField) Add a new result field in the the first free column.
protected void	internalClear() Set all columns to null and restart the index at 0.
String	toString()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

DBResultRow

protected DBResultRow(@Nonnull
                      DBResultRow aOther)

Copy constructor

Parameters:

aOther - other DB row to use

DBResultRow

public DBResultRow(@Nonnegative
                   int nCols)

Create an empty result row with the specified number of colums.

Parameters:

nCols - Number of columns. Must be be ≥ 0.

Method Detail

internalClear

protected void internalClear()

Set all columns to null and restart the index at 0. This is mainly intended to resuse the same object in a loop.

internalAdd

protected void internalAdd(@Nonnull
                           DBResultField aResultField)

Add a new result field in the the first free column. This method increases the index.

Parameters:

aResultField - The result field to add. May not be null.

See Also:

getUsedColumnIndex()

getUsedColumnIndex

@Nonnegative
public int getUsedColumnIndex()

Returns:

The last used column. For an empty object that is null.

getColumnCount

@Nonnegative
public int getColumnCount()

Returns:

The number of columns as provided in the constructor. Always ≥ 0.

get

@Nullable
public DBResultField get(@Nonnegative
                                    int nIndex)

Get the result field at the specified index

Parameters:

nIndex - The 0-based index to query

Returns:

The result field at the specific index.

Throws:

ArrayIndexOutOfBoundsException - If the index is invalid

getColumnType

public int getColumnType(@Nonnegative
                         int nIndex)

Get the column type of the column at the specified index.

Parameters:

nIndex - The 0-based index to query

Returns:

The column type as defined in Types.

Throws:

ArrayIndexOutOfBoundsException - If the index is invalid

NullPointerException - if the column at the specified index contains a null value

getColumnTypeName

@Nullable
public String getColumnTypeName(@Nonnegative
                                           int nIndex)

Get the column type name of the column at the specified index.

Parameters:

nIndex - The 0-based index to query

Returns:

The column type name based on the constants of Types.

Throws:

ArrayIndexOutOfBoundsException - If the index is invalid

NullPointerException - if the column at the specified index contains a null value

getColumnName

@Nonnull
 @Nonempty
public String getColumnName(@Nonnegative
                                                  int nIndex)

Get the column name of the column at the specified index.

Parameters:

nIndex - The 0-based index to query

Returns:

The name of the column. Neither null nor empty.

Throws:

ArrayIndexOutOfBoundsException - If the index is invalid

NullPointerException - if the column at the specified index contains a null value

getValue

@Nullable
public Object getValue(@Nonnegative
                                  int nIndex)

getAsString

@Nullable
public String getAsString(@Nonnegative
                                     int nIndex)

getAsBigDecimal

@Nullable
public BigDecimal getAsBigDecimal(@Nonnegative
                                             int nIndex)

getAsBigInteger

@Nullable
public BigInteger getAsBigInteger(@Nonnegative
                                             int nIndex)

getAsBoolean

public boolean getAsBoolean(@Nonnegative
                            int nIndex)

getAsBoolean

public boolean getAsBoolean(@Nonnegative
                            int nIndex,
                            boolean bDefault)

getAsByte

public byte getAsByte(@Nonnegative
                      int nIndex)

getAsByte

public byte getAsByte(@Nonnegative
                      int nIndex,
                      byte nDefault)

getAsByteArray

@Nullable
public byte[] getAsByteArray(@Nonnegative
                                        int nIndex)

getAsChar

public char getAsChar(@Nonnegative
                      int nIndex)

getAsChar

public char getAsChar(@Nonnegative
                      int nIndex,
                      char cDefault)

getAsDouble

public double getAsDouble(@Nonnegative
                          int nIndex)

getAsDouble

public double getAsDouble(@Nonnegative
                          int nIndex,
                          double dDefault)

getAsFloat

public float getAsFloat(@Nonnegative
                        int nIndex)

getAsFloat

public float getAsFloat(@Nonnegative
                        int nIndex,
                        float fDefault)

getAsInt

public int getAsInt(@Nonnegative
                    int nIndex)

getAsInt

public int getAsInt(@Nonnegative
                    int nIndex,
                    int nDefault)

getAsLong

public long getAsLong(@Nonnegative
                      int nIndex)

getAsLong

public long getAsLong(@Nonnegative
                      int nIndex,
                      long nDefault)

getAsShort

public short getAsShort(@Nonnegative
                        int nIndex)

getAsShort

public short getAsShort(@Nonnegative
                        int nIndex,
                        short nDefault)

getAsBooleanObj

@Nullable
public Boolean getAsBooleanObj(@Nonnegative
                                          int nIndex)

getAsByteObj

@Nullable
public Byte getAsByteObj(@Nonnegative
                                    int nIndex)

getAsCharObj

@Nullable
public Character getAsCharObj(@Nonnegative
                                         int nIndex)

getAsDoubleObj

@Nullable
public Double getAsDoubleObj(@Nonnegative
                                        int nIndex)

getAsFloatObj

@Nullable
public Float getAsFloatObj(@Nonnegative
                                      int nIndex)

getAsIntObj

@Nullable
public Integer getAsIntObj(@Nonnegative
                                      int nIndex)

getAsLongObj

@Nullable
public Long getAsLongObj(@Nonnegative
                                    int nIndex)

getAsShortObj

@Nullable
public Short getAsShortObj(@Nonnegative
                                      int nIndex)

getAsBlob

@Nullable
public Blob getAsBlob(@Nonnegative
                                 int nIndex)

getAsClob

@Nullable
public Clob getAsClob(@Nonnegative
                                 int nIndex)

getAsDate

@Nullable
public Date getAsDate(@Nonnegative
                                 int nIndex)

getAsLocalDate

@Nullable
public LocalDate getAsLocalDate(@Nonnegative
                                           int nIndex)

getAsNClob

@Nullable
public NClob getAsNClob(@Nonnegative
                                   int nIndex)

getAsRowId

@Nullable
public RowId getAsRowId(@Nonnegative
                                   int nIndex)

getAsTime

@Nullable
public Time getAsTime(@Nonnegative
                                 int nIndex)

getAsLocalTime

@Nullable
public LocalTime getAsLocalTime(@Nonnegative
                                           int nIndex)

getAsTimestamp

@Nullable
public Timestamp getAsTimestamp(@Nonnegative
                                           int nIndex)

getAsLocalDateTime

@Nullable
public LocalDateTime getAsLocalDateTime(@Nonnegative
                                                   int nIndex)

getAsOffsetDateTime

@Nullable
public OffsetDateTime getAsOffsetDateTime(@Nonnegative
                                                     int nIndex)

getColumnNameToIndexMap

@Nonnull
 @ReturnsMutableCopy
public com.helger.commons.collection.impl.ICommonsMap<String,Integer> getColumnNameToIndexMap()

Returns:

A map that contains the mapping from column name to the respective index

getClone

@Nonnull
public DBResultRow getClone()

Specified by:

getClone in interface com.helger.commons.lang.ICloneable<DBResultRow>

toString

public String toString()

Overrides:

toString in class Object