A table of features that typically represents real-world objects created from an ArcGIS feature service. An instance of this class represents the dataset of an individual layer or table in an ArcGIS map or feature service. The map or feature service may be hosted in the cloud on ArcGIS Online, or on-premises on an ArcGIS Server. To access these services you may need to provide authentication in your application.
You can construct a ServiceFeatureTable directly from the feature service using its URI or PortalItem. Alternatively, you can obtain a ServiceFeatureTable from a FeatureLayer or a FeatureTable that is part of an ArcGISMap or ArcGISScene. You can also obtain a ServiceFeatureTable directly from its service geodatabase using ServiceGeodatabase.getTable(Long).
The ServiceFeatureTable adopts the loadable pattern so many of its properties are initialized asynchronously after connecting to the service. For more information, see Loadable.
If the ServiceFeatureTable.hasGeometry is true, you can display the features in an ArcGISMap or ArcGISScene. To do this create a FeatureLayer from the feature table and add it to the map or scene's collection of operational layers (GeoModel.operationalLayers). Spatial features are requested in the SpatialReference that matches the ArcGISMap or ArcGISScene and are displayed using the Symbol information defined by the map or feature service.
You can query the data in the ServiceFeatureTable based on SQL expressions and/or spatial relationships. Use the QueryParameters object to define your spatial or attribute query and pass it to the ServiceFeatureTable.queryFeatures(QueryParameters, QueryFeatureFields) method. If the service feature table is related to any other tables that are part of the map or scene, use the ServiceFeatureTable.queryRelatedFeatures(ArcGISFeature, RelatedQueryParameters, QueryFeatureFields) method to query the related tables. For more information see RelatedQueryParameters.
A ServiceFeatureTable can have editable attribute fields, feature templates(FeatureTemplate), feature types (FeatureType), and editing capabilities defined in ArcGISFeatureLayerInfo.capabilities. You can create, delete, and update data in the local cache depending upon whether the service allows those operations, who owns the data, and what ownership-based access control policies are in place. Permission to edit the data is managed by the author of the feature service. Explore ServiceFeatureTable.isEditable, ServiceFeatureTable.canAdd(), ServiceFeatureTable.canUpdate(Feature), and ServiceFeatureTable.canDelete(Feature) for information on what is permitted. If the service supports attachments (ServiceFeatureTable.hasAttachments), you can also view and potentially edit the attachments. If you want to apply your edits to the feature service, you must call the ServiceGeodatabase.applyEdits() method on the ServiceFeatureTable.serviceGeodatabase. This will ensure that the table and any tables involved in geodatabase behavior are updated. Areas that have geodatabase behavior include: * Composite relationships * Annotation feature layers * Utility network association deletion semantics * Attribute rules
The ServiceFeatureTable supports querying and editing contingent values. See ServiceFeatureTable.getContingentValuesOrNull(ArcGISFeature, String) for more information.
If you wish to adopt an offline workflow, you can take areas of a ServiceFeatureTable offline using the GeodatabaseSyncTask. If you wish to take an ArcGISMap offline use the OfflineMapTask. See Build offline applications[https://developers.arcgis.com/documentation/mapping-apis-and-services/offline/] for more information.
Feature Request Mode
The FeatureRequestMode determines whether ServiceFeatureTable features are cached locally (for quicker access by map and scene layers) and whether queries are performed on the local cache or on the server. Consider which of these 3 modes is appropriate for your application:
FeatureRequestMode.OnInteractionCache - User interactions (pan or zoom) with the MapView or SceneView request features from the server and cache them locally for the duration of the session. Subsequent interactions with the MapView or SceneView will refresh this local cache. Queries are executed on the local cache or (if requested features are not resident in the cache) on the server. If the network connection is lost then the application can still operate with the local cache. This is the default mode.
FeatureRequestMode.OnInteractionNoCache - Your application will display or query features directly from the server. They are not cached locally. This mode ensures that you are working against the latest data, but it has a high network bandwidth since it goes to the server for all interactions (pans, zooms, selects, or queries).
FeatureRequestMode.ManualCache - Your application must explicitly call ServiceFeatureTable.populateFromService(QueryParameters, Boolean, MutableListImpl) to query the feature service and cache the resulting features in the ServiceFeatureTable. All queries are made against this local cache. You must adopt this mode for tables that contain non-spatial records (see ServiceFeatureTable.hasGeometry).
Creates a new service feature table object from an ArcGIS feature service or feature layer portal item. If the portal item is a feature service, the ServiceFeatureTable will be created from the first layer on the service. If the portal item is a feature layer, the ServiceFeatureTable will be created from the feature layer.
The factor used to calculate a buffered extent around the current visible area when requesting features from a service. New features are requested from the service if the visible area of the MapView exceeds the buffered extent. A change in the visible area can result from any user interaction with the MapView, such as a pan or zoom action. The buffer factor is applied when the FeatureRequestMode is in either FeatureRequestMode.OnInteractionCache or FeatureRequestMode.OnInteractionNoCache.
An expression (SQL where clause) to filter features queried in this table. The definition expression string uses the SQL-92 where clause syntax (https://en.wikipedia.org/wiki/SQL-92). Be sure to escape special characters in the expression string as required for your platform. The DATE keyword expects the date format yyyy-mm-dd and the TIMESTAMP keyword expects the time stamp format yyyy-mm-dd hh:mm:ss. For more information see the ArcGIS Blog article "Querying Feature Services Date-Time Queries".
The spatial reference of the table. A spatial reference defines how the coordinates of a feature's Geometry correspond to locations in the real world. For more information see the SpatialReference class or the Spatial references[https://developers.arcgis.com/documentation/spatial-references/] documentation.
Unknown data from the source JSON. Unknown JSON is a dictionary of values not defined in the ArcGIS specification used to create this object but found in the source JSON. If the object is written back to JSON, any unknown JSON data is not persisted. The ArcGIS specification may be for a web map, web scene, REST API, and so on.
Unsupported data from the source JSON. Unsupported JSON is a dictionary of values defined in the ArcGIS specification used to create this object but not currently used in this API. If the object is written back to JSON, any unsupported JSON data is persisted. The ArcGIS specification may be from a web map, web scene, REST API, and so on.
Uploads any changes to the local table to the feature service. ServiceFeatureTable.applyEdits() is meant to be used for single table workflows or tables without geodatabase behavior (see below). If an edit on this table can cause an edit to another table due to geodatabase behavior, it is highly recommended to use ServiceGeodatabase.applyEdits() instead to prevent data inconsistency, so that dependent edits are all applied or none are (if an error occurs).
Loads all attributes and geometries for features that have not been loaded and fetches attributes and geometries for previously loaded features. Features returned from ServiceFeatureTable.queryFeatures(QueryParameters, QueryFeatureFields) or ServiceFeatureTable.queryRelatedFeatures(ArcGISFeature, RelatedQueryParameters, QueryFeatureFields) may be in the minimally loaded state (minimum attributes required for rendering and no m-values). To load all attributes, pass an Iterable of the features to this method.
Queries the feature service and places the resulting features in the local table, which is cached for the duration of the session. The ServiceFeatureTable must have its ServiceFeatureTable.featureRequestMode set to FeatureRequestMode.ManualCache. This method is useful for non-geographic data. It's also helpful when you want to avoid accessing the service for a feature whose geometry is in the current extent of the map or scene.
Queries features from this table's cache and/or from the feature service used to create this table. If the request mode of the table is FeatureRequestMode.ManualCache, then the query is always performed on the local table.
Queries for related features in this service feature table using the provided parameters and query feature fields. See ServiceFeatureTable.queryFeatures(QueryParameters, QueryFeatureFields) for more details.
Undoes all of the local edits since the last server acknowledgment. ServiceFeatureTable.undoLocalEdits() is meant to be used for single table workflows or tables without geodatabase behavior (see below). If the service which the table belongs to has geodatabase behavior (see below), it is highly recommended to use ServiceGeodatabase.undoLocalEdits(). Undoing edits in one table can cause data inconsistencies between the local cache and the service if ServiceFeatureTable.undoLocalEdits() is used.
Determines whether you can add new features to the table. Although this method may state that the table allows new features to be added, the application may not be licensed to permit this. For example, a user cannot add features to a secured feature table if the application is licensed at the Lite level (LicenseLevel.Lite).
Determines whether you can delete the feature from the table. Although this method may state that the table allows the feature to be deleted, the application may not be licensed to permit this. For example, a user cannot delete features from a secured feature table if the application is licensed at the Lite level (LicenseLevel.Lite).
Determines whether you can edit the geometry field in a table. Although this method may state that the table allows geometry fields to be edited, the application may not be licensed to permit this. For example, a user cannot update geometry in a secured feature table if the application is licensed at the Lite level (LicenseLevel.Lite).
Determines whether you can update the feature in the table. Although this method may state that the table allows the feature to be updated, the application may not be licensed to permit this. For example, a user cannot update features in a secured feature table if the application is licensed at the Lite level (LicenseLevel.Lite).
Creates a new feature based on the provided feature subtype and geometry.
Creates a new feature based on the provided feature template and geometry.
Creates a new feature based on the provided feature type and geometry.
Deletes a feature from the table. Deleting a feature from a GeodatabaseFeatureTable in a stand-alone mobile geodatabase created with ArcGIS Pro is not supported when the table participates in a controller dataset, such as a utility network or parcel fabric. Use FeatureTable.canDelete(Feature) to determine if this operation is allowed.
Returns possible values for the specified field, in the context of defined contingencies. This method iterates over all the field groups that the input field participates in. For each, it looks at the input feature's field values for the other fields participating in that field group. Contingencies that are satisfied by the other fields are identified, and their values for the input field are aggregated. These are returned in a ContingentValuesResult, which contains a dictionary of field group names to an array of ContingentValue objects accessed via ContingentValuesResult.byFieldGroup, specifying possible values for the input field that will satisfy a contingency in that field group. If the feature participates in multiple field groups and there are values that will satisfy all groups, they will be returned by ContingentValuesResult.allGroups.
Returns all the features that were added, updated or deleted since the last sync. Returns a result object containing a feature edit iterator. For mobile geodatabase created by ArcGIS Pro, the iterator in the result object is empty because there is no concept of syncing.
Checks whether the feature table has local edits For ServiceFeatureTable, local edits are edits that have not yet been applied to the feature service. For GeodatabaseFeatureTable, local edits are edits that have been made since the last acknowledged upload. For mobile geodatabases created by ArcGIS Pro, this method returns false because there is no concept of uploading or applying edits. For mobile geodatabases, use GeodatabaseFeatureTable.hasLocalEditsSince(Instant).
Queries for related features of a given feature in a specific relationship. The origin and all destination tables must be associated with the same map, either as a feature source for a layer or added to the map via its table collection. Otherwise, the query will return no results.
Returns list of tables related by the given relationship info. Only returns tables that have been added to the map. If there are multiple instances of the related table on the map, all such instances will be returned.