public class TdbFacetSet extends TdbMessageProvider implements com.tietoenator.trip.jxp.internal.utils.DOMSink
Constructor and Description |
---|
TdbFacetSet(TdbSession session)
Create a new facet set
|
Modifier and Type | Method and Description |
---|---|
void |
add(TdbFacet f)
Add a facet to this facet set.
|
void |
clear(boolean remove)
Clears accumulated state from this object.
|
void |
close()
Closes this facet set by releasing server-side resources and removes the
the accumulated state from the object.
|
void |
get()
Retrieve the values for the facets in this facet set.
|
TdbFacet |
getFacet(int index)
Retrieve one of the facets associated with this facet set.
|
int |
getFacetCount()
Number of facets associated with this facet set.
|
void |
removeBaselines()
Removes all previously registered baseline data in the session.
|
codeList, getLastCode, getLastMessage, hasMessages, messageList, resetMessages
cancel, getSession, isCancelable, setCancelable
public TdbFacetSet(TdbSession session) throws TdbException
session
- Active physical TRIP sessionTdbException
- If the session is not valid for use with facet sets.public void add(TdbFacet f)
f
- Facet to addpublic int getFacetCount()
public TdbFacet getFacet(int index)
index
- Zero-based indexpublic void close()
public void clear(boolean remove)
remove
- If false, accumulated state is cleared from the associated
facets, if true, close() is in addition called on all facets associated
with this object and they are removed from this set along with any database
and search set specifications.public void removeBaselines() throws TdbException
TdbException
public void get() throws TdbException
Certain facet types, especially those based on term lists, may not actually return any facets in this operation, but instead employ an on-demand loading of values so that very large amount of facet values can be handled. This is usually the case if the number of values for a facet exceed 100.
TdbException
- If the retrieval failed.