org.lightcouch

Class CouchDbDesign

java.lang.Object

org.lightcouch.CouchDbDesign

public class CouchDbDesign
extends java.lang.Object

Provides API to work with design documents.

Usage Example:

 // read from system files
 DesignDocument design1 = dbClient.design().getFromDesk("example");
 
 // sync with the database
 dbClient.design().synchronizeWithDb(design1);
 
 // sync all with the database
 dbClient.syncDesignDocsWithDb();
 
 // read from the database
 DesignDocument design2 = dbClient.design().getFromDb("_design/example");
 

Since:

0.0.2

See Also:

CouchDbClient#design() dbClient.design()} to access the API., DesignDocument

Field Summary

Fields

Modifier and Type	Field and Description
private CouchDbClientBase	dbc
private static java.lang.String	DESIGN_DOCS_DIR
private static java.lang.String	DESIGN_PREFIX
private static java.lang.String	FILTERS
private static java.lang.String	FULLTEXT
private static java.lang.String	INDEXES
private static java.lang.String	JAVASCRIPT
private static java.lang.String	LISTS
private static java.lang.String	MAP_JS
private static java.lang.String	REDUCE_JS
private static java.lang.String	REWRITES
private static java.lang.String	SHOWS
private static java.lang.String	UPDATES
private static java.lang.String	VALIDATE_DOC
private static java.lang.String	VIEWS

Constructor Summary

Constructors

Constructor and Description
CouchDbDesign(CouchDbClientBase dbc)

Method Summary

Modifier and Type	Method and Description
java.util.List<DesignDocument>	getAllFromDesk() Gets all design documents from desk.
DesignDocument	getFromDb(java.lang.String id) Gets a design document from the database.
DesignDocument	getFromDb(java.lang.String id, java.lang.String rev) Gets a design document from the database.
DesignDocument	getFromDesk(java.lang.String id) Gets a design document from desk.
private java.util.Map<java.lang.String,java.lang.String>	populateMap(java.lang.String rootPath, java.util.List<java.lang.String> elements, java.lang.String element)
java.lang.String	readContent(java.util.List<java.lang.String> elements, java.lang.String rootPath, java.lang.String element)
void	synchronizeAllWithDb() Synchronize all design documents on desk to the database.
Response	synchronizeWithDb(DesignDocument document) Synchronizes a design document to the Database.

Methods inherited from class java.lang.Object

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

Field Detail

DESIGN_DOCS_DIR

private static final java.lang.String DESIGN_DOCS_DIR

See Also:

Constant Field Values

JAVASCRIPT

private static final java.lang.String JAVASCRIPT

See Also:

Constant Field Values

DESIGN_PREFIX

private static final java.lang.String DESIGN_PREFIX

See Also:

Constant Field Values

VALIDATE_DOC

private static final java.lang.String VALIDATE_DOC

See Also:

Constant Field Values

VIEWS

private static final java.lang.String VIEWS

See Also:

Constant Field Values

FILTERS

private static final java.lang.String FILTERS

See Also:

Constant Field Values

SHOWS

private static final java.lang.String SHOWS

See Also:

Constant Field Values

LISTS

private static final java.lang.String LISTS

See Also:

Constant Field Values

UPDATES

private static final java.lang.String UPDATES

See Also:

Constant Field Values

REWRITES

private static final java.lang.String REWRITES

See Also:

Constant Field Values

FULLTEXT

private static final java.lang.String FULLTEXT

See Also:

Constant Field Values

INDEXES

private static final java.lang.String INDEXES

See Also:

Constant Field Values

MAP_JS

private static final java.lang.String MAP_JS

See Also:

Constant Field Values

REDUCE_JS

private static final java.lang.String REDUCE_JS

See Also:

Constant Field Values

dbc

private CouchDbClientBase dbc

Constructor Detail

CouchDbDesign

CouchDbDesign(CouchDbClientBase dbc)

Method Detail

synchronizeWithDb

public Response synchronizeWithDb(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 equals(). If both documents are not equal, then the given document will be saved to the database and updates the existing document.

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.

synchronizeAllWithDb

public void synchronizeAllWithDb()

Synchronize all design documents on desk to the database.

See Also:

synchronizeWithDb(DesignDocument), CouchDbClientBase.syncDesignDocsWithDb()

getFromDb

public DesignDocument getFromDb(java.lang.String id)

Gets a design document from the database.

Parameters:

id - The document id

Returns:

DesignDocument

getFromDb

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

Gets a design document from the database.

Parameters:

id - The document id

rev - The document revision

Returns:

DesignDocument

getAllFromDesk

public java.util.List<DesignDocument> getAllFromDesk()

Gets all design documents from desk.

See Also:

getFromDesk(String)

getFromDesk

public DesignDocument getFromDesk(java.lang.String id)

Gets a design document from desk.

Parameters:

id - The document id to get.

Returns:

DesignDocument

populateMap

private java.util.Map<java.lang.String,java.lang.String> populateMap(java.lang.String rootPath,
                                                                     java.util.List<java.lang.String> elements,
                                                                     java.lang.String element)

readContent

public java.lang.String readContent(java.util.List<java.lang.String> elements,
                                    java.lang.String rootPath,
                                    java.lang.String element)