Skip navigation links

oracle.search.query.webservice.client
Class GroupAttribute

java.lang.Object
oracle.search.query.webservice.client.GroupAttribute

public class GroupAttribute

extends Object

GroupAttribute represents the grouping settings of a document attribute

Constructor Summary

GroupAttribute()

GroupAttribute(SortAttribute groupingAttribute, String groupingOption, String optionParameter)

Method Summary

SortAttribute	getGroupingAttribute() Return the attribute used for grouping
String	getGroupingOption() Return the grouping option
String	getOptionParameter() Return the grouping option parameter
void	setGroupingAttribute(SortAttribute groupingAttribute) Set the attribute used for grouping
void	setGroupingOption(String groupingOption) Set the grouping option
void	setOptionParameter(String optionParameter) Set the parameter string for the grouping option.

Methods inherited from class java.lang.Object

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

Constructor Detail

GroupAttribute

public GroupAttribute()

GroupAttribute

public GroupAttribute(SortAttribute groupingAttribute,
                      String groupingOption,
                      String optionParameter)

Parameters:

groupingAttribute - the grouping attribute

groupingOption - grouping option. Only supports "EQUALITY" grouping

optionParameter - parameter used for grouping option

Method Detail

getGroupingAttribute

public SortAttribute getGroupingAttribute()

Return the attribute used for grouping

getGroupingOption

public String getGroupingOption()

Return the grouping option

getOptionParameter

public String getOptionParameter()

Return the grouping option parameter

setGroupingAttribute

public void setGroupingAttribute(SortAttribute groupingAttribute)

Set the attribute used for grouping

Parameters:

groupingAttribute - the grouping attribute

setGroupingOption

public void setGroupingOption(String groupingOption)

Set the grouping option

Parameters:

groupingOption - grouping option: only "EQUALITY" is supported in current release

setOptionParameter

public void setOptionParameter(String optionParameter)

Set the parameter string for the grouping option. The applicable value is specific to the option.

Parameters:

optionParameter - grouping option parameter. It is null if the grouping option is "EQUALITY"

Skip navigation links