com.marklogic.client.io

Class ValuesListHandle

java.lang.Object

com.marklogic.client.impl.HandleImplementation<R,W>

com.marklogic.client.io.BaseHandle<InputStream,OperationNotSupported>

com.marklogic.client.io.ValuesListHandle

All Implemented Interfaces:

ContentDescriptor, AbstractReadHandle, ValuesListReadHandle, ValuesListResults

public class ValuesListHandle
extends BaseHandle<InputStream,OperationNotSupported>
implements ValuesListReadHandle, ValuesListResults

A ValuesListHandle represents a list of available named lexicon configurations from saved query options.

Field Summary

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

UNKNOWN_LENGTH

Constructor Summary

Constructors

Constructor and Description
ValuesListHandle() The constructor.

Method Summary

Modifier and Type	Method and 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.
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, setPointInTimeQueryTimestamp, setResponseServerTimestamp

Methods inherited from class java.lang.Object

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

Constructor Detail

ValuesListHandle

public ValuesListHandle()

The constructor.

Method Detail

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.

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.