com.marklogic.client.query

Interface ValuesResults

All Known Implementing Classes:

ValuesHandle

public interface ValuesResults

ValuesResults represents one set of values from a values query.

Method Summary

Modifier and Type	Method and Description
AggregateResult	getAggregate(String name) Returns the aggregate result for the named aggregate function.
AggregateResult[]	getAggregates() Returns an array of the aggregates.
ValuesMetrics	getMetrics() Returns performance metrics about the query.
String	getName() Returns the name of the values.
ValuesDefinition	getQueryCriteria() Return the query definition for this set of results.
String	getType() Returns the type of the values.
CountedDistinctValue[]	getValues() Returns an array of the values.

Method Detail

getQueryCriteria

ValuesDefinition getQueryCriteria()

Return the query definition for this set of results.

Returns:

The query criteria.

getName

String getName()

Returns the name of the values.

Returns:

The name.

getType

String getType()

Returns the type of the values.

The type is an XSD type, for example "xs:boolean" or "xs:integer".

Returns:

The type.

getValues

CountedDistinctValue[] getValues()

Returns an array of the values.

Returns:

The array of values.

getAggregates

AggregateResult[] getAggregates()

Returns an array of the aggregates.

Returns:

The array of aggrgates.

getAggregate

AggregateResult getAggregate(String name)

Returns the aggregate result for the named aggregate function.

Parameters:

name - The name of the aggregate function.

Returns:

The corresponding aggregate, or null if no such aggregate exists.

getMetrics

ValuesMetrics getMetrics()

Returns performance metrics about the query.

Returns:

The metrics