com.cloudant.client.api

Class DesignDocumentManager

java.lang.Object

com.cloudant.client.api.DesignDocumentManager

public class DesignDocumentManager
extends java.lang.Object

Provides API to work with design documents.

Usage Example:

 // read from javascript design document file
 
 DesignDocument design = DesignDocumentManager.fromFile("../example.js");
 

 // read from directory of design documents
 
 List<DesignDocument> design =
                  DesignDocumentManager.fromDirectory("../design-files/");
 

 // sync with the database
 
 db.getDesignDocumentManager().put(designDoc);
 

 // sync multiple design documents with the database
 
 db.getDesignDocumentManager().put(listDesignDocuments);
 

 // read from the database
 
 DesignDocument designDoc2 = db.getDesignDocumentManager().get("_design/example");
 
 

See Database.getDesignDocumentManager() to access the API.

Since:

2.0.0

See Also:

DesignDocument

Method Summary

Modifier and Type	Method and Description
static java.util.List<DesignDocument>	fromDirectory(java.io.File directory) Deserialize a directory of javascript design documents to a List of DesignDocument objects.
static DesignDocument	fromFile(java.io.File file) Deserialize a javascript design document file to a DesignDocument object.
DesignDocument	get(java.lang.String id) Gets a design document from the database.
DesignDocument	get(java.lang.String id, java.lang.String rev) Gets a design document using the id and revision from the database.
java.util.List<DesignDocument>	list() Performs a query to retrieve all the design documents defined in the database.
void	put(DesignDocument... designDocs) Synchronize multiple design documents with the database.
Response	put(DesignDocument document) Synchronizes a design document to the Database.
Response	remove(DesignDocument designDocument) Removes a design document using DesignDocument object from the database.
Response	remove(java.lang.String id) Removes a design document from the database.
Response	remove(java.lang.String id, java.lang.String rev) Removes a design document using the id and rev from the database.

Methods inherited from class java.lang.Object

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

Method Detail

put

public Response put(DesignDocument document)

Synchronizes a design document to the Database.

This method will first try to find a document in the database with the same _id as the given document, if it is not found then the given document will be saved to the database.

If the document was found in the database, it will be compared with the given document using DesignDocument.equals(Object). Both the _rev value and content must match for the given documents to be considered equal. This method will not update the revision of the local design document.

• If the documents are equal then no action is taken.
• If the documents are not equal then the given document will be saved to the database therefore updating the existing document.

If the design document's _id is not prefixed with _design/, then the _design/ prefix will be added.

Parameters:

document - the design document to synchronize

Returns:

Response as a result of a document save or update, or returns null if no action was taken and the document in the database is up-to-date with the given document.

put

public void put(DesignDocument... designDocs)

Synchronize multiple design documents with the database.

Parameters:

designDocs - DesignDocument objects to put in the database

See Also:

put(DesignDocument)

get

public DesignDocument get(java.lang.String id)

Gets a design document from the database.

Parameters:

id - the design document id (optionally prefixed with "_design/")

Returns:

DesignDocument

get

public DesignDocument get(java.lang.String id,
                          java.lang.String rev)

Gets a design document using the id and revision from the database.

Parameters:

id - the document id (optionally prefixed with "_design/")

rev - the document revision

Returns:

DesignDocument

remove

public Response remove(java.lang.String id)

Removes a design document from the database.

Parameters:

id - the document id (optionally prefixed with "_design/")

Returns:

DesignDocument

remove

public Response remove(java.lang.String id,
                       java.lang.String rev)

Removes a design document using the id and rev from the database.

Parameters:

id - the document id (optionally prefixed with "_design/")

rev - the document revision

Returns:

DesignDocument

remove

public Response remove(DesignDocument designDocument)

Removes a design document using DesignDocument object from the database.

Parameters:

designDocument - the design document object to be removed

Returns:

DesignDocument

list

public java.util.List<DesignDocument> list()
                                    throws java.io.IOException

Performs a query to retrieve all the design documents defined in the database.

Returns:

a list of the design documents from the database

Throws:

java.io.IOException - if there was an error communicating with the server

Since:

2.5.0

fromDirectory

public static java.util.List<DesignDocument> fromDirectory(java.io.File directory)
                                                    throws java.io.FileNotFoundException

Deserialize a directory of javascript design documents to a List of DesignDocument objects.

Parameters:

directory - the directory containing javascript files

Returns:

DesignDocument

Throws:

java.io.FileNotFoundException - if the file does not exist or cannot be read

fromFile

public static DesignDocument fromFile(java.io.File file)
                               throws java.io.FileNotFoundException

Deserialize a javascript design document file to a DesignDocument object.

Parameters:

file - the design document javascript file (UTF-8 encoded)

Returns:

DesignDocument

Throws:

java.io.FileNotFoundException - if the file does not exist or cannot be read