com.marklogic.client.admin.config

Class QueryOptions.JsonKey

java.lang.Object

com.marklogic.client.admin.config.QueryOptions.JsonKey

All Implemented Interfaces:

MetadataExtract

Enclosing class:

QueryOptions

public static class QueryOptions.JsonKey
extends Object
implements MetadataExtract

Models a JSON Key. JSON keys refer to keys in JSON data structures by name.

Constructor Summary

Constructors

Constructor and Description
JsonKey() Zero-argument constructor.
JsonKey(String name) Constructs the JSON key specifier with the key.

Method Summary

Modifier and Type	Method and Description
void	build(QueryOptions.QueryExtractMetadata extractMetadata) Adds this JSON key to the metadata extraction specification.
void	build(QueryOptions.QueryTuples values) Adds this JSON key to the tuples query specification.
void	build(QueryOptions.QueryValues values) Adds this JSON key to the values query specification.
String	getName() Returns the key.

Methods inherited from class java.lang.Object

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

Constructor Detail

JsonKey

public JsonKey()

Zero-argument constructor.

JsonKey

public JsonKey(String name)

Constructs the JSON key specifier with the key.

Parameters:

name - the JSON key

Method Detail

getName

public String getName()

Returns the key.

Returns:

the key

build

public void build(QueryOptions.QueryExtractMetadata extractMetadata)

Adds this JSON key to the metadata extraction specification.

Specified by:

build in interface MetadataExtract

build

public void build(QueryOptions.QueryValues values)

Adds this JSON key to the values query specification.

Parameters:

values - the query

build

public void build(QueryOptions.QueryTuples values)

Adds this JSON key to the tuples query specification.

Parameters:

values - the query