com.dpslink.flash.db.search

Class ProductSearch2

java.lang.Object

com.dpslink.flash.db.search.ProductSearch2

All Implemented Interfaces:

ProductSearchInterface, java.io.Serializable

public class ProductSearch2
extends java.lang.Object
implements ProductSearchInterface

An implementation of the ProductSearchInterface that searches products using the IBM AS/400 Webserver search engine.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
protected class	ProductSearch2.ProductSort Comparator class that implements a product sort using product code and unit of measure code.

Field Summary

Fields

Modifier and Type	Field and Description
protected static java.lang.String	cvIndexDir Index directory
protected static java.lang.String	cvIndexName Index name
protected static java.lang.String	cvNumberOfMatches Number of matches to return
protected static java.lang.String	cvTargetURL URL to the search service macro
protected static int	cvTimeout The number of seconds to wait for a response from the search service
private java.util.HashMap<java.lang.String,java.util.Date>	ivTrace Map to hold trace timing by boundry name
private static long	serialVersionUID The class' serialization version id.
static boolean	TRACE Constant which turns on detailed tracing

Constructor Summary

Constructors

Constructor and Description
ProductSearch2() Default constructor.

Method Summary

Modifier and Type	Method and Description
static java.lang.String	getAbsolutePath(java.lang.String s) Adds the site's root path if the given path is relative (relative means path does not begin with /), otherwise the path is assumed to be absolute already and simply returns as is.
java.util.ArrayList<Product>	getMatchingProducts(FlashServletContext ctx, java.lang.String searchString, java.util.ArrayList<java.lang.String[]> searchAttributes) Returns a list of products that match the given search criteria and are in the session user's catalog.
java.util.ArrayList<Product>	getMatchingProducts(FlashServletContext ctx, java.lang.String searchString, java.util.ArrayList<java.lang.String[]> searchAttributes, java.lang.String catcat, int maxhits) Returns a list of products that match the given search criteria and are in the given catalog category.
protected java.lang.String	getUnFSValidFileName(java.lang.String name) Returns a product ID based on a file system safe file name.
protected boolean	isCodeInList(java.lang.String code, java.util.ArrayList<Product> list) Checks if list of products contains product with code.
protected java.lang.String	processResultLine(java.lang.String line) Extracts the product ID string from the supplied string.
protected java.util.ArrayList<java.lang.String>	querySearchService(java.lang.String query) Communicates with the AS/400 webserver search service.
protected void	trace(java.lang.String x) Detailed tracing.
protected void	traceEnd(java.lang.String x) End detailed trace boundry, outputs elapsed time since the start of this boundry.
protected void	traceStart(java.lang.String x) Start detailed trace boundry.
protected java.util.ArrayList<java.lang.String>	verifyProductCodes(UserCatalogVerifier ucv, java.util.ArrayList<java.lang.String> prodCodes) Verifies that each product code within the given collection of product codes is in the session user's catalog and/or in the user's set of permits and returns a collection that contains only the product codes that pass the verification.

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

TRACE

public static final boolean TRACE

Constant which turns on detailed tracing

cvTimeout

protected static final int cvTimeout

The number of seconds to wait for a response from the search service

cvTargetURL

protected static final java.lang.String cvTargetURL

URL to the search service macro

cvIndexDir

protected static final java.lang.String cvIndexDir

Index directory

cvIndexName

protected static final java.lang.String cvIndexName

Index name

cvNumberOfMatches

protected static final java.lang.String cvNumberOfMatches

Number of matches to return

ivTrace

private java.util.HashMap<java.lang.String,java.util.Date> ivTrace

Map to hold trace timing by boundry name

Constructor Detail

ProductSearch2

public ProductSearch2()

Default constructor.

Method Detail

getMatchingProducts

public java.util.ArrayList<Product> getMatchingProducts(FlashServletContext ctx,
                                                        java.lang.String searchString,
                                                        java.util.ArrayList<java.lang.String[]> searchAttributes)

Returns a list of products that match the given search criteria and are in the session user's catalog.

Specified by:

getMatchingProducts in interface ProductSearchInterface

Parameters:

ctx - (FlashServletContext) The current servlet context.

searchString - (String) The search criteria.

searchAttributes - (ArrayList) The extended attributes search criteria, a list of String[] where element 0 is attribute code, and 1 is relation.

Returns:

ArrayList - List containing matching products.

getMatchingProducts

public java.util.ArrayList<Product> getMatchingProducts(FlashServletContext ctx,
                                                        java.lang.String searchString,
                                                        java.util.ArrayList<java.lang.String[]> searchAttributes,
                                                        java.lang.String catcat,
                                                        int maxhits)

Returns a list of products that match the given search criteria and are in the given catalog category.

Specified by:

getMatchingProducts in interface ProductSearchInterface

Parameters:

ctx - (FlashServletContext) The current servlet context.

searchString - (String) The search criteria.

searchAttributes - (ArrayList) The extended attributes search criteria, a list of String[] where element 0 is attribute code, and 1 is relation.

catcat - (String) The catalog category for the results.

maxhits - (int) The maximum number of matches. A 0 (zero) indicates no maximum.

Returns:

ArrayList - List containing matching products.

getAbsolutePath

public static java.lang.String getAbsolutePath(java.lang.String s)

Adds the site's root path if the given path is relative (relative means path does not begin with /), otherwise the path is assumed to be absolute already and simply returns as is.

Parameters:

s - (String) The string to process.

Returns:

String - The given string with the root path prepended to it, if needed.

getUnFSValidFileName

protected java.lang.String getUnFSValidFileName(java.lang.String name)

Returns a product ID based on a file system safe file name. This method attempts to undo what is done in FileSystemHelper.getFSValidFileName().

Parameters:

name - (String) A file name (not including file path) that is to be manipulated.

Returns:

String - A code that has invalid character restored.

isCodeInList

protected boolean isCodeInList(java.lang.String code,
                               java.util.ArrayList<Product> list)

Checks if list of products contains product with code.

Parameters:

code - (String) The product code to check.

list - (ArrayList) The list products to check.

Returns:

boolean - true if the code is in the list, otherwise false.

querySearchService

protected java.util.ArrayList<java.lang.String> querySearchService(java.lang.String query)

Communicates with the AS/400 webserver search service.

Parameters:

query - (String) The user's search string.

Returns:

ArrayList - of product ID strings that qualify based on the query string.

processResultLine

protected java.lang.String processResultLine(java.lang.String line)

Extracts the product ID string from the supplied string.

Parameters:

line - (String) The raw result string from the search server.

Returns:

String - Substring of the raw string containing the extract product ID.

verifyProductCodes

protected java.util.ArrayList<java.lang.String> verifyProductCodes(UserCatalogVerifier ucv,
                                                                   java.util.ArrayList<java.lang.String> prodCodes)

Verifies that each product code within the given collection of product codes is in the session user's catalog and/or in the user's set of permits and returns a collection that contains only the product codes that pass the verification.

Parameters:

ucv - (UserCatalogVerifier) The verifier to use for verification.

prodCodes - (ArrayList) The set of product codes that are to be verified.

Returns:

ArrayList - The list of product codes that pass verification.

trace

protected void trace(java.lang.String x)

Detailed tracing.

Parameters:

x - (String) Text to add to the trace.

traceStart

protected void traceStart(java.lang.String x)

Start detailed trace boundry.

Parameters:

x - (String) Name of the trace boundry.

traceEnd

protected void traceEnd(java.lang.String x)

End detailed trace boundry, outputs elapsed time since the start of this boundry.

Parameters:

x - (String) Name of the trace boundry.