com.marklogic.client.admin.config

Class QueryOptions.QuerySortOrder

java.lang.Object

com.marklogic.client.admin.config.QueryOptions.QuerySortOrder

All Implemented Interfaces:

Annotatable<QueryOptions.QuerySortOrder>, Indexed

Enclosing class:

QueryOptions

public static class QueryOptions.QuerySortOrder
extends Object
implements Indexed, Annotatable<QueryOptions.QuerySortOrder>

Models criteria for sorting results.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	QueryOptions.QuerySortOrder.Direction Direction enumerates the order for sorting values.
static class	QueryOptions.QuerySortOrder.Score Score enumerates whether or not the relevance score is used.

Constructor Summary

Constructors

Constructor and Description
QueryOptions.QuerySortOrder()

Method Summary

Methods

Modifier and Type	Method and Description
QueryOptions.QuerySortOrder	annotate(String xmlString)
List<QueryOptions.QueryAnnotation>	getAnnotations()
QName	getAttribute()
String	getCollation()
QueryOptions.QuerySortOrder.Direction	getDirection()
QName	getElement()
String	getFieldName()
String	getJsonKey()
QueryOptions.QuerySortOrder.Score	getScore()
String	getType()
void	setAttribute(QueryOptions.MarkLogicQName attribute)
void	setCollation(String collation)
void	setDirection(QueryOptions.QuerySortOrder.Direction direction)
void	setElement(QueryOptions.MarkLogicQName element)
void	setField(QueryOptions.Field field)
void	setJsonKey(QueryOptions.JsonKey jsonKey)
void	setPath(QueryOptions.PathIndex pathIndex)
void	setScore()
void	setType(String type)
void	unsetScore()

Methods inherited from class java.lang.Object

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

Constructor Detail

QueryOptions.QuerySortOrder

public QueryOptions.QuerySortOrder()

Method Detail

getAnnotations

public List<QueryOptions.QueryAnnotation> getAnnotations()

Specified by:

getAnnotations in interface Annotatable<QueryOptions.QuerySortOrder>

annotate

public QueryOptions.QuerySortOrder annotate(String xmlString)

Specified by:

annotate in interface Annotatable<QueryOptions.QuerySortOrder>

getAttribute

public QName getAttribute()

getCollation

public String getCollation()

getDirection

public QueryOptions.QuerySortOrder.Direction getDirection()

getElement

public QName getElement()

getFieldName

public String getFieldName()

getJsonKey

public String getJsonKey()

getType

public String getType()

setAttribute

public void setAttribute(QueryOptions.MarkLogicQName attribute)

Specified by:

setAttribute in interface Indexed

setCollation

public void setCollation(String collation)

setDirection

public void setDirection(QueryOptions.QuerySortOrder.Direction direction)

setElement

public void setElement(QueryOptions.MarkLogicQName element)

Specified by:

setElement in interface Indexed

setField

public void setField(QueryOptions.Field field)

Specified by:

setField in interface Indexed

setPath

public void setPath(QueryOptions.PathIndex pathIndex)

Specified by:

setPath in interface Indexed

setScore

public void setScore()

getScore

public QueryOptions.QuerySortOrder.Score getScore()

unsetScore

public void unsetScore()

setType

public void setType(String type)

setJsonKey

public void setJsonKey(QueryOptions.JsonKey jsonKey)

Specified by:

setJsonKey in interface Indexed