Package com.esri.arcgisruntime.data

Class FeatureCollection

java.lang.Object

com.esri.arcgisruntime.data.FeatureCollection

All Implemented Interfaces:

JsonSerializable, Loadable

public final class FeatureCollection
extends java.lang.Object
implements Loadable, JsonSerializable

Represents a collection of Features, usually contained in an ArcGISMap as JSON or by-reference to a JSON file or PortalItem. The features are stored within a collection of FeatureCollectionTables. Use this class to maintain and serialize collections of features to/from JSON as well as saving them to and loading them from PortalItems. To render features from a FeatureCollection, construct a FeatureCollectionLayer and add the layer as a operational layer to ArcGISMap.

Since:

100.0.0

See Also:

FeatureCollectionTable, ArcGISMap, PortalItem

Constructor Summary

Constructors

Constructor	Description
FeatureCollection()	Creates an empty FeatureCollection.
FeatureCollection(PortalItem portalItem)	Creates a FeatureCollection based on a PortalItem.
FeatureCollection(java.lang.Iterable<FeatureCollectionTable> featureCollectionTables)	Creates a FeatureCollection from a set of feature collection tables.

Method Summary

Modifier and Type	Method	Description
void	addDoneLoadingListener(java.lang.Runnable listener)	Adds a listener to the loadable resource that is invoked when loading has completed.
void	addLoadStatusChangedListener(LoadStatusChangedListener listener)	Adds a LoadStatusChangedListener to the loadable resource that is invoked whenever the load status changes.
void	cancelLoad()	Cancels loading metadata for the object.
static FeatureCollection	fromJson(java.lang.String json)	Creates a FeatureCollection instance from a JSON string.
Item	getItem()	Gets the associated Item of this FeatureCollection.
ArcGISRuntimeException	getLoadError()	Returns the most recent error that was encountered when the loadable resource transitioned to the LoadStatus.FAILED_TO_LOAD state, either due to calling the Loadable.loadAsync() or Loadable.retryLoadAsync() method.
LoadStatus	getLoadStatus()	Returns the LoadStatus of the loadable resource.
java.util.List<FeatureCollectionTable>	getTables()	Gets the feature collection tables in this FeatureCollection.
java.util.Map<java.lang.String,java.lang.Object>	getUnknownJson()	If this object was created from JSON, this method gets unknown data from the source JSON.
java.util.Map<java.lang.String,java.lang.Object>	getUnsupportedJson()	If this object was created from JSON, this method gets unsupported data from the source JSON.
void	loadAsync()	Loads the metadata of the loadable resource asynchronously.
boolean	removeDoneLoadingListener(java.lang.Runnable listener)	Removes a done loading listener from the loadable resource.
boolean	removeLoadStatusChangedListener(LoadStatusChangedListener listener)	Removes a LoadStatusChangedListener from the loadable resource.
void	retryLoadAsync()	Loads or retries loading metadata for the object asynchronously.
ListenableFuture<PortalItem>	saveAsAsync(Portal portal, PortalFolder portalFolder, java.lang.String title, java.lang.Iterable<java.lang.String> tags, java.lang.String description, byte[] thumbnailData)	Executes an asynchronous operation to save this FeatureCollection by creating a new PortalItem on the given portal in the given folder.
ListenableFuture<PortalItem>	saveAsync()	Executes an asynchronous operation to save any changes that have been made to the FeatureCollection to the Portal.
java.lang.String	toJson()	Serializes this object to a JSON string.

Methods inherited from class java.lang.Object

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

Constructor Detail

FeatureCollection

public FeatureCollection()

Creates an empty FeatureCollection.

Since:

100.0.0

FeatureCollection

public FeatureCollection(java.lang.Iterable<FeatureCollectionTable> featureCollectionTables)

Creates a FeatureCollection from a set of feature collection tables.

Parameters:

featureCollectionTables - the feature collection tables to add to this FeatureCollection

Since:

100.0.0

FeatureCollection

public FeatureCollection(PortalItem portalItem)

Creates a FeatureCollection based on a PortalItem.

If the portal item is not in LoadStatus.LOADED state it will be loaded automatically when this FeatureCollection instance is loaded.

If the loaded portalItem is not of type PortalItem.Type.FEATURE_COLLECTION the FeatureCollection will fail to load.

Parameters:

portalItem - the PortalItem associated with this FeatureCollection instance

Throws:

java.lang.IllegalArgumentException - if the portalItem is null

Since:

100.0.0

See Also:

PortalItem

Method Detail

getTables

public java.util.List<FeatureCollectionTable> getTables()

Gets the feature collection tables in this FeatureCollection. The list is modifiable, that is, tables can be added and removed.

Returns:

a modifiable list of feature collection tables

Since:

100.0.0

getItem

public Item getItem()

Gets the associated Item of this FeatureCollection.

Returns:

the associated Item or null if this FeatureCollection is not associated with an Item

Since:

100.0.0

fromJson

public static FeatureCollection fromJson(java.lang.String json)

Creates a FeatureCollection instance from a JSON string.

Parameters:

json - a JSON string that represents a FeatureCollection

Returns:

a FeatureCollection instance

Throws:

java.lang.IllegalArgumentException - if json is null or empty

Since:

100.0.0

toJson

public java.lang.String toJson()

Description copied from interface: JsonSerializable

Serializes this object to a JSON string. Note that unknown JSON is omitted from the serialized string.

Specified by:

toJson in interface JsonSerializable

Returns:

a JSON string

getUnknownJson

public java.util.Map<java.lang.String,java.lang.Object> getUnknownJson()

Description copied from interface: JsonSerializable

If this object was created from JSON, this method gets unknown data from the source JSON. Unknown JSON is a Map of values that were in the source JSON but are not known by the Runtime and therefore not exposed in the API.

Specified by:

getUnknownJson in interface JsonSerializable

Returns:

an unmodifiable Map containing unknown JSON data. The keys are Strings containing names. The types of the values depend on the types of tokens within the JSON as follows:

• a Map<String, Object> represents an object in the JSON
• a List<Object> represents an array in the JSON
• a String represents a string in the JSON
• a Double represents a number in the JSON
• a Boolean represents true or false in the JSON
• null represents null in the JSON

getUnsupportedJson

public java.util.Map<java.lang.String,java.lang.Object> getUnsupportedJson()

Description copied from interface: JsonSerializable

If this object was created from JSON, this method gets unsupported data from the source JSON. Unsupported JSON is a Map of values that are supported by webmaps and known to the version of the webmap specification the API supports (see system requirements), but are not explicitly exposed through the Runtime API.

Specified by:

getUnsupportedJson in interface JsonSerializable

Returns:

an unmodifiable Map containing unsupported JSON data. The keys are Strings containing names. The types of the values depend on the types of tokens within the JSON as follows:

• a Map<String, Object> represents an object in the JSON
• a List<Object> represents an array in the JSON
• a String represents a string in the JSON
• a Double represents a number in the JSON
• a Boolean represents true or false in the JSON
• null represents null in the JSON

saveAsAsync

public ListenableFuture<PortalItem> saveAsAsync(Portal portal,
                                                PortalFolder portalFolder,
                                                java.lang.String title,
                                                java.lang.Iterable<java.lang.String> tags,
                                                java.lang.String description,
                                                byte[] thumbnailData)

Executes an asynchronous operation to save this FeatureCollection by creating a new PortalItem on the given portal in the given folder. Once completed, the FeatureCollection will be associated with the new PortalItem object. The new item will belong to the user currently signed in to the portal and its access level will be PortalItem.Access.PRIVATE.

Note that if the FeatureCollection was already associated with a PortalItem object (either because the FeatureCollection was created using a PortalItem or was previously saved), that object will be replaced with a new PortalItem, effectively 'duplicating' the FeatureCollection on the portal.

The result is a reference to the FeatureCollection's PortalItem object.

Parameters:

portal - the portal on which to save the FeatureCollection; must not be null

portalFolder - a PortalFolder belonging to the current user in which to save the FeatureCollection, or null to save it in the user's root folder

title - a title for the FeatureCollection; must not be null or empty

tags - a list of tags to associate with the FeatureCollection, or null if none

description - a description for the FeatureCollection, or null if none

thumbnailData - thumbnail data for the FeatureCollection, or null if none

Returns:

a ListenableFuture for tracking when the operation is done and getting the result; also allows cancellation. Calling get() on the returned future may throw an ExecutionException with its cause set to an exception as follows:

• IOException if the network request fails

Throws:

java.lang.IllegalArgumentException - if portal or title is null, or title is an empty string

java.lang.IllegalStateException - if the FeatureCollection is not loaded

ArcGISRuntimeException - if the current LicenseLevel is too low for this operation (LicenseLevel.BASIC or higher is required to save feature collections to a portal)

Since:

100.0.0

saveAsync

public ListenableFuture<PortalItem> saveAsync()

Executes an asynchronous operation to save any changes that have been made to the FeatureCollection to the Portal. The FeatureCollection must be associated with a PortalItem object, and must be loaded. The result is a reference to the FeatureCollection's PortalItem object.

Updates the FeatureCollection content data on the portal and also updates the portal item properties stored on the portal to match those stored within the FeatureCollection's PortalItem object.

Returns:

a ListenableFuture for tracking when the operation is done and getting the result; also allows cancellation. Calling get() on the returned future may throw an ExecutionException with its cause set to an exception as follows:

• IOException if the network request fails

Throws:

java.lang.IllegalStateException - if the FeatureCollection is not loaded or is not associated with a PortalItem object

ArcGISRuntimeException - if the current LicenseLevel is too low for this operation (LicenseLevel.BASIC or higher is required to save feature collections to a portal)

Since:

100.0.0

getLoadStatus

public LoadStatus getLoadStatus()

Description copied from interface: Loadable

Returns the LoadStatus of the loadable resource.

Specified by:

getLoadStatus in interface Loadable

Returns:

the LoadStatus of the loadable resource

getLoadError

public ArcGISRuntimeException getLoadError()

Description copied from interface: Loadable

Returns the most recent error that was encountered when the loadable resource transitioned to the LoadStatus.FAILED_TO_LOAD state, either due to calling the Loadable.loadAsync() or Loadable.retryLoadAsync() method.

If the resource subsequently transitions to LoadStatus.LOADED (for example, if a call to retryLoadAsync completes successfully) the error is cleared out.

Specified by:

getLoadError in interface Loadable

Returns:

the most recent error that was encountered when the loadable resource transitioned to the LoadStatus.FAILED_TO_LOAD state.

cancelLoad

public void cancelLoad()

Description copied from interface: Loadable

Cancels loading metadata for the object.

Cancels loading the metadata if the object is loading, and always invokes the done loading listener.

A load operation that is in progress (LoadStatus.LOADING state) can be cancelled by calling this method and the resource will transition from LoadStatus.LOADING to LoadStatus.FAILED_TO_LOAD state. If the load operation was successfully cancelled, a CancellationException will be returned from Loadable.getLoadError().

Cancellation should be used carefully because all enqueued done loading listeners for that resource instance will get invoked with an error stating that the operation was cancelled. Thus, one component in the application can cancel the load operation initiated by other components.

This method does nothing if the resource is not in LoadStatus.LOADING state.

Specified by:

cancelLoad in interface Loadable

loadAsync

public void loadAsync()

Description copied from interface: Loadable

Loads the metadata of the loadable resource asynchronously.

The load status changes from LoadStatus.NOT_LOADED to LoadStatus.LOADING. A listener can be added via Loadable.addDoneLoadingListener(java.lang.Runnable) that is invoked upon completion of the asynchronous load operation.

If the load operation completes successfully, the load status will be LoadStatus.LOADED, which means the resource has loaded its metadata.

If the load operation failed, the load status will be LoadStatus.FAILED_TO_LOAD and the error can be retrieved by calling Loadable.getLoadError().

This method can be called concurrently and repeatedly, but only one attempt is ever made to perform the load operation. If a load operation is already in progress (LoadStatus.LOADING state) when loadAsync is called, it simply piggy-backs on the outstanding operation and the done loading listener added to the loadable resource is enqueued to be invoked when that operation completes. If the operation has already completed (LoadStatus.LOADED or LoadStatus.FAILED_TO_LOAD state) when loadAsync is called, the done loading listener is immediately invoked when added to the loadable resource.

If a loadable resource has failed to load, calling loadAsync on it subsequently will not change its state. The done loading listener will be invoked immediately when added to the loadable resource. In order to retry loading the resource, Loadable.retryLoadAsync() needs to be used.

A load operation that is in progress (LoadStatus.LOADING state) can be cancelled by calling Loadable.cancelLoad().

Specified by:

loadAsync in interface Loadable

retryLoadAsync

public void retryLoadAsync()

Description copied from interface: Loadable

Loads or retries loading metadata for the object asynchronously.

Will retry loading the metadata if the object's load status is LoadStatus.FAILED_TO_LOAD. Will load the object if it is not loaded. Will not retry to load the object if the object is loaded.

For more details on the load process see Loadable.loadAsync().

Specified by:

retryLoadAsync in interface Loadable

addDoneLoadingListener

public void addDoneLoadingListener(java.lang.Runnable listener)

Description copied from interface: Loadable

Adds a listener to the loadable resource that is invoked when loading has completed.

The listener may be added at any point, whether the loadable resource has already completed loading or not.

• For resources that are not loaded when the listener is added (LoadStatus is NOT_LOADED or LOADING): When the resource completes loading, the listener will be invoked on the UI thread if it is added from the UI thread, otherwise it is not guaranteed on which thread the listener is invoked.
• For resources that are already loaded when the listener is added (LoadStatus is LOADED or FAILED_TO_LOAD): The listener will be called immediately, on the current thread.

Alternatively, to be notified when there is any change in the load status, use the Loadable.addLoadStatusChangedListener(LoadStatusChangedListener) method instead.

Specified by:

addDoneLoadingListener in interface Loadable

Parameters:

listener - a Runnable that is invoked upon completion of the load operation

removeDoneLoadingListener

public boolean removeDoneLoadingListener(java.lang.Runnable listener)

Description copied from interface: Loadable

Removes a done loading listener from the loadable resource.

Specified by:

removeDoneLoadingListener in interface Loadable

Parameters:

listener - the listener to be removed

Returns:

true if the listener was removed, otherwise false

addLoadStatusChangedListener

public void addLoadStatusChangedListener(LoadStatusChangedListener listener)

Description copied from interface: Loadable

Adds a LoadStatusChangedListener to the loadable resource that is invoked whenever the load status changes.

Adding this listener on the UI thread will cause it to be invoked on the UI thread, otherwise it is not guaranteed on which thread the listener is invoked.

The listener will not be called if added to a loadable resource that has already completed loading. To be notified when a loadable resource has completed loading, including if the resource is already loaded when the listener is added, use the Loadable.addDoneLoadingListener(Runnable) method.

Specified by:

addLoadStatusChangedListener in interface Loadable

Parameters:

listener - the LoadStatusChangedListener to be added

removeLoadStatusChangedListener

public boolean removeLoadStatusChangedListener(LoadStatusChangedListener listener)

Description copied from interface: Loadable

Removes a LoadStatusChangedListener from the loadable resource.

Specified by:

removeLoadStatusChangedListener in interface Loadable

Parameters:

listener - the LoadStatusChangedListener to be removed

Returns:

true if the listener was removed, otherwise false