public class TdbSearchFacet extends TdbFacet implements com.tietoenator.trip.jxp.internal.utils.DOMSink
Constructor and Description |
---|
TdbSearchFacet(java.lang.String facetid)
Constructor
|
Modifier and Type | Method and Description |
---|---|
void |
add(java.lang.String id,
java.lang.String query)
Add a search order to generate a facet value.
|
void |
clear()
Clears accumulated state from this object.
|
void |
close()
Closes this facet by releasing server-side resources and removes the
the accumulated state from the object.
|
TdbFacetValue |
getValue(int index)
Retrieve a facet value object.
|
void |
setSortOrder(TdbFacetSortOrder sortOrder)
Sets the sort order for the values of this facet.
|
getBaselineKey, getBaselineSize, getDatabase, getDefaultTimeout, getFetchFrom, getFetchTo, getLowerFrequencyLimit, getName, getSearchSet, getSortOrder, getTimeout, getUpdateValueCount, getUpperFrequencyLimit, getValueCount, isBaselineAtEnd, isOpenExisting, isRegisterBaseline, isResetBaseline, isUseBaseline, iterator, setBaselineAtEnd, setBaselineKey, setBaselineSize, setDatabase, setDefaultTimeout, setFetchFrom, setFetchTo, setFrequencyLimits, setOpenExisting, setRegisterBaseline, setResetBaseline, setSearchSet, setTimeout, setUseBaseline
public TdbSearchFacet(java.lang.String facetid)
facetid
- The unique, application assigned name of the facet.public void setSortOrder(TdbFacetSortOrder sortOrder) throws TdbException
The only sort order type supported for this facet class is Default. Any other value will result in a TdbException being thrown.
setSortOrder
in class TdbFacet
sortOrder
- Sort order typeTdbException
- Always thrown with code NOT_SUPPORTED unless assigned Defaultpublic void clear()
TdbFacet
public void close()
TdbFacet
public void add(java.lang.String id, java.lang.String query)
id
- Name or identity string for this facet (must be unique within the facet).query
- CCL command - BASE, FIND, or FUZZ.public TdbFacetValue getValue(int index) throws TdbException
TdbFacet
getValue
in class TdbFacet
index
- 0-based index of facet valueTdbException
- If facet value could not be returned.