Class ServiceGeodatabase

java.lang.Object
com.esri.arcgisruntime.data.ServiceGeodatabase
All Implemented Interfaces:
RemoteResource, Loadable

public final class ServiceGeodatabase extends Object implements Loadable, RemoteResource
A container for a collection of ServiceFeatureTable connected to a feature service.

A ServiceGeodatabase connects to a feature service as a whole, grouping together ServiceFeatureTable instances for related records queries, connecting to a version in a branch-versioned service, and managing edits for all tables.

Since:
100.9.0
  • Property Details

  • Constructor Details

    • ServiceGeodatabase

      public ServiceGeodatabase(String serviceUrl)
      Constructs a ServiceGeodatabase with the given URL and connected to the default version in the feature service.

      If the service is branch versioned, the ServiceGeodatabase will connect to the default version.

      Parameters:
      serviceUrl - the URL of the feature service or the portal item to connect to
      Throws:
      IllegalArgumentException - if serviceUrl is null or empty
      Since:
      100.9.0
    • ServiceGeodatabase

      public ServiceGeodatabase(String serviceUrl, String versionName)
      Constructs a ServiceGeodatabase with the given URL and connected to a specific version in the feature service.

      If a version with the name does not exist, or the service is not branch versioned, the ServiceGeodatabase will fail to load.

      Parameters:
      serviceUrl - the URL of the feature service or portal item to connect to
      versionName - the existing version name to connect to when the ServiceGeodatabase loads; if it is null, this constructor is equivalent to ServiceGeodatabase(String).
      Throws:
      IllegalArgumentException - if serviceUrl is null or empty
      Since:
      100.9.0
    • ServiceGeodatabase

      public ServiceGeodatabase(PortalItem portalItem)
      Creates a new ServiceGeodatabase from a feature service portal item, and connects to the default version in the feature service.

      If the service is branch versioned, the ServiceGeodatabase will connect to the default version.

      Parameters:
      portalItem - a feature service PortalItem
      Throws:
      IllegalArgumentException - if portalItem is null
      Since:
      100.12.0
      See Also:
    • ServiceGeodatabase

      public ServiceGeodatabase(PortalItem portalItem, FeatureServiceSessionType sessionType)
      Creates a new ServiceGeodatabase from a feature service portal item, and connects to the default version in the feature service.

      If the service is branch versioned, the ServiceGeodatabase will connect to the default version.

      If using FeatureServiceSessionType.PERSISTENT and the service is not branch versioned, the ServiceGeodatabase will fail to load.

      If using FeatureServiceSessionType.PERSISTENT, it is important to call closeAsync() before destruction.

      Parameters:
      portalItem - a feature service PortalItem
      sessionType - the type of read and edit sessions to use when working with the service
      Throws:
      IllegalArgumentException - if portalItem is null
      IllegalArgumentException - if sessionType is null
      Since:
      100.12.0
      See Also:
    • ServiceGeodatabase

      public ServiceGeodatabase(PortalItem portalItem, String versionName)
      Creates a new ServiceGeodatabase from a feature service portal item, and connects to a specific version in the feature service.

      If a version with the name does not exist, or the service is not branch versioned, the ServiceGeodatabase will fail to load.

      Parameters:
      portalItem - a feature service PortalItem
      versionName - the existing version to connect to when the ServiceGeodatabase loads
      Throws:
      IllegalArgumentException - if portalItem is null
      IllegalArgumentException - if versionName is null
      Since:
      100.12.0
      See Also:
    • ServiceGeodatabase

      public ServiceGeodatabase(PortalItem portalItem, String versionName, FeatureServiceSessionType sessionType)
      Creates a new ServiceGeodatabase from a feature service portal item, and connects to a specific version in the feature service.

      If a version with the name does not exist, or the service is not branch versioned, the ServiceGeodatabase will fail to load.

      If using FeatureServiceSessionType.PERSISTENT and the service is not branch versioned, the ServiceGeodatabase will fail to load.

      If using FeatureServiceSessionType.PERSISTENT, it is important to call closeAsync() before destruction.

      Parameters:
      portalItem - a feature service PortalItem
      versionName - the existing version to connect to when the ServiceGeodatabase loads
      sessionType - the type of read and edit sessions to use when working with the service
      Throws:
      IllegalArgumentException - if portalItem is null
      IllegalArgumentException - if versionName is null
      IllegalArgumentException - if sessionType is null
      Since:
      100.12.0
      See Also:
    • ServiceGeodatabase

      public ServiceGeodatabase(String url, FeatureServiceSessionType sessionType)
      Creates a new ServiceGeodatabase connected to the default version in a feature service.

      If the service is branch versioned, the ServiceGeodatabase will connect to the default version.

      If using FeatureServiceSessionType.PERSISTENT and the service is not branch versioned, the ServiceGeodatabase will fail to load.

      If using FeatureServiceSessionType.PERSISTENT, it is important to call closeAsync() before destruction.

      Parameters:
      url - the URL of the feature service or the portal item to connect to
      sessionType - the type of read and edit sessions to use when working with the service
      Throws:
      IllegalArgumentException - if url is null
      IllegalArgumentException - if sessionType is null
      Since:
      100.10.0
    • ServiceGeodatabase

      public ServiceGeodatabase(String url, String versionName, FeatureServiceSessionType sessionType)
      Creates a new ServiceGeodatabase connected to a specific version in a feature service.

      If a version with the name does not exist, or the service is not branch versioned, the ServiceGeodatabase will fail to load.

      If using FeatureServiceSessionType.PERSISTENT, it is important to call closeAsync() when you are done with the session.

      Parameters:
      url - the URL of the feature service or portal item to connect to
      versionName - the existing version to connect to when the ServiceGeodatabase loads; if it is null, this constructor is equivalent to ServiceGeodatabase(String, FeatureServiceSessionType)
      sessionType - the type of read and edit sessions to use when working with the service
      Throws:
      IllegalArgumentException - if url is null
      IllegalArgumentException - if sessionType is null
      Since:
      100.10.0
  • Method Details

    • createVersionAsync

      public ListenableFuture<ServiceVersionInfo> createVersionAsync(ServiceVersionParameters newVersion)
      Asynchronously creates a new version in the service based on the default version.

      Branch versioning requires that the default version always be the ancestor of all other versions. If the service isn't branch versioned, an ArcGISRuntimeException is thrown.

      Parameters:
      newVersion - a ServiceVersionParameters to set the properties of the new version
      Returns:
      a ListenableFuture that represents the creation of a new version in the service. When the operation is done the result is a ServiceVersionInfo containing the full metadata for the new version
      Throws:
      IllegalArgumentException - if newVersion is null
      ArcGISRuntimeException - if the service isn't branch versioned, or if the version parameters do not include a name
      Since:
      100.9.0
    • fetchVersionsAsync

      public ListenableFuture<List<ServiceVersionInfo>> fetchVersionsAsync()
      Asynchronously retrieves a list of all versions on the service.
      Returns:
      a ListenableFuture that represents the retrieval of all versions on the service. When the operation is done the result contains a list of ServiceVersionInfo objects.
      Throws:
      ArcGISRuntimeException - if the service isn't branch versioned
      Since:
      100.9.0
    • getConnectedTables

      public ListenableList<ServiceFeatureTable> getConnectedTables()
      Gets the collection of feature tables managed by the ServiceGeodatabase.
      Returns:
      an unmodifiable listenable list of feature tables managed by the ServiceGeodatabase
      Since:
      100.9.0
    • getDefaultVersionName

      public String getDefaultVersionName()
      Gets the name of the default version.
      Returns:
      the name of the default version
      Since:
      100.9.0
    • getServiceInfo

      public ArcGISFeatureServiceInfo getServiceInfo()
      Gets the metadata of the service this object is connected to.
      Returns:
      an ArcGISFeatureServiceInfo
      Since:
      100.9.0
    • isSupportsBranchVersioning

      public boolean isSupportsBranchVersioning()
      Gets whether the service supports branch versioning.
      Returns:
      true if the service supports branch versioning, false otherwise
      Since:
      100.9.0
    • getTable

      public ServiceFeatureTable getTable(long layerId)
      Gets a service feature table object from the ID of a layer or table in the service.

      If a table instance for the layer already exists in getConnectedTables(), the existing object will be returned. Otherwise, a new ServiceFeatureTable will be created.

      Parameters:
      layerId - the layer id for which to create the table
      Returns:
      a table instance for working with the table or layer in the feature service
      Throws:
      ArcGISRuntimeException - if no table or layer exists in the service with the given ID
      Since:
      100.9.0
    • getVersionName

      public String getVersionName()
      Gets the name of the version the ServiceGeodatabase is currently connected to.
      Returns:
      the name of the version the ServiceGeodatabase is currently connected to
      Since:
      100.9.0
    • getSessionType

      public FeatureServiceSessionType getSessionType()
      Gets the type of read and edit sessions to use when working with the service.

      The default value is FeatureServiceSessionType.TRANSIENT.

      If the feature service this ServiceGeodatabase references is not branch-versioned, only FeatureServiceSessionType.TRANSIENT is supported. If using FeatureServiceSessionType.PERSISTENT, it is important to call closeAsync() when you are done with the session. Cannot be set after the ServiceGeodatabase is loaded. When the ServiceGeodatabase is created by loading a ArcGISMap, use LoadSettings to control the session type.

      Returns:
      the type of read and edit sessions to use when working with the service
      Since:
      100.10.0
    • setSessionType

      public void setSessionType(FeatureServiceSessionType sessionType)
      Sets the type of read and edit sessions to use when working with the service.

      The default value is FeatureServiceSessionType.TRANSIENT.

      Cannot be set after the ServiceGeodatabase is loaded.

      Parameters:
      sessionType - the type of read and edit sessions to use when working with the service
      Throws:
      IllegalArgumentException - if sessionType is null
      Since:
      100.10.0
    • switchVersionAsync

      public ListenableFuture<Void> switchVersionAsync(String versionName)
      Asynchronously switches all connected feature tables to the new version.

      Check the result of hasLocalEdits() before attempting to switch versions, to make sure all changes are saved to the service or discarded from the local cache. Use the applyEditsAsync() or undoLocalEditsAsync() methods as appropriate to save or discard changes before switching versions.

      Parameters:
      versionName - the name of the version to connect to
      Returns:
      a ListenableFuture that represents the success of switching versions. When the operation is done, the version is switched successfully if no runtime error is thrown
      Throws:
      IllegalArgumentException - if versionName is null
      ArcGISRuntimeException - if the service isn't branch versioned, or no version exists with the supplied name or any of getConnectedTables() have unapplied edits
      Since:
      100.9.0
    • applyEditsAsync

      public ListenableFuture<List<FeatureTableEditResult>> applyEditsAsync()
      Asynchronously applies all local edits in all tables to the service.

      This method applies all feature table edits to the feature service as a single transaction. If one of the edits fails, all edits are rolled-back, and geodatabase integrity is preserved. This is the recommended approach to applying edits and is typically more efficient than calling ServiceFeatureTable.applyEditsAsync() on each table.

      However, this method can only succeed if all tables either support or do not support global IDs. A mix of global ID support is not permitted and will result in an error.

      Use ArcGISFeatureServiceInfo.canUseServiceGeodatabaseApplyEditsProperty() to determine whether you can successfully apply your edits through this method.

      Returns:
      a ListenableFuture that applies the all local edits to the service. When the operation is done the result contains a list of FeatureTableEditResult objects.
      Since:
      100.9.0
    • closeAsync

      public ListenableFuture<Void> closeAsync()
      Closes this service geodatabase.

      A request to stop any active reading or editing sessions with the feature service is sent and once this asynchronous process is complete,this service geodatabase will be closed.

      Before calling this method, there should be no references to all related data. For example, terminate fetch versions, create version, switch, apply or undo edits, remove feature layers, and release tables from map.

      After calling this method, accessing this service geodatabase or any of its connected tables will fail with an ArcGISRuntimeException

      Closing this service geodatabase is not necessary if it has not been loaded.

      Returns:
      a ListenableFuture that has no return value
      Since:
      100.10.0
    • hasLocalEdits

      public boolean hasLocalEdits()
      Gets whether any of the tables in the ServiceGeodatabase have unapplied edits.
      Returns:
      whether any of the tables have unapplied edits
      Since:
      100.9.0
    • undoLocalEditsAsync

      public ListenableFuture<Void> undoLocalEditsAsync()
      Asynchronously undoes all of the local edits in all the tables.
      Returns:
      a ListenableFuture that represents the success of undoing local edits. When the operation is done, the local edits are undone successfully if no exception is thrown.
      Since:
      100.9.0
    • getPortalItem

      public PortalItem getPortalItem()
      Gets the PortalItem which the ServiceGeodatabase was created from.
      Returns:
      the PortalItem which the ServiceGeodatabase was created from, or null if none
      Since:
      100.12.0
      See Also:
    • getLoadError

      public ArcGISRuntimeException getLoadError()
      Gets the value of the property loadError.
      Specified by:
      getLoadError in interface Loadable
      Property description:
      Returns:
      the most recent error that was encountered when the loadable resource transitioned to the LoadStatus.FAILED_TO_LOAD state.
    • getLoadStatus

      public LoadStatus getLoadStatus()
      Gets the value of the property loadStatus.
      Specified by:
      getLoadStatus in interface Loadable
      Property description:
      Returns:
      the LoadStatus of the loadable resource
    • 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(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, add a listener to the Loadable.loadStatusProperty() instead.

      Specified by:
      addDoneLoadingListener in interface Loadable
      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 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
    • loadStatusProperty

      public ReadOnlyObjectProperty<LoadStatus> loadStatusProperty()
      Description copied from interface: Loadable
      The load status.
      Specified by:
      loadStatusProperty in interface Loadable
      See Also:
    • loadErrorProperty

      public ReadOnlyObjectProperty<ArcGISRuntimeException> loadErrorProperty()
      Description copied from interface: Loadable
      The load error.
      Specified by:
      loadErrorProperty in interface Loadable
      See Also:
    • 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()
      Description copied from interface: RemoteResource
      Gets the URI of this RemoteResource. Typically this is the URI used to instantiate the object.
      Specified by:
      getUri in interface RemoteResource
      Returns:
      the URI of this RemoteResource