Package com.marklogic.client.query

Interface ValuesDefinition

public interface ValuesDefinition

A ValuesDefinition represents a values query used to retreive values from the server.

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static class	ValuesDefinition.Direction	The possible directions.
static class	ValuesDefinition.Frequency	The kinds of frequencies.

Method Summary

Modifier and Type	Method	Description
java.lang.String[]	getAggregate()	Returns the name of the aggregate function applied to this query.
java.lang.String	getAggregatePath()	Returns the aggregate path.
ValuesDefinition.Direction	getDirection()	Returns the direction of the results in this values query.
ValuesDefinition.Frequency	getFrequency()	Returns the frequency of the results.
java.lang.String	getName()	Returns the name of the values constraint.
java.lang.String	getOptionsName()	Returns the name of the options node used for this values query.
ValueQueryDefinition	getQueryDefinition()	Returns the query definition associated with this values query.
java.lang.String	getView()	Returns the view for this values query.
void	setAggregate(java.lang.String... aggregate)	Sets the name of the aggregate function to be applied as part of this values query.
void	setAggregatePath(java.lang.String aggregate)	Sets the aggregate path.
void	setDirection(ValuesDefinition.Direction dir)	Sets the direction of the results to use in this values query.
void	setFrequency(ValuesDefinition.Frequency freq)	Sets the frequency to be used in this values query.
void	setName(java.lang.String name)	Sets the name of the values constraint.
void	setOptionsName(java.lang.String optname)	Set the name of the options node to use for this values query.
void	setQueryDefinition(ValueQueryDefinition qdef)	Set the query definition associated with this values query.
void	setView(java.lang.String view)	Sets the view for this values query.

Method Detail

getName

java.lang.String getName()

Returns the name of the values constraint.

Returns:

The name of the values constraint.

setName

void setName(java.lang.String name)

Sets the name of the values constraint.

Parameters:

name - The values constraint name.

getQueryDefinition

ValueQueryDefinition getQueryDefinition()

Returns the query definition associated with this values query.

Returns:

The query definition.

setQueryDefinition

void setQueryDefinition(ValueQueryDefinition qdef)

Set the query definition associated with this values query.

Parameters:

qdef - The query definition.

getOptionsName

java.lang.String getOptionsName()

Returns the name of the options node used for this values query.

Returns:

The name of the options node.

setOptionsName

void setOptionsName(java.lang.String optname)

Set the name of the options node to use for this values query.

Parameters:

optname - The name of the options node.

getAggregate

java.lang.String[] getAggregate()

Returns the name of the aggregate function applied to this query.

Returns:

The name of the function.

setAggregate

void setAggregate(java.lang.String... aggregate)

Sets the name of the aggregate function to be applied as part of this values query.

Parameters:

aggregate - The name of the function.

getAggregatePath

java.lang.String getAggregatePath()

Returns the aggregate path.

Returns:

The path.

setAggregatePath

void setAggregatePath(java.lang.String aggregate)

Sets the aggregate path.

Parameters:

aggregate - The aggregate path.

getView

java.lang.String getView()

Returns the view for this values query.

Returns:

The view.

setView

void setView(java.lang.String view)

Sets the view for this values query.

Parameters:

view - The view.

getDirection

ValuesDefinition.Direction getDirection()

Returns the direction of the results in this values query.

Returns:

The direction.

setDirection

void setDirection(ValuesDefinition.Direction dir)

Sets the direction of the results to use in this values query.

Parameters:

dir - The direction.

getFrequency

ValuesDefinition.Frequency getFrequency()

Returns the frequency of the results.

Returns:

The frequency.

setFrequency

void setFrequency(ValuesDefinition.Frequency freq)

Sets the frequency to be used in this values query.

Parameters:

freq - The frequency.