atg.repository.search.refinement
Class FacetValueNode

java.lang.Object
  atg.repository.search.refinement.FacetValueNode

public class FacetValueNode
extends java.lang.Object

Represents a facet value in a hierarchical tree-like structure. Each facet value node can have child values. This is most likely to be used when representing the category hierarchy, when each category is a facet value of a global category facet and each category's child categories are child facet values of its facet value.

Field Summary

static java.lang.String	CLASS_VERSION Class version string
protected FacetValueNode[]	mChildFacetValues
protected FacetValue	mFacetValue
protected FacetHolder	mParentFacetHolder

Constructor Summary

FacetValueNode(FacetValue pFacetValue, FacetHolder pParentFacetHolder)
Constructor

FacetValueNode(FacetValue pFacetValue, FacetHolder pParentFacetHolder, FacetValueNode[] pChildFacetValues)
Constructor.

Method Summary

FacetValueNode[]	getChildFacetValues() Getter for the array of child facet values
FacetValue	getFacetValue() Getter for the facet value for this node
FacetHolder	getParentFacetHolder() Getter for the parent facet holder
void	setChildFacetValues(FacetValueNode[] pChildFacetValues) Setter for the array of child facet values
void	setFacetValue(FacetValue pFacetValue) Setter for the facet value for this node
void	setParentFacetHolder(FacetHolder pParentFacetHolder) Setter for the parent facet holder

Methods inherited from class java.lang.Object

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

Field Detail

CLASS_VERSION

public static java.lang.String CLASS_VERSION

Class version string

mFacetValue

protected FacetValue mFacetValue

mParentFacetHolder

protected FacetHolder mParentFacetHolder

mChildFacetValues

protected FacetValueNode[] mChildFacetValues

Constructor Detail

FacetValueNode

public FacetValueNode(FacetValue pFacetValue,
                      FacetHolder pParentFacetHolder)

Constructor

Parameters:

pFacetValue - The facet value associated with this node

pParentFacetHolder - The parent facet holder that owns this child node value.

FacetValueNode

public FacetValueNode(FacetValue pFacetValue,
                      FacetHolder pParentFacetHolder,
                      FacetValueNode[] pChildFacetValues)

Constructor.

Parameters:

pFacetValue - The facet value associated with this node

pParentFacetHolder - The parent facet holder that owns this child node.

pChildFacetValues - The list of child values for this facet value

Method Detail

getFacetValue

public FacetValue getFacetValue()

Getter for the facet value for this node

Returns:

A FacetValue bean

setFacetValue

public void setFacetValue(FacetValue pFacetValue)

Setter for the facet value for this node

Parameters:

pFacetValue - A FacetValue bean

getParentFacetHolder

public FacetHolder getParentFacetHolder()

Getter for the parent facet holder

Returns:

The FacetHolder bean that represents the parent of this node

setParentFacetHolder

public void setParentFacetHolder(FacetHolder pParentFacetHolder)

Setter for the parent facet holder

Parameters:

pParentFacetHolder - The FacetHolder bean that represents the parent of this node

getChildFacetValues

public FacetValueNode[] getChildFacetValues()

Getter for the array of child facet values

Returns:

An array of FacetValueNode instances.

setChildFacetValues

public void setChildFacetValues(FacetValueNode[] pChildFacetValues)

Setter for the array of child facet values

Parameters:

pChildFacetValues - An array of FacetValueNode instances.