Skip navigation links

oracle.search.query.webservice.client
Class GroupAttribute

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

All Implemented Interfaces:

Serializable

public class GroupAttribute

extends Object

implements Serializable

GroupAttribute represents the grouping settings of a document attribute.

See Also:

Serialized Form

Constructor Summary

GroupAttribute(SortAttribute groupingAttribute, String groupingOption, String optionParameter)

Method Summary

SortAttribute	getGroupingAttribute() Returns the attribute used for grouping.
String	getGroupingOption() Returns the grouping option.
String	getOptionParameter() Returns the grouping option parameter.
void	setGroupingAttribute(SortAttribute groupingAttribute) Sets the attribute used for grouping.
void	setGroupingOption(String groupingOption) Sets the grouping option.
void	setOptionParameter(String optionParameter) Sets 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(SortAttribute groupingAttribute,
                      String groupingOption,
                      String optionParameter)

Parameters:

groupingAttribute - grouping attribute

groupingOption - grouping option. Only supports "EQUALITY" grouping

optionParameter - parameter used for grouping option

Method Detail

getGroupingAttribute

public SortAttribute getGroupingAttribute()

Returns the attribute used for grouping.

setGroupingAttribute

public void setGroupingAttribute(SortAttribute groupingAttribute)

Sets the attribute used for grouping.

Parameters:

groupingAttribute - the grouping attribute

getGroupingOption

public String getGroupingOption()

Returns the grouping option.

setGroupingOption

public void setGroupingOption(String groupingOption)

Sets the grouping option.

Parameters:

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

getOptionParameter

public String getOptionParameter()

Returns the grouping option parameter.

setOptionParameter

public void setOptionParameter(String optionParameter)

Sets 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