Description

An OGC API - Features feature collection table.

To display data from an OGC feature collection table in an AGSFeatureLayer, use the initWithFeatureTable: (AGSFeatureLayer) initializer where the AGSOGCFeatureCollectionTable is the parameter that is passed into the initializer. Note: The AGSOGCFeatureCollectionTable should not be confused with AGSFeatureCollectionTable which is used as an input to create an AGSFeatureCollectionLayer.

The ArcGIS Runtime API for OGC API Features provides the building blocks for manipulating features on the Web. For more information about the OGC API Features specification see the documents: OGC API - Features - Part 1 and OGC API - Features - Part 2.

The class includes two important API: AGSOGCFeatureCollectionTable::featureRequestMode property and populateFromServiceWithParameters:clearCache:outfields:completion: (AGSOGCFeatureCollectionTable) method. Only the AGSFeatureRequestModeManualCache mode is supported. This means populateFromServiceWithParameters:clearCache:outfields:completion: (AGSOGCFeatureCollectionTable) must be called to populate, query, and return features from the service. For the AGSQueryParameters::whereClause that is used by the populateFromServiceWithParameters:clearCache:outfields:completion: (AGSOGCFeatureCollectionTable) method, you can input any CQL2-TEXT or CQL2-JSON string as defined in the document OGC API - Features - Part3.

When populating or updating a local table from an OGC service, you can now request features in a specified AGSSpatialReference (also referred to as SRS in ArcGIS or CRS in OGC). This leverages the power of the server to return features in the same spatial reference as your map rather than having to re-project them on the client.

This class supports loading and querying of features from a non-spatial OGC feature collection table.

Since: 100.9

Inheritance diagram for AGSOGCFeatureCollectionTable:

Instance Methods
(id< AGSCancelable >)	- addFeature:completion:

(id< AGSCancelable >)	- addFeatures:completion:

(void)	- cancelLoad

(BOOL)	- canDeleteFeature:

(BOOL)	- canUpdateFeature:

(AGSFeature *)	- createFeature

(AGSFeature *)	- createFeatureWithAttributes:geometry:

(id< AGSCancelable >)	- deleteFeature:completion:

(id< AGSCancelable >)	- deleteFeatures:completion:

(void)	- doCancelLoading

(void)	- doStartLoading:

(nullable AGSField *)	- fieldForName:

(instancetype)	- initWithFeatureCollectionInfo:

(instancetype)	- initWithURL:collectionID:

(void)	- loadDidFinishWithError:

(void)	- loadWithCompletion:

(void)	- onLoadStatusChanged

(id< AGSCancelable >)	- populateFromServiceWithParameters:clearCache:outfields:completion:

(id< AGSCancelable >)	- queryExtentWithParameters:completion:

(id< AGSCancelable >)	- queryFeatureCountWithParameters:completion:

(id< AGSCancelable >)	- queryFeaturesWithParameters:completion:

(id< AGSCancelable >)	- queryStatisticsWithParameters:completion:

(void)	- retryLoadWithCompletion:

(id< AGSCancelable >)	- updateFeature:completion:

(id< AGSCancelable >)	- updateFeatures:completion:

Class Methods
(instancetype)	+ OGCFeatureCollectionTableWithFeatureCollectionInfo:

(instancetype)	+ OGCFeatureCollectionTableWithURL:collectionID:

Properties
BOOL	canAddFeature

BOOL	canEditGeometry

AGSCredential *	credential

NSString *	displayName

BOOL	editable

AGSEnvelope *	extent

AGSOGCFeatureCollectionInfo *	featureCollectionInfo

AGSFeatureLayer *	featureLayer

AGSFeatureRequestMode	featureRequestMode

NSArray< AGSField * > *	fields

AGSGeometryType	geometryType

BOOL	hasGeometry

BOOL	hasM

BOOL	hasZ

AGSLayer *	layer

NSError *	loadError

AGSLoadStatus	loadStatus

NSInteger	numberOfFeatures

AGSPopupDefinition *	popupDefinition

BOOL	popupEnabled

AGSRequestConfiguration *	requestConfiguration

AGSSpatialReference *	spatialReference

NSString *	tableName

NSURL *	URL

Method Documentation

◆ cancelLoad

- (void) cancelLoad

requiredinherited

Cancels loading if it is in progress, otherwise it does nothing. This should be called carefully because other objects could be waiting for loadWithCompletion: or retryLoadWithCompletion: to complete and this will call them all back with the error of NSUserCancelledError

Since: 100

◆ canDeleteFeature:

- (BOOL) canDeleteFeature: (AGSFeature *) feature

Indicates whether the source allows this particular feature to be deleted. The method first checks to verify if the source is capable of deleting any features in general. It also checks specific ownership-based access control policies of the source to see if the user attempting to perform the operation has persmissions to delete this particular feature.

Parameters

feature Can be nil, in which case, this method only checks if the source is capable of deleting any features in general

Returns: A boolean value

Since: 100

◆ canUpdateFeature:

- (BOOL) canUpdateFeature: (AGSFeature *) feature

Indicates whether the source allows updating this particular feature. The method first checks to verify if the source is capable of updating any features in general. It also checks specific ownership-based access control policies of the source to see if the user attempting to perform the operation has persmissions to edit this patricular feature.

Parameters

feature Can be nil, in which case, this method only checks if the source is capable of updating any features in general

Returns: A boolean value

Since: 100

◆ createFeature

- (AGSFeature *) createFeature

Create a new, empty feature. Note, the new feature is only available in memory at this point, it is not committed to the dataset.

Returns: empty feature

Since: 100

Note: The feature will need to be explicitly added to the dataset. See addFeature:completion:

◆ createFeatureWithAttributes:geometry:

- (AGSFeature *) createFeatureWithAttributes:	(NSDictionary< NSString , id > )	attributes
geometry:	(nullable AGSGeometry *)	geometry

Create a new feature with the provided attribute values and, optionally, geometry. Note, the new feature is only available in memory at this point, it is not committed to the dataset.

Parameters

attributes	for the feature
geometry	for the feature

Returns: feature

Since: 100

Note: The feature will need to be explicitly added to the dataset. See addFeature:completion:

◆ doCancelLoading

- (void) doCancelLoading

Never call this method directly. The framework calls this method on a background thread when cancelLoad (AGSLoadable-p) is called. It is meant to be overriden by subclasses. Subclasses should override this method to cancel loading their data and call loadDidFinishWithError: (AGSLoadableBase(ForSubclassEyesOnly)) at the end passing in an error representing NSUserCancelledError.

Since: 100

Provided by category AGSLoadableBase(ForSubclassEyesOnly).

◆ doStartLoading:

- (void) doStartLoading: (BOOL) retrying

Never call this method directly. The framework calls this method on a background thread when loadWithCompletion: (AGSLoadable-p) or retryLoadWithCompletion: (AGSLoadable-p) is called. It is meant to be overriden by subclasses. Subclasses should override this method to load their data and call loadDidFinishWithError: (AGSLoadableBase(ForSubclassEyesOnly)) upon completion, passing in the error if any.

Parameters

retrying flag that is true if this method was called from retryLoadWithCompletion: (AGSLoadable-p).

Since: 100

Provided by category AGSLoadableBase(ForSubclassEyesOnly).

◆ fieldForName:

- (nullable AGSField *) fieldForName: (NSString *) fieldName

Convenience method to getting a field object given its name

Parameters

fieldName The name of the field.

Returns: field

Since: 100

◆ initWithFeatureCollectionInfo:

- (instancetype) initWithFeatureCollectionInfo: (AGSOGCFeatureCollectionInfo *) featureCollectionInfo

Creates a new OGC API - Features feature collection table.

Parameters

featureCollectionInfo An AGSOGCFeatureCollectionInfo object.

Since: 100.9

◆ initWithURL:collectionID:

- (instancetype) initWithURL:	(NSURL *)	URL
collectionID:	(NSString *)	collectionID

Initialize a new OGC API - Features feature collection table.

Parameters

URL	The URL of the OGC API - Features service landing page that contains the feature collection.
collectionID	The unique identifier for the collection from the service.

Since: 100.9

◆ loadDidFinishWithError:

- (void) loadDidFinishWithError: (nullable NSError *) error

Only subclasses should call this method in doStartLoading: (AGSLoadableBase(ForSubclassEyesOnly)) and doCancelLoading (AGSLoadableBase(ForSubclassEyesOnly)) when done loading or failed to load.

Since: 100

Provided by category AGSLoadableBase(ForSubclassEyesOnly).

◆ loadWithCompletion:

- (void) loadWithCompletion: (nullable void(^)(NSError *__nullable error)) completion

requiredinherited

Loads data for the object asynchronously. The completion block is invoked upon completion.

You can call this method any number of times, however only one attempt is made to load the data. If it is already loading, it will just continue to load (i.e. not force a reload). If it has already loaded successfully, the completion block will be invoked right away. If it has already failed to load, the completion block will be invoked right away with error previously encountered. This method supports multiple callers and will call them all back on completion. However, each caller's completion block will be invoked once and only once.

Parameters

completion block that is invoked when object loads successfully or fails to load. An error is passed to the block if the object fails to load.

Note: The completion block is always invoked on the main thread.

Since: 100

See also: - cancelLoad to cancel loading; - retryLoadWithCompletion: to force reload

◆ OGCFeatureCollectionTableWithFeatureCollectionInfo:

+ (instancetype) OGCFeatureCollectionTableWithFeatureCollectionInfo: (AGSOGCFeatureCollectionInfo *) featureCollectionInfo

Creates a new OGC API - Features feature collection table.

Parameters

featureCollectionInfo An AGSOGCFeatureCollectionInfo object.

Since: 100.9

◆ OGCFeatureCollectionTableWithURL:collectionID:

+ (instancetype) OGCFeatureCollectionTableWithURL:	(NSURL *)	URL
collectionID:	(NSString *)	collectionID

Creates a new OGC API - Features feature collection table.

Parameters

URL	The URL of the OGC API - Features service landing page that contains the feature collection.
collectionID	The unique identifier for the collection from the service.

Since: 100.9

◆ onLoadStatusChanged

- (void) onLoadStatusChanged

Never call this method directly. The framework calls this method on a background thread when AGSLoadable::loadStatus changes is called. Subclasses can optionally implement this to know when their loading status has changed.

Since: 100

Provided by category AGSLoadableBase(ForSubclassEyesOnly).

◆ populateFromServiceWithParameters:clearCache:outfields:completion:

- (id<AGSCancelable>) populateFromServiceWithParameters:	(nullable AGSQueryParameters *)	parameters
clearCache:	(BOOL)	clearCache
outfields:	(nullable NSArray< NSString * > *)	outfields
completion:	(void(^)(AGSFeatureQueryResult __nullable result, NSError __nullable error))	completion

Populate the OGC API - Features feature collection table with the results of a query.

Use the default (empty) AGSQueryParameters to get all features from the service. Specifying nil or an empty NSMutableArray for outfields will result in the default set of outfields being used. Spatial queries (those that specify geometries) must use the Intersects spatial relationship.

Parameters

parameters	Parameters that define how features are returned from the service.
clearCache	If `YES`, clears existing table data before populating it with features returned from the service.
outfields	A list of field names specifying which attribute values (columns) should be included in the table.
completion	Block that is invoked when the operation finishes. The `result` parameter is populated if the operation completed successfully, otherwise the `error` parameter is populated.

Returns: An operation which can be canceled.

Since: 100.9

◆ queryExtentWithParameters:completion:

- (id<AGSCancelable>) queryExtentWithParameters:	(AGSQueryParameters *)	parameters
completion:	(void(^)(AGSEnvelope __nullable extent, NSError __nullable error))	completion

Query the dataset to find the geographic extent covering matched features or records.

Parameters

parameters	representing the query criteria
completion	The block that is called when the query is complete

Returns: operation which can be canceled

See also: AGSFeatureServiceSessionType

Since: 100.2

◆ queryFeatureCountWithParameters:completion:

- (id<AGSCancelable>) queryFeatureCountWithParameters:	(AGSQueryParameters *)	parameters
completion:	(void(^)(NSInteger count, NSError *__nullable error))	completion

Query the dataset to find the number of matched features or records.

Parameters

parameters	representing the query criteria
completion	The block that is called when the query is complete

Returns: operation which can be canceled

See also: AGSFeatureServiceSessionType

Since: 100.2

◆ queryFeaturesWithParameters:completion:

- (id<AGSCancelable>) queryFeaturesWithParameters:	(AGSQueryParameters *)	parameters
completion:	(nullable void(^)(AGSFeatureQueryResult __nullable result, NSError __nullable error))	completion

Query the dataset to find specific features or records.

Parameters

parameters	representing the query criteria
completion	The block that is called when the query is complete

Returns: operation which can be canceled

See also: AGSFeatureServiceSessionType

Since: 100

◆ queryStatisticsWithParameters:completion:

- (id<AGSCancelable>) queryStatisticsWithParameters:	(AGSStatisticsQueryParameters *)	parameters
completion:	(void(^)(AGSStatisticsQueryResult __nullable result, NSError __nullable error))	completion

Query the dataset to compute statistics on matched features or records.

Parameters

parameters	representing the query criteria
completion	The block that is called when the query is complete

Returns: operation which can be canceled

See also: AGSFeatureServiceSessionType

Since: 100.2

◆ retryLoadWithCompletion:

- (void) retryLoadWithCompletion: (nullable void(^)(NSError *__nullable error)) completion

requiredinherited

Tries to reload when an object has failed to load. This method should be called judiciously. It should be called when:

you didn't have network connectivity earlier when it failed and you want to retry now that you have connectivity
the server was down earlier when it failed and you want to retry
the request is taking too long and you want to cancel it and retry, in which case you will first call cancelLoad and then this method

If the data hasn't started loading, it will start loading. If it is already loading, it will just continue to load. If it has already loaded successfully, calls back right away. If it has already failed to load, tries again. This method supports multiple callers and will call them all back on completion. However, each caller's completion block will be invoked once and only once.

Parameters

completion block that is invoked when object loads successfully or fails to load. An error is passed to the block if the object fails to load.

Note: The completion block is always invoked on the main thread.

Since: 100

Property Documentation

◆ canAddFeature

- (BOOL) canAddFeature

readnonatomicassigninherited

Indicates whether the source supports adding new features.

Since: 100

◆ canEditGeometry

- (BOOL) canEditGeometry

readnonatomicassigninherited

Indicates whether the source supports updating geometry of existing features.

Since: 100

◆ credential

- (AGSCredential*) credential

readwritenonatomicstronginherited

Security credentials to access the remote resource. Only applicable if the resource is secured.

Since: 100

◆ displayName

- (NSString*) displayName

readwritenonatomiccopyinherited

User-friendly name that can be displayed in the UI (for example in a Table of Contents)

Since: 100.3

◆ editable

- (BOOL) editable

readnonatomicassigninherited

Indicates whether the dataset can be edited. For details on which fine-grained editing capabilites are supported, refer to canUpdateFeature: and canDeleteFeature:

Since: 100

◆ extent

- (AGSEnvelope*) extent

readnonatomicstronginherited

The extent of the dataset.

Since: 100

◆ featureCollectionInfo

- (AGSOGCFeatureCollectionInfo*) featureCollectionInfo

readnonatomicstrong

The OGC API - Features feature collection metadata, which includes id, title, and description.

Since: 100.9

◆ featureLayer

- (AGSFeatureLayer*) featureLayer

readnonatomicweakinherited

The feature layer this table is associated with, or created from, if any. nil if this table is not associated with a feature layer. This property is populated when the AGSFeatureLayer is created from the AGSFeatureTable.

Since: 100.0

Deprecated:: 100.7.0. Use AGSFeatureTable::layer instead

Provided by category AGSFeatureTable(AGSDeprecated).

◆ featureRequestMode

- (AGSFeatureRequestMode) featureRequestMode

readwritenonatomicassign

The mode defining when features are requested from the service.

Warning: : At v100.9, OGC API - Features collection table only supports AGSFeatureRequestModeManualCache but defaults to AGSFeatureRequestModeOnInteractionCache. Set the feature request mode to manual before attempting to populate the table.

Since: 100.9

◆ fields

- (NSArray<AGSField*>*) fields

readnonatomiccopyinherited

Array of AGSField objects representing the fields (columns) in the dataset.

See also: AGSField

Since: 100

◆ geometryType

- (AGSGeometryType) geometryType

readnonatomicassigninherited

The type of geometry used by geographic feautres. Only applicable if hasGeometry is true.

Since: 100

◆ hasGeometry

- (BOOL) hasGeometry

readnonatomicassigninherited

Indicates whether the dataset contains a geometry field (column). If YES, the dataset contains geographic features. If NO, the dataset contains non-spatial records, similar to a database table.

Since: 100

◆ hasM

- (BOOL) hasM

readnonatomicassigninherited

Indicates whether features may contain M values

Since: 100.2

◆ hasZ

- (BOOL) hasZ

readnonatomicassigninherited

Indicates whether features may contain Z values

Since: 100.2

◆ layer

- (AGSLayer*) layer

readnonatomicweakinherited

The layer this table is associated with, or created from, if any. This can be an AGSAnnotationLayer, an AGSDimensionLayer, an AGSFeatureLayer, or nil if this table is not associated with a layer. This property is populated when the layer is created from the AGSFeatureTable.

Since: 100.7

◆ loadError

- (NSError*) loadError

readnonatomicstronginherited

The error that was encountered during the most recent load operation. Will be nil if the operation succeeded.

Since: 100

◆ loadStatus

- (AGSLoadStatus) loadStatus

readrequirednonatomicassigninherited

Status of the load operation.

Since: 100

◆ numberOfFeatures

- (NSInteger) numberOfFeatures

readnonatomicassigninherited

The total number of features or records in the dataset.

Since: 100

◆ popupDefinition

- (AGSPopupDefinition*) popupDefinition

readwritenonatomicstronginherited

The AGSPopupDefinition associated with the popup source. This property will be nil if an error occurs or if the popup source is not associated with a popup definition.

Since: 100

◆ popupEnabled

- (BOOL) popupEnabled

readwriterequirednonatomicassigninherited

Indicates whether popups are enabled on this source.

Since: 100

◆ requestConfiguration

- (AGSRequestConfiguration*) requestConfiguration

readwritenonatomicstronginherited

The AGSRequestConfiguration object which defines the behavior and policies to use when accessing the remote resource. The default will be nil. If it is nil the [AGSRequestConfiguration globalConfiguration] will be used.

Since: 100

◆ spatialReference

- (AGSSpatialReference*) spatialReference

readnonatomicstronginherited

The spatial reference of the dataset.

Since: 100

◆ tableName

- (NSString*) tableName

readnonatomiccopyinherited

Name of the dataset.

Since: 100

◆ URL

- (NSURL*) URL

readrequirednonatomicstronginherited

The URL of the remote resource.

Since: 100

Description

Instance Methods

Class Methods

Properties

Method Documentation

◆ cancelLoad

◆ canDeleteFeature:

◆ canUpdateFeature:

◆ createFeature

◆ createFeatureWithAttributes:geometry:

◆ doCancelLoading

◆ doStartLoading:

◆ fieldForName:

◆ initWithFeatureCollectionInfo:

◆ initWithURL:collectionID:

◆ loadDidFinishWithError:

◆ loadWithCompletion:

◆ OGCFeatureCollectionTableWithFeatureCollectionInfo:

◆ OGCFeatureCollectionTableWithURL:collectionID:

◆ onLoadStatusChanged

◆ populateFromServiceWithParameters:clearCache:outfields:completion:

◆ queryExtentWithParameters:completion:

◆ queryFeatureCountWithParameters:completion:

◆ queryFeaturesWithParameters:completion:

◆ queryStatisticsWithParameters:completion:

◆ retryLoadWithCompletion:

Property Documentation

◆ canAddFeature

◆ canEditGeometry

◆ credential

◆ displayName

◆ editable

◆ extent

◆ featureCollectionInfo

◆ featureLayer

◆ featureRequestMode

◆ fields

◆ geometryType

◆ hasGeometry

◆ hasM

◆ hasZ

◆ layer

◆ loadError

◆ loadStatus

◆ numberOfFeatures

◆ popupDefinition

◆ popupEnabled

◆ requestConfiguration

◆ spatialReference

◆ tableName

◆ URL