SGRecordAnnotation


This protocol helps with the retrieval and updating process of records used in SGLocationService.

Extends Protocol: SGAnnotation
Declared In: SGRecordAnnotation.h

Discussion

The SGRecordAnnotation is used to provide annotation-related information for both the SGLocationService and the SGARView . Using the SGGeoJSONEncoder, the location service is able to create a simple GeoJSON representation of the record and update or retain information about it.



Methods

-created
-expires
-layer

The layer where the record is registered.

-properties
-recordId
-type
-updateRecordWithGeoJSONObject:

created


- (double) created; 
Return Value

The time interval.

Discussion

@abstract The time at which the record was created, in Unix time. Default is a current timestamp.


expires


- (double) expires; 
Discussion

@abstract The time at which the record will expire, in Unix time. Default is 24 hours from creation. @result The time interval.


layer


The layer where the record is registered.

- (NSString*) layer; 
Discussion

The convention for layers is a reverse URL (e.g com.simplgeo.tree). @result The name of the layer.


properties


- (NSDictionary*) properties; 
Discussion

@abstract The properties associated with the record. @result Extra properties that help define the record.


recordId


- (NSString*) recordId; 
Discussion

@abstract Returns the unique identifer for the record. @result The unique identifier for the record.


type


- (NSString*) type; 
Discussion

@abstract The type of record. Default is object. @discussion A list of types can be found in SGLocationTypes.h. @result The type for the record.


updateRecordWithGeoJSONObject:


- (void) updateRecordWithGeoJSONObject:(NSDictionary*)dictionary; 
Parameters
dictionary

The GeoJSON dictionary.

Discussion

@abstract Updates the annotation with the contents of a GeoJSON Object.

© SimpleGeo Last Updated: 03/31/2010