com.marklogic.client.admin.config

Class QueryOptions.Aggregate

java.lang.Object

com.marklogic.client.admin.config.QueryOptions.Aggregate

Enclosing class:

QueryOptions

public static final class QueryOptions.Aggregate
extends Object

Corresponds to aggregate element in Search API configuration. Configures inclusion of aggregate function in call to a values endpoint.

Constructor Summary

Constructors

Constructor and Description
Aggregate()

Method Summary

Modifier and Type	Method and Description
String	getApply() Gets the apply function.
String	getUdf() Gets a user-defined function plugin
void	setApply(String apply) Sets the aggregate function name.
void	setUdf(String udf) Sets the user-defined function plugin.

Methods inherited from class java.lang.Object

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

Constructor Detail

Aggregate

public Aggregate()

Method Detail

getApply

public String getApply()

Gets the apply function.

Returns:

A string corresponding to a built-in aggregate function, or to a user-defined function.

getUdf

public String getUdf()

Gets a user-defined function plugin

Returns:

The name of a user-defined plugin. There is no guarantee that this plugin actually exists.

setApply

public void setApply(String apply)

Sets the aggregate function name.

Parameters:

apply - The function name

setUdf

public void setUdf(String udf)

Sets the user-defined function plugin.

Parameters:

udf - The UDF plugin name.