org.cdlib.xtf.textEngine.facet
Class FacetSpec

Object
  FacetSpec

public class FacetSpec
extends Object

Stores a facet specification, as part of a QueryRequest.

Author:

Martin Haye

Field Summary

String	field Name of the meta-data field to group by
GroupSelector	groupSelector Selection of groups
boolean	includeEmptyGroups Whether to include empty groups by default
String	sortDocsBy If any documents are selected, this field specifies which meta-data field(s) to sort the documents by.
String	sortGroupsBy How to sort the groups.

Constructor Summary

FacetSpec()

Method Summary

Methods inherited from class Object

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

Field Detail

field

public String field

Name of the meta-data field to group by

groupSelector

public GroupSelector groupSelector

Selection of groups

sortGroupsBy

public String sortGroupsBy

How to sort the groups. Currently "value" and "totalDocs" are the only permissible values.

includeEmptyGroups

public boolean includeEmptyGroups

Whether to include empty groups by default

sortDocsBy

public String sortDocsBy

If any documents are selected, this field specifies which meta-data field(s) to sort the documents by.

Constructor Detail

FacetSpec

public FacetSpec()