ContentDescriptor, AbstractReadHandle, ValuesReadHandle, ValuesResultspublic class ValuesHandle extends BaseHandle<java.io.InputStream,OperationNotSupported> implements ValuesReadHandle, ValuesResults
UNKNOWN_LENGTH| Constructor | Description |
|---|---|
ValuesHandle() |
Zero-argument constructor.
|
| Modifier and Type | Method | Description |
|---|---|---|
AggregateResult |
getAggregate(java.lang.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.
|
java.lang.String |
getName() |
Returns the name of the values.
|
ValuesDefinition |
getQueryCriteria() |
Return the query definition for this set of results.
|
java.lang.String |
getType() |
Returns the type of the values.
|
CountedDistinctValue[] |
getValues() |
Returns an array of the values.
|
protected java.lang.Class<java.io.InputStream> |
receiveAs() |
|
protected void |
receiveContent(java.io.InputStream content) |
|
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.
|
getByteLength, getFormat, getMimetype, getServerTimestamp, setByteLength, setMimetype, setServerTimestamppublic void setFormat(Format format)
setFormat in interface ContentDescriptorsetFormat in class BaseHandle<java.io.InputStream,OperationNotSupported>format - The format, which must be Format.XML or an exception will be raised.public ValuesHandle withFormat(Format format)
format - The format, which must be Format.XML or an exception will be raised.protected java.lang.Class<java.io.InputStream> receiveAs()
receiveAs in class com.marklogic.client.impl.HandleImplementation<java.io.InputStream,OperationNotSupported>protected void receiveContent(java.io.InputStream content)
receiveContent in class com.marklogic.client.impl.HandleImplementation<java.io.InputStream,OperationNotSupported>public void setQueryCriteria(ValuesDefinition vdef)
Calling this method always deletes any cached values.
vdef - The new ValuesDefinitionpublic ValuesDefinition getQueryCriteria()
ValuesResultsgetQueryCriteria in interface ValuesResultspublic java.lang.String getName()
ValuesResultsgetName in interface ValuesResultspublic java.lang.String getType()
ValuesResultsThe type is an XSD type, for example "xs:boolean" or "xs:integer".
getType in interface ValuesResultspublic CountedDistinctValue[] getValues()
ValuesResultsgetValues in interface ValuesResultspublic AggregateResult[] getAggregates()
ValuesResultsgetAggregates in interface ValuesResultspublic AggregateResult getAggregate(java.lang.String name)
ValuesResultsgetAggregate in interface ValuesResultsname - The name of the aggregate function.public ValuesMetrics getMetrics()
ValuesResultsgetMetrics in interface ValuesResultsCopyright © 2013-2019 MarkLogic Corporation.