com.marklogic.client.query

Interface SuggestDefinition

public interface SuggestDefinition

Represents the criteria for a suggestion call, in which the beginning of a term is supplied for possible suggested endings.

Method Summary

Modifier and Type	Method and Description
Integer	getCursorPosition() Returns the cursor position for the suggest call.
Integer	getLimit() Returns the maximum number of suggestions to fetch.
String	getOptionsName() Returns the name of the query options used for this query.
String[]	getQueryStrings() Returns the array of strings set for this SuggestDefinition.
String	getStringCriteria() Returns the text of the suggestion call.
void	setCursorPosition(Integer cursorPosition) Sets the cursor position to use in the suggest call.
void	setLimit(Integer limit) Sets a limit for a suggest call.
void	setOptionsName(String name) Sets the name of the query options to be used for this query.
void	setQueryStrings(String... qtext) Sets zero or more search strings to AND with the suggestion call.
void	setStringCriteria(String pqtext) Sets one or more criteria for the suggestion call.

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.

setStringCriteria

void setStringCriteria(String pqtext)

Sets one or more criteria for the suggestion call.

Parameters:

pqtext - A string for input to suggestions.

getStringCriteria

String getStringCriteria()

Returns the text of the suggestion call.

Returns:

The suggestion input.

setQueryStrings

void setQueryStrings(String... qtext)

Sets zero or more search strings to AND with the suggestion call.

Parameters:

qtext - Zero or more string queries to qualify that input string.

getQueryStrings

String[] getQueryStrings()

Returns the array of strings set for this SuggestDefinition.

Returns:

The query text strings and suggestion input.

setLimit

void setLimit(Integer limit)

Sets a limit for a suggest call. Only this number of suggestions will be returned by the server. Server default is 10.

Parameters:

limit - The maximum number of suggestions to fetch.

getLimit

Integer getLimit()

Returns the maximum number of suggestions to fetch.

Returns:

The limit.

setCursorPosition

void setCursorPosition(Integer cursorPosition)

Sets the cursor position to use in the suggest call.

Parameters:

cursorPosition - The cursor position.

getCursorPosition

Integer getCursorPosition()

Returns the cursor position for the suggest call.

Returns:

The cursor position