com.dpslink.base.obj

Class MappedAttributesObject

java.lang.Object

com.dpslink.base.obj.MappedAttributesObject

All Implemented Interfaces:

java.io.Serializable

Direct Known Subclasses:

AbstractField, ERPInterfaceAS400, ERPInterfaceBogus, ERPObject, FlashServletRequest, FlashSiteInfo, GenericMappedObject, JDBCObject, JDBCObjectController, NotificationMessage, Option, ThreadServletContext, UnitMeasureHandler.MultiPriceBreak

public abstract class MappedAttributesObject
extends java.lang.Object
implements java.io.Serializable

An abstract serializable object definition that provides storage and retrieval of mapped attributes.

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
protected int	ivHashCode The object's hash code.
protected java.lang.String[]	ivHashFlds The object's set of hash code field names.
protected java.util.HashMap<java.lang.String,java.lang.Object>	ivObjAttrs The object's attribute field names and values.
private static long	serialVersionUID The class' serialization version id.

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	MappedAttributesObject() The constructor for the abstract object.
protected	MappedAttributesObject(java.lang.String[] hashflds) The constructor for the abstract object.

Method Summary

Modifier and Type	Method and Description
void	cloneMapAttributes(MappedAttributesObject obj) Clones this object's map of attribute field names and values and assigns the cloned map of attributes to the given object.
abstract boolean	equals(java.lang.Object obj) Compares the given object to this object and determines if the two are equal.
java.lang.String	formatValue(java.lang.String fldname) Returns a formatted string for the given field name.
java.lang.String	formatValue(java.lang.String fldname, boolean fmtgrps) Returns a formatted string for the given field name.
java.lang.String[]	getHashFields() Returns this object's set of hash code field names.
protected java.util.ArrayList<?>	getMapArrayList(java.lang.String fldname) Returns a field's value from the map of attributes as an array list.
java.util.HashMap<java.lang.String,java.lang.Object>	getMapAttributes() Returns the map of object attribute field names and values.
protected java.math.BigDecimal	getMapBigDecimal(java.lang.String fldname) Returns a field's value from the map of attributes as a big decimal.
protected boolean	getMapBoolean(java.lang.String fldname) Returns a field's value from the map of attributes as a boolean.
protected java.util.Date	getMapDate(java.lang.String fldname) Returns a field's value from the map of attributes as a date.
protected double	getMapDouble(java.lang.String fldname) Returns a field's value from the map of attributes as a double.
protected int	getMapInteger(java.lang.String fldname) Returns a field's value from the map of attributes as an int.
protected long	getMapLong(java.lang.String fldname) Returns a field's value from the map of attributes as a long.
protected MappedAttributesObject	getMapMapped(java.lang.String fldname) Returns a field's value from the map of attributes as a mapped attributes object.
java.lang.Object	getMapObject(java.lang.String fldname) Returns a field's value from the map of attributes as an object.
protected short	getMapShort(java.lang.String fldname) Returns a field's value from the map of attributes as a short.
protected java.lang.String	getMapString(java.lang.String fldname) Returns a field's value from the map of attributes as a string.
protected java.lang.String	getMapString(java.lang.String fldname, boolean trim) Returns a field's value from the map of attributes as a string.
protected java.lang.StringBuffer	getMapStringBuffer(java.lang.String fldname) Returns a field's value from the map of attributes as a string buffer.
protected java.lang.StringBuilder	getMapStringBuilder(java.lang.String fldname) Returns a field's value from the map of attributes as a string builder.
protected java.sql.Time	getMapTime(java.lang.String fldname) Returns a field's value from the map of attributes as a date.
protected java.util.Date	getMapTimestamp(java.lang.String fldname) Returns a field's value from the map of attributes as a date.
protected java.util.Vector<?>	getMapVector(java.lang.String fldname) Returns a field's value from the map of attributes as a vector.
int	hashCode() Returns a hash code for this object based on the field names supplied on the constructor.
void	setHashFields(java.lang.String[] hashFlds) Sets this object's set of hash code field names.
protected void	setMap(java.lang.String fldname, java.util.ArrayList<?> value) Sets a field's value in the map of attributes to an array list.
protected void	setMap(java.lang.String fldname, java.math.BigDecimal value) Sets a field's value in the map of attributes to a big decimal.
protected void	setMap(java.lang.String fldname, boolean value) Sets a field's value in the map of attributes to a boolean.
protected void	setMap(java.lang.String fldname, java.util.Date value) Sets a field's value in the map of attributes to a date.
protected void	setMap(java.lang.String fldname, double value) Sets a field's value in the map of attributes to a double.
protected void	setMap(java.lang.String fldname, int value) Sets a field's value in the map of attributes to an int.
protected void	setMap(java.lang.String fldname, long value) Sets a field's value in the map of attributes to a long.
protected void	setMap(java.lang.String fldname, MappedAttributesObject value) Sets a field's value in the map of attributes to a mapped attributes object.
protected void	setMap(java.lang.String fldname, short value) Sets a field's value in the map of attributes to a short.
protected void	setMap(java.lang.String fldname, java.lang.String value) Sets a field's value in the map of attributes to a string.
protected void	setMap(java.lang.String fldname, java.lang.String value, boolean trim) Sets a field's value in the map of attributes to a string.
protected void	setMap(java.lang.String fldname, java.lang.StringBuffer value) Sets a field's value in the map of attributes to a string buffer.
protected void	setMap(java.lang.String fldname, java.lang.StringBuilder value) Sets a field's value in the map of attributes to a string builder.
protected void	setMap(java.lang.String fldname, java.sql.Time value) Sets a field's value in the map of attributes to a time.
protected void	setMap(java.lang.String fldname, java.util.Vector<?> value) Sets a field's value in the map of attributes to a vector.
void	setMapAttributes(java.util.HashMap<java.lang.String,java.lang.Object> attrs) Sets the map of object attribute field names and values.
void	setMapObject(java.lang.String fldname, java.lang.Object value) Sets a field's value in the map of attributes to an object.
protected void	setMapTime(java.lang.String fldname, java.util.Date value) Sets a field's value in the map of attributes to a time.
protected void	setMapTimestamp(java.lang.String fldname, java.util.Date value) Sets a field's value in the map of attributes to a timestamp.
java.lang.String[]	toStringArray(java.lang.String[] fields) Returns a formatted string array for the given array of field names.

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

ivObjAttrs

protected java.util.HashMap<java.lang.String,java.lang.Object> ivObjAttrs

The object's attribute field names and values.

ivHashFlds

protected java.lang.String[] ivHashFlds

The object's set of hash code field names.

ivHashCode

protected int ivHashCode

The object's hash code.

Constructor Detail

MappedAttributesObject

protected MappedAttributesObject()

The constructor for the abstract object. Initializes all field values to null. The object's hash code is zero.

MappedAttributesObject

protected MappedAttributesObject(java.lang.String[] hashflds)

The constructor for the abstract object. Initializes all field values to null.

Parameters:

hashflds - (String[]) The set of field names used to determine the object's hash code. The field names supplied should match the fields referenced in the object's equals method. If no fields names are supplied, the object's hash code is zero.

Method Detail

cloneMapAttributes

public void cloneMapAttributes(MappedAttributesObject obj)
                        throws java.lang.CloneNotSupportedException

Clones this object's map of attribute field names and values and assigns the cloned map of attributes to the given object.

Parameters:

obj - (MappedAttributesObject) The object that will be assigned the cloned map of attributes.

Throws:

java.lang.CloneNotSupportedException - - if one or more of this object's attributes cannot be cloned.

getHashFields

public java.lang.String[] getHashFields()

Returns this object's set of hash code field names.

Returns:

String[] - The hash code field names.

setHashFields

public void setHashFields(java.lang.String[] hashFlds)

Sets this object's set of hash code field names.

Parameters:

hashFlds - (String[]) The hash code field names.

getMapAttributes

public java.util.HashMap<java.lang.String,java.lang.Object> getMapAttributes()

Returns the map of object attribute field names and values.

Returns:

HashMap - The object's attribute field names and values.

setMapAttributes

public void setMapAttributes(java.util.HashMap<java.lang.String,java.lang.Object> attrs)

Sets the map of object attribute field names and values.

Parameters:

attrs - (HashMap) The object's attribute field names values.

getMapArrayList

protected java.util.ArrayList<?> getMapArrayList(java.lang.String fldname)

Returns a field's value from the map of attributes as an array list.

Parameters:

fldname - (String) The name of the field to retrieve.

Returns:

ArrayList - The specified field's value.

getMapBigDecimal

protected java.math.BigDecimal getMapBigDecimal(java.lang.String fldname)

Returns a field's value from the map of attributes as a big decimal.

Parameters:

fldname - (String) The name of the field to retrieve.

Returns:

BigDecimal - The specified field's value.

getMapBoolean

protected boolean getMapBoolean(java.lang.String fldname)

Returns a field's value from the map of attributes as a boolean.

Parameters:

fldname - (String) The name of the field to retrieve.

Returns:

boolean - The specified field's value.

getMapDate

protected java.util.Date getMapDate(java.lang.String fldname)

Returns a field's value from the map of attributes as a date.

Parameters:

fldname - (String) The name of the field to retrieve.

Returns:

java.util.Date - The specified field's value.

getMapDouble

protected double getMapDouble(java.lang.String fldname)

Returns a field's value from the map of attributes as a double.

Parameters:

fldname - (String) The name of the field to retrieve.

Returns:

double - The specified field's value.

getMapInteger

protected int getMapInteger(java.lang.String fldname)

Returns a field's value from the map of attributes as an int.

Parameters:

fldname - (String) The name of the field to retrieve.

Returns:

int - The specified field's value.

getMapLong

protected long getMapLong(java.lang.String fldname)

Returns a field's value from the map of attributes as a long.

Parameters:

fldname - (String) The name of the field to retrieve.

Returns:

long - The specified field's value.

getMapMapped

protected MappedAttributesObject getMapMapped(java.lang.String fldname)

Returns a field's value from the map of attributes as a mapped attributes object.

Parameters:

fldname - (String) The name of the field to retrieve.

Returns:

MappedAttributesObject - The specified field's value.

getMapObject

public java.lang.Object getMapObject(java.lang.String fldname)

Returns a field's value from the map of attributes as an object.

Parameters:

fldname - (String) The name of the field to retrieve.

Returns:

Object - The specified field's value.

getMapShort

protected short getMapShort(java.lang.String fldname)

Returns a field's value from the map of attributes as a short.

Parameters:

fldname - (String) The name of the field to retrieve.

Returns:

short - The specified field's value.

getMapString

protected java.lang.String getMapString(java.lang.String fldname)

Returns a field's value from the map of attributes as a string. Assumes the returned value should be trimmed.

Parameters:

fldname - (String) The name of the field to retrieve.

Returns:

String - The specified field's value.

getMapString

protected java.lang.String getMapString(java.lang.String fldname,
                                        boolean trim)

Returns a field's value from the map of attributes as a string.

Parameters:

fldname - (String) The name of the field to retrieve.

trim - (boolean) true if the returned value should be trimmed, otherwise false.

Returns:

String - The specified field's value.

getMapStringBuffer

protected java.lang.StringBuffer getMapStringBuffer(java.lang.String fldname)

Returns a field's value from the map of attributes as a string buffer.

Parameters:

fldname - (String) The name of the field to retrieve.

Returns:

StringBuffer - The specified field's value.

getMapStringBuilder

protected java.lang.StringBuilder getMapStringBuilder(java.lang.String fldname)

Returns a field's value from the map of attributes as a string builder.

Parameters:

fldname - (String) The name of the field to retrieve.

Returns:

StringBuilder - The specified field's value.

getMapTime

protected java.sql.Time getMapTime(java.lang.String fldname)

Returns a field's value from the map of attributes as a date.

Parameters:

fldname - (String) The name of the field to retrieve.

Returns:

java.sql.Time - The specified field's value.

getMapTimestamp

protected java.util.Date getMapTimestamp(java.lang.String fldname)

Returns a field's value from the map of attributes as a date.

Parameters:

fldname - (String) The name of the field to retrieve.

Returns:

java.util.Date - The specified field's value.

getMapVector

protected java.util.Vector<?> getMapVector(java.lang.String fldname)

Returns a field's value from the map of attributes as a vector.

Parameters:

fldname - (String) The name of the field to retrieve.

Returns:

Vector - The specified field's value.

setMap

protected void setMap(java.lang.String fldname,
                      java.util.ArrayList<?> value)

Sets a field's value in the map of attributes to an array list.

Parameters:

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

value - (ArrayList) The array list value to set.

setMap

protected void setMap(java.lang.String fldname,
                      java.math.BigDecimal value)

Sets a field's value in the map of attributes to a big decimal.

Parameters:

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

value - (BigDecimal) The value to set.

setMap

protected void setMap(java.lang.String fldname,
                      boolean value)

Sets a field's value in the map of attributes to a boolean.

Parameters:

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

value - (boolean) The value to set.

setMap

protected void setMap(java.lang.String fldname,
                      java.sql.Time value)

Sets a field's value in the map of attributes to a time.

Parameters:

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

value - (java.sql.Time) The value to set.

setMap

protected void setMap(java.lang.String fldname,
                      java.util.Date value)

Sets a field's value in the map of attributes to a date.

Parameters:

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

value - (java.util.Date) The value to set.

setMap

protected void setMap(java.lang.String fldname,
                      double value)

Sets a field's value in the map of attributes to a double.

Parameters:

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

value - (double) The value to set.

setMap

protected void setMap(java.lang.String fldname,
                      int value)

Sets a field's value in the map of attributes to an int.

Parameters:

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

value - (int) The value to set.

setMap

protected void setMap(java.lang.String fldname,
                      long value)

Sets a field's value in the map of attributes to a long.

Parameters:

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

value - (long) The value to set.

setMap

protected void setMap(java.lang.String fldname,
                      MappedAttributesObject value)

Sets a field's value in the map of attributes to a mapped attributes object.

Parameters:

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

value - (MappedAttributesObject) The value to set.

setMap

protected void setMap(java.lang.String fldname,
                      short value)

Sets a field's value in the map of attributes to a short.

Parameters:

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

value - (short) The value to set.

setMap

protected void setMap(java.lang.String fldname,
                      java.lang.String value)

Sets a field's value in the map of attributes to a string. Assumes the string value should be trimmed.

Parameters:

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

value - (String) The value to set.

setMap

protected void setMap(java.lang.String fldname,
                      java.lang.String value,
                      boolean trim)

Sets a field's value in the map of attributes to a string.

Parameters:

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

value - (String) The value to set.

trim - (boolean) true if the string value should be trimmed, otherwise false.

setMap

protected void setMap(java.lang.String fldname,
                      java.lang.StringBuffer value)

Sets a field's value in the map of attributes to a string buffer.

Parameters:

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

value - (StringBuffer) The value to set.

setMap

protected void setMap(java.lang.String fldname,
                      java.lang.StringBuilder value)

Sets a field's value in the map of attributes to a string builder.

Parameters:

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

value - (StringBuilder) The value to set.

setMap

protected void setMap(java.lang.String fldname,
                      java.util.Vector<?> value)

Sets a field's value in the map of attributes to a vector.

Parameters:

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

value - (Vector) The vector value to set.

setMapObject

public void setMapObject(java.lang.String fldname,
                         java.lang.Object value)

Sets a field's value in the map of attributes to an object.

Parameters:

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

value - (Object) The object value to set.

setMapTime

protected void setMapTime(java.lang.String fldname,
                          java.util.Date value)

Sets a field's value in the map of attributes to a time.

Parameters:

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

value - (java.util.Date) The value to set.

setMapTimestamp

protected void setMapTimestamp(java.lang.String fldname,
                               java.util.Date value)

Sets a field's value in the map of attributes to a timestamp.

Parameters:

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

value - (java.util.Date) The value to set.

toStringArray

public java.lang.String[] toStringArray(java.lang.String[] fields)

Returns a formatted string array for the given array of field names. The values in the returned array are in the same sequence as the given array of field names.

Parameters:

fields - (String[]) An array of table field names.

Returns:

String[] - A formatted array of field values.

formatValue

public java.lang.String formatValue(java.lang.String fldname)

Returns a formatted string for the given field name.

For numbers: zero values are always formatted and always includes grouping separators.

Parameters:

fldname - (String) The name of the field to format.

Returns:

String - The field's formatted value.

formatValue

public java.lang.String formatValue(java.lang.String fldname,
                                    boolean fmtgrps)

Returns a formatted string for the given field name.

For numbers: zero values are always formatted and optionally includes grouping separators.

Parameters:

fldname - (String) The name of the field to format.

fmtgrps - (boolean) true if grouping separators are to be included, otherwise false.

Returns:

String - The field's formatted value.

hashCode

public int hashCode()

Returns a hash code for this object based on the field names supplied on the constructor.

Overrides:

hashCode in class java.lang.Object

Returns:

int - The object's hash code.

equals

public abstract boolean equals(java.lang.Object obj)

Compares the given object to this object and determines if the two are equal.

Overrides:

equals in class java.lang.Object

Parameters:

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

Returns:

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