org.apache.solr.search.grouping

Class GroupingSpecification

java.lang.Object

org.apache.solr.search.grouping.GroupingSpecification

public class GroupingSpecification
extends Object

Encapsulates the grouping options like fields group sort and more specified by clients.

WARNING: This API is experimental and might change in incompatible ways in the next release.

Constructor Summary

Constructors

Constructor and Description
GroupingSpecification()

Method Summary

Modifier and Type	Method and Description
String[]	getFields()
String[]	getFunctions()
int	getGroupLimit() Deprecated.
int	getGroupOffset() Deprecated.
Sort	getGroupSort() Deprecated.
SortSpec	getGroupSortSpec()
int	getLimit() Deprecated.
int	getOffset() Deprecated.
String[]	getQueries()
Grouping.Format	getResponseFormat()
Sort	getSortWithinGroup() Deprecated.
int	getWithinGroupLimit() Deprecated.
int	getWithinGroupOffset() Deprecated.
SortSpec	getWithinGroupSortSpec()
boolean	isIncludeGroupCount()
boolean	isMain()
boolean	isNeedScore()
boolean	isTruncateGroups()
void	setFields(String[] fields)
void	setFunctions(String[] functions)
void	setGroupSortSpec(SortSpec groupSortSpec)
void	setIncludeGroupCount(boolean includeGroupCount)
void	setMain(boolean main)
void	setNeedScore(boolean needScore)
void	setQueries(String[] queries)
void	setResponseFormat(Grouping.Format responseFormat)
void	setTruncateGroups(boolean truncateGroups)
void	setWithinGroupSortSpec(SortSpec withinGroupSortSpec)

Methods inherited from class java.lang.Object

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

Constructor Detail

GroupingSpecification

public GroupingSpecification()

Method Detail

getFields

public String[] getFields()

setFields

public void setFields(String[] fields)

getQueries

public String[] getQueries()

setQueries

public void setQueries(String[] queries)

getFunctions

public String[] getFunctions()

setFunctions

public void setFunctions(String[] functions)

getWithinGroupOffset

@Deprecated
public int getWithinGroupOffset()

Deprecated.

getGroupOffset

@Deprecated
public int getGroupOffset()

Deprecated.

getWithinGroupLimit

@Deprecated
public int getWithinGroupLimit()

Deprecated.

getGroupLimit

@Deprecated
public int getGroupLimit()

Deprecated.

getOffset

@Deprecated
public int getOffset()

Deprecated.

getLimit

@Deprecated
public int getLimit()

Deprecated.

getGroupSort

@Deprecated
public Sort getGroupSort()

Deprecated.

getSortWithinGroup

@Deprecated
public Sort getSortWithinGroup()

Deprecated.

isIncludeGroupCount

public boolean isIncludeGroupCount()

setIncludeGroupCount

public void setIncludeGroupCount(boolean includeGroupCount)

isMain

public boolean isMain()

setMain

public void setMain(boolean main)

getResponseFormat

public Grouping.Format getResponseFormat()

setResponseFormat

public void setResponseFormat(Grouping.Format responseFormat)

isNeedScore

public boolean isNeedScore()

setNeedScore

public void setNeedScore(boolean needScore)

isTruncateGroups

public boolean isTruncateGroups()

setTruncateGroups

public void setTruncateGroups(boolean truncateGroups)

getGroupSortSpec

public SortSpec getGroupSortSpec()

setGroupSortSpec

public void setGroupSortSpec(SortSpec groupSortSpec)

getWithinGroupSortSpec

public SortSpec getWithinGroupSortSpec()

setWithinGroupSortSpec

public void setWithinGroupSortSpec(SortSpec withinGroupSortSpec)