com.middlemindgames.tdb

Class FormBuilder

java.lang.Object

com.middlemindgames.tdb.FormBuilder

public class FormBuilder
extends java.lang.Object

Creates a new instance of the formBuilder class. The formBuilder class is responsible for creating Java Swing forms from DATADICTIONARY table rows, and from the config.xml configuration file. It supports other SQL generation tasks.

Constructor Summary

Constructors

Constructor and Description
FormBuilder(java.lang.String xmlFile) Create new instance of the formBuilder class.
FormBuilder(java.lang.String xmlFile, DataAccess da) Create new instance of the formBuilder class.

Method Summary

Modifier and Type	Method and Description
int	buildForm(java.sql.ResultSet data, javax.swing.JPanel container, java.sql.ResultSet vals, int pY, int wkspcId) Build form on a specified panel.
int	buildFormFromSql(java.sql.ResultSet data, javax.swing.JPanel container, int w_id) Builds a form from a query into the DATADICTIONARY table.
int	buildFormFromSql(java.sql.ResultSet data, javax.swing.JPanel container, int posY, int w_id) Builds a form from a query into the DATADICTIONARY table.
int	buildFormFromSql(java.sql.ResultSet data, javax.swing.JPanel container, java.sql.ResultSet vals, int w_id) Builds a form from a query into the DATADICTIONARY table.
int	buildFormFromSql(java.sql.ResultSet data, javax.swing.JPanel container, java.sql.ResultSet vals, int posY, int w_id) Builds a form from a query into the DATADICTIONARY table.
int	buildFormFromXml(javax.swing.JPanel container) Builds a form based on the parameters found in the loaded XML file.
void	clearForm(javax.swing.JPanel panel) Clears all the generated text input fields by setting their value to an empty string.
java.lang.String	generateSqlInsert(java.sql.ResultSet data, javax.swing.JPanel container) Calls generateSqlInsert without any specified Workspace id.
java.lang.String	generateSqlInsert(java.sql.ResultSet data, javax.swing.JPanel container, java.lang.String workspaces_id) Generates an SQL insert statement from the information provided in the given JPanel container.
java.lang.String	generateSqlUpdate(java.sql.ResultSet data, javax.swing.JPanel container, java.lang.String id) Generates an SQL update statement from the information provided in the given JPanel container.
DataAccess	getDataAccess() Data access getter.
java.lang.String[]	getTagNames() Returns the tag names for all children off the root XML node.
org.w3c.dom.NodeList	getXmlData(java.lang.String key) Requires that the XML file be loaded and the root element set.
java.lang.String[]	getXmlData(java.lang.String[] keys) Get values from XmlDocument for a set of given keys.
java.lang.String[]	getXmlData(java.lang.String[] keys, java.lang.String xmlFile) Get values from an XmlDocument for a set of given keys.
org.w3c.dom.NodeList	getXmlData(java.lang.String key, java.lang.String xmlFile) Returns a NodeList of all the entries in the XML file that match the given key.
static java.lang.String[]	getXmlDataStatic(java.lang.String[] keys, java.lang.String xmlFile) Get values from an XmlDocument for a set of given keys.
static org.w3c.dom.NodeList	getXmlDataStatic(java.lang.String key, java.lang.String xmlFile) Returns a NodeList of all the entries in the XML file that match the given key.
static void	increasePanelHeight(javax.swing.JPanel container, int posY) Increases panel height based on position of last control.
static void	increasePanelWidth(javax.swing.JPanel container, int posX, int width) Increases panel width based on size and position of a control.
void	setDataAccess(DataAccess da) Data access setter.
java.lang.String	validateFormSql(java.sql.ResultSet data, javax.swing.JPanel container) Check the fields of a form against validation specifications in the Data Dictionary.
boolean	writeSettings(javax.swing.JPanel panel) Writes the values in the given JPanel container to the XML structure loaded from the configuration file.
boolean	writeSettings(javax.swing.JPanel panel, java.lang.String xmlFile) Writes the setting contents of the given JPanel to the specified XML configuration file.

Methods inherited from class java.lang.Object

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

Constructor Detail

FormBuilder

public FormBuilder(java.lang.String xmlFile,
                   DataAccess da)

Create new instance of the formBuilder class.

Parameters:

xmlFile - XmlDocument File path. Create fields for the Document and the root Element.

da - dataAccess class for database queries.

See Also:

DataAccess

FormBuilder

public FormBuilder(java.lang.String xmlFile)

Create new instance of the formBuilder class.

Parameters:

xmlFile - XmlDocument File path. Create fields for the Document and the root Element.

See Also:

DataAccess

Method Detail

getDataAccess

public DataAccess getDataAccess()

Data access getter.

Returns:

Returns the dataAccess class used by this formBuilder.

See Also:

DataAccess

setDataAccess

public void setDataAccess(DataAccess da)

Data access setter.

Parameters:

da - Sets the dataAccess class used by this form builder.

See Also:

DataAccess

getXmlData

public org.w3c.dom.NodeList getXmlData(java.lang.String key,
                                       java.lang.String xmlFile)

Returns a NodeList of all the entries in the XML file that match the given key.

Parameters:

key - An XML key to find data for.

xmlFile - An XML file to parse for the specified key.

Returns:

Returns a NodeList for the specified XML key.

getXmlDataStatic

public static org.w3c.dom.NodeList getXmlDataStatic(java.lang.String key,
                                                    java.lang.String xmlFile)

Returns a NodeList of all the entries in the XML file that match the given key.

Parameters:

key - An XML key to find data for.

xmlFile - An XML file to parse for the specified key.

Returns:

Returns a NodeList for the specified XML key.

getXmlData

public org.w3c.dom.NodeList getXmlData(java.lang.String key)

Requires that the XML file be loaded and the root element set.

Parameters:

key - An XML key to find data for.

Returns:

Returns a NodeList for the specified XML key.

clearForm

public void clearForm(javax.swing.JPanel panel)

Clears all the generated text input fields by setting their value to an empty string.

Parameters:

panel - The panel to clear.

writeSettings

public boolean writeSettings(javax.swing.JPanel panel,
                             java.lang.String xmlFile)

Writes the setting contents of the given JPanel to the specified XML configuration file. Assumes that the provided XML configuration file is the same file the configuration information was loaded from, or that it has the same general structure of the default XML configuration file.

Parameters:

panel - The JPanel that has all the XML configuration settings. JPanel should be auto generated from a buildForm method call.

xmlFile - The target XML configuration file used to save the configuration info, defaults to config.xml.

Returns:

Returns true of the process was successful, false otherwise.

writeSettings

public boolean writeSettings(javax.swing.JPanel panel)

Writes the values in the given JPanel container to the XML structure loaded from the configuration file.

Parameters:

panel - A JPanel container that has text fields and text areas with the data to be saved in the XML configuration file.

Returns:

Returns true if the write was a success, false otherwise.

getXmlData

public java.lang.String[] getXmlData(java.lang.String[] keys,
                                     java.lang.String xmlFile)

Get values from an XmlDocument for a set of given keys.

Parameters:

keys - Array of keys to look up.

xmlFile - XmlDocument File path.

Returns:

Array of values for given keys.

getXmlDataStatic

public static java.lang.String[] getXmlDataStatic(java.lang.String[] keys,
                                                  java.lang.String xmlFile)

Get values from an XmlDocument for a set of given keys.

Parameters:

keys - Array of keys to look up.

xmlFile - XmlDocument File path.

Returns:

Array of values for given keys.

getTagNames

public java.lang.String[] getTagNames()

Returns the tag names for all children off the root XML node. Designed to skip "Table" tags. Assumes that the root object has been set and the initial XML configuration file has been loaded.

Returns:

Returns an array of strings representing the tags found.

getXmlData

public java.lang.String[] getXmlData(java.lang.String[] keys)

Get values from XmlDocument for a set of given keys. Uses formBuilder instance field 'root' as XmlDoc to search. Assumes the configuration file has been parsed and loaded and a root node has been found.

Parameters:

keys - Array of keys to look up.

Returns:

Array of values for given keys.

generateSqlInsert

public java.lang.String generateSqlInsert(java.sql.ResultSet data,
                                          javax.swing.JPanel container)

Calls generateSqlInsert without any specified Workspace id.

Parameters:

data - The original data result set that was used to populate the JPanel form.

container - The JPanel that contains information to generate SQL insert for.

Returns:

An SQL insert query.

generateSqlInsert

public java.lang.String generateSqlInsert(java.sql.ResultSet data,
                                          javax.swing.JPanel container,
                                          java.lang.String workspaces_id)
                                   throws java.lang.Exception

Generates an SQL insert statement from the information provided in the given JPanel container.

Parameters:

data - Dataset containing table schema for target table.

container - Form containing fields to add as new DB row.

workspaces_id - Workspace id to use as SELECT filter.

Returns:

String representing the generated SQL insert query.

Throws:

java.lang.Exception - Throws generic exception.

generateSqlUpdate

public java.lang.String generateSqlUpdate(java.sql.ResultSet data,
                                          javax.swing.JPanel container,
                                          java.lang.String id)
                                   throws java.lang.Exception

Generates an SQL update statement from the information provided in the given JPanel container.

Parameters:

data - Dataset containing table schema for target table.

container - Form containing fields to add as new DB row.

id - Row ID used to specify which row to update.

Returns:

String representing the generated SQL insert query.

Throws:

java.lang.Exception - Throws generic exception.

validateFormSql

public java.lang.String validateFormSql(java.sql.ResultSet data,
                                        javax.swing.JPanel container)

Check the fields of a form against validation specifications in the Data Dictionary.

Parameters:

data - SQL query results containing validation data from DataDictionary.

container - Form to validate.

Returns:

First validation err

buildFormFromSql

public int buildFormFromSql(java.sql.ResultSet data,
                            javax.swing.JPanel container,
                            int w_id)

Builds a form from a query into the DATADICTIONARY table.

Parameters:

data - A result set from the database, specifically from the DATADICTIONARY table.

container - The JPanel container that will store the generated form.

w_id - The current workspace id.

Returns:

Y position, relative to container top, of last field added to form.

buildFormFromSql

public int buildFormFromSql(java.sql.ResultSet data,
                            javax.swing.JPanel container,
                            java.sql.ResultSet vals,
                            int w_id)

Builds a form from a query into the DATADICTIONARY table.

Parameters:

data - A result set from the database, specifically from the DATADICTIONARY table.

container - The JPanel container that will store the generated form.

vals - A set of values used to populate the generate form fields.

w_id - The current workspace id.

Returns:

Y position, relative to container top, of last field added to form.

buildFormFromSql

public int buildFormFromSql(java.sql.ResultSet data,
                            javax.swing.JPanel container,
                            java.sql.ResultSet vals,
                            int posY,
                            int w_id)

Builds a form from a query into the DATADICTIONARY table.

Parameters:

data - A result set from the database, specifically from the DATADICTIONARY table.

container - The JPanel container that will store the generated form.

vals - A set of values used to populate the generate form fields.

posY - Y position, relative to container top, of first form field.

w_id - The current workspace id.

Returns:

Y position, relative to container top, of last field added to form.

buildFormFromSql

public int buildFormFromSql(java.sql.ResultSet data,
                            javax.swing.JPanel container,
                            int posY,
                            int w_id)

Builds a form from a query into the DATADICTIONARY table.

Parameters:

data - A result set from the database, specifically from the DATADICTIONARY table.

container - The JPanel container that will store the generated form.

posY - Y position, relative to container top, of first form field.

w_id - The current workspace id.

Returns:

Y position, relative to container top, of last field added to form.

increasePanelWidth

public static void increasePanelWidth(javax.swing.JPanel container,
                                      int posX,
                                      int width)

Increases panel width based on size and position of a control.

Parameters:

container - Panel to resize.

posX - X position of control.

width - Width of control.

increasePanelHeight

public static void increasePanelHeight(javax.swing.JPanel container,
                                       int posY)

Increases panel height based on position of last control.

Parameters:

container - Panel to resize.

posY - Y position of last control.

buildForm

public int buildForm(java.sql.ResultSet data,
                     javax.swing.JPanel container,
                     java.sql.ResultSet vals,
                     int pY,
                     int wkspcId)
              throws java.lang.Exception

Build form on a specified panel. Form consists of input fields specified in DataDictionary.

Parameters:

data - Set of input fields and field attributes for the form.

container - Places form fields inside this panel.

vals - Set of strings to populate any text fields that already have existing values.

pY - Y position, relative to container top, of first form field.

wkspcId - The current workspace id.

Returns:

Y position, relative to container top, of last field added to form.

Throws:

java.lang.Exception - Throws generic exception.

buildFormFromXml

public int buildFormFromXml(javax.swing.JPanel container)

Builds a form based on the parameters found in the loaded XML file. Assumes that a configuration XML file has been loaded.

Parameters:

container - Places form fields inside this panel.

Returns:

Y position, relative to container top, of last field added to form.