DesignDocument (cloudant-client 2.20.0 API)

java.lang.Object
- com.cloudant.client.org.lightcouch.Document
- - com.cloudant.client.api.model.DesignDocument

public class DesignDocument
extends com.cloudant.client.org.lightcouch.Document

Encapsulates a design document.

This is the type of design document objects used by the DesignDocumentManager.

This class can be used as a deserialization target for design documents stored in a database. For example:

 
 DesignDocument exampleDDoc = database.find(DesignDocument.class, "_design/exampleDesignDoc");

This class can also be used to create or update design documents. For example:

 
 // Create
 DesignDocument ddoc = new DesignDocument();
 // Call setters on ddoc to populate document
 ddoc.setId("_design/exampleDesignDoc");
 // Save to create the design document
 database.save(ddoc)

 // Update
 DesignDocument ddoc = database.find(DesignDocument.class, "_design/exampleDesignDoc");
 // Call setters to update values
 Map<String, String> updates = new HashMap<String, String>();
 updates.put("newUpdateHandler", "function (doc, req) { ... }");
 ddoc.setUpdates(updates);
 // Update the design document
 database.update(ddoc);

Since:: 0.0.2
See Also:: DesignDocumentManager

Nested Class Summary

Nested Classes
Modifier and Type	Class and Description
`static class`	`DesignDocument.MapReduce` Encapsulates the Map-Reduce function of a view.
`static class`	`DesignDocument.Options` Encapsulates design document options.

Constructor Summary

Constructors
Constructor and Description

DesignDocument()

Constructors
Constructor and Description
`DesignDocument()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`boolean`	`equals(java.lang.Object o)` Compares this design document to the specified object.
`java.util.Map<java.lang.String,java.lang.String>`	`getFilters()` Get the changes feed filter functions defined in this design document.
`com.google.gson.JsonObject`	`getFulltext()`
`com.google.gson.JsonObject`	`getIndexes()` Get a JSON object containing all the indexes defined in the design document.
`java.lang.String`	`getLanguage()` Get the language used for the views defined in this design document.
`java.util.Map<java.lang.String,java.lang.String>`	`getLists()` Get the list functions defined in this design document.
`DesignDocument.Options`	`getOptions()` Get the options defined in this design document.
`com.google.gson.JsonArray`	`getRewrites()` Get the array of URL rewriting rules set in the design document's `rewrites` property.
`java.util.Map<java.lang.String,java.lang.String>`	`getShows()` Get the show functions defined in this design document.
`java.util.Map<java.lang.String,java.lang.String>`	`getUpdates()` Get the update handlers defined in this design document.
`java.lang.String`	`getValidateDocUpdate()` Get the string of the javascript function set for the design document's `validate_doc_update` property.
`java.util.Map<java.lang.String,DesignDocument.MapReduce>`	`getViews()` Get the views defined in this design document.
`int`	`hashCode()`
`void`	`setFilters(java.util.Map<java.lang.String,java.lang.String> filters)` Define the changes feed filter functions set in this design document.
`void`	`setFulltext(com.google.gson.JsonObject fulltext)`
`void`	`setIndexes(com.google.gson.JsonObject indexes)` Set a JSON object defining the indexes of this design document.
`void`	`setLanguage(java.lang.String language)` Set the language of the design document.
`void`	`setLists(java.util.Map<java.lang.String,java.lang.String> lists)` Set the list functions defined in this design document.
`void`	`setOptions(DesignDocument.Options options)` Set design document options.
`void`	`setRewrites(com.google.gson.JsonArray rewrites)` Set the array of URL rewriting rules set in the design document's `rewrites` property.
`void`	`setShows(java.util.Map<java.lang.String,java.lang.String> shows)` Set the show functions defined in this design document.
`void`	`setUpdates(java.util.Map<java.lang.String,java.lang.String> updates)` Set the update handlers defined in this design document.
`void`	`setValidateDocUpdate(java.lang.String validateDocUpdate)` Set the javascript function for the design document's `validate_doc_update` property.
`void`	`setViews(java.util.Map<java.lang.String,DesignDocument.MapReduce> views)` Set the views defined in this design document's view property.

Methods inherited from class com.cloudant.client.org.lightcouch.Document
addAttachment, getAttachments, getId, getRevision, isDeleted, setAttachments, setDeleted, setId, setRevision

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - DesignDocument
```
public DesignDocument()
```
- Method Detail
  - getLanguage
```
public java.lang.String getLanguage()
```
    Get the language used for the views defined in this design document.
    
    Returns:
    
    typically either "javascript" or "query".
  - getViews
```
public java.util.Map<java.lang.String,DesignDocument.MapReduce> getViews()
```
    Get the views defined in this design document.
    
    Returns:
    
    a map of view name to DesignDocument.MapReduce from the view
    
    See Also:
    
    Views
  - getValidateDocUpdate
```
public java.lang.String getValidateDocUpdate()
```
    Get the string of the javascript function set for the design document's validate_doc_update property.
    
    Returns:
    
    string of validate_doc_update function
    
    See Also:
    
    Update validators
  - getRewrites
```
public com.google.gson.JsonArray getRewrites()
```
    Get the array of URL rewriting rules set in the design document's rewrites property.
    
    Returns:
    
    array of JSON objects each representing a rewrite rule
    
    See Also:
    
    Rewrite rules
  - getFulltext
```
public com.google.gson.JsonObject getFulltext()
```
    Returns:
    
    the design document's fulltext property
  - getIndexes
```
public com.google.gson.JsonObject getIndexes()
```
    Get a JSON object containing all the indexes defined in the design document.
    
    Returns:
    
    the JSON object stored in the design document's indexes property
    
    See Also:
    
    Indexes
  - getFilters
```
public java.util.Map<java.lang.String,java.lang.String> getFilters()
```
    Get the changes feed filter functions defined in this design document.
    
    Returns:
    
    map of filter name to function string
    
    See Also:
    
    Filter functions
  - getShows
```
public java.util.Map<java.lang.String,java.lang.String> getShows()
```
    Get the show functions defined in this design document.
    
    Returns:
    
    map of show function name to function string
    
    See Also:
    
    Show functions
  - getLists
```
public java.util.Map<java.lang.String,java.lang.String> getLists()
```
    Get the list functions defined in this design document.
    
    Returns:
    
    map of list function name to function string
    
    See Also:
    
    List functions
  - getUpdates
```
public java.util.Map<java.lang.String,java.lang.String> getUpdates()
```
    Get the update handlers defined in this design document.
    
    Returns:
    
    map of update handler name to function string
    
    See Also:
    
    Update handlers
  - getOptions
```
public DesignDocument.Options getOptions()
```
    Get the options defined in this design document.
    
    Returns:
    
    design document options, or null if no options are defined
  - setLanguage
```
public void setLanguage(java.lang.String language)
```
    Set the language of the design document.
    
    Parameters:
    
    language - typically "javascript"
  - setViews
```
public void setViews(java.util.Map<java.lang.String,DesignDocument.MapReduce> views)
```
    Set the views defined in this design document's view property.
    
    Parameters:
    
    views - map of view name to MapReduce class
    
    See Also:
    
    Views
  - setValidateDocUpdate
```
public void setValidateDocUpdate(java.lang.String validateDocUpdate)
```
    Set the javascript function for the design document's validate_doc_update property.
    
    Parameters:
    
    validateDocUpdate - string defining validate_doc_update function
    
    See Also:
    
    Update validators
  - setRewrites
```
public void setRewrites(com.google.gson.JsonArray rewrites)
```
    Set the array of URL rewriting rules set in the design document's rewrites property.
    
    Parameters:
    
    rewrites - array of JsonObjects each representing a rewrite rule
    
    See Also:
    
    Rewrite rules
  - setFulltext
```
public void setFulltext(com.google.gson.JsonObject fulltext)
```
    Parameters:
    
    fulltext - JsonObject to set as the design document's fulltext property
  - setIndexes
```
public void setIndexes(com.google.gson.JsonObject indexes)
```
    Set a JSON object defining the indexes of this design document.
    
    Parameters:
    
    indexes - JsonObject defining the indexes
    
    See Also:
    
    Indexes
  - setFilters
```
public void setFilters(java.util.Map<java.lang.String,java.lang.String> filters)
```
    Define the changes feed filter functions set in this design document.
    
    Parameters:
    
    filters - map of filter name to function string
    
    See Also:
    
    Filter functions
  - setShows
```
public void setShows(java.util.Map<java.lang.String,java.lang.String> shows)
```
    Set the show functions defined in this design document.
    
    Parameters:
    
    shows - map of show function name to function string
    
    See Also:
    
    Show functions
  - setLists
```
public void setLists(java.util.Map<java.lang.String,java.lang.String> lists)
```
    Set the list functions defined in this design document.
    
    Parameters:
    
    lists - map of list function name to function string
    
    See Also:
    
    List functions
  - setUpdates
```
public void setUpdates(java.util.Map<java.lang.String,java.lang.String> updates)
```
    Set the update handlers defined in this design document.
    
    Parameters:
    
    updates - map of update handler name to function string
    
    See Also:
    
    Update handlers
  - setOptions
```
public void setOptions(DesignDocument.Options options)
```
    Set design document options.
    
    Parameters:
    
    options - design document options
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class com.cloudant.client.org.lightcouch.Document
  - equals
```
public boolean equals(java.lang.Object o)
```
    Compares this design document to the specified object. The result is true if and only if the argument is not null and is a DesignDocument with the same _id, _rev, and document contents.
    
    Overrides:
    
    equals in class com.cloudant.client.org.lightcouch.Document
    
    Parameters:
    
    o - The object to compare this design document to
    
    Returns:
    
    true if the given object represents a design document equivalent to this design document, false otherwise

Class DesignDocument

Nested Class Summary

Constructor Summary

Method Summary

Methods inherited from class com.cloudant.client.org.lightcouch.Document

Methods inherited from class java.lang.Object

Constructor Detail

DesignDocument

Method Detail

getLanguage

getViews

getValidateDocUpdate

getRewrites

getFulltext

getIndexes

getFilters

getShows

getLists

getUpdates

getOptions

setLanguage

setViews

setValidateDocUpdate

setRewrites

setFulltext

setIndexes

setFilters

setShows

setLists

setUpdates

setOptions

hashCode

equals