com.dpslink.base.jdbc

Class JDBCObject<DBOBJ extends MappedAttributesObject>

java.lang.Object

com.dpslink.base.obj.MappedAttributesObject

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

All Implemented Interfaces:

JDBCObjectKey<DBOBJ>, java.io.Serializable, java.lang.Comparable<DBOBJ>

Direct Known Subclasses:

AdmPurgeCategories.CatalogPath, Cart, CartAdjustmentLine, CartConfirmationLine, CartLine, CatalogCategory, CatalogProduct, Category, CategoryListItem, CDBatch, Country, CreditCard, Customer, FavoritesDescriptor, ImportBatch, ImportCriteria, ImportMetaCriteria, ImportValidation, JDBCGenericObject, Leadtime, LogonAttempt, Manufacturer, NotificationPref, OrderAudit, OrderAuditLine, OrderRequest, OrderRequestLine, PasswordHistory, PendingProduct, Permit, PermitProduct, PermitUser, Product, ProductAttribute, ProductAttributeDescriptor, ProductGroup, ProductGroupXref, ProductLookupHandler.ERPItem, Products.SelectableFilter, PunchOutSession, QuantityOnOrder, QuantityPriceBreak, RelatedProductsXref, RelationshipType, RestockNotification, SalesRep, SalesRepCustomer, SalesRepUser, SearchLogProduct, SecurityProfile, Shipper, ShipperCountry, SiteActivity, SiteActivityPage, Special, SpecialsType, State, UnitMeasure, User, WarehouseDetail, WarehouseQuantity, WordFix, Xref

public abstract class JDBCObject<DBOBJ extends MappedAttributesObject>
extends MappedAttributesObject
implements java.lang.Comparable<DBOBJ>, JDBCObjectKey<DBOBJ>

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

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
static java.util.Date	LOWVAL_RPG_DATE The *LOWVAL value for an empty date field as used by RPG (01-01-0001).
static java.sql.Time	LOWVAL_RPG_TIME The *LOWVAL value for an empty time field as used by RPG (00:00:00).
private static long	serialVersionUID The class' serialization version id.
static java.lang.String	STATUS_ACTIVE The status code for an active object.
static java.lang.String	STATUS_BLANK The status code for an active object.
static java.lang.String	STATUS_CANCELED The status code for a canceled object.
static java.lang.String	STATUS_DELETED The status code for a deleted object.
static java.lang.String	STATUS_INACTIVE The status code for an inactive object.
static java.lang.String	STATUS_PENDING The status code for pending object.

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

ivHashCode, ivHashFlds, ivObjAttrs

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
boolean	after(DBOBJ obj) Answers if this object is greater than the given object based on the object's compareTo method results.
boolean	before(DBOBJ obj) Answers if this object is less than the given object based on the object's compareTo method results.
int	compareTo(DBOBJ obj) Compares this object to the given object and determines if this object is less than, equal to or greater than the given object.
boolean	equals(java.lang.Object obj) Compares the given object to this object and determines if the two are equal.
java.lang.String	fmtStatus() Returns a formatted string for the status field.
java.lang.String	fmtStatus(java.lang.String fldname) Returns a formatted string for the given status field name.
java.lang.String	getObjectStatus() Returns the object's status code.
DBOBJ	hashKey() Returns a lightweight instance of this object which only contains the attributes for the hash code fields that were defined in the object's constructor.
void	setObjectStatus(java.lang.String value) Sets the object's status code.

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

STATUS_BLANK

public static final java.lang.String STATUS_BLANK

The status code for an active object.

See Also:

Constant Field Values

STATUS_ACTIVE

public static final java.lang.String STATUS_ACTIVE

The status code for an active object.

See Also:

Constant Field Values

STATUS_CANCELED

public static final java.lang.String STATUS_CANCELED

The status code for a canceled object.

See Also:

Constant Field Values

STATUS_DELETED

public static final java.lang.String STATUS_DELETED

The status code for a deleted object.

See Also:

Constant Field Values

STATUS_INACTIVE

public static final java.lang.String STATUS_INACTIVE

The status code for an inactive object.

See Also:

Constant Field Values

STATUS_PENDING

public static final java.lang.String STATUS_PENDING

The status code for pending object.

See Also:

Constant Field Values

LOWVAL_RPG_DATE

public static final java.util.Date LOWVAL_RPG_DATE

The *LOWVAL value for an empty date field as used by RPG (01-01-0001).

LOWVAL_RPG_TIME

public static final java.sql.Time LOWVAL_RPG_TIME

The *LOWVAL value for an empty time field as used by RPG (00:00:00).

Constructor Detail

JDBCObject

protected JDBCObject()

The constructor for the abstract object. Initializes all field values to null. The object's configured db table key fields are used to determine the object's hash code (db.[tblname].Primary, db.[tblname].Index.0). If no configured key fields are found, the object's hash code is zero.

JDBCObject

protected JDBCObject(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

compareTo

public int compareTo(DBOBJ obj)

Compares this object to the given object and determines if this object is less than, equal to or greater than the given object. Comparison is based on hash code fields that were defined in the object's constructor.

Specified by:

compareTo in interface java.lang.Comparable<DBOBJ extends MappedAttributesObject>

Parameters:

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

Returns:

int - The result of the comparison: a negative integer if less than, a positive integer if greater than, a zero if equal.

hashKey

public DBOBJ hashKey()

Returns a lightweight instance of this object which only contains the attributes for the hash code fields that were defined in the object's constructor.

Specified by:

hashKey in interface JDBCObjectKey<DBOBJ extends MappedAttributesObject>

Returns:

DBOBJ - A lightweight instance of this object.

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 hash code fields that were defined in the object's constructor.

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.

after

public boolean after(DBOBJ obj)

Answers if this object is greater than the given object based on the object's compareTo method results.

Parameters:

obj - (DBJOB) The object to compare to this object to.

Returns:

boolean - true if this object is greater than the given object, otherwise false.

before

public boolean before(DBOBJ obj)

Answers if this object is less than the given object based on the object's compareTo method results.

Parameters:

obj - (DBJOB) The object to compare to this object to.

Returns:

boolean - true if this object is less than the given object, otherwise false.

getObjectStatus

public java.lang.String getObjectStatus()

Returns the object's status code.

This code is typically used during maintenance routines to temporarily flag an object within a collection of objects with a particular status.

Returns:

String - The object's status code.

setObjectStatus

public void setObjectStatus(java.lang.String value)

Sets the object's status code.

This code is typically used during maintenance routines to temporarily flag an object within a collection of objects with a particular status.

Parameters:

value - (String) The object's status code.

fmtStatus

public java.lang.String fmtStatus()

Returns a formatted string for the status field. This method assumes the status field name is "status".

Returns:

String - The status field's formatted value.

fmtStatus

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

Returns a formatted string for the given status field name.

Parameters:

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

Returns:

String - The status field's formatted value.