com.marklogic.client.query

Interface QueryDefinition

All Known Subinterfaces:

DeleteQueryDefinition, PojoQueryDefinition, RawCombinedQueryDefinition, RawQueryByExampleDefinition, RawQueryDefinition, RawStructuredQueryDefinition, SPARQLQueryDefinition, StringQueryDefinition, StructuredQueryBuilder.Box, StructuredQueryBuilder.Circle, StructuredQueryBuilder.Point, StructuredQueryBuilder.Polygon, StructuredQueryBuilder.Region, StructuredQueryDefinition, ValueQueryDefinition

public interface QueryDefinition

A QueryDefinition represents the common parts of all kinds of searches that can be performed.

Method Summary

Modifier and Type	Method and Description
String[]	getCollections() Returns the array of collections to which the query is limited.
String	getDirectory() Returns the directory to which the query is limited.
String	getOptionsName() Returns the name of the query options used for this query.
ServerTransform	getResponseTransform() Returns the transform that modifies responses to this query on the server.
void	setCollections(String... collections) Sets the list of collections to which the query should be limited.
void	setDirectory(String directory) Sets the directory to which the query should be limited.
void	setOptionsName(String name) Sets the name of the query options to be used for this query.
void	setResponseTransform(ServerTransform transform) Specifies a transform that modifies responses to this query on the server.

Method Detail

getOptionsName

String getOptionsName()

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

Returns:

The options name.

setOptionsName

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 search will fail.

Parameters:

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

getCollections

String[] getCollections()

Returns the array of collections to which the query is limited.

Returns:

The array of collection URIs.

setCollections

void setCollections(String... collections)

Sets the list of collections to which the query should be limited.

Parameters:

collections - The list of collection URIs.

getDirectory

String getDirectory()

Returns the directory to which the query is limited.

Returns:

The directory URI.

setDirectory

void setDirectory(String directory)

Sets the directory to which the query should be limited.

Parameters:

directory - The directory URI.

getResponseTransform

ServerTransform getResponseTransform()

Returns the transform that modifies responses to this query on the server.

Returns:

The transform.

setResponseTransform

void setResponseTransform(ServerTransform transform)

Specifies a transform that modifies responses to this query on the server.

Parameters:

transform - A server transform to modify the query response.