public class TuplesHandle extends BaseHandle<java.io.InputStream,OperationNotSupported> implements TuplesReadHandle, TuplesResults
UNKNOWN_LENGTH
Constructor and Description |
---|
TuplesHandle() |
Modifier and Type | Method and 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 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.
|
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)
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,
getServerTimestamp,
setByteLength,
setMimetype,
setServerTimestamp
public void setFormat(Format format)
setFormat
in interface ContentDescriptor
setFormat
in class BaseHandle<java.io.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.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 ValuesDefinition getQueryCriteria()
getQueryCriteria
in interface TuplesResults
public void setQueryCriteria(ValuesDefinition vdef)
vdef
- The query criteria.public java.lang.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(java.lang.String name)
TuplesResults
getAggregate
in interface TuplesResults
name
- The name of the aggregate function.public ValuesMetrics getMetrics()
TuplesResults
getMetrics
in interface TuplesResults
Copyright © 2024 MarkLogic Corporation. All Rights Reserved.