[ You are here:
XTF ->
Tag Reference ->
crossQuery ->
Search Result Formatter -> Group Result Tag ]
Group Result Tag
This tag identifies and contains the results for the count (and possibly document hits) for a single group within a facet. One copy of this tag will be sent into the
Result Formatter for group selected by the
Facet Query Tag specified in the query. The Group Result Tag will appear within a
Facet Result Tag container, or in the case of a hierarchical facet, may appear inside another Group Result Tag. It has the form:
<group value = "GroupValue"
rank = "GroupSortedRank"
totalSubGroups = "NumOfSubGroups"
totalDocs = "NumberOfDocs"
startDoc = "FirstDocNumber"
endDoc = "EndDocNumber">
GroupResult <!-- if facet is hierarchical -->
GroupResult
…
DocumentHit <!-- if document hits were requested -->
DocumentHit
…
</group>
where
value="GroupValue" |
is the specific facet value of the group being reported. One might also think of this as the "name" of the group. |
rank="GroupSortedRank" |
is the ordinal ranking of this group within the set of groups at this level, with 1 being the first in sort order. Note that this is an absolute ranking for the group with respect to the entire set, and not a page relative ranking. For more information about paging groups, see the Group Selection section of the XTF Programmer's Guide. |
totalSubGroups="NumOfSubGroups" |
is, for a hierarchical facet, the number of sub-groups this group contains, which may be more than were actually selected and returned. For a non-hierarchical facet, this will always be zero. |
totalDocs="NumberOfDocs" |
is the number of documents that had matches for the specified main query and had GroupValue in the facet field. |
startDoc="FirstDocNumber" |
is the sequential document number for the highest ranking document match reported for the current group. Note that this may not be the overall highest ranking document if a paged query was specified. See the Group Selection section of the XTF Programmer's Guide for more details about paging documents. |
endDoc="LastDocNumber" |
is the sequential document number for the lowest ranking document match reported for the current group. Note that this may not be the overall lowest ranking document if a paged query was specified. See the Group Selection section of the XTF Programmer's Guide for more details about paging documents. |
If any groups matched the group selection in the Facet Query Tag, then one or more Group Result Tags will appear as children of the Facet Result Tag. If the facet is also hierarchical, Group Result Tags may contain nested Group Result Tags for sub-groups. If any document hits were selected, then one or more
Document Hit Tags will also be included.