public class ValuesHandle extends BaseHandle<InputStream,OperationNotSupported> implements ValuesReadHandle, ValuesResults
UNKNOWN_LENGTH
Constructor and Description |
---|
ValuesHandle()
Zero-argument constructor.
|
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.
|
getByteLength, getFormat, getMimetype, setByteLength, setMimetype
public void setFormat(Format format)
setFormat
in interface ContentDescriptor
setFormat
in class BaseHandle<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.public void setQueryCriteria(ValuesDefinition vdef)
Calling this method always deletes any cached values.
vdef
- The new ValuesDefinitionpublic ValuesDefinition getQueryCriteria()
ValuesResults
getQueryCriteria
in interface ValuesResults
public String getName()
ValuesResults
getName
in interface ValuesResults
public String getType()
ValuesResults
The type is an XSD type, for example "xs:boolean" or "xs:integer".
getType
in interface ValuesResults
public CountedDistinctValue[] getValues()
ValuesResults
getValues
in interface ValuesResults
public AggregateResult[] getAggregates()
ValuesResults
getAggregates
in interface ValuesResults
public AggregateResult getAggregate(String name)
ValuesResults
getAggregate
in interface ValuesResults
name
- The name of the aggregate function.public ValuesMetrics getMetrics()
ValuesResults
getMetrics
in interface ValuesResults
Copyright © 2013-2016 MarkLogic Corporation.