com.fgm.javaUtils.database

Class DbTable

java.lang.Object

com.fgm.javaUtils.database.DbTable

public class DbTable
extends java.lang.Object

Class that manages the conversion of a ResultSet to something more usable.

Author:

phil.feldman

Field Summary

Fields

Modifier and Type	Field and Description
private org.apache.log4j.Logger	_logger The _logger.
private java.util.List<java.lang.String>	header List containing the column headers.
private java.util.regex.Pattern	removeSpecialCharacters Regex to remove special characters that we don't want in the DB.
private java.util.List<java.util.List<java.lang.String>>	table List of List containing the full table.

Constructor Summary

Constructors

Constructor and Description
DbTable() Instantiates a new db table.
DbTable(java.util.List<java.util.List<java.lang.String>> data) Create a table based on a List> of rows.
DbTable(java.sql.ResultSet rs) Create a table based on a ResultSet.

Method Summary

Methods

Modifier and Type	Method and Description
boolean	addRow(java.util.List<java.lang.String> row) Add a row of string values to the table.
java.util.HashMap<java.lang.String,java.lang.Object>	findRow(java.lang.String columnName, java.lang.String value) Return a row based on a key/value pair.
java.util.List<java.lang.Integer>	getColumnInt(java.lang.String headerName) Get the values of a column as a List given the column name.
java.util.List<java.lang.String>	getColumnNames() Get all the column names.
java.util.List<java.lang.String>	getColumnString(java.lang.String headerName) Get the values of a column as a List given the column name.
java.lang.String	getFirstValue(java.lang.String headerName) Gets the first value in a column.
java.util.List<java.lang.String>	getHeaders() Return the names of all the columns.
java.util.HashMap<java.lang.String,java.lang.Object>	getRowAsKeyVal(int row) Return a row based on the index of that row
int	getSize() Return the number of rows in this table.
java.util.List<java.util.List<java.lang.String>>	getTable() Get all the rows.
static void	main(java.lang.String[] args) The main method.
static DbTable	makeErrorTable(java.lang.String headerMsg, java.lang.String rowMsg) Make a table that contains an error message.
protected void	parseResultSet(java.sql.ResultSet rs) Parse the ResultSet into the table structure.
boolean	setHeader(java.util.List<java.lang.String> columnNames) Reset the table and set the headers.
java.util.List<java.util.HashMap<java.lang.String,java.lang.String>>	toHashMapList() Return the table as a List of HashMaps
java.lang.String	toJsonString() Return the entire table as a String
java.lang.String	toString() Return the entire table as a lightly-formatted String.
boolean	writeToVizDb(DbHelper dbh, java.lang.String tableName) Write to viz db.

Methods inherited from class java.lang.Object

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

Field Detail

header

private java.util.List<java.lang.String> header

List containing the column headers.

table

private java.util.List<java.util.List<java.lang.String>> table

List of List containing the full table.

removeSpecialCharacters

private java.util.regex.Pattern removeSpecialCharacters

Regex to remove special characters that we don't want in the DB.

_logger

private org.apache.log4j.Logger _logger

The _logger.

Constructor Detail

DbTable

public DbTable()

Instantiates a new db table.

DbTable

public DbTable(java.sql.ResultSet rs)

Create a table based on a ResultSet. This will produce a List of column names and a List> of rows

Parameters:

rs - the rs

DbTable

public DbTable(java.util.List<java.util.List<java.lang.String>> data)

Create a table based on a List> of rows.

Parameters:

data - the data

Method Detail

getSize

public int getSize()

Return the number of rows in this table.

Returns:

the size

getHeaders

public java.util.List<java.lang.String> getHeaders()

Return the names of all the columns.

Returns:

the headers

getTable

public java.util.List<java.util.List<java.lang.String>> getTable()

Get all the rows.

Returns:

the table

getColumnNames

public java.util.List<java.lang.String> getColumnNames()

Get all the column names.

Returns:

list containing the column names. This is opposed to getHeaders, that returns the meta-data about the table

parseResultSet

protected void parseResultSet(java.sql.ResultSet rs)
                       throws java.sql.SQLException

Parse the ResultSet into the table structure.

Parameters:

rs - the rs

Throws:

java.sql.SQLException - the SQL exception

getColumnString

public java.util.List<java.lang.String> getColumnString(java.lang.String headerName)

Get the values of a column as a List given the column name.

Parameters:

headerName - the header name

Returns:

the column string

getColumnInt

public java.util.List<java.lang.Integer> getColumnInt(java.lang.String headerName)

Get the values of a column as a List given the column name.

Parameters:

headerName - the header name

Returns:

the column int

getFirstValue

public java.lang.String getFirstValue(java.lang.String headerName)

Gets the first value in a column. Generally used if you expect only one row

Parameters:

headerName - the header name

Returns:

the first value

findRow

public java.util.HashMap<java.lang.String,java.lang.Object> findRow(java.lang.String columnName,
                                                           java.lang.String value)

Return a row based on a key/value pair.

Parameters:

columnName - the column name

value - the value to match

Returns:

HashMap representing the row

getRowAsKeyVal

public java.util.HashMap<java.lang.String,java.lang.Object> getRowAsKeyVal(int row)

Return a row based on the index of that row

Parameters:

row - the row

Returns:

the row as key val

setHeader

public boolean setHeader(java.util.List<java.lang.String> columnNames)

Reset the table and set the headers.

Parameters:

columnNames - the column names

Returns:

true, if successful

addRow

public boolean addRow(java.util.List<java.lang.String> row)

Add a row of string values to the table.

Parameters:

row - a List

Returns:

true, if successful

writeToVizDb

public boolean writeToVizDb(DbHelper dbh,
                   java.lang.String tableName)

Write to viz db.

Parameters:

dbh - the dbh

tableName - the table name

Returns:

true, if successful

toJsonString

public java.lang.String toJsonString()

Return the entire table as a String

toString

public java.lang.String toString()

Return the entire table as a lightly-formatted String.

Overrides:

toString in class java.lang.Object

Returns:

the string

makeErrorTable

public static DbTable makeErrorTable(java.lang.String headerMsg,
                     java.lang.String rowMsg)

Make a table that contains an error message.

Parameters:

headerMsg - the header msg

rowMsg - the row msg

Returns:

the db table

toHashMapList

public java.util.List<java.util.HashMap<java.lang.String,java.lang.String>> toHashMapList()

Return the table as a List of HashMaps

Returns:

the list

main

public static void main(java.lang.String[] args)

The main method. For debugging

Parameters:

args - the arguments