Class TdbFieldTermFacet

java.lang.Object
com.tietoenator.trip.jxp.facet.TdbFacet
com.tietoenator.trip.jxp.facet.TdbFieldTermFacet
All Implemented Interfaces:
Iterable<TdbFacetValue>
Direct Known Subclasses:
TdbClassificationFacet, TdbKvpFacet

public class TdbFieldTermFacet extends TdbFacet
A facet whose values are a subset of the terms of a TRIP database field.
  • Constructor Details

    • TdbFieldTermFacet

      public TdbFieldTermFacet(String fieldname) throws TdbException
      Create a facet based on a field in the currently open database or in a search set.
      Parameters:
      fieldname - Name of field or view
      Throws:
      TdbException - If invalid arguments were supplied.
    • TdbFieldTermFacet

      public TdbFieldTermFacet(String fieldname, String mask) throws TdbException
      Create a facet based on a field in the currently open database
      Parameters:
      fieldname - Name of field or view
      mask - Comparison mask to select values from the field
      Throws:
      TdbException - If invalid arguments were supplied.
  • Method Details

    • getFetchSize

      public int getFetchSize()
      The number of values for that this facet will request from TRIPsystem per network request. The default is 100. Set this to a higher number if your application immediately need access to more values than that.
      Returns:
      Number of values fetched from TRIPsystem at a time.
    • setFetchSize

      public void setFetchSize(int size)
      The number of values for that this facet will request from TRIPsystem per network request. The default is 100 and the max valid value is 10000. Set this to a higher number if your application immediately need access to more values than that.
      Parameters:
      size - Number of facet values to fetch from TRIPsystem at a time
    • getMask

      public String getMask()
      Returns the comparison mask
    • setMask

      public void setMask(String newMask) throws TdbException
      Alter the search mask for the facet.
      Throws:
      TdbException
    • 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
    • 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.