com.couchbase.mock.views

Class View

java.lang.Object

com.couchbase.mock.views.View

public class View
extends Object

This represents a compiled Couchbase View that is part of the bucket. A view consists of a DesignDocument consisting of a map function and optionally a reduce function.

Author:

Sergey Avseyev, Mark Nunberg

Constructor Summary

Constructors

Constructor and Description
View(String name, String map)
View(String name, String map, String reduce) Create a new view

Method Summary

Modifier and Type	Method and Description
QueryResult	execute(Iterable<Item> items)
QueryResult	execute(Iterable<Item> items, Configuration config) Executes the view query with the given parameters see executeRaw(Iterable, Configuration)
String	executeRaw(Iterable<Item> items, Configuration config) Executes the view query with the given parameters.
String	getMapSource() Gets the JavaScript source code for the map function
String	getName() Gets the name of the view
String	getReduceSource() Gets the JavaScript source code for the reduce function

Methods inherited from class java.lang.Object

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

Constructor Detail

View

public View(String name,
            String map)
     throws ScriptException

Throws:

ScriptException

View

public View(@NotNull
            String name,
            @NotNull
            String map,
            @Nullable
            String reduce)
     throws ScriptException

Create a new view

Parameters:

name - The name of the view

map - The JavaScript map function as a String

reduce - The JavaScript reduce function, as a String

Throws:

org.mozilla.javascript.EcmaError - if the map or reduce functions could not be parsed

ScriptException

Method Detail

getName

public String getName()

Gets the name of the view

Returns:

The name of the view

getMapSource

public String getMapSource()

Gets the JavaScript source code for the map function

Returns:

The map source code

getReduceSource

public String getReduceSource()

Gets the JavaScript source code for the reduce function

Returns:

The reduce source code

execute

public QueryResult execute(Iterable<Item> items)
                    throws QueryExecutionException

Throws:

QueryExecutionException

execute

public QueryResult execute(Iterable<Item> items,
                           Configuration config)
                    throws QueryExecutionException

Executes the view query with the given parameters see executeRaw(Iterable, Configuration)

Parameters:

items - The items in the bucket which should be processed via the view

config - The configuration for the view, acting as a filter on the items processed

Returns:

A results object which may be inspected

Throws:

QueryExecutionException - If there was an error while processing the options

executeRaw

public String executeRaw(Iterable<Item> items,
                         Configuration config)
                  throws QueryExecutionException

Executes the view query with the given parameters.

Parameters:

items - The items to be indexed

config - The configuration to use for filters

Returns:

A string suitable for returning to a Couchbase client

Throws:

QueryExecutionException - If a query execution error occurs