com.couchbase.mock.views

Class DesignDocument

java.lang.Object

com.couchbase.mock.views.DesignDocument

public class DesignDocument
extends Object

Author:

Mark Nunberg, Sergey Avseyev

Method Summary

Modifier and Type	Method and Description
static DesignDocument	create(String body, String name) Create a new design document
String	getBody()
String	getId() Get the name of the design document
ArrayList<View>	getViews() Get a list of views contained within this design document

Methods inherited from class java.lang.Object

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

Method Detail

create

public static DesignDocument create(String body,
                                    String name)
                             throws DesignParseException

Create a new design document

Parameters:

body - The JSON encoded source of this design document

name - The name of the design document. This should be the simple name, e.g. beer. If the body contains a _id property, then that property will override name

Returns:

A new design document

Throws:

DesignParseException - if a design parse error occurs

getBody

public String getBody()

Returns:

Get the raw JSON string from which this design was constructed

getId

public String getId()

Get the name of the design document

Returns:

A string in the form of _design/$name

getViews

public ArrayList<View> getViews()

Get a list of views contained within this design document

Returns:

The list of views