org.lightcouch

Class CouchDbClientBase

java.lang.Object

org.lightcouch.CouchDbClientBase

Direct Known Subclasses:

CouchDbClient, CouchDbClientAndroid

public abstract class CouchDbClientBase
extends java.lang.Object

Contains a client Public API implementation.

Author:

Ahmed Yehia

See Also:

CouchDbClient, CouchDbClientAndroid

Method Summary

Modifier and Type	Method and Description
void	batch(java.lang.Object object) Saves a document with batch=ok query param.
java.util.List<Response>	bulk(java.util.List<?> objects, boolean newEdits) Performs bulk documents create and update request.
Changes	changes() Provides access to Change Notifications API.
boolean	contains(java.lang.String id) Checks if a document exist in the database.
CouchDbContext	context() Provides access to DB server APIs.
CouchDbDesign	design() Provides access to CouchDB Design Documents.
org.apache.http.HttpResponse	executeRequest(org.apache.http.client.methods.HttpRequestBase request) Executes a HTTP request.
<T> T	find(java.lang.Class<T> classType, java.lang.String id) Finds an Object of the specified type.
<T> T	find(java.lang.Class<T> classType, java.lang.String id, Params params) Finds an Object of the specified type.
<T> T	find(java.lang.Class<T> classType, java.lang.String id, java.lang.String rev) Finds an Object of the specified type.
java.io.InputStream	find(java.lang.String id) Finds a document and return the result as InputStream.
java.io.InputStream	find(java.lang.String id, java.lang.String rev) Finds a document given id and revision and returns the result as InputStream.
<T> T	findAny(java.lang.Class<T> classType, java.lang.String uri) This method finds any document given a URI.
<T> java.util.List<T>	findDocs(java.lang.String jsonQuery, java.lang.Class<T> classOfT) Find documents using a declarative JSON querying syntax.
java.net.URI	getBaseUri()
java.net.URI	getDBUri()
com.google.gson.Gson	getGson()
java.lang.String	invokeUpdateHandler(java.lang.String updateHandlerUri, java.lang.String docId, Params params) Invokes an Update Handler.
Response	post(java.lang.Object object) Saves an object in the database using HTTP POST request.
Response	remove(java.lang.Object object) Removes a document from the database.
Response	remove(java.lang.String id, java.lang.String rev) Removes a document from the database given both a document _id and _rev values.
Replication	replication() Provides access to CouchDB replication APIs.
Replicator	replicator() Provides access to the replicator database.
Response	save(java.lang.Object object) Saves an object in the database, using HTTP PUT request.
Response	saveAttachment(java.io.InputStream in, java.lang.String name, java.lang.String contentType) Saves an attachment to a new document with a generated UUID as the document id.
Response	saveAttachment(java.io.InputStream in, java.lang.String name, java.lang.String contentType, java.lang.String docId, java.lang.String docRev) Saves an attachment to an existing document given both a document id and revision, or save to a new document given only the id, and rev as null.
void	setGsonBuilder(com.google.gson.GsonBuilder gsonBuilder) Sets a GsonBuilder to create Gson instance.
void	syncDesignDocsWithDb() Synchronize all design documents with the database.
Response	update(java.lang.Object object) Updates an object in the database, the object must have the correct _id and _rev values.
View	view(java.lang.String viewId) Provides access to CouchDB View APIs.

Methods inherited from class java.lang.Object

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

Method Detail

context

public CouchDbContext context()

Provides access to DB server APIs.

Returns:

CouchDbContext

design

public CouchDbDesign design()

Provides access to CouchDB Design Documents.

Returns:

CouchDbDesign

view

public View view(java.lang.String viewId)

Provides access to CouchDB View APIs.

Parameters:

viewId - The view id.

Returns:

View

replication

public Replication replication()

Provides access to CouchDB replication APIs.

Returns:

Replication

replicator

public Replicator replicator()

Provides access to the replicator database.

Returns:

Replicator

changes

public Changes changes()

Provides access to Change Notifications API.

Returns:

Changes

find

public <T> T find(java.lang.Class<T> classType,
                  java.lang.String id)

Finds an Object of the specified type.

Type Parameters:

T - Object type.

Parameters:

classType - The class of type T.

id - The document id.

Returns:

An object of type T.

Throws:

NoDocumentException - If the document is not found in the database.

find

public <T> T find(java.lang.Class<T> classType,
                  java.lang.String id,
                  Params params)

Finds an Object of the specified type.

Type Parameters:

T - Object type.

Parameters:

classType - The class of type T.

id - The document id.

params - Extra parameters to append.

Returns:

An object of type T.

Throws:

NoDocumentException - If the document is not found in the database.

find

public <T> T find(java.lang.Class<T> classType,
                  java.lang.String id,
                  java.lang.String rev)

Finds an Object of the specified type.

Type Parameters:

T - Object type.

Parameters:

classType - The class of type T.

id - The document _id field.

rev - The document _rev field.

Returns:

An object of type T.

Throws:

NoDocumentException - If the document is not found in the database.

findAny

public <T> T findAny(java.lang.Class<T> classType,
                     java.lang.String uri)

This method finds any document given a URI.

The URI must be URI-encoded.

Type Parameters:

T - The class type.

Parameters:

classType - The class of type T.

uri - The URI as string.

Returns:

An object of type T.

find

public java.io.InputStream find(java.lang.String id)

Finds a document and return the result as InputStream.

Note: The stream must be closed after use to release the connection.

Parameters:

id - The document _id field.

Returns:

The result as InputStream

Throws:

NoDocumentException - If the document is not found in the database.

See Also:

find(String, String)

find

public java.io.InputStream find(java.lang.String id,
                                java.lang.String rev)

Finds a document given id and revision and returns the result as InputStream.

Note: The stream must be closed after use to release the connection.

Parameters:

id - The document _id field.

rev - The document _rev field.

Returns:

The result as InputStream

Throws:

NoDocumentException - If the document is not found in the database.

findDocs

public <T> java.util.List<T> findDocs(java.lang.String jsonQuery,
                                      java.lang.Class<T> classOfT)

Find documents using a declarative JSON querying syntax.

Type Parameters:

T - The class type.

Parameters:

jsonQuery - The JSON query string.

classOfT - The class of type T.

Returns:

The result of the query as a List<T>

Throws:

CouchDbException - If the query failed to execute or the request is invalid.

contains

public boolean contains(java.lang.String id)

Checks if a document exist in the database.

Parameters:

id - The document _id field.

Returns:

true If the document is found, false otherwise.

save

public Response save(java.lang.Object object)

Saves an object in the database, using HTTP PUT request.

If the object doesn't have an _id value, the code will assign a UUID as the document id.

Parameters:

object - The object to save

Returns:

Response

Throws:

DocumentConflictException - If a conflict is detected during the save.

post

public Response post(java.lang.Object object)

Saves an object in the database using HTTP POST request.

The database will be responsible for generating the document id.

Parameters:

object - The object to save

Returns:

Response

batch

public void batch(java.lang.Object object)

Saves a document with batch=ok query param.

Parameters:

object - The object to save.

update

public Response update(java.lang.Object object)

Updates an object in the database, the object must have the correct _id and _rev values.

Parameters:

object - The object to update

Returns:

Response

Throws:

DocumentConflictException - If a conflict is detected during the update.

remove

public Response remove(java.lang.Object object)

Removes a document from the database.

The object must have the correct _id and _rev values.

Parameters:

object - The document to remove as object.

Returns:

Response

Throws:

NoDocumentException - If the document is not found in the database.

remove

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

Removes a document from the database given both a document _id and _rev values.

Parameters:

id - The document _id field.

rev - The document _rev field.

Returns:

Response

Throws:

NoDocumentException - If the document is not found in the database.

bulk

public java.util.List<Response> bulk(java.util.List<?> objects,
                                     boolean newEdits)

Performs bulk documents create and update request.

Parameters:

objects - The List of documents objects.

newEdits - If false, prevents the database from assigning documents new revision IDs.

Returns:

List<Response> Containing the resulted entries.

saveAttachment

public Response saveAttachment(java.io.InputStream in,
                               java.lang.String name,
                               java.lang.String contentType)

Saves an attachment to a new document with a generated UUID as the document id.

To retrieve an attachment, see find(String).

Parameters:

in - The InputStream holding the binary data.

name - The attachment name.

contentType - The attachment "Content-Type".

Returns:

Response

saveAttachment

public Response saveAttachment(java.io.InputStream in,
                               java.lang.String name,
                               java.lang.String contentType,
                               java.lang.String docId,
                               java.lang.String docRev)

Saves an attachment to an existing document given both a document id and revision, or save to a new document given only the id, and rev as null.

To retrieve an attachment, see find(String).

Parameters:

in - The InputStream holding the binary data.

name - The attachment name.

contentType - The attachment "Content-Type".

docId - The document id to save the attachment under, or null to save under a new document.

docRev - The document revision to save the attachment under, or null when saving to a new document.

Returns:

Response

invokeUpdateHandler

public java.lang.String invokeUpdateHandler(java.lang.String updateHandlerUri,
                                            java.lang.String docId,
                                            Params params)

Invokes an Update Handler.

 Params params = new Params()
        .addParam("field", "foo")
        .addParam("value", "bar"); 
 String output = dbClient.invokeUpdateHandler("designDoc/update1", "docId", params);
 

Parameters:

updateHandlerUri - The Update Handler URI, in the format: designDoc/update1

docId - The document id to update.

params - The query parameters as Params.

Returns:

The output of the request.

executeRequest

public org.apache.http.HttpResponse executeRequest(org.apache.http.client.methods.HttpRequestBase request)

Executes a HTTP request.

Note: The response must be closed after use to release the connection.

Parameters:

request - The HTTP request to execute.

Returns:

HttpResponse

syncDesignDocsWithDb

public void syncDesignDocsWithDb()

Synchronize all design documents with the database.

setGsonBuilder

public void setGsonBuilder(com.google.gson.GsonBuilder gsonBuilder)

Sets a GsonBuilder to create Gson instance.

Useful for registering custom serializers/deserializers, such as JodaTime classes.

Parameters:

gsonBuilder - The GsonBuilder

getBaseUri

public java.net.URI getBaseUri()

Returns:

The base URI.

getDBUri

public java.net.URI getDBUri()

Returns:

The database URI.

getGson

public com.google.gson.Gson getGson()

Returns:

The Gson instance.