sky.engine.connector.database
Interface DBRow

All Known Implementing Classes:

DBCachedRow, DBDirectRow

public interface DBRow

Once a select query is executed against a back-end relational database, results are returned as DBRow objects. Each DBRow obect represents a row of database that is returned by the back-end database.

$RCSfile: DBRow.java,v $
$Revision: 1.4 $
$Date: 2005/04/24 03:14:04 $

Method Summary

int	getColumnCount() Get the number of columns in this row.
java.lang.String	getColumnName(int pos) Get the name of column at the given position.
java.lang.String	getHTMLData(int pos) Get row data that appears undera given column, but replace all new lines in the data with <BR>
java.lang.String	getHTMLData(java.lang.String name) Get row data that appears undera given column, but replace all new lines in the data with <BR>
java.lang.String	getSQLData(int pos) Get row data that appears under a given column, but return a blank string in cases where data is sql "NULL" value in the database.
java.lang.String	getSQLData(java.lang.String name) Get row data that appears under a given column, but return a blank string in cases where data is sql "NULL" value in the database.
java.lang.String	getStringData(int pos) Get row data that appears under a given column, but return a blank string in cases where data is sql "NULL" value in the database.
java.lang.String	getStringData(java.lang.String name) Get row data that appears under a given column, but return a blank string in cases where data is sql "NULL" value in the database.
int	setColumnCount() REMOVE
java.lang.String	setColumnName(int pos, java.lang.String name) REMOVE
java.lang.String	setString(int pos, java.lang.String value) REMOVE
java.lang.String	setString(java.lang.String name, java.lang.String value) REMOVE
java.lang.String	toString() Convert this row to a string.

Method Detail

getColumnCount

public int getColumnCount()
                   throws ErrorMessage

Get the number of columns in this row.

Returns:

column count

Throws:

ErrorMessage - if there is any error in getting column count.

setColumnCount

public int setColumnCount()
                   throws ErrorMessage

REMOVE

Throws:

ErrorMessage

getStringData

public java.lang.String getStringData(int pos)
                               throws ErrorMessage

Get row data that appears under a given column, but return a blank string in cases where data is sql "NULL" value in the database.

Parameters:

pos - column id

Returns:

Row data that appears under a given column.

Throws:

ErrorMessage - if there is problem in getting the data.

getHTMLData

public java.lang.String getHTMLData(int pos)
                             throws ErrorMessage

Get row data that appears undera given column, but replace all new lines in the data with <BR>

Parameters:

pos - column id

Returns:

Row data that appears under a given column formatted as per HTML syntax rules.

Throws:

ErrorMessage - if there is a problem in getting and formatting the data.

getSQLData

public java.lang.String getSQLData(int pos)
                            throws ErrorMessage

Get row data that appears under a given column, but return a blank string in cases where data is sql "NULL" value in the database.

Parameters:

pos - column id

Returns:

Row data that appears under a given column.

Throws:

ErrorMessage - if there is problem in getting the data.

setString

public java.lang.String setString(int pos,
                                  java.lang.String value)
                           throws ErrorMessage

REMOVE

Throws:

ErrorMessage

getStringData

public java.lang.String getStringData(java.lang.String name)
                               throws ErrorMessage

Get row data that appears under a given column, but return a blank string in cases where data is sql "NULL" value in the database.

Parameters:

name - column name

Returns:

Row data that appears under a given column.

Throws:

ErrorMessage - if there is problem in getting the data.

getHTMLData

public java.lang.String getHTMLData(java.lang.String name)
                             throws ErrorMessage

Get row data that appears undera given column, but replace all new lines in the data with <BR>

Parameters:

name - column name

Returns:

Row data that appears under a given column formatted as per HTML syntax rules.

Throws:

ErrorMessage - if there is a problem in getting and formatting the data.

getSQLData

public java.lang.String getSQLData(java.lang.String name)
                            throws ErrorMessage

Get row data that appears under a given column, but return a blank string in cases where data is sql "NULL" value in the database.

Parameters:

name - column name

Returns:

Row data that appears under a given column.

Throws:

ErrorMessage - if there is problem in getting the data.

setString

public java.lang.String setString(java.lang.String name,
                                  java.lang.String value)
                           throws ErrorMessage

REMOVE

Throws:

ErrorMessage

getColumnName

public java.lang.String getColumnName(int pos)
                               throws ErrorMessage

Get the name of column at the given position.

Parameters:

pos - column id.

Returns:

column name

Throws:

ErrorMessage - if there is problem getting the column name.

setColumnName

public java.lang.String setColumnName(int pos,
                                      java.lang.String name)
                               throws ErrorMessage

REMOVE

Throws:

ErrorMessage

toString

public java.lang.String toString()

Convert this row to a string.

Returns:

String representation of this row.