Class TuplesHandle

All Implemented Interfaces:

ContentDescriptor, AbstractReadHandle, TuplesReadHandle, TuplesResults

• Field Summary

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

  UNKNOWN_LENGTH

• Constructor Summary

  Constructors
  Constructor

  Description

  TuplesHandle()

   

• Method Summary

  All MethodsInstance MethodsConcrete Methods

  Modifier and Type

  Method

  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.

  protected Class<InputStream>

  receiveAs()

   

  protected void

  receiveContent(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.

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

  getByteLength, getFormat, getMimetype, getServerTimestamp, setByteLength, setMimetype, setServerTimestamp

  Methods inherited from class com.marklogic.client.impl.HandleImplementation

  getPointInTimeQueryTimestamp, isResendable, sendContent, setPointInTimeQueryTimestamp, setResendable, setResponseServerTimestamp

  Methods inherited from class java.lang.Object

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

• Constructor Details

  • TuplesHandle

    public TuplesHandle()

• Method Details

  • 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 TuplesHandle 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 TuplesHandle instance on which this method was called.

  • receiveAs

    protected Class<InputStream> receiveAs()

    Overrides:

    receiveAs in class com.marklogic.client.impl.HandleImplementation<InputStream,OperationNotSupported>

  • receiveContent

    protected void receiveContent(InputStream content)

    Overrides:

    receiveContent in class com.marklogic.client.impl.HandleImplementation<InputStream,OperationNotSupported>

  • getQueryCriteria

    public ValuesDefinition getQueryCriteria()
    Returns the tuples query definition used to identify this set of tuples.

    Specified by:

    getQueryCriteria in interface TuplesResults

    Returns:

    The query criteria.

  • setQueryCriteria

    public void setQueryCriteria(ValuesDefinition vdef)
    Specifies the tuples query definition used to identify this set of tuples.

    Parameters:

    vdef - The query criteria.

  • getName

    public String getName()
    Description copied from interface: TuplesResults
    Returns the name of the tuples.

    Specified by:

    getName in interface TuplesResults

    Returns:

    The name.

  • getTuples

    public Tuple[] getTuples()
    Returns an array of the Tuples returned by this query.

    Specified by:

    getTuples in interface TuplesResults

    Returns:

    The tuples array.

  • getAggregates

    public AggregateResult[] getAggregates()
    Description copied from interface: TuplesResults
    Returns an array of the aggregates.

    Specified by:

    getAggregates in interface TuplesResults

    Returns:

    The array of aggrgates.

  • getAggregate

    public AggregateResult getAggregate(String name)
    Description copied from interface: TuplesResults
    Returns the aggregate result for the named aggregate function.

    Specified by:

    getAggregate in interface TuplesResults

    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: TuplesResults
    Returns performance metrics about the query.

    Specified by:

    getMetrics in interface TuplesResults

    Returns:

    The metrics

Copyright (c) 2010-2025 Progress Software Corporation and/or its subsidiaries or affiliates. All Rights Reserved.