Class ValuesListHandle

All Implemented Interfaces:

ContentDescriptor, AbstractReadHandle, ValuesListReadHandle, ValuesListResults

• Field Summary

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

  UNKNOWN_LENGTH

• Constructor Summary

  Constructors
  Constructor

  Description

  ValuesListHandle()

  The constructor.

• Method Summary

  All MethodsInstance MethodsConcrete Methods

  Modifier and Type

  Method

  Description

  String

  getOptionsName()

  Returns the name of the query options used for this query.

  HashMap<String,String>

  getValuesMap()

  Returns a HashMap of the named lexicon configurations.

  protected Class<InputStream>

  receiveAs()

   

  protected void

  receiveContent(InputStream content)

   

  void

  setFormat(Format format)

  Sets the format associated with this handle.

  void

  setOptionsName(String name)

  Sets the name of the query options to be used for this query.

  ValuesListHandle

  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

  • ValuesListHandle

    public ValuesListHandle()
    The constructor.

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

  • getOptionsName

    public String getOptionsName()
    Returns the name of the query options used for this query.

    Returns:

    The options name.

  • setOptionsName

    public void setOptionsName(String name)
    Sets the name of the query options to be used for this query. If no query options node with the specified name exists, the query will fail.

    Parameters:

    name - The name of the saved query options node on the server.

  • 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>

  • getValuesMap

    public HashMap<String,String> getValuesMap()
    Returns a HashMap of the named lexicon configurations. The keys are the names of the lexicons, the values are the corresponding URIs on the server.

    Specified by:

    getValuesMap in interface ValuesListResults

    Returns:

    The map of names to URIs.

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