com.dpslink.base.jdbc

Class JDBCObjectController<DBOBJ extends JDBCObject<DBOBJ>>

java.lang.Object

com.dpslink.base.obj.MappedAttributesObject

com.dpslink.base.jdbc.JDBCObjectController<DBOBJ>

All Implemented Interfaces:

java.io.Serializable

Direct Known Subclasses:

CartController, CartLineController, CatalogCategoryController, CatalogProductController, CategoryController, CDBatchController, CountryController, CreditCardController, CustomerController, FavoritesDescriptorController, ImportBatchController, ImportCriteriaController, ImportValidationController, JDBCGenericObjectController, LeadtimeController, LogonAttemptController, ManufacturerController, NotificationPrefController, OrderAuditController, OrderAuditLineController, PasswordHistoryController, PendingProductController, PermitController, PermitProductController, PermitUserController, ProductAttributeController, ProductAttributeDescriptorController, ProductController, ProductGroupController, ProductGroupXrefController, PunchOutSessionController, RelatedProductsXrefController, RelationshipTypeController, RestockNotificationController, SalesRepController, SalesRepCustomerController, SalesRepUserController, SearchLogProductController, SecurityProfileController, ShipperController, ShipperCountryController, SiteActivityController, SiteActivityPageController, SpecialController, SpecialsTypeController, StateController, UnitMeasureController, UserController, WordFixController, XrefController

public abstract class JDBCObjectController<DBOBJ extends JDBCObject<DBOBJ>>
extends MappedAttributesObject

An abstract JDBC object controller definition. This is the class from which all JDBC object controllers are derived. Provides default object controller functionality, plus method signatures for required JDBC object-specific controller functionality.

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
protected java.lang.Class<DBOBJ>	ivDBObjCls The class of the JDBC object associated with the controller.
protected int	ivFieldCount The number of fields in the table associated with the controller.
protected java.lang.String	ivFieldKeyAlt The alternate key definition resource key for the table associated with the controller.
protected java.lang.String	ivFieldKeyPri The primary key definition resource key for the table associated with the controller.
protected java.lang.String	ivFieldResPfx The field definition resource key prefix for the table associated with the controller.
protected int	ivSyncLast The zero-based index of the last sync field for the table associated with the controller.
protected java.lang.String	ivSyncType The sync record type for the table associated with the controller.
protected java.lang.String	ivTableName The name of the database table associated with the controller.
private static long	serialVersionUID The class' serialization version id.

Fields inherited from class com.dpslink.base.obj.MappedAttributesObject

ivHashCode, ivHashFlds, ivObjAttrs

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	JDBCObjectController(java.lang.Class<DBOBJ> objcls) A special constructor for the abstract object controller.
protected	JDBCObjectController(java.lang.Class<DBOBJ> objcls, java.lang.String tblname) The recommended constructor for the abstract object controller.

Method Summary

Modifier and Type	Method and Description
boolean	add(DBOBJ obj) Adds a new record to the table associated with the controller.
int	add(DBOBJ obj, boolean logdup) Adds a new record to the table associated with the controller.
int	add(java.lang.String[] data) Adds a new record to the table associated with the controller using the given string array of field values.
protected java.util.HashMap<java.lang.String,java.lang.Object>	arrayToMap(java.lang.String[] data) Returns a map of field names and values using the given string array of field values.
protected java.util.HashMap<java.lang.String,java.lang.Object>	arrayToMap(java.lang.String[] data, java.util.HashMap<java.lang.String,java.lang.Object> attrs) Returns a map of field names and values using the given string array of field values.
private java.util.HashMap<java.lang.String,java.lang.Object>	arrayToMap(java.lang.String[] data, java.util.HashMap<java.lang.String,java.lang.Object> attrs, boolean forupdate) Returns a map of field names and values using the given string array of field values.
int	countAll() Returns the number of records in the table associated with the controller.
boolean	delete(DBOBJ obj) Deletes an existing record from the table associated with the controller.
int	delete(java.lang.String[] data) Deletes one or more existing records from the table associated with the controller.
boolean	deleteAll() Deletes all records in the table associated with the controller.
void	dispose() Disposes of the controller and its owned objects.
boolean	equals(java.lang.Object obj) Compares the given object to this object and determines if the two are equal.
java.util.ArrayList<DBOBJ>	getAll() Returns a collection of all records in the table associated with the controller.
java.sql.Connection	getConnection() Returns the JDBC connection associated with the controller.
JDBCConnectionInfo	getConnectionInfo() Returns the JDBC connection information object that owns this controller.
<DBOBJCTLR extends JDBCObjectController<? extends JDBCObject<?>>> DBOBJCTLR	getController(java.lang.Class<DBOBJCTLR> ctlrcls) Returns the JDBC object controller for the given controller class.
java.lang.String[]	getFieldNames() Returns an array of field names for the table associated with the controller.
protected java.lang.String[]	getFieldNamesForKey() Returns an array of primary key field names for the table associated with the controller.
protected java.lang.String[]	getFieldNamesForUpdate() Returns an array of update field names for the table associated with the controller.
protected boolean[]	getFieldNulls() Returns an array of field nullable flags for the table associated with the controller.
protected boolean[]	getFieldNullsForKey() Returns an array of primary key field nullable flags for the table associated with the controller.
protected boolean[]	getFieldNullsForUpdate() Returns an array of update field nullable flags for the table associated with the controller.
protected java.lang.String	getFieldsForOrderBy() Returns the SQL 'order by' clause field string for the table associated with the controller.
protected java.lang.String	getFieldsForWhere() Returns the SQL 'where' clause field string for the table associated with the controller.
protected double	getFieldSize(java.lang.String fldname) Returns the size of a field (metadata column size and decimal digits).
protected int[]	getFieldTypes() Returns an array of field types (java.sql.Types) for the table associated with the controller.
protected int[]	getFieldTypesForKey() Returns an array of primary key field types (java.sql.Types) for the table associated with the controller.
protected int[]	getFieldTypesForUpdate() Returns an array of update field types (java.sql.Types) for the table associated with the controller.
protected java.lang.String	getStatementForDelete() Returns the SQL delete statement string for the table associated with the controller.
protected java.lang.String	getStatementForGet() Returns the SQL get statement string for the table associated with the controller.
protected java.lang.String	getStatementForGetAll() Returns the SQL get all statement string for the table associated with the controller.
protected java.lang.String	getStatementForInsert() Returns the SQL insert statement string for the table associated with the controller.
protected java.lang.String	getStatementForUpdate() Returns the SQL update statement string for the table associated with the controller.
protected java.lang.String	getStatementKey(java.lang.String stmtsfx) Returns the full SQL statement resource key for a given statement resource key suffix.
protected java.lang.String	getStatementString(java.lang.String stmtsfx) Returns an SQL statement string for a given statement resource key suffix.
java.lang.String	getTableName() Returns the name of the database table associated with the controller.
protected boolean	hasFieldNamesForKey() Answers if the table associated with the controller has key field names.
protected boolean	hasFieldNamesForUpdate() Answers if the table associated with the controller has update field names.
protected boolean	isDuplicate(java.lang.Exception e) Answers if the given exception is a SQL duplicate record exception.
protected java.lang.String[]	resultSetToArray(java.sql.ResultSet rs) Returns a string array of sync field values from the given SQL result set.
protected java.util.HashMap<java.lang.String,java.lang.Object>	resultSetToMap(java.sql.ResultSet rs) Returns a map of field names and values from the given SQL result set.
protected java.util.HashMap<java.lang.String,java.lang.Object>	resultSetToMap(java.sql.ResultSet rs, java.lang.String tblname) Returns a map of field names and values from the given SQL result set.
DBOBJ	resultSetToObject(java.sql.ResultSet rs) Returns a database object from the given SQL result set.
void	setConnectionInfo(JDBCConnectionInfo cninf) Sets the JDBC connection information object that owns this controller.
protected boolean	setPSDeleteValues(java.sql.PreparedStatement ps, DBOBJ obj) Sets the parameter values for the SQL prepared statement that will be used to delete the given object.
protected boolean	setPSExistsValues(java.sql.PreparedStatement ps, DBOBJ obj) Sets the parameter values for the SQL prepared statement that will be used to determine the existence of the given object.
protected boolean	setPSInsertValues(java.sql.PreparedStatement ps, DBOBJ obj) Sets the parameter values for the SQL prepared statement that will be used to insert the given object.
protected boolean	setPSUpdateValues(java.sql.PreparedStatement ps, DBOBJ obj) Sets the parameter values for the SQL prepared statement that will be used to update the given object.
protected void	setPSValue(java.sql.PreparedStatement ps, DBOBJ obj, java.lang.String fldname, int fldtype, boolean fldnull, int parmidx) Sets a parameter value for an SQL prepared statement using the supplied values.
boolean	update(DBOBJ obj) Updates an existing record in the table associated with the controller.
int	update(java.lang.String[] data) Updates an existing record in the table associated with the controller using the given string array of field values.
DBOBJ	valuesToObject(java.util.HashMap<java.lang.String,java.lang.Object> attrs) Returns a database object from the given set of attributes.

Methods inherited from class com.dpslink.base.obj.MappedAttributesObject

cloneMapAttributes, formatValue, formatValue, getHashFields, getMapArrayList, getMapAttributes, getMapBigDecimal, getMapBoolean, getMapDate, getMapDouble, getMapInteger, getMapLong, getMapMapped, getMapObject, getMapShort, getMapString, getMapString, getMapStringBuffer, getMapStringBuilder, getMapTime, getMapTimestamp, getMapVector, hashCode, setHashFields, setMap, setMap, setMap, setMap, setMap, setMap, setMap, setMap, setMap, setMap, setMap, setMap, setMap, setMap, setMap, setMapAttributes, setMapObject, setMapTime, setMapTimestamp, toStringArray

Methods inherited from class java.lang.Object

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

Field Detail

serialVersionUID

private static final long serialVersionUID

The class' serialization version id.

See Also:

Constant Field Values

ivDBObjCls

protected java.lang.Class<DBOBJ extends JDBCObject<DBOBJ>> ivDBObjCls

The class of the JDBC object associated with the controller.

ivTableName

protected java.lang.String ivTableName

The name of the database table associated with the controller.

ivFieldResPfx

protected java.lang.String ivFieldResPfx

The field definition resource key prefix for the table associated with the controller.

ivFieldKeyPri

protected java.lang.String ivFieldKeyPri

The primary key definition resource key for the table associated with the controller.

ivFieldKeyAlt

protected java.lang.String ivFieldKeyAlt

The alternate key definition resource key for the table associated with the controller.

ivFieldCount

protected int ivFieldCount

The number of fields in the table associated with the controller.

ivSyncType

protected java.lang.String ivSyncType

The sync record type for the table associated with the controller.

ivSyncLast

protected int ivSyncLast

The zero-based index of the last sync field for the table associated with the controller.

Constructor Detail

JDBCObjectController

protected JDBCObjectController(java.lang.Class<DBOBJ> objcls)

A special constructor for the abstract object controller. This constructor does not perform any initialization and does not associate the controller with any specific database table. Invokers of this constructor must perform all necessary initializations and make the necessary table association.

Parameters:

objcls - (Class) The class of the JDBC object associated with the controller.

JDBCObjectController

protected JDBCObjectController(java.lang.Class<DBOBJ> objcls,
                               java.lang.String tblname)

The recommended constructor for the abstract object controller. Performs controller initialization and associates the controller with the specified database table name.

Parameters:

objcls - (Class) The class of the JDBC object associated with the controller.

tblname - (String) The name of the database table associated with the controller.

Method Detail

equals

public boolean equals(java.lang.Object obj)

Compares the given object to this object and determines if the two are equal. Equality is based on table name.

Specified by:

equals in class MappedAttributesObject

Parameters:

obj - (Object) The object to compare with this object.

Returns:

boolean - true if the specified object is equal to this object, otherwise false.

add

public boolean add(DBOBJ obj)

Adds a new record to the table associated with the controller. Assumes that duplicates are always logged as an exception.

Parameters:

obj - (JDBCObject) The object for the record to be added.

Returns:

boolean - true if the record added successfully, otherwise false.

add

public int add(DBOBJ obj,
               boolean logdup)

Adds a new record to the table associated with the controller.

Parameters:

obj - (JDBCObject) The object for the record to be added.

logdup - (boolean) true if duplicate errors are to be logged as an exception, otherwise false. When duplicates are logged, the return value of 1 is never returned.

Returns:

int - 0 = success, 1 = duplicate, 2 = failure.

add

public int add(java.lang.String[] data)

Adds a new record to the table associated with the controller using the given string array of field values. The array of values is assumed to be in the same order as the fields in the table. Invoked during sync while processing incoming records from the server.

Parameters:

data - (String[]) A string array of field values.

Returns:

int - 0 = success, 1 = field count mismatch, 2 = conversion error, 3 = duplicate record, 4+ = other error.

arrayToMap

protected java.util.HashMap<java.lang.String,java.lang.Object> arrayToMap(java.lang.String[] data)
                                                                   throws java.lang.Exception

Returns a map of field names and values using the given string array of field values. The array of values are assumed to be in the same order as the fields in the table. Invoked during sync while processing incoming records from the server. Intended for use when adding new records to the table associated with the controller.

Currently only supports the following SQL data types. All other data types are processed as Types.OTHER values.
• Types.CHAR
• Types.DATE
• Types.DECIMAL
• Types.INTEGER
• Types.SMALLINT
• Types.TIMESTAMP
• Types.VARCHAR

Parameters:

data - (String[]) A string array of field values.

Returns:

HashMap - A collection of field names and values.

Throws:

java.lang.Exception - - if an error occurs while processing the array of field values.

arrayToMap

protected java.util.HashMap<java.lang.String,java.lang.Object> arrayToMap(java.lang.String[] data,
                                                                          java.util.HashMap<java.lang.String,java.lang.Object> attrs)
                                                                   throws java.lang.Exception

Returns a map of field names and values using the given string array of field values. The array of values are assumed to be in the same order as the fields in the table. Invoked during sync while processing incoming records from the server. Intended for use when updating existing records in the table associated with the controller.

Currently only supports the following SQL data types. All other data types are processed as Types.OTHER values.
• Types.CHAR
• Types.DATE
• Types.DECIMAL
• Types.INTEGER
• Types.SMALLINT
• Types.TIMESTAMP
• Types.VARCHAR

Parameters:

data - (String[]) A string array of field values.

attrs - (HashMap) A pre-existing collection of field names and values.

Returns:

HashMap - A revised collection of field names and values.

Throws:

java.lang.Exception - - if an error occurs while processing the array of field values.

arrayToMap

private java.util.HashMap<java.lang.String,java.lang.Object> arrayToMap(java.lang.String[] data,
                                                                        java.util.HashMap<java.lang.String,java.lang.Object> attrs,
                                                                        boolean forupdate)
                                                                 throws java.lang.Exception

Returns a map of field names and values using the given string array of field values. The array of values are assumed to be in the same order as the fields in the table. Invoked during sync while processing incoming records from the server.

Currently only supports the following SQL data types. All other data types are processed as Types.OTHER values.
• Types.CHAR
• Types.DATE
• Types.DECIMAL
• Types.INTEGER
• Types.SMALLINT
• Types.TIMESTAMP
• Types.VARCHAR

Parameters:

data - (String[]) A string array of field values.

attrs - (HashMap) A pre-existing collection of field names and values.

forupdate - (boolean) true if the string array of field values is going to be used to update an existing object, otherwise false. When true, fields in the string array that contain an empty string are ignored (a map value is not set); plus, for CHAR and VARCHAR fields, a double quoted empty string (\"\") in the string array denotes that the map field value should be set to an empty string.

Returns:

HashMap - A revised collection of field names and values.

Throws:

java.lang.Exception - - if an error occurs while processing the array of field values.

countAll

public int countAll()

Returns the number of records in the table associated with the controller.

Returns:

int - The number of records in the table.

delete

public boolean delete(DBOBJ obj)

Deletes an existing record from the table associated with the controller.

Parameters:

obj - (JDBCObject) The object for the record to be deleted.

Returns:

boolean - true if the record deleted successfully, otherwise false.

delete

public int delete(java.lang.String[] data)

Deletes one or more existing records from the table associated with the controller. Invoked during sync while processing incoming records from the server.

NOTE: This method provides no actual logic and always returns success. Subclasses must provide their own implementation of what's needed here.

Parameters:

data - (String[]) A string array of field values.

Returns:

int - 0 = success, 1 = field count mismatch, 7 = failure.

deleteAll

public boolean deleteAll()

Deletes all records in the table associated with the controller.

Returns:

boolean - true if the deletes are successful, otherwise false.

dispose

public void dispose()

Disposes of the controller and its owned objects.

getAll

public java.util.ArrayList<DBOBJ> getAll()

Returns a collection of all records in the table associated with the controller.

Returns:

ArrayList - A collection of all records.

getConnection

public java.sql.Connection getConnection()

Returns the JDBC connection associated with the controller. A shortcut convenience method for getConnectionInfo().getConnection().

Returns:

Connection - The controller's JDBC connection.

getConnectionInfo

public JDBCConnectionInfo getConnectionInfo()

Returns the JDBC connection information object that owns this controller.

Returns:

JDBCConnectionInfo - The controller's owning JDBC connection information object.

getController

public <DBOBJCTLR extends JDBCObjectController<? extends JDBCObject<?>>> DBOBJCTLR getController(java.lang.Class<DBOBJCTLR> ctlrcls)

Returns the JDBC object controller for the given controller class. A shortcut convenience method for getConnectionInfo().getController().

Parameters:

ctlrcls - (Class) The class for the desired controller.

Returns:

JDBCObjectController - The JDBC object controller.

getFieldNames

public java.lang.String[] getFieldNames()

Returns an array of field names for the table associated with the controller.

Returns:

String[] - The field names for the associated table.

getFieldNamesForKey

protected java.lang.String[] getFieldNamesForKey()

Returns an array of primary key field names for the table associated with the controller.

Returns:

String[] - The primary key field names for the associated table.

getFieldNamesForUpdate

protected java.lang.String[] getFieldNamesForUpdate()

Returns an array of update field names for the table associated with the controller.

Returns:

String[] - The update field names for the associated table.

getFieldNulls

protected boolean[] getFieldNulls()

Returns an array of field nullable flags for the table associated with the controller.

Returns:

boolean[] - The field nullable flags for the associated table.

getFieldNullsForKey

protected boolean[] getFieldNullsForKey()

Returns an array of primary key field nullable flags for the table associated with the controller.

Returns:

boolean[] - The primary key field nullable flags for the associated table.

getFieldNullsForUpdate

protected boolean[] getFieldNullsForUpdate()

Returns an array of update field nullable flags for the table associated with the controller.

Returns:

boolean[] - The update field nullable flags for the associated table.

getFieldSize

protected double getFieldSize(java.lang.String fldname)

Returns the size of a field (metadata column size and decimal digits).

Parameters:

fldname - (String) The name of a field in the table associated with this controller.

Returns:

double - The field's size (i.e. 5.0, 6.2, 10.0, etc.).

getFieldTypes

protected int[] getFieldTypes()

Returns an array of field types (java.sql.Types) for the table associated with the controller.

Currently only supports the following SQL data types. All other data types are processed as Types.OTHER values.
• Types.CHAR
• Types.DATE
• Types.DECIMAL
• Types.INTEGER
• Types.SMALLINT
• Types.TIMESTAMP
• Types.VARCHAR

Returns:

int[] - The field types for the associated table.

getFieldTypesForKey

protected int[] getFieldTypesForKey()

Returns an array of primary key field types (java.sql.Types) for the table associated with the controller.

Currently only supports the following SQL data types. All other data types are processed as Types.OTHER values.
• Types.CHAR
• Types.DATE
• Types.DECIMAL
• Types.INTEGER
• Types.SMALLINT
• Types.TIMESTAMP
• Types.VARCHAR

Returns:

int[] - The primary key field types for the associated table.

getFieldTypesForUpdate

protected int[] getFieldTypesForUpdate()

Returns an array of update field types (java.sql.Types) for the table associated with the controller.

Currently only supports the following SQL data types. All other data types are processed as Types.OTHER values.
• Types.CHAR
• Types.DATE
• Types.DECIMAL
• Types.INTEGER
• Types.SMALLINT
• Types.TIMESTAMP
• Types.VARCHAR

Returns:

int[] - The update field types for the associated table.

getFieldsForOrderBy

protected java.lang.String getFieldsForOrderBy()

Returns the SQL 'order by' clause field string for the table associated with the controller.

Returns:

String - The associated table's SQL order by clause field string.

getFieldsForWhere

protected java.lang.String getFieldsForWhere()

Returns the SQL 'where' clause field string for the table associated with the controller.

Returns:

String - The associated table's SQL where clause field string.

getStatementForDelete

protected java.lang.String getStatementForDelete()

Returns the SQL delete statement string for the table associated with the controller.

Returns:

String - The associated table's SQL delete statement string.

getStatementForGet

protected java.lang.String getStatementForGet()

Returns the SQL get statement string for the table associated with the controller.

Returns:

String - The associated table's SQL get statement string.

getStatementForGetAll

protected java.lang.String getStatementForGetAll()

Returns the SQL get all statement string for the table associated with the controller.

Returns:

String - The associated table's SQL get all statement string.

getStatementForInsert

protected java.lang.String getStatementForInsert()

Returns the SQL insert statement string for the table associated with the controller.

Returns:

String - The associated table's SQL insert statement string.

getStatementForUpdate

protected java.lang.String getStatementForUpdate()

Returns the SQL update statement string for the table associated with the controller.

Returns:

String - The associated table's SQL update statement string.

getStatementKey

protected java.lang.String getStatementKey(java.lang.String stmtsfx)

Returns the full SQL statement resource key for a given statement resource key suffix.

Parameters:

stmtsfx - (String) The resource key suffix for the desired SQL statement. "SQL.." is prepended to the suffix to form the actual resource key for the requested SQL statement.

Returns:

String - The full SQL statement resource key for the specified statement key suffix.

getStatementString

protected java.lang.String getStatementString(java.lang.String stmtsfx)

Returns an SQL statement string for a given statement resource key suffix.

Parameters:

stmtsfx - (String) The resource key suffix for the desired SQL statement. "SQL.." is prepended to the suffix to form the actual resource key for the requested SQL statement.

Returns:

String - The SQL statement string for the specified statement key suffix.

getTableName

public java.lang.String getTableName()

Returns the name of the database table associated with the controller.

Returns:

String - The table's name.

hasFieldNamesForKey

protected boolean hasFieldNamesForKey()

Answers if the table associated with the controller has key field names.

Returns:

boolean - true if the table has key field names, otherwise false.

hasFieldNamesForUpdate

protected boolean hasFieldNamesForUpdate()

Answers if the table associated with the controller has update field names.

Returns:

boolean - true if the table has update field names, otherwise false.

isDuplicate

protected boolean isDuplicate(java.lang.Exception e)

Answers if the given exception is a SQL duplicate record exception.

Parameters:

e - (Exception) The exception to check.

Returns:

boolean - true if the exception is a SQL duplicate record exception, otherwise false.

resultSetToArray

protected java.lang.String[] resultSetToArray(java.sql.ResultSet rs)
                                       throws java.sql.SQLException

Returns a string array of sync field values from the given SQL result set. The first element of the array contains the table's sync record type. The remaining elements of the array contain values for the fields included in an outbound sync record. The fields in the result set are assumed to be in the same sequence as the fields in an outbound sync record.

Currently only supports the following SQL data types. All other data types are processed as Types.OTHER values.
• Types.CHAR
• Types.DATE
• Types.DECIMAL
• Types.INTEGER
• Types.SMALLINT
• Types.TIMESTAMP
• Types.VARCHAR

Parameters:

rs - (ResultSet) The result set containing the database record from which the field values are to be obtained.

Returns:

HashMap - The obtained field values from the result set.

Throws:

java.sql.SQLException - - if an error occurs while processing the result set.

resultSetToMap

protected java.util.HashMap<java.lang.String,java.lang.Object> resultSetToMap(java.sql.ResultSet rs)
                                                                       throws java.sql.SQLException

Returns a map of field names and values from the given SQL result set.

Currently only supports the following SQL data types. All other data types are processed as Types.OTHER values.
• Types.CHAR
• Types.DATE
• Types.DECIMAL
• Types.INTEGER
• Types.SMALLINT
• Types.TIMESTAMP
• Types.VARCHAR

Parameters:

rs - (ResultSet) The result set containing the database record from which the names and values are to be obtained.

Returns:

HashMap - The obtained names and values from the result set.

Throws:

java.sql.SQLException - - if an error occurs while processing the result set.

resultSetToMap

protected java.util.HashMap<java.lang.String,java.lang.Object> resultSetToMap(java.sql.ResultSet rs,
                                                                              java.lang.String tblname)
                                                                       throws java.sql.SQLException

Returns a map of field names and values from the given SQL result set.

Currently only supports the following SQL data types. All other data types are processed as Types.OTHER values.
• Types.CHAR
• Types.DATE
• Types.DECIMAL
• Types.INTEGER
• Types.SMALLINT
• Types.TIMESTAMP
• Types.VARCHAR

Parameters:

rs - (ResultSet) The result set containing the database record from which the names and values are to be obtained.

tblname - (String) The name of a table. Only store column values from this table in the map.

Returns:

HashMap - The obtained names and values from the result set.

Throws:

java.sql.SQLException - - if an error occurs while processing the result set.

resultSetToObject

public DBOBJ resultSetToObject(java.sql.ResultSet rs)
                        throws java.sql.SQLException

Returns a database object from the given SQL result set.

Parameters:

rs - (ResultSet) The result set containing the database record from which the new object is to be created.

Returns:

DBObject - An object initialized with values from the result set.

Throws:

java.sql.SQLException - - if an error occurs while processing the result set.

setConnectionInfo

public void setConnectionInfo(JDBCConnectionInfo cninf)

Sets the JDBC connection information object that owns this controller.

Parameters:

cninf - (JDBCConnectionInfo) The controller's JDBC connection information object.

setPSDeleteValues

protected boolean setPSDeleteValues(java.sql.PreparedStatement ps,
                                    DBOBJ obj)

Sets the parameter values for the SQL prepared statement that will be used to delete the given object. This method assumes that all unpersisted fields for the object are defined after all persisted fields.

Currently only supports the following SQL data types. All other data types are processed as Types.OTHER values.
• Types.CHAR
• Types.DATE
• Types.DECIMAL
• Types.INTEGER
• Types.SMALLINT
• Types.TIMESTAMP
• Types.VARCHAR

Parameters:

ps - (PreparedStatement) The SQL prepared statement that is to have its values set.

obj - (JDBCObject) The object that is to be deleted.

Returns:

boolean - true if setting the SQL parameters is successful, otherwise false.

setPSExistsValues

protected boolean setPSExistsValues(java.sql.PreparedStatement ps,
                                    DBOBJ obj)

Sets the parameter values for the SQL prepared statement that will be used to determine the existence of the given object. This method assumes that all unpersisted fields for the object are defined after all persisted fields.

Currently only supports the following SQL data types. All other data types are processed as Types.OTHER values.
• Types.CHAR
• Types.DATE
• Types.DECIMAL
• Types.INTEGER
• Types.SMALLINT
• Types.TIMESTAMP
• Types.VARCHAR

Parameters:

ps - (PreparedStatement) The SQL prepared statement that is to have its values set.

obj - (JDBCObject) The object that is to be checked.

Returns:

boolean - true if setting the SQL parameters is successful, otherwise false.

setPSInsertValues

protected boolean setPSInsertValues(java.sql.PreparedStatement ps,
                                    DBOBJ obj)

Sets the parameter values for the SQL prepared statement that will be used to insert the given object. This method assumes that all unpersisted fields for the object are defined after all persisted fields.

Currently only supports the following SQL data types. All other data types are processed as Types.OTHER values.
• Types.CHAR
• Types.DATE
• Types.DECIMAL
• Types.INTEGER
• Types.SMALLINT
• Types.TIMESTAMP
• Types.VARCHAR

Parameters:

ps - (PreparedStatement) The SQL prepared statement that is to have its values set.

obj - (JDBCObject) The object that is to be inserted.

Returns:

boolean - true if setting the SQL parameters is successful, otherwise false.

setPSUpdateValues

protected boolean setPSUpdateValues(java.sql.PreparedStatement ps,
                                    DBOBJ obj)

Sets the parameter values for the SQL prepared statement that will be used to update the given object. This method assumes that all unpersisted fields for the object are defined after all persisted fields.

Currently only supports the following SQL data types. All other data types are processed as Types.OTHER values.
• Types.CHAR
• Types.DATE
• Types.DECIMAL
• Types.INTEGER
• Types.SMALLINT
• Types.TIMESTAMP
• Types.VARCHAR

Parameters:

ps - (PreparedStatement) The SQL prepared statement that is to have its values set.

obj - (JDBCObject) The object that is to be updated.

Returns:

boolean - true if setting the SQL parameters is successful, otherwise false.

setPSValue

protected void setPSValue(java.sql.PreparedStatement ps,
                          DBOBJ obj,
                          java.lang.String fldname,
                          int fldtype,
                          boolean fldnull,
                          int parmidx)
                   throws java.lang.Exception

Sets a parameter value for an SQL prepared statement using the supplied values.

Currently only supports the following SQL data types. All other data types are processed as Types.OTHER values.
• Types.CHAR
• Types.DATE
• Types.DECIMAL
• Types.INTEGER
• Types.SMALLINT
• Types.TIMESTAMP
• Types.TIME
• Types.VARCHAR

Parameters:

ps - (PreparedStatement) The SQL prepared statement that is to have a value set.

obj - (JDBCObject) The object that contains the value to set.

fldname - (String) The name of the field for the value to set.

fldtype - (int) The type of field for the value to set.

fldnull - (boolean) The nullable flag of field for the value to set.

parmidx - (int) The index of the parameter to set.

Throws:

java.lang.Exception - - if an error occurs while setting the parameter value.

update

public boolean update(DBOBJ obj)

Updates an existing record in the table associated with the controller.

Parameters:

obj - (JDBCObject) The object for the record to be updated.

Returns:

boolean - true if the record updated successfully, otherwise false.

update

public int update(java.lang.String[] data)

Updates an existing record in the table associated with the controller using the given string array of field values. The array of values is assumed to be in the same order as the fields in the table. Invoked during sync while processing incoming records from the server.

NOTE: This method provides no actual logic and always returns success. Subclasses must provide their own implementation of what's needed here.

Parameters:

data - (String[]) A string array of field values.

Returns:

int - 0 = success, 1 = field count mismatch, 2 = conversion error, 5 = record not found, 6+ = other error.

valuesToObject

public DBOBJ valuesToObject(java.util.HashMap<java.lang.String,java.lang.Object> attrs)

Returns a database object from the given set of attributes.

Parameters:

attrs - (HashMap) The attributes to assign to the new object.

Returns:

JDBCObject - An object initialized with the specified attributes.