com.neurosys.modules.etl

Class MultiCategoryLookup<T extends HierarchialDomainObject>

java.lang.Object

com.neurosys.etl.common.transformers.UsesIntermediateObjectImpl<Map<String,Object>>

com.neurosys.modules.etl.MultiCategoryLookup<T>

Type Parameters:

T - as HierarchialDomainObject

All Implemented Interfaces:

ContextAware<Map<String,Object>>, Lookup, UsesIntermediateObject<Map<String,Object>>, CacheLookups, Serializable, org.apache.commons.collections.Transformer

Direct Known Subclasses:

ProductMultiCategoryLookup

public class MultiCategoryLookup<T extends HierarchialDomainObject>
extends UsesIntermediateObjectImpl<Map<String,Object>>
implements Lookup, CacheLookups

Searches for a category to match a criteria defined by queryTransformer. Typically search by Name or DisplayName (case insensitive).

Since a sub-category display name may not be unique, sometimes a combination of parent and child maybe used. This implementation can derive Category parent up to 3 Levels.
Ensure UsesIntermediateObject.getResultNamesUsed() is set to list of {resultNamesUsed1, resultNamesUsed2, resultNamesUsed3} in the configuration for 3 levels by default.

It will compare the Cat-Level Name to IHierarchialReference.getName() or HierarchialDomainObject.getDisplayName(); whichever matches

Parent level category names maybe cached using the #ETL_CATEGORY_CACHE_NAME

important: Since this extends UsesIntermediateObject; it will expect the Category and Sub-Category names to be provided in order in the following convention:
subCatLevel1, subCatLevel2, ..etc. Where 1 refers to top most the level among all the ones to be looked up. If you are not looking up based on some root category, then 1 will still be assigned to the sub category.
For example, if we are looking for "Mens > Shirts > t-Shirt". But we want to lookup t-Shirts and don't want to consider all 3, but just the last 2 are sufficient to identify the sub-cat. Then Shirts is subCatLevel1, and t-Shirts is subCatLevel2.

TODO: Create an N-level category derivation and deprecate this 3 level version.

Author:

Arjun Dhar

See Also:

Serialized Form

Field Summary

Fields inherited from class com.neurosys.etl.common.transformers.UsesIntermediateObjectImpl

intermediateResults, resultNamesUsed, resultsThatAreOptional

Fields inherited from interface com.neurosys.lookups.CacheLookups

CONTENT_PUBLISH_CACHE_NAME, PRODUCT_LOOKUP_CACHE_NAME, PRODUCT_SEARCH_CACHE_NAME, TEMPLATEPAGE_MAPPING_CACHE_NAME

Constructor Summary

Constructors

Constructor and Description
MultiCategoryLookup()

Method Summary

Modifier and Type	Method and Description
void	clear()
org.springframework.cache.CacheManager	getCacheManager()
String	getCacheName()
protected T	getCategory(String[] nameSubCats)
int	getLevels()
org.apache.commons.collections.Transformer	getQueryTransformer() Accepts an Array of category names.
protected T	lookupCache(String[] nameSubCats)
protected static String	printCatHierarchy(String[] subCatLevels)
void	setCacheManager(org.springframework.cache.CacheManager cacheManager)
void	setCacheName(String cacheName)
void	setLevels(int levels)
void	setQueryTransformer(org.apache.commons.collections.Transformer queryTransformer) Accepts an Array of category names.
Object	transform(Object in) For a Given String, Lookup a value for it

Methods inherited from class com.neurosys.etl.common.transformers.UsesIntermediateObjectImpl

determineInput, getInputFromContext, getInterMediateResults, getResultNamesThatAreOptional, getResultNamesUsed, setIntermediateResults, setResultNamesThatAreOptional, setResultNamesUsed

Methods inherited from class java.lang.Object

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

Constructor Detail

MultiCategoryLookup

public MultiCategoryLookup()

Method Detail

clear

public void clear()

printCatHierarchy

protected static final String printCatHierarchy(String[] subCatLevels)

transform

public Object transform(Object in)

Description copied from interface: Lookup

For a Given String, Lookup a value for it

Specified by:

transform in interface Lookup

Specified by:

transform in interface org.apache.commons.collections.Transformer

lookupCache

protected T lookupCache(String[] nameSubCats)

getCategory

protected T getCategory(String[] nameSubCats)

getQueryTransformer

public org.apache.commons.collections.Transformer getQueryTransformer()

Accepts an Array of category names. Lower index indicates higher precendence in the category hierarchy.
Returns type T

setQueryTransformer

public void setQueryTransformer(org.apache.commons.collections.Transformer queryTransformer)

Accepts an Array of category names. Lower index indicates higher precendence in the category hierarchy.
Returns type T

getLevels

public int getLevels()

setLevels

public void setLevels(int levels)

getCacheManager

public org.springframework.cache.CacheManager getCacheManager()

setCacheManager

public void setCacheManager(org.springframework.cache.CacheManager cacheManager)

getCacheName

public String getCacheName()

setCacheName

public void setCacheName(String cacheName)