Package de.cxp.ocs.preprocessor.util

Class CategorySearchData

java.lang.Object

de.cxp.ocs.preprocessor.util.CategorySearchData

public class CategorySearchData
extends Object

Takes a list of / separated category paths and splits them into separate levels. Also saves all leaf paths.

Field Summary

Fields

Modifier and Type	Field	Description
static String	CATEGORY_LEAF_SUFFIX
static String	CATEGORY_LVL_SUFFIX
static String	PATH_SEPARATOR

Constructor Summary

Constructors

Constructor	Description
CategorySearchData()	Creates a new instance and splits the category paths into levels and leafs.

Method Summary

Modifier and Type	Method	Description
void	add(Collection<String[]> categoryPaths)
Collection<String>	getCategory(int lvl)	Returns a category by level.
Collection<String>	getCategoryLeaf()	Returns the leaf entries of each path.
int	getCategoryLvlDepth()	Returns the number of the deepest category level from the path list.
void	toSourceItem(Map<String,Object> sourceData, String categoryFieldName)	Copies the data of this instance into the sourceData map.

Methods inherited from class java.lang.Object

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

Field Detail

CATEGORY_LEAF_SUFFIX

public static final String CATEGORY_LEAF_SUFFIX

See Also:

Constant Field Values

CATEGORY_LVL_SUFFIX

public static final String CATEGORY_LVL_SUFFIX

See Also:

Constant Field Values

PATH_SEPARATOR

public static final String PATH_SEPARATOR

See Also:

Constant Field Values

Constructor Detail

CategorySearchData

public CategorySearchData()

Creates a new instance and splits the category paths into levels and leafs.

Method Detail

add

public void add(Collection<String[]> categoryPaths)

getCategoryLvlDepth

public int getCategoryLvlDepth()

Returns the number of the deepest category level from the path list.

Returns:

the category depth.

getCategory

public Collection<String> getCategory(int lvl)

Returns a category by level.

Parameters:

lvl - the level of the category to return.

Returns:

the category.

Throws:

IndexOutOfBoundsException - if the level is lower than 0 or greater than getCategoryLvlDepth()

getCategoryLeaf

public Collection<String> getCategoryLeaf()

Returns the leaf entries of each path.

Returns:

the leaf entries.

toSourceItem

public void toSourceItem(Map<String,Object> sourceData,
                         String categoryFieldName)

Copies the data of this instance into the sourceData map. The name of the category field is used as prefix, followed by either

1. _lvl_x
2. _leaf

for each level and once for all leafs.

Parameters:

sourceData - the source item where the data will be stored.

categoryFieldName - the category field which is used to obtain the name of the stored fields.