atg.repository.search.refinement
Class FacetHolder

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

public class FacetHolder
extends java.lang.Object

This class holds a single facet and the facet values that are associated with it. This can be used when rendering a facet trail and when rendering the facet values where you wish to group the associated values with the facet.

Field Summary

static java.lang.String	CLASS_VERSION Class version string
protected FacetValueNode[]	mAllFacetValueNodes
protected atg.repository.search.refinement.Facet	mFacet
protected java.util.ArrayList	mFacetValueNodes

Constructor Summary

FacetHolder(atg.repository.search.refinement.Facet pFacet)
Constructor.

FacetHolder(atg.repository.search.refinement.Facet pFacet, FacetValueNode[] pFacetValues)
Constructor.

Method Summary

void	addFacetValueNode(FacetValueNode pFacetValueNode)
FacetValueNode[]	getAllFacetValueNodes()
atg.repository.search.refinement.Facet	getFacet() Getter for the facet associated with this node
FacetValueNode[]	getFacetValueNodes() Getter for the array of facet values associated with this facet
void	removeFacetValueNode(FacetValueNode pFacetValueNode)
void	setAllFacetValueNodes(FacetValueNode[] pAllFacetValueNodes)
void	setFacet(atg.repository.search.refinement.Facet pFacet) Setter for the facet associated with this node
void	setFacetValueNodes(FacetValueNode[] pFacetValueNodes) Setter for the array of facet values associated with this facet
java.lang.String	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

mFacet

protected atg.repository.search.refinement.Facet mFacet

mFacetValueNodes

protected java.util.ArrayList mFacetValueNodes

mAllFacetValueNodes

protected FacetValueNode[] mAllFacetValueNodes

Constructor Detail

FacetHolder

public FacetHolder(atg.repository.search.refinement.Facet pFacet)

Constructor. Sets the facet.

Parameters:

pFacet - Facet for this instance.

FacetHolder

public FacetHolder(atg.repository.search.refinement.Facet pFacet,
                   FacetValueNode[] pFacetValues)

Constructor. Sets the facet and facet values.

Parameters:

pFacet - Facet for this class.

pFacetValues - Array of facet value nodes for this instance.

Method Detail

getFacet

public atg.repository.search.refinement.Facet getFacet()

Getter for the facet associated with this node

Returns:

The Facet object for this facet node.

setFacet

public void setFacet(atg.repository.search.refinement.Facet pFacet)

Setter for the facet associated with this node

Parameters:

pFacet - The Facet object for this facet node.

getFacetValueNodes

public FacetValueNode[] getFacetValueNodes()

Getter for the array of facet values associated with this facet

Returns:

An array of FacetValueNode instances.

setFacetValueNodes

public void setFacetValueNodes(FacetValueNode[] pFacetValueNodes)

Setter for the array of facet values associated with this facet

addFacetValueNode

public void addFacetValueNode(FacetValueNode pFacetValueNode)

removeFacetValueNode

public void removeFacetValueNode(FacetValueNode pFacetValueNode)

getAllFacetValueNodes

public FacetValueNode[] getAllFacetValueNodes()

setAllFacetValueNodes

public void setAllFacetValueNodes(FacetValueNode[] pAllFacetValueNodes)

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object