atg.repository.search.refinement
Class Facet

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

Direct Known Subclasses:

RefinementFacet, SearchFacet

public abstract class Facet
extends java.lang.Object

This is an abstract bean class that represents a refinement element. This will provide methods to get the ID and display name for a facet. This class will have subclasses for some of the different types of facets such as search facets and refinement facets.

Field Summary

static java.lang.String

CLASS_VERSION Class version string

Constructor Summary

Facet()

Method Summary

boolean	equals(java.lang.Object o)
java.lang.String	getDebug() If this is not null then it returns the reason why the facet isn't valid in the response.
abstract java.lang.String	getId() Gets the ID of the facet
abstract java.lang.String	getLabel() Gets the display name label for the facet
java.lang.String	toString() Returns a string representation of this facet.

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

Constructor Detail

Facet

public Facet()

Method Detail

getId

public abstract java.lang.String getId()

Gets the ID of the facet

Returns:

The ID of the facet.

getLabel

public abstract java.lang.String getLabel()
                                   throws FacetException

Gets the display name label for the facet

Returns:

A String object representing the display name label for the facet.

Throws:

FacetException - for problems getting the label.

getDebug

public java.lang.String getDebug()

If this is not null then it returns the reason why the facet isn't valid in the response. This will only come back in search testing where facet details mode is turned on for the query.

Returns:

String with reason why facet is invalid, e.g. refineMax

equals

public boolean equals(java.lang.Object o)

Overrides:

equals in class java.lang.Object

toString

public java.lang.String toString()

Returns a string representation of this facet.

Overrides:

toString in class java.lang.Object