API Reference 0.4.0couchclientSpatialView

SpatialView class

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

class SpatialView extends ViewBase {

 SpatialView(String bucketName, String designDocName, String viewName)
     : super(bucketName, designDocName, viewName);

 /**
  * Will always return true, because Spatial Views need to have a map
  * function.
  *
  * @return true.
  */
 //@override
 bool get hasMap
 => true;

 /**
  * Will always return false, because Spatial Views can't have reduce
  * functions.
  *
  * @return false.
  */
 //@override
 bool get hasReduce
 => false;

 //@override
 String get uri
 => "/$bucketName/_design/$designDocName/_spatial/$viewName";
}

Extends

ViewBase > SpatialView

Constructors

new SpatialView(String bucketName, String designDocName, String viewName) #

Creates a new Object instance.

Object instances have no meaningful state, and are only useful through their identity. An Object instance is equal to itself only.

docs inherited from Object
SpatialView(String bucketName, String designDocName, String viewName)
   : super(bucketName, designDocName, viewName);

Properties

final String bucketName #

inherited from ViewBase
final String bucketName

final String designDocName #

inherited from ViewBase
final String designDocName

final bool hasMap #

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

@return true.

bool get hasMap
=> true;

final bool hasReduce #

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

@return false.

bool get hasReduce
=> false;

final String uri #

Returns the URI/String representation of the View.

@return the URI path of the View to query against the cluster.

docs inherited from ViewBase
String get uri
=> "/$bucketName/_design/$designDocName/_spatial/$viewName";

final String viewName #

inherited from ViewBase
final String viewName