org.cdlib.xtf.textEngine.facet
Class ResultGroup

Object
  ResultGroup

public class ResultGroup
extends Object

Records the results of a single group in field-grouped query.

Author:

Martin Haye

Field Summary

DocHit[]	docHits One hit per document
int	endDoc Oridinal rank of the last document hit returned, plus 1
int	rank Ordinal rank of this group
int	startDoc Ordinal rank of the first document hit returned (0-based)
ResultGroup[]	subGroups The selected sub-groups (if any)
int	totalDocs Total number of documents in this group (possibly many more than are returned in this particular request.)
int	totalSubGroups Total number of sub-groups (possibly more than are selected by this particular request.)
String	value Facet value for this group

Constructor Summary

ResultGroup()

Method Summary

Methods inherited from class Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

value

public String value

Facet value for this group

rank

public int rank

Ordinal rank of this group

totalSubGroups

public int totalSubGroups

Total number of sub-groups (possibly more than are selected by this particular request.)

subGroups

public ResultGroup[] subGroups

The selected sub-groups (if any)

totalDocs

public int totalDocs

Total number of documents in this group (possibly many more than are returned in this particular request.)

startDoc

public int startDoc

Ordinal rank of the first document hit returned (0-based)

endDoc

public int endDoc

Oridinal rank of the last document hit returned, plus 1

docHits

public DocHit[] docHits

One hit per document

Constructor Detail

ResultGroup

public ResultGroup()