com.plumtree.server.search
Interface IPTSGroupInfo

public interface IPTSGroupInfo

Holder class for info about a single "group" of results discovered during execution of a query request.

See Also:

IPTSQueryRequest.setResultsGroupBy(), IPTSQueryResponse.getGroups()

Method Summary

java.lang.String	getGroupLabel() Returns a text label for this group.
IPTSQuery	getGroupQuery() Returns an IPTSQuery that may be used to restrict a followup query to the members of this group.
com.plumtree.openfoundation.util.IXPEnumerator	getResultsInGroup() Returns an enumeration of search results within this group.
int	getReturnedCountInGroup() Returns the number of results in this group, within the subset that fell within the requested results range.
java.lang.String	getTotalCountInGroup() Returns the total number of results in this group, across the entire search index.

Method Detail

getGroupLabel

java.lang.String getGroupLabel()

Returns a text label for this group. For the "all others" group, returns null.

If the group-by field was IPTSPortalCollection.FolderPath, this will be the folder name. If the group-by field was IPTSPlumtreeCollection.CategorizeableObjectType, this will be a code for the object type.. see the javadocs for that method for more details. For any other group-by field, this will be a single token in the field that is common to all members of the group.

Returns:

a textual label for this group

getTotalCountInGroup

java.lang.String getTotalCountInGroup()

Returns the total number of results in this group, across the entire search index.

Returns:

total number of results in this group, across the entire search index. May be prefixed with '~', if the total is an estimate.

getReturnedCountInGroup

int getReturnedCountInGroup()

Returns the number of results in this group, within the subset that fell within the requested results range.

Returns:

Number of results in this group, within the subset that fell within the requested result range (see IPTSQueryRequest.setResultsCount). This number will always be less than or equal to IPTSQueryResponse.getReturnedCount().

getResultsInGroup

com.plumtree.openfoundation.util.IXPEnumerator getResultsInGroup()

Returns an enumeration of search results within this group.

Returns:

An enumeration of the results in this group (actually, the subset that fell within the requested result range). Elements are of type IPTSResult. Call getRank() on each result to find its *overall* (ungrouped) relevance rank.

getGroupQuery

IPTSQuery getGroupQuery()

Returns an IPTSQuery that may be used to restrict a followup query to the members of this group.

Returns:

an IPTSQuery that may be used to restrict a followup query to the members of this group. This query should be ANDed with the original query.