public class TdbFieldTermFacet extends TdbFacet
Constructor and Description |
---|
TdbFieldTermFacet(java.lang.String fieldname)
Create a facet based on a field in the currently open database
or in a search set.
|
TdbFieldTermFacet(java.lang.String fieldname,
java.lang.String mask)
Create a facet based on a field in the currently open database
|
Modifier and Type | Method and Description |
---|---|
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.
|
java.lang.String |
getMask()
Returns the comparison mask
|
TdbFacetValue |
getValue(int index)
Retrieve a facet value object.
|
void |
setMask(java.lang.String newMask)
Alter the search mask for the facet.
|
getBaselineKey, getBaselineSize, getDatabase, getFetchFrom, getFetchTo, getLowerFrequencyLimit, getName, getSearchSet, getSortOrder, getTimeout, getUpperFrequencyLimit, getValueCount, isRegisterBaseline, isUseBaseline, iterator, setBaselineKey, setBaselineSize, setDatabase, setFetchFrom, setFetchTo, setFrequencyLimits, setRegisterBaseline, setSearchSet, setSortOrder, setTimeout, setUseBaseline
public TdbFieldTermFacet(java.lang.String fieldname) throws TdbException
fieldname
- Name of field or viewTdbException
- If invalid arguments were supplied.public TdbFieldTermFacet(java.lang.String fieldname, java.lang.String mask) throws TdbException
fieldname
- Name of field or viewmask
- Comparison mask to select values from the fieldTdbException
- If invalid arguments were supplied.public java.lang.String getMask()
public void setMask(java.lang.String newMask) throws TdbException
TdbException
public void clear()
TdbFacet
public void close()
TdbFacet
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.