com.cloudant.client.api.model

Class IndexField

java.lang.Object

com.cloudant.client.api.model.IndexField

public class IndexField
extends java.lang.Object

Encapsulates a Cloudant IndexField definition

Since:

0.0.1

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	IndexField.SortOrder Ascending or descending sort order

Constructor Summary

Constructors

Constructor and Description
IndexField(java.lang.String name, IndexField.SortOrder order) Encapsulates a Cloudant Sort Syntax for a json field.

Method Summary

Modifier and Type	Method and Description
java.lang.String	getName()
IndexField.SortOrder	getOrder()
java.lang.String	toString()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

IndexField

public IndexField(java.lang.String name,
                  IndexField.SortOrder order)

Encapsulates a Cloudant Sort Syntax for a json field. Used to specify an element of the 'index.fields' array (POST db/_index) and 'sort' array (db/_find) @see sort Syntax

Parameters:

name - can be any field (dotted notation is available for sub-document fields)

order - can be "asc" or "desc"

Method Detail

getName

public java.lang.String getName()

Returns:

the name

getOrder

public IndexField.SortOrder getOrder()

Returns:

the order

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object