com.dpslink.flash.db.util

Class ProductLookupHandler

java.lang.Object

com.dpslink.flash.db.util.DBUHandler

com.dpslink.flash.db.util.ProductLookupHandler

All Implemented Interfaces:

DBUInterface, java.io.Serializable

public class ProductLookupHandler
extends DBUHandler

Handles the retrieving of a product using a scanned or entered code. The scanned or entered code could be a product code, a UPC, a customer part number or a manufacturer part number.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
class	ProductLookupHandler.ERPItem Inner class that defines the fields and methods for an ERP item object.

Field Summary

Fields

Modifier and Type	Field and Description
protected JDBCConnectionInfo	ivERPConn The current JDBC connection to the backend ERP system.
private static long	serialVersionUID The class' serialization version id.
protected static boolean	UPCA_PREFIX The configured flag for including UPCA prefix.
protected static boolean	UPCA_SUFFIX The configured flag for including UPCA suffix.
protected static boolean	UPCE_EXPAND The configured flag for including UPCE prefix.
protected static boolean	UPCE_PREFIX The configured flag for including UPCE prefix.
protected static boolean	UPCE_SUFFIX The configured flag for including UPCE suffix.

Fields inherited from class com.dpslink.flash.db.util.DBUHandler

ivContext

Constructor Summary

Constructors

Constructor and Description
ProductLookupHandler() Constructs a new instance of the product lookup handler with a null servlet or thread context.

Method Summary

Modifier and Type	Method and Description
Product	findProduct(java.lang.String code, java.lang.String format) Finds the product for a given code and format.
protected Product	findProduct(java.lang.String code, java.lang.String format, int start) Finds the product for a given code and format.
protected Product	findProductInERP(java.lang.String code) Finds the product for a given code in the backend ERP database.
protected Product	findProductInFlash(java.lang.String code) Finds the product for a given code in the frontend Flash database.
protected java.lang.String	getModifiedCode(java.lang.String code, java.lang.String format, int iteration) Returns the given code's modified code based on the given format, where the modified code might be an expansion of the given code and/or one that has had its prefix and/or suffix information removed (based on configured parameters).
protected java.lang.String	getModifiedUPCA(java.lang.String code, int iteration) Returns the given code's modified UPCA code.
protected java.lang.String	getModifiedUPCE(java.lang.String code, int iteration) Returns the given code's modified UPCE code.
protected boolean	isFormatManual(java.lang.String format) Answers if the given format is for manual entry.
protected boolean	isFormatUPCA(java.lang.String format) Answers if the given format is for a UPCA barcode.
protected boolean	isFormatUPCE(java.lang.String format) Answers if the given format is for a UPCE barcode.
protected boolean	isPossibleUPCA(java.lang.String code, java.lang.String format) Answers if the given code and format represents a possible UPCA barcode.
protected boolean	isPossibleUPCE(java.lang.String code, java.lang.String format) Answers if the given code and format represent a possible UPCE barcode.

Methods inherited from class com.dpslink.flash.db.util.DBUHandler

getContext, setContext

Methods inherited from class java.lang.Object

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

Field Detail

serialVersionUID

private static final long serialVersionUID

The class' serialization version id.

See Also:

Constant Field Values

UPCA_PREFIX

protected static final boolean UPCA_PREFIX

The configured flag for including UPCA prefix.

UPCA_SUFFIX

protected static final boolean UPCA_SUFFIX

The configured flag for including UPCA suffix.

UPCE_EXPAND

protected static final boolean UPCE_EXPAND

The configured flag for including UPCE prefix.

UPCE_PREFIX

protected static final boolean UPCE_PREFIX

The configured flag for including UPCE prefix.

UPCE_SUFFIX

protected static final boolean UPCE_SUFFIX

The configured flag for including UPCE suffix.

ivERPConn

protected JDBCConnectionInfo ivERPConn

The current JDBC connection to the backend ERP system.

Constructor Detail

ProductLookupHandler

public ProductLookupHandler()

Constructs a new instance of the product lookup handler with a null servlet or thread context.

A CONTEXT MUST BE SET BEFORE INVOKING ANY OTHER METHODS.

.

Method Detail

findProduct

public Product findProduct(java.lang.String code,
                           java.lang.String format)

Finds the product for a given code and format.

Parameters:

code - (String) The code to use for performing the lookup.

format - (String) The format of the lookup code (manual, UPC_A, UPC_E, EAN_8, EAN_13, CODE_39, CODE_128, etc.).

Returns:

Product - The found product or null if no product was found.

findProduct

protected Product findProduct(java.lang.String code,
                              java.lang.String format,
                              int start)

Finds the product for a given code and format.

Parameters:

code - (String) The code to use for performing the lookup.

format - (String) The format of the lookup code (manual, UPC_A, UPC_E, EAN_8, EAN_13, CODE_39, CODE_128, etc.).

start - (int) The starting iteration to process when attempting to find a matching product. Possible values are 1, 2 or 3.

Returns:

Product - The found product or null if no product was found.

findProductInERP

protected Product findProductInERP(java.lang.String code)

Finds the product for a given code in the backend ERP database.

Parameters:

code - (String) The code to use for performing the lookup.

Returns:

Product - The found product or null if no product was found.

findProductInFlash

protected Product findProductInFlash(java.lang.String code)

Finds the product for a given code in the frontend Flash database.

Parameters:

code - (String) The code to use for performing the lookup.

Returns:

Product - The found product or null if no product was found.

getModifiedCode

protected java.lang.String getModifiedCode(java.lang.String code,
                                           java.lang.String format,
                                           int iteration)

Returns the given code's modified code based on the given format, where the modified code might be an expansion of the given code and/or one that has had its prefix and/or suffix information removed (based on configured parameters).

Parameters:

code - (String) The code to modify.

format - (String) The format of the code to modify (manual, UPC_A, UPC_E, EAN_8, EAN_13, CODE_39, CODE_128, etc.).

iteration - (int) The current lookup iteration being made to find a matching product. Possible values are 1, 2 or 3. The first iteration will always return the given code as is. The second and third iterations will return a modified code depending on the given format and any corresponding configuration values for the format.

Returns:

String - The code's modified code.

getModifiedUPCA

protected java.lang.String getModifiedUPCA(java.lang.String code,
                                           int iteration)

Returns the given code's modified UPCA code.

Parameters:

code - (String) The code to modify.

iteration - (int) The current lookup iteration being made to find a matching product. Possible values are 2 or 3.

Returns:

String - The code's modified UPCA code.

getModifiedUPCE

protected java.lang.String getModifiedUPCE(java.lang.String code,
                                           int iteration)

Returns the given code's modified UPCE code.

Parameters:

code - (String) The code to modify.

iteration - (int) The current lookup iteration being made to find a matching product. Possible values are 2 or 3.

Returns:

String - The code's modified UPCE code.

isFormatManual

protected boolean isFormatManual(java.lang.String format)

Answers if the given format is for manual entry.

Parameters:

format - (String) The format to check.

Returns:

boolean - true if the format is manual entry, otherwise false.

isFormatUPCA

protected boolean isFormatUPCA(java.lang.String format)

Answers if the given format is for a UPCA barcode.

Parameters:

format - (String) The format to check.

Returns:

boolean - true if the format is UPCA barcode, otherwise false.

isFormatUPCE

protected boolean isFormatUPCE(java.lang.String format)

Answers if the given format is for a UPCE barcode.

Parameters:

format - (String) The format to check.

Returns:

boolean - true if the format is UPCE barcode, otherwise false.

isPossibleUPCA

protected boolean isPossibleUPCA(java.lang.String code,
                                 java.lang.String format)

Answers if the given code and format represents a possible UPCA barcode. The two are considered to represent a possible UPCA barcode if the format is "manual" and the code consists of 12 digits and the site is configured to exclude UPCA prefixes and/or suffixes.

Parameters:

code - (String) The code to check.

format - (String) The format to check.

Returns:

boolean - true if the code and format potentially represent a UPCA barcode, otherwise false.

isPossibleUPCE

protected boolean isPossibleUPCE(java.lang.String code,
                                 java.lang.String format)

Answers if the given code and format represent a possible UPCE barcode. The two are considered to represent a possible UPCE barcode if the format is "manual" and the code consists of either 6 or 8 digits and the site is configured to expand UPCE to UPCA or the code consists of 8 digits and the site is configured to exclude UPCE prefixes and/or suffixes.

Parameters:

code - (String) The code to check.

format - (String) The format to check.

Returns:

boolean - true if the code and format potentially represent a UPCE barcode, otherwise false.