org.cdlib.xtf.textEngine.facet

Class DynamicGroupData

Object

GroupData

DynamicGroupData

Direct Known Subclasses:

FRBRGroupData

public abstract class DynamicGroupData
extends GroupData

Abstract class representing dynamically generated group data for a facet query.

Constructor Summary

Constructors

Constructor and Description
DynamicGroupData()

Method Summary

Modifier and Type	Method and Description
abstract void	collect(int doc, float score) Collect/build data for the given document and score.
abstract void	finish() Complete any tasks to finish building the group data.
abstract void	init(IndexReader indexReader, Set tokFields, String params) Initialize the data from the given index reader, set of tokenized fields, and parameter string.

Methods inherited from class GroupData

child, compare, debugGroups, field, findGroup, firstLink, isDynamic, linkGroup, name, nChildren, nDocHits, nextLink, nGroups, parent, score, sibling

Methods inherited from class Object

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

Constructor Detail

DynamicGroupData

public DynamicGroupData()

Method Detail

init

public abstract void init(IndexReader indexReader,
                          Set tokFields,
                          String params)
                   throws IOException

Initialize the data from the given index reader, set of tokenized fields, and parameter string.

Throws:

IOException

collect

public abstract void collect(int doc,
                             float score)

Collect/build data for the given document and score.

Parameters:

doc - Lucene document identifier for matching document

score - Calculated score for the doc (always greater than zero)

finish

public abstract void finish()

Complete any tasks to finish building the group data.