net.floodlightcontroller.storage
Interface IResultSet

All Superinterfaces:
java.lang.Iterable<IResultSet>
All Known Implementing Classes:
NoSqlResultSet

public interface IResultSet
extends java.lang.Iterable<IResultSet>

Interface to iterate over the results from a storage query.

Author:
rob

Method Summary
 void close()
          This should be called when the client is done using the result set.
 boolean containsColumn(java.lang.String columnName)
           
 void deleteRow()
          Delete the current row in the result set.
 boolean getBoolean(java.lang.String columnName)
           
 java.lang.Boolean getBooleanObject(java.lang.String columnName)
           
 byte getByte(java.lang.String columnName)
           
 byte[] getByteArray(java.lang.String columnName)
           
 java.lang.Byte getByteObject(java.lang.String columnName)
           
 java.util.Date getDate(java.lang.String columnName)
           
 double getDouble(java.lang.String columnName)
           
 java.lang.Double getDoubleObject(java.lang.String columnName)
           
 float getFloat(java.lang.String columnName)
           
 java.lang.Float getFloatObject(java.lang.String columnName)
           
 int getInt(java.lang.String columnName)
           
 java.lang.Integer getIntegerObject(java.lang.String columnName)
           
 long getLong(java.lang.String columnName)
           
 java.lang.Long getLongObject(java.lang.String columnName)
           
 java.util.Map<java.lang.String,java.lang.Object> getRow()
          Get the current row in the result set.
 short getShort(java.lang.String columnName)
           
 java.lang.Short getShortObject(java.lang.String columnName)
           
 java.lang.String getString(java.lang.String columnName)
           
 boolean isNull(java.lang.String columnName)
           
 boolean next()
          Advance to the next row in the result set.
 void save()
          Save/commit any pending updates to the data in the result set.
 void setBoolean(java.lang.String columnName, boolean value)
           
 void setBooleanObject(java.lang.String columnName, java.lang.Boolean value)
           
 void setByte(java.lang.String columnName, byte value)
           
 void setByteArray(java.lang.String columnName, byte[] byteArray)
           
 void setByteObject(java.lang.String columnName, java.lang.Byte value)
           
 void setDate(java.lang.String columnName, java.util.Date date)
           
 void setDouble(java.lang.String columnName, double value)
           
 void setDoubleObject(java.lang.String columnName, java.lang.Double value)
           
 void setFloat(java.lang.String columnName, float value)
           
 void setFloatObject(java.lang.String columnName, java.lang.Float value)
           
 void setInt(java.lang.String columnName, int value)
           
 void setIntegerObject(java.lang.String columnName, java.lang.Integer value)
           
 void setLong(java.lang.String columnName, long value)
           
 void setLongObject(java.lang.String columnName, java.lang.Long value)
           
 void setNull(java.lang.String columnName)
           
 void setShort(java.lang.String columnName, short value)
           
 void setShortObject(java.lang.String columnName, java.lang.Short value)
           
 void setString(java.lang.String columnName, java.lang.String value)
           
 
Methods inherited from interface java.lang.Iterable
iterator
 

Method Detail

close

void close()
This should be called when the client is done using the result set. This will release any underlying resources (e.g. a database connection), which you don't want to wait for or rely on finalizers to release.


next

boolean next()
Advance to the next row in the result set.

Returns:
Returns true if there are more rows to process (i.e. if there's a valid current row) and false if there are no more rows in the result set.

save

void save()
Save/commit any pending updates to the data in the result set. This must be called after any calls to the set methods or deleting rows for the changes to be applied/committed to the storage source. Note that this doesn't need to be called after each set method or even after each row. It is typically called at the end after updating all of the rows in the result set.


getRow

java.util.Map<java.lang.String,java.lang.Object> getRow()
Get the current row in the result set. This returns all of the columns in the current row.

Returns:
Map containing all of the columns in the current row, indexed by the column name.

deleteRow

void deleteRow()
Delete the current row in the result set.


containsColumn

boolean containsColumn(java.lang.String columnName)

getString

java.lang.String getString(java.lang.String columnName)

getShort

short getShort(java.lang.String columnName)

getInt

int getInt(java.lang.String columnName)

getLong

long getLong(java.lang.String columnName)

getFloat

float getFloat(java.lang.String columnName)

getDouble

double getDouble(java.lang.String columnName)

getBoolean

boolean getBoolean(java.lang.String columnName)

getByte

byte getByte(java.lang.String columnName)

getByteArray

byte[] getByteArray(java.lang.String columnName)

getDate

java.util.Date getDate(java.lang.String columnName)

getShortObject

java.lang.Short getShortObject(java.lang.String columnName)

getIntegerObject

java.lang.Integer getIntegerObject(java.lang.String columnName)

getLongObject

java.lang.Long getLongObject(java.lang.String columnName)

getFloatObject

java.lang.Float getFloatObject(java.lang.String columnName)

getDoubleObject

java.lang.Double getDoubleObject(java.lang.String columnName)

getBooleanObject

java.lang.Boolean getBooleanObject(java.lang.String columnName)

getByteObject

java.lang.Byte getByteObject(java.lang.String columnName)

isNull

boolean isNull(java.lang.String columnName)

setString

void setString(java.lang.String columnName,
               java.lang.String value)

setShort

void setShort(java.lang.String columnName,
              short value)

setInt

void setInt(java.lang.String columnName,
            int value)

setLong

void setLong(java.lang.String columnName,
             long value)

setFloat

void setFloat(java.lang.String columnName,
              float value)

setDouble

void setDouble(java.lang.String columnName,
               double value)

setBoolean

void setBoolean(java.lang.String columnName,
                boolean value)

setByte

void setByte(java.lang.String columnName,
             byte value)

setByteArray

void setByteArray(java.lang.String columnName,
                  byte[] byteArray)

setDate

void setDate(java.lang.String columnName,
             java.util.Date date)

setShortObject

void setShortObject(java.lang.String columnName,
                    java.lang.Short value)

setIntegerObject

void setIntegerObject(java.lang.String columnName,
                      java.lang.Integer value)

setLongObject

void setLongObject(java.lang.String columnName,
                   java.lang.Long value)

setFloatObject

void setFloatObject(java.lang.String columnName,
                    java.lang.Float value)

setDoubleObject

void setDoubleObject(java.lang.String columnName,
                     java.lang.Double value)

setBooleanObject

void setBooleanObject(java.lang.String columnName,
                      java.lang.Boolean value)

setByteObject

void setByteObject(java.lang.String columnName,
                   java.lang.Byte value)

setNull

void setNull(java.lang.String columnName)