atg.commerce.endeca.index.dimension

Class CategoryNode

java.lang.Object

atg.commerce.endeca.index.dimension.CategoryNode

All Implemented Interfaces:

java.io.Serializable

public class CategoryNode
extends java.lang.Object
implements java.io.Serializable

A CategoryNode represents a category in the product catalog hierarchy. A category node is identified by is category id and contains methods to access parent and child CategoryNodes.

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	CLASS_VERSION Class version string

Constructor Summary

Constructors

Constructor and Description
CategoryNode(java.lang.String pCategoryId, java.lang.String pDisplayName, java.lang.String pRootCatalogId, java.util.Set pAncestorCatalogIds) Constructs an instanceof CategoryNode

Method Summary

Modifier and Type	Method and Description
boolean	addChild(CategoryNode pChild) Adds a child to this node
java.util.Set<java.lang.String>	getAncestorCatalogIds() Access the set of ancestor catalog ids
java.util.List<CategoryNode>	getAncestors() Returns a ordered list of ancestors of this node
java.util.List<CategoryNode>	getAncestorsAndSelf() Returns a ordered list of ancestors of this node including the current node
java.lang.String	getCategoryId() Access the category id
CategoryNode	getChild(int pIndex) Access a child using an index
int	getChildSequenceNumber() Return the child sequence number of this node.
java.lang.String	getDisplayName() Access this nodes display name
int	getNumberOfChildren() Access the number of children of this node
CategoryNode	getParent() Access the parent node
atg.commerce.endeca.index.dimension.CategoryPath	getPath() Access the path of this node
java.lang.String	getPathAsString() Access the path of this node represented as a string
java.lang.String	getRootCatalogId() Access the root catalog id
void	setAncestorCatalogIds(java.util.Set<java.lang.String> pAncestorCatalogIds) set the ancestor catalog ids
void	setCategoryId(java.lang.String pCategoryId) Set the category id
void	setDisplayName(java.lang.String pDisplayName) Set this nodes display name
void	setParent(CategoryNode pParent) Set the parent node
void	setRootCatalogId(java.lang.String pRootCatalogId) set the roota catalog id
java.lang.String	toString() toString

Methods inherited from class java.lang.Object

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

Field Detail

CLASS_VERSION

public static java.lang.String CLASS_VERSION

Class version string

Constructor Detail

CategoryNode

public CategoryNode(java.lang.String pCategoryId,
                    java.lang.String pDisplayName,
                    java.lang.String pRootCatalogId,
                    java.util.Set pAncestorCatalogIds)

Constructs an instanceof CategoryNode

Parameters:

pCategoryId - the category id of this node

pDisplayName - the display name of this node

pRootCatalogId - the root catalog id of this node

pAncestorCatalogIds - a set of ancestory catalogs

Method Detail

setParent

public void setParent(CategoryNode pParent)

Set the parent node

Parameters:

pParent - the parent node

getParent

public CategoryNode getParent()

Access the parent node

getAncestors

public java.util.List<CategoryNode> getAncestors()

Returns a ordered list of ancestors of this node

Parameters:

an - ordered list of category nodes

getAncestorsAndSelf

public java.util.List<CategoryNode> getAncestorsAndSelf()

Returns a ordered list of ancestors of this node including the current node

Parameters:

an - ordered list of category nodes

addChild

public boolean addChild(CategoryNode pChild)

Adds a child to this node

Parameters:

pChild - a category node

Returns:

true if the child was added successfully, false otherwise

getNumberOfChildren

public int getNumberOfChildren()

Access the number of children of this node

Returns:

the nubmer of children

getChild

public CategoryNode getChild(int pIndex)

Access a child using an index

Parameters:

pIndex - the index number

Returns:

the child at the index position or null

getCategoryId

public java.lang.String getCategoryId()

Access the category id

Returns:

the category id

setCategoryId

public void setCategoryId(java.lang.String pCategoryId)

Set the category id

Parameters:

pCategoryId - the category id

getRootCatalogId

public java.lang.String getRootCatalogId()

Access the root catalog id

Returns:

the root catalog id

setRootCatalogId

public void setRootCatalogId(java.lang.String pRootCatalogId)

set the roota catalog id

Parameters:

pRootCatalogId - the catalog id

getDisplayName

public java.lang.String getDisplayName()

Access this nodes display name

Returns:

a string

setDisplayName

public void setDisplayName(java.lang.String pDisplayName)

Set this nodes display name

Parameters:

pDisplayName - the display name

getAncestorCatalogIds

public java.util.Set<java.lang.String> getAncestorCatalogIds()

Access the set of ancestor catalog ids

Returns:

a set of ancetor catalog ids

setAncestorCatalogIds

public void setAncestorCatalogIds(java.util.Set<java.lang.String> pAncestorCatalogIds)

set the ancestor catalog ids

getChildSequenceNumber

public int getChildSequenceNumber()

Return the child sequence number of this node. The child sequence number represents an ordering of a parent nodes children.

Returns:

an integer representing ones child sequence

getPath

public atg.commerce.endeca.index.dimension.CategoryPath getPath()

Access the path of this node

Returns:

a CategoryPath object

getPathAsString

public java.lang.String getPathAsString()

Access the path of this node represented as a string

Returns:

a string

toString

public java.lang.String toString()

toString

Overrides:

toString in class java.lang.Object