com.cloudant.client.api.model

Class Index

java.lang.Object

com.cloudant.client.api.model.Index

public class Index
extends java.lang.Object

Encapsulates a Cloudant Index definition

Since:

0.0.1

Constructor Summary

Constructors

Constructor and Description
Index(java.lang.String designDocId, java.lang.String name, java.lang.String type)

Method Summary

Modifier and Type	Method and Description
void	addIndexField(java.lang.String fieldName, IndexField.SortOrder order)
java.lang.String	getDesignDocId()
java.util.Iterator<IndexField>	getFields()
java.lang.String	getName()
java.lang.String	getType()
java.lang.String	toString()

Methods inherited from class java.lang.Object

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

Constructor Detail

Index

public Index(java.lang.String designDocId,
             java.lang.String name,
             java.lang.String type)

Method Detail

getDesignDocId

public java.lang.String getDesignDocId()

Returns:

the designDocId

getName

public java.lang.String getName()

Returns:

the index name

getType

public java.lang.String getType()

Returns:

the index type e.g. json

getFields

public java.util.Iterator<IndexField> getFields()

Returns:

the IndexFields

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

addIndexField

public void addIndexField(java.lang.String fieldName,
                          IndexField.SortOrder order)