com.dpslink.flash.imports

Class Import<DBOBJ extends JDBCObject<?>>

java.lang.Object

com.dpslink.flash.imports.Import<DBOBJ>

All Implemented Interfaces:

java.io.Serializable

Direct Known Subclasses:

CatalogCategoryImport, CatalogProductImport, CategoryImport, CustomerImport, FavoritesDescriptorImport, FavoritesItemImport, ManufacturerImport, PermitImport, PermitProductImport, PermitUserImport, ProductAttributeImport, ProductGroupImport, ProductGroupXrefImport, ProductImport, RelatedProductsXrefImport, RelationshipTypeImport, SalesRepCustomerImport, SalesRepImport, SalesRepUserImport, SecurityProfileImport, SpecialsImport, UserImport, XrefImport

public abstract class Import<DBOBJ extends JDBCObject<?>>
extends java.lang.Object
implements java.io.Serializable

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

NOTE: A single instance of the implementing class is cached by ImportProcessor and used throughout the import processing.

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
static int	ACTION_ADD The action code for add.
static int	ACTION_CLEAR The action code for clear.
static int	ACTION_DELETE The action code for delete.
static int	ACTION_UPDATE The action code for update.
static int	ACTION_UPDATE_ADD The action code for update-add.
private java.lang.String	ivClassPrefix The import object's class name prefix (the class name sans the "Import" suffix).
protected FlashServletContext	ivContext The current context for the servlet or thread using the object.
protected int	ivLineNo The current line number being processed.
protected int	ivNumFields The number of fields in an import record.
protected DBOBJ	ivObject The database object being added, updated or deleted.
protected boolean	ivStarAll A flag indicating if doing *ALL wildcard processing.
protected java.lang.String	ivTextLine The current line of import text data being processed.
protected boolean	ivUseMixedCase A flag indicating if doing mixed-case processing.
protected java.util.HashMap<java.lang.String,java.lang.String>	ivValues The values from the supplied set of data.
private static java.util.regex.Pattern	REGEX_DECIMAL The regular expression for determining a valid decimal number.
private static java.util.regex.Pattern	REGEX_INTEGER The regular expression for determining a valid integer number.
private static long	serialVersionUID The class' serialization version id.

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	Import() The constructor for the abstract import object.

Method Summary

Modifier and Type	Method and Description
protected abstract boolean	addRecord() Adds a new record to the Flash database.
protected abstract boolean	deleteRecord() Deletes an existing record from the Flash database.
FlashServletContext	getContext() Returns the import object's servlet context (i.e.
protected java.lang.String	getMixedCase(java.lang.String s) Returns a mixed case string for the given string.
int	getNumFields() Returns the number of fields in an import record (does not include import record type and action code).
java.lang.String	getProperty(java.lang.String key) Returns a requested value from properties.
protected int	getTrueAction(int action) Returns the actual action to perform (add, update, delete).
abstract void	housekeeping() Garbage collection: Kills (nullifies) objects used by the import class.
abstract boolean	importData(int action, java.util.ArrayList<java.lang.String> data, int lineNo) Imports a record of data values into the Flash database.
protected boolean	isDecimal(java.lang.String value) Answers if a string value represents a valid decimal number.
protected boolean	isInteger(java.lang.String value) Answers if a string value represents a valid integer number.
protected boolean	isStarAll(java.lang.String value) Answers if a given value equals the configured *ALL wildcard value in properties.
protected boolean	isTrue(java.lang.String key) Answers if a configured value in properties is true.
protected void	log(java.lang.String msgid) Writes a IMPORT log file entry for the given message id.
protected void	log(java.lang.String msgid, java.lang.String... values) Writes a IMPORT log file entry for the given message id.
protected java.lang.String	qualifyKey(java.lang.String key) Returns the given property key prefixed with "Import." and the import object's class name sans the "Import" suffix ("Import.ivClassPrefix.key").
protected java.lang.String	qualifyMsgId(java.lang.String msgid) Returns the given message id prefixed with the import object's class name sans the "Import" suffix ("ivClassPrefix.msgid").
void	setContext(FlashServletContext ctx) Sets the import object's servlet context (i.e.
void	setTextLine(java.lang.String text) Sets the current line of import text data being processed.
protected abstract boolean	updateRecord() Updates an existing record in the Flash database.
protected abstract boolean	validForAdd() Answers if appropriate data has been supplied in order to add a record to the Flash database.
protected abstract boolean	validForDelete() Answers if appropriate data has been supplied in order to delete a record in the Flash database.
protected abstract boolean	validForUpdate() Answers if appropriate data has been supplied in order to update a record in the Flash database.

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

REGEX_INTEGER

private static final java.util.regex.Pattern REGEX_INTEGER

The regular expression for determining a valid integer number.

REGEX_DECIMAL

private static final java.util.regex.Pattern REGEX_DECIMAL

The regular expression for determining a valid decimal number.

ACTION_ADD

public static final int ACTION_ADD

The action code for add.

See Also:

Constant Field Values

ACTION_UPDATE

public static final int ACTION_UPDATE

The action code for update.

See Also:

Constant Field Values

ACTION_DELETE

public static final int ACTION_DELETE

The action code for delete.

See Also:

Constant Field Values

ACTION_UPDATE_ADD

public static final int ACTION_UPDATE_ADD

The action code for update-add.

See Also:

Constant Field Values

ACTION_CLEAR

public static final int ACTION_CLEAR

The action code for clear.

See Also:

Constant Field Values

ivClassPrefix

private java.lang.String ivClassPrefix

The import object's class name prefix (the class name sans the "Import" suffix).

ivContext

protected FlashServletContext ivContext

The current context for the servlet or thread using the object.

ivValues

protected java.util.HashMap<java.lang.String,java.lang.String> ivValues

The values from the supplied set of data.

ivObject

protected DBOBJ extends JDBCObject<?> ivObject

The database object being added, updated or deleted.

ivTextLine

protected java.lang.String ivTextLine

The current line of import text data being processed.

ivLineNo

protected int ivLineNo

The current line number being processed.

ivStarAll

protected boolean ivStarAll

A flag indicating if doing *ALL wildcard processing.

ivUseMixedCase

protected boolean ivUseMixedCase

A flag indicating if doing mixed-case processing.

ivNumFields

protected int ivNumFields

The number of fields in an import record.

Constructor Detail

Import

protected Import()

The constructor for the abstract import object.

Method Detail

getContext

public FlashServletContext getContext()

Returns the import object's servlet context (i.e. the current context for the servlet or thread using the object).

Returns:

FlashServletContext - The current servlet or thread context.

setContext

public void setContext(FlashServletContext ctx)

Sets the import object's servlet context (i.e. the current context for the servlet or thread using the object).

Parameters:

ctx - (FlashServletContext) The current servlet or thread context.

getMixedCase

protected java.lang.String getMixedCase(java.lang.String s)

Returns a mixed case string for the given string. Performs standard mixed case processing and then applies WordFix corrections to the result. This is a shortcut convenience method for getContext().getController(WordFixController.class).getMixedCase().

Parameters:

s - (String) The string to process.

Returns:

String - The processed results.

getNumFields

public int getNumFields()

Returns the number of fields in an import record (does not include import record type and action code).

Returns:

int - The number of fields.

getProperty

public java.lang.String getProperty(java.lang.String key)

Returns a requested value from properties.

Parameters:

key - (String) The key for the desired value. The key is automatically prefixed with the results of qualifyKey ("Import.ivClassPrefix.key").

Returns:

String - The value for the given key or null if the key does not exist in properties.

getTrueAction

protected int getTrueAction(int action)

Returns the actual action to perform (add, update, delete). The action could be modified depending on various factors, such as whether a database record already exists.

Parameters:

action - (int) The current action.

Returns:

int - The actual action to perform.

isDecimal

protected boolean isDecimal(java.lang.String value)

Answers if a string value represents a valid decimal number.

Parameters:

value - (String) The value to check.

Returns:

boolean - true if the value is a valid decimal, otherwise false.

isInteger

protected boolean isInteger(java.lang.String value)

Answers if a string value represents a valid integer number.

Parameters:

value - (String) The value to check.

Returns:

boolean - true if the value is a valid integer, otherwise false.

isStarAll

protected boolean isStarAll(java.lang.String value)

Answers if a given value equals the configured *ALL wildcard value in properties.

Parameters:

value - (String) The value to check.

Returns:

boolean - true if the given value is the same, otherwise false.

isTrue

protected boolean isTrue(java.lang.String key)

Answers if a configured value in properties is true.

Parameters:

key - (String) The key for the configured value to check. The key is automatically prefixed with the results of qualifyKey ("Import.ivClassPrefix.key").

Returns:

boolean - true if true, otherwise false.

log

protected void log(java.lang.String msgid)

Writes a IMPORT log file entry for the given message id.

Parameters:

msgid - (String) The id for the message to log. The msgid is automatically prefixed with "MSG.Import." plus the results of qualifyMsgId ("MSG.Import.ivClassPrefix.msgid").

log

protected void log(java.lang.String msgid,
                   java.lang.String... values)

Writes a IMPORT log file entry for the given message id.

Parameters:

msgid - (String) The id for the message to log. The msgid is automatically prefixed with "MSG.Import." plus the results of qualifyMsgId ("MSG.Import.ivClassPrefix.msgid").

values - (String) The value(s) to replace in the message text. This parameter uses the varargs feature and can therefore be passed as multiple parms (msgid, value1, value2, value3, valueN) or as an array (msgid, values[]).

qualifyKey

protected java.lang.String qualifyKey(java.lang.String key)

Returns the given property key prefixed with "Import." and the import object's class name sans the "Import" suffix ("Import.ivClassPrefix.key").

Parameters:

key - (String) The property key to qualify.

Returns:

String - The qualified results.

qualifyMsgId

protected java.lang.String qualifyMsgId(java.lang.String msgid)

Returns the given message id prefixed with the import object's class name sans the "Import" suffix ("ivClassPrefix.msgid").

Parameters:

msgid - (String) The id for the message to qualify.

Returns:

String - The qualified results.

setTextLine

public void setTextLine(java.lang.String text)

Sets the current line of import text data being processed.

Parameters:

text - (String) The current line of text.

housekeeping

public abstract void housekeeping()

Garbage collection: Kills (nullifies) objects used by the import class.

importData

public abstract boolean importData(int action,
                                   java.util.ArrayList<java.lang.String> data,
                                   int lineNo)

Imports a record of data values into the Flash database.

Parameters:

action - (int) The action code (i.e. add, update, delete).

data - (ArrayList) The set of data values to be imported. Each element corresponds to a field in the original text line.

lineNo - (int) The current line number being processed

Returns:

boolean - true if the import of data was successful, otherwise false.

addRecord

protected abstract boolean addRecord()

Adds a new record to the Flash database.

Returns:

boolean - true if the add was successful, otherwise false.

deleteRecord

protected abstract boolean deleteRecord()

Deletes an existing record from the Flash database.

Returns:

boolean - true if the delete was successful, otherwise false.

updateRecord

protected abstract boolean updateRecord()

Updates an existing record in the Flash database.

Returns:

boolean - true if the update was successful, otherwise false.

validForAdd

protected abstract boolean validForAdd()

Answers if appropriate data has been supplied in order to add a record to the Flash database.

Returns:

boolean - true if appropriate data has been supplied, otherwise false.

validForDelete

protected abstract boolean validForDelete()

Answers if appropriate data has been supplied in order to delete a record in the Flash database.

Returns:

boolean - true if appropriate data has been supplied, otherwise false.

validForUpdate

protected abstract boolean validForUpdate()

Answers if appropriate data has been supplied in order to update a record in the Flash database.

Returns:

boolean - true if appropriate data has been supplied, otherwise false.