Package com.esri.arcgisruntime.data

Enum ServiceFeatureTable.FeatureRequestMode

java.lang.Object

java.lang.Enum<ServiceFeatureTable.FeatureRequestMode>

com.esri.arcgisruntime.data.ServiceFeatureTable.FeatureRequestMode

All Implemented Interfaces:

Serializable, Comparable<ServiceFeatureTable.FeatureRequestMode>

Enclosing class:

ServiceFeatureTable

public static enum ServiceFeatureTable.FeatureRequestMode
extends Enum<ServiceFeatureTable.FeatureRequestMode>

The feature request mode for a ServiceFeatureTable. It determines (1) whether features are cached locally (for quicker access by map and scene layers) and (2) whether queries are performed on the local cache or on the server.

Since:

100.0.0

Enum Constant Summary

Enum Constants

Enum Constant	Description
MANUAL_CACHE	The features are requested from the server by an explicit call to populateFromServiceAsync(QueryParameters, boolean, Iterable<String>), which populates the local cache.
ON_INTERACTION_CACHE	The features are requested from the server as they are needed, in response to user or developer interaction with the layer (pan, zoom).
ON_INTERACTION_NO_CACHE	The features are always requested from the server and are never cached.
UNDEFINED	The feature request mode is undefined.

Method Summary

Modifier and Type	Method	Description
static ServiceFeatureTable.FeatureRequestMode	valueOf(String name)	Returns the enum constant of this type with the specified name.
static ServiceFeatureTable.FeatureRequestMode[]	values()	Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

UNDEFINED

public static final ServiceFeatureTable.FeatureRequestMode UNDEFINED

The feature request mode is undefined. The feature table has not been loaded and the mode has yet to be set.

MANUAL_CACHE

public static final ServiceFeatureTable.FeatureRequestMode MANUAL_CACHE

The features are requested from the server by an explicit call to populateFromServiceAsync(QueryParameters, boolean, Iterable<String>), which populates the local cache. Queries performed on the table will be executed locally.

In this mode, the features have all fields defined by the Iterable<String> you pass to populateFromServiceAsync(QueryParameters, boolean, Iterable<String>).

ON_INTERACTION_CACHE

public static final ServiceFeatureTable.FeatureRequestMode ON_INTERACTION_CACHE

The features are requested from the server as they are needed, in response to user or developer interaction with the layer (pan, zoom). Features are cached in the local table for the duration of the session. Queries are executed on the local cache or (if requested features are not resident in the cache) on the server. This mode is the default.

In this mode, features have a minimum set of attributes, and feature geometries have no m values even if m values are defined by the service. This is an optimization for faster rendering. To access all attributes or access geometries that contain m values, the features you get from a query must be loaded. You can load them yourself or request that the query method return them already loaded (see ServiceFeatureTable.QueryFeatureFields.LOAD_ALL. For more information, see the class description for ServiceFeatureTable.

ON_INTERACTION_NO_CACHE

public static final ServiceFeatureTable.FeatureRequestMode ON_INTERACTION_NO_CACHE

The features are always requested from the server and are never cached. 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).

In this mode, features have a minimum set of attributes, and feature geometries have no m values even if m values are defined by the service. This is an optimization for faster rendering. To access all attributes or access geometries that contain m values, the features you get from a query must be loaded. You can load them yourself or request that the query method return them already loaded (see ServiceFeatureTable.QueryFeatureFields.LOAD_ALL. For more information, see the class description for ServiceFeatureTable.

Method Detail

values

public static ServiceFeatureTable.FeatureRequestMode[] values()

Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:

for (ServiceFeatureTable.FeatureRequestMode c : ServiceFeatureTable.FeatureRequestMode.values())
    System.out.println(c);

Returns:

an array containing the constants of this enum type, in the order they are declared

valueOf

public static ServiceFeatureTable.FeatureRequestMode valueOf(String name)

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

IllegalArgumentException - if this enum type has no constant with the specified name

NullPointerException - if the argument is null