com.dpslink.flash.db

Class UnitMeasureController

java.lang.Object

com.dpslink.base.obj.MappedAttributesObject

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

com.dpslink.flash.db.UnitMeasureController

All Implemented Interfaces:

java.io.Serializable

public class UnitMeasureController
extends JDBCObjectController<UnitMeasure>

The controller for the UnitMeasure class. Provides methods for retrieving and persisting unit of measure table records in the database.

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
private static java.util.Hashtable<java.lang.String,UnitMeasure>	cvCache The cache of all unit of measure objects per unit of measure code.
private static long	serialVersionUID The class' serialization version id.

Fields inherited from class com.dpslink.base.jdbc.JDBCObjectController

ivDBObjCls, ivFieldCount, ivFieldKeyAlt, ivFieldKeyPri, ivFieldResPfx, ivSyncLast, ivSyncType, ivTableName

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

ivHashCode, ivHashFlds, ivObjAttrs

Constructor Summary

Constructors

Constructor and Description
UnitMeasureController() The constructor for the controller.

Method Summary

Modifier and Type	Method and Description
int	add(UnitMeasure obj, boolean logdup) Adds a new record to the table associated with the controller.
boolean	delete(UnitMeasure obj) Deletes an existing record from the table associated with the controller.
boolean	deleteAll() Deletes all records in the table associated with the controller.
UnitMeasure	get(java.lang.String code) Returns the unit of measure record for the given unit of measure code.
java.util.ArrayList<UnitMeasure>	getAll() Returns a collection of all records in the table associated with the controller.
UnitMeasure	getISO(java.lang.String code) Returns the unit of measure record for the given ISO code.
Select	getUISelect(java.lang.String code) Returns an HTML Select object that contains all units of measure and has the given code as the preselected code in the set of options.
boolean	hasUom(java.lang.String code) Answers if a unit of measure code exists in the unit of measure table.
private void	loadCache() Loads the cache of units of measure with all units of measure.
boolean	update(UnitMeasure obj) Updates an existing record in the table associated with the controller.

Methods inherited from class com.dpslink.base.jdbc.JDBCObjectController

add, add, arrayToMap, arrayToMap, countAll, delete, dispose, equals, getConnection, getConnectionInfo, getController, getFieldNames, getFieldNamesForKey, getFieldNamesForUpdate, getFieldNulls, getFieldNullsForKey, getFieldNullsForUpdate, getFieldsForOrderBy, getFieldsForWhere, getFieldSize, getFieldTypes, getFieldTypesForKey, getFieldTypesForUpdate, getStatementForDelete, getStatementForGet, getStatementForGetAll, getStatementForInsert, getStatementForUpdate, getStatementKey, getStatementString, getTableName, hasFieldNamesForKey, hasFieldNamesForUpdate, isDuplicate, resultSetToArray, resultSetToMap, resultSetToMap, resultSetToObject, setConnectionInfo, setPSDeleteValues, setPSExistsValues, setPSInsertValues, setPSUpdateValues, setPSValue, update, valuesToObject

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

cvCache

private static final java.util.Hashtable<java.lang.String,UnitMeasure> cvCache

The cache of all unit of measure objects per unit of measure code.

Constructor Detail

UnitMeasureController

public UnitMeasureController()

The constructor for the controller.

Method Detail

add

public int add(UnitMeasure obj,
               boolean logdup)

Adds a new record to the table associated with the controller. Overrides add in JDBCObjectController.

Overrides:

add in class JDBCObjectController<UnitMeasure>

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 if not. When duplicates are logged, the return value of 1 is never returned.

Returns:

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

delete

public boolean delete(UnitMeasure obj)

Deletes an existing record from the table associated with the controller. Overrides delete in JDBCObjectController.

Overrides:

delete in class JDBCObjectController<UnitMeasure>

Parameters:

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

Returns:

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

deleteAll

public boolean deleteAll()

Deletes all records in the table associated with the controller. Overrides deleteAll in JDBCObjectController.

Overrides:

deleteAll in class JDBCObjectController<UnitMeasure>

Returns:

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

getAll

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

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

Overrides:

getAll in class JDBCObjectController<UnitMeasure>

Returns:

ArrayList - A collection of all records.

update

public boolean update(UnitMeasure obj)

Updates an existing record in the table associated with the controller. Overrides update in JDBCObjectController.

Overrides:

update in class JDBCObjectController<UnitMeasure>

Parameters:

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

Returns:

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

get

public UnitMeasure get(java.lang.String code)

Returns the unit of measure record for the given unit of measure code.

Parameters:

code - (String) The unit of measure code for the desired record.

Returns:

UnitMeasure - An object initialized with values from the database.

getISO

public UnitMeasure getISO(java.lang.String code)

Returns the unit of measure record for the given ISO code. If the unit of measure cannot be found with the given ISO code, then an attempt is made to retrieve the unit of measure using the ISO code as the normal code.

Parameters:

code - (String) The ISO code for the desired record.

Returns:

UnitMeasure - An object initialized with values from the database.

getUISelect

public Select getUISelect(java.lang.String code)

Returns an HTML Select object that contains all units of measure and has the given code as the preselected code in the set of options. Invokers must assign a form field name to the returned object via the setName method before adding the object to the velocity template data.

Parameters:

code - (String) The unit of measure code to preselect in the select's set of options. Pass an empty string for this parameter if a blank option is to be created as the first option and then preselected. Pass a null for this parameter if no blank option and no preselecting is desired.

Returns:

Select - An HTML Select object.

hasUom

public boolean hasUom(java.lang.String code)

Answers if a unit of measure code exists in the unit of measure table.

Parameters:

code - (String) The unit of measure code to check.

Returns:

boolean - true if the unit of measure code exists, otherwise false.

loadCache

private void loadCache()

Loads the cache of units of measure with all units of measure.