Couchbase Lite
Objective-C API for iOS and Mac OS
Properties | List of all members
CBLGeoQueryRow Class Reference

A result row from a CouchbaseLite geo-query. More...

#import <CBLQuery+Geo.h>

Inheritance diagram for CBLGeoQueryRow:
CBLQueryRow

Properties

CBLGeoRect boundingBox
 The row's geo bounding box in native form. More...
 
NSDictionary * geometry
 The GeoJSON object emitted as the key of the emit() call by the map function. More...
 
NSString * geometryType
 The GeoJSON object type of the row's geometry. More...
 
- Properties inherited from CBLQueryRow
id key
 The row's key: this is the first parameter passed to the emit() call that generated the row. More...
 
id value
 The row's value: this is the second parameter passed to the emit() call that generated the row. More...
 
NSString * documentID
 The ID of the document described by this view row. More...
 
NSString * sourceDocumentID
 The ID of the document that caused this view row to be emitted. More...
 
NSString * documentRevisionID
 The revision ID of the document this row was mapped from. More...
 
CBLDatabasedatabase
 
CBLDocumentdocument
 The document this row was mapped from. More...
 
NSDictionary * documentProperties
 The properties of the document this row was mapped from. More...
 
id key0
 Convenience for use in keypaths. More...
 
id key1
 
id key2
 
id key3
 
UInt64 sequenceNumber
 The database sequence number of the associated doc/revision. More...
 
NSArray * conflictingRevisions
 Returns all conflicting revisions of the document, as an array of CBLRevision, or nil if the document is not in conflict. More...
 

Additional Inherited Members

- Instance Methods inherited from CBLQueryRow
(id) - keyAtIndex:
 If this row's key is an array, returns the item at that index in the array. More...
 

Detailed Description

A result row from a CouchbaseLite geo-query.

A CBLQuery with its .boundingBox property set will produce CBLGeoQueryRows.

Property Documentation

- (CBLGeoRect) boundingBox
readnonatomicassign

The row's geo bounding box in native form.

If the emitted geo object was a point, the boundingBox's min and max will be equal. Note: The coordinates may have slight round-off error, because SQLite internally stores bounding boxes as 32-bit floats, but the coordinates are always rounded outwards – making the bounding box slightly larger – to avoid false negatives in searches.

- (NSDictionary*) geometry
readatomicassign

The GeoJSON object emitted as the key of the emit() call by the map function.

The format is a parsed GeoJSON point or polygon; see http://geojson.org/geojson-spec

- (NSString*) geometryType
readnonatomicassign

The GeoJSON object type of the row's geometry.

Usually "Point" or @"Rectangle", but may be another type if the emitted key was GeoJSON. (The "Rectangle" type is not standard GeoJSON.)


The documentation for this class was generated from the following file: