com.marklogic.client.query

Interface TuplesResults

All Known Implementing Classes:

TuplesHandle

public interface TuplesResults

TupleResults represent the values returned by a tuple 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 tuples.
ValuesDefinition	getQueryCriteria() Returns the query used to locate these tuples.
Tuple[]	getTuples() Returns an array of Tuples.

Method Detail

getQueryCriteria

ValuesDefinition getQueryCriteria()

Returns the query used to locate these tuples.

Returns:

The query definition.

getName

String getName()

Returns the name of the tuples.

Returns:

The name.

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.

getTuples

Tuple[] getTuples()

Returns an array of Tuples.

Returns:

The array of tuples.

getMetrics

ValuesMetrics getMetrics()

Returns performance metrics about the query.

Returns:

The metrics