public class TuplesHandle extends BaseHandle<InputStream,OperationNotSupported> implements TuplesReadHandle, TuplesResults
UNKNOWN_LENGTH
Constructor and Description |
---|
TuplesHandle() |
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 tuples query definition used to identify this set of tuples.
|
Tuple[] |
getTuples()
Returns an array of the Tuples returned by this query.
|
void |
setFormat(Format format)
Sets the format associated with this handle.
|
void |
setQueryCriteria(ValuesDefinition vdef)
Specifies the tuples query definition used to identify this set of tuples.
|
TuplesHandle |
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 TuplesHandle withFormat(Format format)
format
- The format, which must be Format.XML or an exception will be raised.public ValuesDefinition getQueryCriteria()
getQueryCriteria
in interface TuplesResults
public void setQueryCriteria(ValuesDefinition vdef)
vdef
- The query criteria.public String getName()
TuplesResults
getName
in interface TuplesResults
public Tuple[] getTuples()
getTuples
in interface TuplesResults
public AggregateResult[] getAggregates()
TuplesResults
getAggregates
in interface TuplesResults
public AggregateResult getAggregate(String name)
TuplesResults
getAggregate
in interface TuplesResults
name
- The name of the aggregate function.public ValuesMetrics getMetrics()
TuplesResults
getMetrics
in interface TuplesResults
Copyright © 2013-2016 MarkLogic Corporation.