atg.repository.search.refinement
Class SearchFacet

java.lang.Object
  atg.repository.search.refinement.Facet
      atg.repository.search.refinement.SearchFacet

public class SearchFacet
extends Facet

Represents a text search refinement element, where a user has typed in a search term in an input field and clicked on an associated Search button. Extends the Facet class by overriding the getId() and getLabel() methods, recognising the fact that a text search facet does not actually exist as a facet in the refinement repository. Therefore it does not have a repository ID and needs an ID from the FacetManager and a display name retrieved from a locale-specific resource bundle.

Field Summary

static java.lang.String	CLASS_VERSION Class version string
protected java.lang.String	mId

Constructor Summary

SearchFacet(java.lang.String pId)
Constructor method

Method Summary

java.lang.String	getId() Gets the ID of the facet
java.lang.String	getLabel() Gets the display name label for the facet

Methods inherited from class atg.repository.search.refinement.Facet

equals, getDebug, toString

Methods inherited from class java.lang.Object

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

Field Detail

CLASS_VERSION

public static java.lang.String CLASS_VERSION

Class version string

mId

protected java.lang.String mId

Constructor Detail

SearchFacet

public SearchFacet(java.lang.String pId)

Constructor method

Parameters:

pId - The ID of the search facet.

Method Detail

getId

public java.lang.String getId()

Description copied from class: Facet

Gets the ID of the facet

Specified by:

getId in class Facet

Returns:

A String containing the ID of the facet

See Also:

The facet ID for a search facet will come from the FacetManager, since it does not reside in the refinement repository.

getLabel

public java.lang.String getLabel()
                          throws FacetException

Description copied from class: Facet

Gets the display name label for the facet

Specified by:

getLabel in class Facet

Returns:

A String containing the display name for this facet.

Throws:

FacetException - for problems getting the label

See Also:

Gets the display name to be used for the text search facet.