javatools.db
Class DbTable

java.lang.Object
  |
  +--javatools.db.DbTable

public class DbTable
extends java.lang.Object

A class representing tabular data. Could be a real database table or the result of a SELECT.


Field Summary
(package private)  java.util.HashMap colNameMap
           
(package private)  int columnCount
           
(package private)  java.util.List columns
           
(package private)  DbDatabase db
           
(package private)  int[] displaySize
           
(package private)  java.lang.String[] names
           
(package private)  java.sql.PreparedStatement stmt
           
(package private)  java.lang.String tableName
           
(package private)  int[] types
           
 
Constructor Summary
DbTable(DbDatabase db)
           
 
Method Summary
 void close()
           
 DbDeleter deleter()
          Return a deleter for deleting rows in the database
 boolean equals(java.lang.Object o)
           
protected  void finalize()
           
(package private)  DbColumn getAddColumn()
           
 DbColumn getColumn(int index)
          Get the column of the given index.
 DbColumn getColumn(java.lang.String name)
          Get the DbColumn representing the column with this name.
 DbDatabase getDatabase()
          Get the database that this table came fr
 java.lang.String getFullTableName()
           
 DbInserter inserter()
          Return an inserter for inserting new data in the database.
 DbInserter inserter(DbSelector selector)
          Return an inserter for inserting new data in the database.
 DbIterator iterator()
          Return an iterator to iterate over the rows in this table.
(package private)  void setResultSet(java.sql.ResultSet rs)
           
(package private)  void setStatement(java.sql.PreparedStatement stmt)
           
 void setTableName(java.lang.String v)
           
(package private)  java.lang.String standardiseColumnName(java.lang.String name)
           
 java.lang.String toString()
           
 DbUpdater updater()
          Return an updater for updating rows in the database
 
Methods inherited from class java.lang.Object
clone, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Field Detail

db

DbDatabase db

stmt

java.sql.PreparedStatement stmt

tableName

java.lang.String tableName

columnCount

int columnCount

colNameMap

java.util.HashMap colNameMap

columns

java.util.List columns

names

java.lang.String[] names

displaySize

int[] displaySize

types

int[] types
Constructor Detail

DbTable

public DbTable(DbDatabase db)
        throws DbException
Method Detail

setTableName

public void setTableName(java.lang.String v)

getColumn

public DbColumn getColumn(java.lang.String name)
                   throws DbException
Get the DbColumn representing the column with this name.

Parameters:
name - Description of Parameter
Returns:
The column value
Throws:
DbException - Description of Exception

getColumn

public DbColumn getColumn(int index)
                   throws DbException
Get the column of the given index. Index is a zero based array.

Parameters:
index - Description of Parameter
Returns:
The column value
Throws:
DbException - Description of Exception

getDatabase

public DbDatabase getDatabase()
Get the database that this table came fr

Returns:
The database value

getFullTableName

public java.lang.String getFullTableName()

toString

public java.lang.String toString()
Overrides:
toString in class java.lang.Object

equals

public boolean equals(java.lang.Object o)
Overrides:
equals in class java.lang.Object

inserter

public DbInserter inserter(DbSelector selector)
                    throws DbException
Return an inserter for inserting new data in the database. This method is for SQL of the form INSERT INTO table(...) SELECT ...

Parameters:
selector - Description of Parameter
Returns:
Description of the Returned Value
Throws:
DbException - Description of Exception

inserter

public DbInserter inserter()
                    throws DbException
Return an inserter for inserting new data in the database. This method is for SQL of the form INSERT INTO table(...) VALUES(...)

Returns:
Description of the Returned Value
Throws:
DbException - Description of Exception

updater

public DbUpdater updater()
                  throws DbException
Return an updater for updating rows in the database

Returns:
Description of the Returned Value
Throws:
DbException - Description of Exception

deleter

public DbDeleter deleter()
                  throws DbException
Return a deleter for deleting rows in the database

Returns:
Description of the Returned Value
Throws:
DbException - Description of Exception

iterator

public DbIterator iterator()
                    throws DbException
Return an iterator to iterate over the rows in this table.

BUGS: Currently you can only iterate over a table that was returned from a DbSelector.

Returns:
Description of the Returned Value
Throws:
DbException - Description of Exception

close

public void close()
           throws DbException
DbException

finalize

protected void finalize()
                 throws java.lang.Throwable
Overrides:
finalize in class java.lang.Object
java.lang.Throwable

setStatement

void setStatement(java.sql.PreparedStatement stmt)
            throws DbException
DbException

setResultSet

void setResultSet(java.sql.ResultSet rs)
            throws DbException
DbException

getAddColumn

DbColumn getAddColumn()
                throws DbException
DbException

standardiseColumnName

java.lang.String standardiseColumnName(java.lang.String name)