com.marklogic.client.io

Class ValuesHandle

java.lang.Object

com.marklogic.client.impl.HandleImplementation<R,W>

com.marklogic.client.io.BaseHandle<InputStream,OperationNotSupported>

com.marklogic.client.io.ValuesHandle

All Implemented Interfaces:

ContentDescriptor, AbstractReadHandle, ValuesReadHandle, ValuesResults

public class ValuesHandle
extends BaseHandle<InputStream,OperationNotSupported>
implements ValuesReadHandle, ValuesResults

A ValuesHandle represents a list of values or of tuples (combination of values for the same document) retrieved from the indexes.

Field Summary

Fields inherited from interface com.marklogic.client.document.ContentDescriptor

UNKNOWN_LENGTH

Constructor Summary

Constructors

Constructor and Description
ValuesHandle() Zero-argument constructor.

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.
void	setFormat(Format format) Sets the format associated with this handle.
void	setQueryCriteria(ValuesDefinition vdef) Sets the query definition used when retrieving values.
ValuesHandle	withFormat(Format format) Fluent setter for the format associated with this handle.

Methods inherited from class com.marklogic.client.io.BaseHandle

getByteLength, getFormat, getMimetype, setByteLength, setMimetype

Methods inherited from class java.lang.Object

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

Constructor Detail

ValuesHandle

public ValuesHandle()

Zero-argument constructor.

Method Detail

setFormat

public void setFormat(Format format)

Sets the format associated with this handle. This handle only supports XML.

Specified by:

setFormat in interface ContentDescriptor

Overrides:

setFormat in class BaseHandle<InputStream,OperationNotSupported>

Parameters:

format - The format, which must be Format.XML or an exception will be raised.

withFormat

public ValuesHandle withFormat(Format format)

Fluent setter for the format associated with this handle. This handle only supports XML.

Parameters:

format - The format, which must be Format.XML or an exception will be raised.

Returns:

The SearchHandle instance on which this method was called.

setQueryCriteria

public void setQueryCriteria(ValuesDefinition vdef)

Sets the query definition used when retrieving values.

Calling this method always deletes any cached values.

Parameters:

vdef - The new ValuesDefinition

getQueryCriteria

public ValuesDefinition getQueryCriteria()

Description copied from interface: ValuesResults

Return the query definition for this set of results.

Specified by:

getQueryCriteria in interface ValuesResults

Returns:

The query criteria.

getName

public String getName()

Description copied from interface: ValuesResults

Returns the name of the values.

Specified by:

getName in interface ValuesResults

Returns:

The name.

getType

public String getType()

Description copied from interface: ValuesResults

Returns the type of the values.

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

Specified by:

getType in interface ValuesResults

Returns:

The type.

getValues

public CountedDistinctValue[] getValues()

Description copied from interface: ValuesResults

Returns an array of the values.

Specified by:

getValues in interface ValuesResults

Returns:

The array of values.

getAggregates

public AggregateResult[] getAggregates()

Description copied from interface: ValuesResults

Returns an array of the aggregates.

Specified by:

getAggregates in interface ValuesResults

Returns:

The array of aggrgates.

getAggregate

public AggregateResult getAggregate(String name)

Description copied from interface: ValuesResults

Returns the aggregate result for the named aggregate function.

Specified by:

getAggregate in interface ValuesResults

Parameters:

name - The name of the aggregate function.

Returns:

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

getMetrics

public ValuesMetrics getMetrics()

Description copied from interface: ValuesResults

Returns performance metrics about the query.

Specified by:

getMetrics in interface ValuesResults

Returns:

The metrics