com.dpslink.flash.db.util

Class UserCatalogExportHandler

java.lang.Object

com.dpslink.flash.db.util.DBUHandler

com.dpslink.flash.db.util.UserCatalogExportHandler

All Implemented Interfaces:

DBUInterface, java.io.Serializable

public class UserCatalogExportHandler
extends DBUHandler

Handles the creation of an export file for a user's catalog.

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
protected java.util.ArrayList<java.lang.String>	ivErrors A collection of accumulated error messages.
private static long	serialVersionUID The class' serialization version id.

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

ivContext

Constructor Summary

Constructors

Constructor and Description
UserCatalogExportHandler() Constructs a new instance of the user catalog export handler with a null servlet or thread context.

Method Summary

Modifier and Type	Method and Description
protected int	exportCategoryProducts(java.io.PrintWriter out, Category category) Performs category export by iterating though all products this category contains.
protected void	exportProductData(java.io.PrintWriter out, Product product, Category category) Writes export product line data in CIF format.
java.util.ArrayList<java.lang.String>	getErrors() Returns the collection of accumulated error messages.
protected java.lang.String	getSmallDescription(Product product) Retrieves a product's small description file as a string.
boolean	run(User user, java.io.File file) Performs the user catalog export processing
protected void	writeHeader(java.io.PrintWriter out) Writes export file header required by CIF standard.
protected void	writeTrailer(java.io.PrintWriter out, int lineItems) Writes export file trailer required by CIF standard.

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

ivErrors

protected java.util.ArrayList<java.lang.String> ivErrors

A collection of accumulated error messages.

Constructor Detail

UserCatalogExportHandler

public UserCatalogExportHandler()

Constructs a new instance of the user catalog export handler with a null servlet or thread context.

A CONTEXT MUST BE SET BEFORE INVOKING ANY OTHER METHODS.

.

Method Detail

getErrors

public java.util.ArrayList<java.lang.String> getErrors()

Returns the collection of accumulated error messages.

Returns:

ArrayList - The error messages.

run

public boolean run(User user,
                   java.io.File file)

Performs the user catalog export processing

Parameters:

user - (User) The user whose catalog is to be exported.

file - (File) The file where the export results are to be written.

Returns:

boolean - true if the export successfully completes, otherwise false.

exportCategoryProducts

protected int exportCategoryProducts(java.io.PrintWriter out,
                                     Category category)
                              throws java.lang.Exception

Performs category export by iterating though all products this category contains.

Parameters:

out - (PrintWriter) The output stream for the export file.

category - (Category) The category being exported.

Throws:

java.lang.Exception - - if an error occurs during processing.

exportProductData

protected void exportProductData(java.io.PrintWriter out,
                                 Product product,
                                 Category category)
                          throws java.lang.Exception

Writes export product line data in CIF format.

Parameters:

out - (PrintWriter) The output stream for the export file.

product - (Product) The product being exported.

category - (Category) The category being exported.

Throws:

java.lang.Exception - - if an error occurs during processing.

getSmallDescription

protected java.lang.String getSmallDescription(Product product)
                                        throws java.lang.Exception

Retrieves a product's small description file as a string.

Parameters:

product - (Product) The product for the desired description.

Returns:

String - The small description text or null if the product does not have a small description.

Throws:

java.lang.Exception - - if an error occurs during processing.

writeHeader

protected void writeHeader(java.io.PrintWriter out)
                    throws java.lang.Exception

Writes export file header required by CIF standard.

Parameters:

out - (PrintWriter) The output stream for the export file.

Throws:

java.lang.Exception - - if an error occurs during processing.

writeTrailer

protected void writeTrailer(java.io.PrintWriter out,
                            int lineItems)
                     throws java.lang.Exception

Writes export file trailer required by CIF standard.

Parameters:

out - (PrintWriter) The output stream for the export file.

lineItems - (int) The number of line items written to the file.

Throws:

java.lang.Exception - - if an error occurs during processing.