com.couchbase.client.protocol.views

Class SpatialView

java.lang.Object

com.couchbase.client.protocol.views.AbstractView

com.couchbase.client.protocol.views.SpatialView

public class SpatialView
extends AbstractView

Holds information about a spatial view that can be queried in Couchbase Server.

Constructor Summary

Constructors

Constructor and Description
SpatialView(java.lang.String database, java.lang.String designDoc, java.lang.String viewName) Create a new Spatial View object.

Method Summary

Modifier and Type	Method and Description
java.lang.String	getURI() Returns the URI/String representation of the Spatial View.
boolean	hasMap() Will always return true, because Spatial Views need to have a map function.
boolean	hasReduce() Will always return false, because Spatial Views can't have reduce functions.

Methods inherited from class com.couchbase.client.protocol.views.AbstractView

getDatabaseName, getDesignDocumentName, getViewName

Methods inherited from class java.lang.Object

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

Constructor Detail

SpatialView

public SpatialView(java.lang.String database,
                   java.lang.String designDoc,
                   java.lang.String viewName)

Create a new Spatial View object.

Parameters:

database - the name of the database.

designDoc - the name of the corresponding design document.

viewName - the name of the view itself.

Method Detail

hasMap

public boolean hasMap()

Will always return true, because Spatial Views need to have a map function.

Specified by:

hasMap in class AbstractView

Returns:

true.

hasReduce

public boolean hasReduce()

Will always return false, because Spatial Views can't have reduce functions.

Specified by:

hasReduce in class AbstractView

Returns:

false.

getURI

public java.lang.String getURI()

Returns the URI/String representation of the Spatial View.

Specified by:

getURI in class AbstractView

Returns:

the URI path of the Spatial View to query against the cluster.