com.dpslink.flash.db

Class StateController

java.lang.Object

com.dpslink.base.obj.MappedAttributesObject

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

com.dpslink.flash.db.StateController

All Implemented Interfaces:

java.io.Serializable

public class StateController
extends JDBCObjectController<State>

The controller for the State class. Provides methods for retrieving and persisting state and province table records in the database.

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
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
StateController() The constructor for the controller.

Method Summary

Modifier and Type	Method and Description
State	get(java.lang.String code) Returns the state record for the given state code.
State	get(java.lang.String code, java.lang.String cntry) Returns the state record for the given state code and country code.
java.util.ArrayList<State>	getAll() Returns a collection of all state records.
java.util.ArrayList<State>	getAll(boolean blanks) Returns a collection of all state records.
java.util.ArrayList<State>	getCountry(java.lang.String code) Returns a collection of state records for a given country code.
Select	getUISelect(java.lang.String code, java.lang.String cntry) Returns an HTML Select object that contains all states and has the given code as the preselected code in the set of options.
State	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.jdbc.JDBCObjectController

add, add, add, arrayToMap, arrayToMap, countAll, delete, delete, deleteAll, 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, update

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

Constructor Detail

StateController

public StateController()

The constructor for the controller.

Method Detail

valuesToObject

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

Returns a database object from the given set of attributes. Overrides valuesToObject in JDBCObjectController.

Overrides:

valuesToObject in class JDBCObjectController<State>

Parameters:

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

Returns:

State - An object initialized with the specified attributes.

get

public State get(java.lang.String code)

Returns the state record for the given state code.

Parameters:

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

Returns:

State - An object initialized with values from the database.

get

public State get(java.lang.String code,
                 java.lang.String cntry)

Returns the state record for the given state code and country code.

Parameters:

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

cntry - (String) The country code for the desired record.

Returns:

State - An object initialized with values from the database.

getAll

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

Returns a collection of all state records. Does not include blank state codes.

Overrides:

getAll in class JDBCObjectController<State>

Returns:

ArrayList - A collection of all states.

getAll

public java.util.ArrayList<State> getAll(boolean blanks)

Returns a collection of all state records. Optionally includes blank state codes.

Parameters:

blanks - (boolean) true to include blank state codes, otherwise false.

Returns:

ArrayList - A collection of all states.

getCountry

public java.util.ArrayList<State> getCountry(java.lang.String code)

Returns a collection of state records for a given country code.

Parameters:

code - (String) The country code for the desired records.

Returns:

ArrayList - A collection of states for the country.

getUISelect

public Select getUISelect(java.lang.String code,
                          java.lang.String cntry)

Returns an HTML Select object that contains all states 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 state 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.

cntry - (String) The country code for the state to preselect. Pass an empty string for this parameter if a state is not supplied or if the country is not known.

Returns:

Select - An HTML Select object.