Module com.esri.arcgisruntime

Package com.esri.arcgisruntime.data

Class OgcFeatureCollectionTable

java.lang.Object

com.esri.arcgisruntime.data.FeatureTable

com.esri.arcgisruntime.data.OgcFeatureCollectionTable

All Implemented Interfaces:

RemoteResource, Loadable, PopupSource

public final class OgcFeatureCollectionTable
extends FeatureTable
implements RemoteResource

Represents an "OGC API - Features" feature collection table.

To display data from an OGC feature collection table in a FeatureLayer, use the FeatureLayer(FeatureTable) constructor where the OgcFeatureCollectionTable is the parameter that is passed into the constructor. Note: The OgcFeatureCollectionTable should not be confused with FeatureCollectionTable, which is used as an input to create a FeatureCollection.

This API provides building blocks for manipulating OGC 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 members: the setFeatureRequestMode(FeatureRequestMode) and populateFromServiceAsync(QueryParameters, boolean, List) methods. Only the ServiceFeatureTable.FeatureRequestMode.MANUAL_CACHE mode is supported. This means populateFromServiceAsync(QueryParameters, boolean, List) must be called to populate, query, and return features from the service. For the where clause (see QueryParameters.getWhereClause()) that is used by the populateFromServiceAsync(QueryParameters, boolean, List) method, you can put any CQL2-TEXT or CQL2-JSON string as defined in the document Common Query Language (CQL2).

When populating or updating a local table from an OGC service, you can now request features in a specified SpatialReference (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.0

Property Summary

Properties inherited from class com.esri.arcgisruntime.data.FeatureTable

loadError, loadStatus

Constructor Summary

Constructors

Constructor	Description
OgcFeatureCollectionTable(OgcFeatureCollectionInfo ogcFeatureCollectionInfo)	Constructs an OGCFeatureCollectionTable from the given OgcFeatureCollectionInfo.
OgcFeatureCollectionTable(String url, String collectionId)	Constructs an OGCFeatureCollectionTable from the URL of the "OGC API - Features" service and the unique identifier for the collection.

Method Summary

Modifier and Type	Method	Description
Credential	getCredential()	Gets the Credential that is set on the network-enabled resource.
ServiceFeatureTable.FeatureRequestMode	getFeatureRequestMode()	Gets the mode defining when features are requested from the service.
RequestConfiguration	getRequestConfiguration()	Gets the RequestConfiguration used to modify the parameters of network requests made by this RemoteResource.
String	getUri()	Gets the URL of the "OGC API - Features" service landing page.
ListenableFuture<FeatureQueryResult>	populateFromServiceAsync(QueryParameters queryParameters, boolean clearCache, List<String> outFields)	Asynchronously populate the "OGC API - Features" feature collection table with the results of a query.
void	setCredential(Credential credential)	Sets a Credential to be used by the network-enabled resource in the event of an authentication challenge.
void	setFeatureRequestMode(ServiceFeatureTable.FeatureRequestMode featureRequestMode)	Sets the mode defining when features are requested from the service.
void	setRequestConfiguration(RequestConfiguration requestConfiguration)	Sets the RequestConfiguration used to modify the parameters of network requests made by this RemoteResource.

Methods inherited from class com.esri.arcgisruntime.data.FeatureTable

addDoneLoadingListener, addFeatureAsync, addFeaturesAsync, addLoadStatusChangedListener, canAdd, cancelLoad, canDelete, canEditGeometry, canUpdate, createFeature, createFeature, deleteFeatureAsync, deleteFeaturesAsync, getDisplayName, getExtent, getField, getFields, getGeometryType, getLayer, getLoadError, getLoadStatus, getPopupDefinition, getSpatialReference, getTableName, getTotalFeatureCount, hasGeometry, hasM, hasZ, isEditable, isPopupEnabled, loadAsync, loadErrorProperty, loadStatusProperty, queryExtentAsync, queryFeatureCountAsync, queryFeaturesAsync, queryStatisticsAsync, removeDoneLoadingListener, removeLoadStatusChangedListener, retryLoadAsync, setDisplayName, setPopupDefinition, setPopupEnabled, updateFeatureAsync, updateFeaturesAsync

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

OgcFeatureCollectionTable

public OgcFeatureCollectionTable(OgcFeatureCollectionInfo ogcFeatureCollectionInfo)

Constructs an OGCFeatureCollectionTable from the given OgcFeatureCollectionInfo.

Parameters:

ogcFeatureCollectionInfo - an OGCFeatureCollectionTable

Throws:

IllegalArgumentException - if ogcFeatureCollectionInfo is null

Since:

100.9.0

OgcFeatureCollectionTable

public OgcFeatureCollectionTable(String url,
 String collectionId)

Constructs an OGCFeatureCollectionTable from the URL of the "OGC API - Features" service and the unique identifier for the collection.

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

Throws:

IllegalArgumentException - if url is null or empty

IllegalArgumentException - if collectionId is null or empty

Since:

100.9.0

Method Details

setFeatureRequestMode

public void setFeatureRequestMode(ServiceFeatureTable.FeatureRequestMode featureRequestMode)

Sets the mode defining when features are requested from the service.

You must set the feature request mode to ServiceFeatureTable.FeatureRequestMode.MANUAL_CACHE before attempting to populate the table using populateFromServiceAsync(QueryParameters, boolean, List).

Parameters:

featureRequestMode - a FeatureRequestMode

Throws:

IllegalArgumentException - if featureRequestMode is null

Since:

100.9.0

getFeatureRequestMode

public ServiceFeatureTable.FeatureRequestMode getFeatureRequestMode()

Gets the mode defining when features are requested from the service.

You must set the feature request mode to ServiceFeatureTable.FeatureRequestMode.MANUAL_CACHE before attempting to populate the table using populateFromServiceAsync(QueryParameters, boolean, List).

Returns:

a FeatureRequestMode

Since:

100.9.0

populateFromServiceAsync

public ListenableFuture<FeatureQueryResult> populateFromServiceAsync(QueryParameters queryParameters,
 boolean clearCache,
 List<String> outFields)

Asynchronously populate the "OGC API - Features" feature collection table with the results of a query.

Use the default (empty) QueryParameters to get all features from the service. Specifying null or an empty List for outfields will result in the default set of outfields being used. Spatial queries (those that specify geometries) must use the QueryParameters.SpatialRelationship.INTERSECTS spatial relationship.

Parameters:

queryParameters - parameters that define how features are returned from the service

clearCache - set to true to clear existing table data before populating it with features returned from the service, false otherwise

outFields - an optional list of names of attribute fields to include in the output result, null or an empty list to include the default outfields set

Returns:

a ListenableFuture that represents the query operation on the service. When the query is done the result returns a list of FeatureQueryResult objects.

Throws:

IllegalArgumentException - if queryParameters is null

Since:

100.9.0

getCredential

public Credential getCredential()

Description copied from interface: RemoteResource

Gets the Credential that is set on the network-enabled resource.

Only applicable if the resource is secured.

Specified by:

getCredential in interface RemoteResource

Returns:

the Credential, or null if there is none

setCredential

public void setCredential(Credential credential)

Description copied from interface: RemoteResource

Sets a Credential to be used by the network-enabled resource in the event of an authentication challenge. The default credential is null.

Only applicable if the resource is secured.

Specified by:

setCredential in interface RemoteResource

Parameters:

credential - the Credential to be used for authentication

getRequestConfiguration

public RequestConfiguration getRequestConfiguration()

Description copied from interface: RemoteResource

Gets the RequestConfiguration used to modify the parameters of network requests made by this RemoteResource.

Specified by:

getRequestConfiguration in interface RemoteResource

Returns:

the RequestConfiguration used to modify network requests

setRequestConfiguration

public void setRequestConfiguration(RequestConfiguration requestConfiguration)

Description copied from interface: RemoteResource

Sets the RequestConfiguration used to modify the parameters of network requests made by this RemoteResource. If not set, the global RequestConfiguration will be used (see RequestConfiguration.getGlobalRequestConfiguration()).

Specified by:

setRequestConfiguration in interface RemoteResource

Parameters:

requestConfiguration - the RequestConfiguration used to modify network requests

getUri

public String getUri()

Gets the URL of the "OGC API - Features" service landing page.

Specified by:

getUri in interface RemoteResource

Returns:

the service's landing page URL

Since:

100.13.0