Class ArcGISFeature
- java.lang.Object
-
- com.esri.arcgisruntime.data.Feature
-
- com.esri.arcgisruntime.data.ArcGISFeature
-
- All Implemented Interfaces:
Loadable
,GeoElement
,AutoCloseable
public final class ArcGISFeature extends Feature implements Loadable, AutoCloseable
AFeature
stored in anArcGISFeatureTable
.An ArcGISFeature can contain:
- A set of attributes that describe the real-world entity it represents.
- A geometry that defines its location and shape. The geometry might contain m values, which are typically used for linear referencing.
- Zero or more feature attachments such as images or documents.
If you create a
ServiceFeatureTable
from the URL of a feature service, features in the table are initially in one of the following states:- A minimum set of attributes are available in the table, and m values are omitted. This is an optimization for faster rendering.
- All attributes defined by the service are available in the table, including m values, which might be NaN.
ServiceFeatureTable.FeatureRequestMode
.By default, a query on ArcGISFeatures in a minimum state will return them in the same state. To access all attributes (or the m values) of features returned by a query, you must load the features. You can do one of the following:
- Call
Loadable.loadAsync()
on each feature. - Call
loadOrRefreshFeaturesAsync(Iterable<Feature>)
. and pass a mutable array of the features to be loaded. - Call
ServiceFeatureTable.queryFeaturesAsync(QueryParameters, ServiceFeatureTable.QueryFeatureFields)
with the constantServiceFeatureTable.QueryFeatureFields.LOAD_ALL
, which returns all features in a fully loaded state.
ServiceFeatureTable
.- Since:
- 100.0.0
-
-
Method Summary
All Methods Instance Methods Concrete Methods Deprecated Methods Modifier and Type Method Description ListenableFuture<Attachment>
addAttachmentAsync(byte[] data, String contentType, String name)
Adds an attachment to this feature.void
addDoneLoadingListener(Runnable listener)
Adds a listener to the loadable resource that is invoked when loading has completed.void
addLoadStatusChangedListener(LoadStatusChangedListener listener)
Adds aLoadStatusChangedListener
to the loadable resource that is invoked whenever the load status changes.void
cancelLoad()
Cancels loading metadata for the object.boolean
canEditAttachments()
Returns whether the attachments of this feature are editable.boolean
canUpdateGeometry()
Returns whether the geometry of this feature can be updated.void
close()
Closes this ArcGISFeature, relinquishing any underlying resources.ListenableFuture<Void>
deleteAttachmentAsync(Attachment attachment)
Deletes this feature's attachment; defined by the given Attachment.ListenableFuture<Void>
deleteAttachmentsAsync(Iterable<Attachment> attachments)
Deletes the attachments, defined by the given Attachment.ListenableFuture<List<Attachment>>
fetchAttachmentsAsync()
Fetches all attachments of this feature.FeatureSubtype
getFeatureSubtype()
Gets the correspondingFeatureSubtype
for this feature.ArcGISFeatureTable
getFeatureTable()
Gets a reference to theArcGISFeatureTable
that this feature came from.ArcGISRuntimeException
getLoadError()
Returns the most recent error that was encountered when the loadable resource transitioned to theLoadStatus.FAILED_TO_LOAD
state, either due to calling theLoadable.loadAsync()
orLoadable.retryLoadAsync()
method.LoadStatus
getLoadStatus()
Returns theLoadStatus
of the loadable resource.void
loadAsync()
Loads the metadata of the loadable resource asynchronously.boolean
refreshObjectId()
Deprecated.As of 100.4.0, replaced byFeature.refresh()
.void
relateFeature(ArcGISFeature feature)
Sets up a relationship between this feature and the provided feature.void
relateFeature(ArcGISFeature feature, RelationshipInfo relationshipInfo)
Sets up a relationship between this feature and the provided feature based on the given relationship info.boolean
removeDoneLoadingListener(Runnable listener)
Removes a done loading listener from the loadable resource.boolean
removeLoadStatusChangedListener(LoadStatusChangedListener listener)
Removes aLoadStatusChangedListener
from the loadable resource.void
retryLoadAsync()
Loads or retries loading metadata for the object asynchronously.void
unrelateFeature(ArcGISFeature feature)
Removes the relationship between this feature and the provided feature.ListenableFuture<Void>
updateAttachmentAsync(Attachment attachment, byte[] data, String contentType, String name)
Updates the feature's attachment, defined by the given Attachment.-
Methods inherited from class com.esri.arcgisruntime.data.Feature
getAttributes, getGeometry, refresh, setGeometry
-
-
-
-
Method Detail
-
getFeatureTable
public ArcGISFeatureTable getFeatureTable()
Gets a reference to theArcGISFeatureTable
that this feature came from.- Overrides:
getFeatureTable
in classFeature
- Returns:
- a reference to the
ArcGISFeatureTable
that this feature came from - Since:
- 100.0.0
-
getFeatureSubtype
public FeatureSubtype getFeatureSubtype()
Gets the correspondingFeatureSubtype
for this feature.If this feature belongs to an
ArcGISFeatureTable
that defines aArcGISFeatureTable.getSubtypeField()
, aFeatureSubtype
that matchesFeatureSubtype.getCode()
with this feature's attribute value for subtype field is returned; otherwise, this will return null.- Returns:
- the FeatureSubtype for this feature, or null if none
- Since:
- 100.9.0
-
canEditAttachments
public boolean canEditAttachments()
Returns whether the attachments of this feature are editable. Attachments are editable if the feature's table supports attachments and one of the following conditions is met:- the feature has not been added to a table
FeatureTable.canUpdate(Feature)
returns true
- Returns:
- true if the attachments of this feature are editable; otherwise false
- Since:
- 100.0.0
-
canUpdateGeometry
public boolean canUpdateGeometry()
Returns whether the geometry of this feature can be updated. Geometries are editable if the feature's table supports geometry and one of the following conditions is met:- the feature has not been added to a table or has not been synced to the server
- the table's edit capabilities and ownership based access control from its layer info allow geometry to be
edited and
FeatureTable.canUpdate(Feature)
returns true
- Returns:
- true if the geometry can be updated, otherwise false.
- Since:
- 100.0.0
-
fetchAttachmentsAsync
public ListenableFuture<List<Attachment>> fetchAttachmentsAsync()
Fetches all attachments of this feature. Attachments are returned in descending order based on their id.- Returns:
- a ListenableFuture that represents the result of the fetch attachments operation and indicates if the result
java.util.concurrent.Future.isDone()
. The resulting list is empty if there are no attachments to this feature. - Since:
- 100.0.0
-
addAttachmentAsync
public ListenableFuture<Attachment> addAttachmentAsync(byte[] data, String contentType, String name)
Adds an attachment to this feature.- Parameters:
data
- the data of the attachment, may be nullcontentType
- the type of file content. Valid types depends on the service associated with this feature. It could be null. This string should represent the MIME type of the attachment file. Examples include "text/plain", "image/jpg", "application/pdf", and so on.name
- the name for this attachment. May be null- Returns:
- a ListenableFuture that represents the result of the add attachments operation and indicates if the result
java.util.concurrent.Future.isDone()
. - Since:
- 100.0.0
-
updateAttachmentAsync
public ListenableFuture<Void> updateAttachmentAsync(Attachment attachment, byte[] data, String contentType, String name)
Updates the feature's attachment, defined by the given Attachment.- Parameters:
attachment
- the attachment to be updateddata
- the new data of the attachment, cannot be nullcontentType
- content type of the new attachment. Its value depends on the data of the attachment. May be null.name
- name of the new attachment. May be null.- Returns:
- a ListenableFuture that represents the result of the update attachments operation and indicates if the result
java.util.concurrent.Future.isDone()
. - Throws:
IllegalArgumentException
- if Attachment is nullIllegalArgumentException
- if data is null- Since:
- 100.0.0
-
deleteAttachmentAsync
public ListenableFuture<Void> deleteAttachmentAsync(Attachment attachment)
Deletes this feature's attachment; defined by the given Attachment.- Parameters:
attachment
- the attachment to be deleted- Returns:
- a ListenableFuture that represents the result of the delete attachment operation and indicates if the result
java.util.concurrent.Future.isDone()
. - Throws:
IllegalArgumentException
- if attachment is null- Since:
- 100.0.0
-
deleteAttachmentsAsync
public ListenableFuture<Void> deleteAttachmentsAsync(Iterable<Attachment> attachments)
Deletes the attachments, defined by the given Attachment.- Parameters:
attachments
- the attachments to be deleted- Returns:
- a ListenableFuture that represents the result of the delete attachments operation and indicates if the result
java.util.concurrent.Future.isDone()
. - Throws:
IllegalArgumentException
- if attachments is null- Since:
- 100.0.0
-
refreshObjectId
@Deprecated public boolean refreshObjectId()
Deprecated.As of 100.4.0, replaced byFeature.refresh()
.Updates both the object Id and global Id (if applicable) of the feature to get the permanent value after edits have been applied to the service withServiceFeatureTable.applyEditsAsync()
.Note: Global Ids are assigned by the server and will always require calling this method to update the feature's attributes with the new value.
- Returns:
- true if the object Id and/or global Id was changed to a permanent Id, false if the Id was already a permanent value or none was available.
- Since:
- 100.0.0
-
relateFeature
public void relateFeature(ArcGISFeature feature)
Sets up a relationship between this feature and the provided feature.If this relationship is keyed on an object ID or global ID, and the origin feature in this call has been created locally, you must first call
ServiceFeatureTable.applyEditsAsync()
andrefreshObjectId()
to obtain the new object ID and global ID generated by the service. If this is not done, then the destination feature will end up referring to an outdated ID and will not be considered related.- Parameters:
feature
- the feature to relate to- Throws:
IllegalArgumentException
- if feature is null- Since:
- 100.1.0
-
relateFeature
public void relateFeature(ArcGISFeature feature, RelationshipInfo relationshipInfo)
Sets up a relationship between this feature and the provided feature based on the given relationship info.If this relationship is keyed on an object ID or global ID, and the origin feature in this call has been created locally, you must first call
ServiceFeatureTable.applyEditsAsync()
andrefreshObjectId()
to obtain the new object ID and global ID generated by the service. If this is not done, then the destination feature will end up referring to an outdated ID and will not be considered related.- Parameters:
feature
- the feature to relate torelationshipInfo
- the relationship info to use when relating the two features, can be null- Throws:
IllegalArgumentException
- if feature is null- Since:
- 100.1.0
-
unrelateFeature
public void unrelateFeature(ArcGISFeature feature)
Removes the relationship between this feature and the provided feature.- Parameters:
feature
- the feature from which this feature should remove its relationship- Throws:
IllegalArgumentException
- if feature is null- Since:
- 100.1.0
-
getLoadStatus
public LoadStatus getLoadStatus()
Description copied from interface:Loadable
Returns theLoadStatus
of the loadable resource.- Specified by:
getLoadStatus
in interfaceLoadable
- 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 theLoadStatus.FAILED_TO_LOAD
state, either due to calling theLoadable.loadAsync()
orLoadable.retryLoadAsync()
method.If the resource subsequently transitions to
LoadStatus.LOADED
(for example, if a call toretryLoadAsync
completes successfully) the error is cleared out.- Specified by:
getLoadError
in interfaceLoadable
- 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 fromLoadStatus.LOADING
toLoadStatus.FAILED_TO_LOAD
state. If the load operation was successfully cancelled, a CancellationException will be returned fromLoadable.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 interfaceLoadable
-
loadAsync
public void loadAsync()
Loads the metadata of the loadable resource asynchronously.The load status changes from
LoadStatus.NOT_LOADED
toLoadStatus.LOADING
. A listener can be added viaLoadable.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 callingLoadable.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) whenloadAsync
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
orLoadStatus.FAILED_TO_LOAD
state) whenloadAsync
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 callingLoadable.cancelLoad()
.An ArcGISFeature is loadable. Depending on a ServiceFeatureTable's feature request mode, queries on the table can return ArcGISFeature objects which have the minimum set of attributes required for rendering and labeling (and geometries do not include m values). For more details, see the following:
ServiceFeatureTable.queryFeaturesAsync(QueryParameters, ServiceFeatureTable.QueryFeatureFields)
,ServiceFeatureTable.FeatureRequestMode.ON_INTERACTION_CACHE
ServiceFeatureTable.FeatureRequestMode.ON_INTERACTION_NO_CACHE
To access all attributes in the returned ArcGISFeatures, call this method on each feature. For alternative ways to load all attributes in the returned features, see
loadOrRefreshFeaturesAsync(Iterable<Feature>)
orServiceFeatureTable.queryFeaturesAsync(QueryParameters, ServiceFeatureTable.QueryFeatureFields)
-
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 interfaceLoadable
-
addDoneLoadingListener
public void addDoneLoadingListener(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 interfaceLoadable
- Parameters:
listener
- a Runnable that is invoked upon completion of the load operation
-
removeDoneLoadingListener
public boolean removeDoneLoadingListener(Runnable listener)
Description copied from interface:Loadable
Removes a done loading listener from the loadable resource.- Specified by:
removeDoneLoadingListener
in interfaceLoadable
- 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 aLoadStatusChangedListener
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 interfaceLoadable
- Parameters:
listener
- theLoadStatusChangedListener
to be added
-
removeLoadStatusChangedListener
public boolean removeLoadStatusChangedListener(LoadStatusChangedListener listener)
Description copied from interface:Loadable
Removes aLoadStatusChangedListener
from the loadable resource.- Specified by:
removeLoadStatusChangedListener
in interfaceLoadable
- Parameters:
listener
- theLoadStatusChangedListener
to be removed- Returns:
- true if the listener was removed, otherwise false
-
close
public void close()
Closes this ArcGISFeature, relinquishing any underlying resources. This method is invoked automatically on objects managed by the try-with-resources statement. Any method invoked on this ArcGISFeature instance after it has been closed throws an IllegalStateException. This method is idempotent, in other words it can be called more than once without any side effects.Calling this method is not mandatory, but recommended on Android if large amounts of ArcGISFeature instances are allocated, to ensure a deterministic and timely release of resources.
Note that this method does not close the underlying geodatabase. For closing the geodatabase see
Geodatabase.close()
.- Specified by:
close
in interfaceAutoCloseable
- Since:
- 100.6.0
-
-