Class TdbSearchFacet

java.lang.Object
com.tietoenator.trip.jxp.facet.TdbFacet
com.tietoenator.trip.jxp.facet.TdbSearchFacet
All Implemented Interfaces:
com.tietoenator.trip.jxp.internal.utils.DOMSink, Iterable<TdbFacetValue>

public class TdbSearchFacet extends TdbFacet implements com.tietoenator.trip.jxp.internal.utils.DOMSink
A type of facet whose values are each based on a a separate search order.
  • Constructor Details

    • TdbSearchFacet

      public TdbSearchFacet(String facetid)
      Constructor
      Parameters:
      facetid - The unique, application assigned name of the facet.
  • Method Details

    • setSortOrder

      public void setSortOrder(TdbFacetSortOrder sortOrder) throws TdbException
      Sets the sort order for the values of this facet.

      The only sort order type supported for this facet class is Default. Any other value will result in a TdbException being thrown.

      Overrides:
      setSortOrder in class TdbFacet
      Parameters:
      sortOrder - Sort order type
      Throws:
      TdbException - Always thrown with code NOT_SUPPORTED unless assigned Default
    • clear

      public void clear()
      Description copied from class: TdbFacet
      Clears accumulated state from this object.
      Overrides:
      clear in class TdbFacet
    • close

      public void close()
      Description copied from class: TdbFacet
      Closes this facet by releasing server-side resources and removes the the accumulated state from the object.
      Specified by:
      close in class TdbFacet
    • add

      public void add(String id, String query)
      Add a search order to generate a facet value.
      Parameters:
      id - Name or identity string for this facet (must be unique within the facet).
      query - CCL command - BASE, FIND, or FUZZ.
    • getValue

      public TdbFacetValue getValue(int index) throws TdbException
      Description copied from class: TdbFacet
      Retrieve a facet value object.
      Specified by:
      getValue in class TdbFacet
      Parameters:
      index - 0-based index of facet value
      Returns:
      TdbFacetValue object
      Throws:
      TdbException - If facet value could not be returned.