Class KmlDataset
- java.lang.Object
-
- com.esri.arcgisruntime.ogc.kml.KmlDataset
-
- All Implemented Interfaces:
RemoteResource
,Loadable
public final class KmlDataset extends Object implements Loadable, RemoteResource
A KML dataset object. A KmlDataset is created from the source of the KML data (.kml/.kmz) on disk or network. Use KmlDataset to create aKmlLayer
instance.The distribution of KML data types typically comes in the form of two file extension types: .kml and .kmz.
Use the value of
getRootNodes()
to obtain a list ofKmlNode
to traverse the KmlNode objects for examining/using individual KML features. ThegetRootNodes()
is populated after a KML dataset has finished loading successfully. A KML dataset will typically contain just one root KmlNode, but not always.Examining nodes within a KmlDataset may be useful for: viewing attributes of the KML data, seeing the organization/structure within the KML dataset, toggling visibility of KML features, and navigating to specific KML features.
A typical KML document will have multiple levels of nodes. Consider using recursion to access all nodes in a KML file. See the guide doc and samples for details.
The KML dataset represents the current state of the KML data specified in a KML or KMZ file. Note that the data can change when network links are refreshed.
- Since:
- 100.4.0
-
-
Constructor Summary
Constructors Constructor Description KmlDataset(KmlNode kmlNode)
Constructs a KmlDataset for the given KmlNode.KmlDataset(String url)
Constructs a KML dataset from the provided path to a KML/KMZ file.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description void
addDoneLoadingListener(Runnable listener)
Adds a listener to the loadable resource that is invoked when loading has completed.void
addKmlNetworkLinkMessageReceivedListener(KmlNetworkLinkMessageReceivedListener listener)
Adds a listener for when a KML network link message is received.void
addKmlNodeBalloonVisibilityChangedListener(KmlNodeBalloonVisibilityChangedListener listener)
Adds a listener to listen to the balloon visibility changes on a KML node.void
addKmlNodeRefreshStatusChangedListener(KmlNodeRefreshStatusChangedListener listener)
Adds a listener for refresh status changes of KML nodes.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.Credential
getCredential()
Gets theCredential
that is set on the network-enabled resource.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.RequestConfiguration
getRequestConfiguration()
Gets theRequestConfiguration
used to modify the parameters of network requests made by thisRemoteResource
.List<KmlNode>
getRootNodes()
Gets an unmodifiable list of KmlNode as root nodes.String
getUri()
Gets the URI of thisRemoteResource
.void
loadAsync()
Loads the metadata of the loadable resource asynchronously.boolean
removeDoneLoadingListener(Runnable listener)
Removes a done loading listener from the loadable resource.boolean
removeKmlNetworkLinkMessageReceivedListener(KmlNetworkLinkMessageReceivedListener listener)
Removes a KML network link message received listener.boolean
removeKmlNodeBalloonVisibilityChangedListener(KmlNodeBalloonVisibilityChangedListener listener)
Removes a node balloon visibility changed listener.boolean
removeKmlNodeRefreshStatusChangedListener(KmlNodeRefreshStatusChangedListener listener)
Removes a node refresh status changed listener.boolean
removeLoadStatusChangedListener(LoadStatusChangedListener listener)
Removes aLoadStatusChangedListener
from the loadable resource.void
retryLoadAsync()
Loads or retries loading metadata for the object asynchronously.void
setCredential(Credential credential)
Sets aCredential
to be used by the network-enabled resource in the event of an authentication challenge.void
setRequestConfiguration(RequestConfiguration requestConfiguration)
Sets theRequestConfiguration
used to modify the parameters of network requests made by thisRemoteResource
.
-
-
-
Constructor Detail
-
KmlDataset
public KmlDataset(String url)
Constructs a KML dataset from the provided path to a KML/KMZ file.A KML dataset is the source of KML information backing a KML layer. Use the KML dataset to interact with the contents of a KML layer. Licensing for KML depends on the method of access. Accessing files on disk requires a higher licensing level than accessing files from network locations.
- Parameters:
url
- the URL location of KML file, either on disk or from the network- Throws:
IllegalArgumentException
- if url is null or empty- Since:
- 100.4.0
-
KmlDataset
public KmlDataset(KmlNode kmlNode)
Constructs a KmlDataset for the given KmlNode.- Parameters:
kmlNode
- a KmlNode- Throws:
IllegalArgumentException
- if kmlNode is null- Since:
- 100.6.0
-
-
Method Detail
-
getRootNodes
public List<KmlNode> getRootNodes()
Gets an unmodifiable list of KmlNode as root nodes.A KML dataset can have multiple root nodes, each of them may have children. When traversing the KML feature tree (for example to build a table of contents), this list of root nodes is the correct starting point. Each root node can be the start of a tree of nodes, so these should be explored recursively.
- Returns:
- a unmodifiable list of KmlNode as root nodes
- Since:
- 100.4.0
-
addKmlNetworkLinkMessageReceivedListener
public void addKmlNetworkLinkMessageReceivedListener(KmlNetworkLinkMessageReceivedListener listener)
Adds a listener for when a KML network link message is received.KML network links may specify messages, such as usage guidelines. Applications are expected to deliver this message once to the end-user, typically in the form of an alert. The event will be raised when a network link is first loaded, or when it is changed in the network link control.
This 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.
- Parameters:
listener
- the listener- Throws:
IllegalArgumentException
- if listener is null- Since:
- 100.4.0
-
removeKmlNetworkLinkMessageReceivedListener
public boolean removeKmlNetworkLinkMessageReceivedListener(KmlNetworkLinkMessageReceivedListener listener)
Removes a KML network link message received listener.- Parameters:
listener
- the listener to remove- Returns:
- true, if successful
- Since:
- 100.4.0
-
addKmlNodeRefreshStatusChangedListener
public void addKmlNodeRefreshStatusChangedListener(KmlNodeRefreshStatusChangedListener listener)
Adds a listener for refresh status changes of KML nodes.This 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.
- Parameters:
listener
- the listener- Throws:
IllegalArgumentException
- if listener is null- Since:
- 100.4.0
-
removeKmlNodeRefreshStatusChangedListener
public boolean removeKmlNodeRefreshStatusChangedListener(KmlNodeRefreshStatusChangedListener listener)
Removes a node refresh status changed listener.- Parameters:
listener
- the listener to remove- Returns:
- true, if successful
- Since:
- 100.4.0
-
addKmlNodeBalloonVisibilityChangedListener
public void addKmlNodeBalloonVisibilityChangedListener(KmlNodeBalloonVisibilityChangedListener listener)
Adds a listener to listen to the balloon visibility changes on a KML node.- Parameters:
listener
- the listener- Throws:
IllegalArgumentException
- if listener is null- Since:
- 100.5.0
-
removeKmlNodeBalloonVisibilityChangedListener
public boolean removeKmlNodeBalloonVisibilityChangedListener(KmlNodeBalloonVisibilityChangedListener listener)
Removes a node balloon visibility changed listener.- Parameters:
listener
- the listener to remove- Returns:
- true if the listener is removed successful, false otherwise
- Since:
- 100.5.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()
Description copied from interface:Loadable
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()
.
-
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
-
getCredential
public Credential getCredential()
Description copied from interface:RemoteResource
Gets theCredential
that is set on the network-enabled resource.Only applicable if the resource is secured.
- Specified by:
getCredential
in interfaceRemoteResource
- Returns:
- the Credential, or null if there is none
-
setCredential
public void setCredential(Credential credential)
Description copied from interface:RemoteResource
Sets aCredential
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 interfaceRemoteResource
- Parameters:
credential
- the Credential to be used for authentication
-
getRequestConfiguration
public RequestConfiguration getRequestConfiguration()
Description copied from interface:RemoteResource
Gets theRequestConfiguration
used to modify the parameters of network requests made by thisRemoteResource
.- Specified by:
getRequestConfiguration
in interfaceRemoteResource
- Returns:
- the
RequestConfiguration
used to modify network requests
-
setRequestConfiguration
public void setRequestConfiguration(RequestConfiguration requestConfiguration)
Description copied from interface:RemoteResource
Sets theRequestConfiguration
used to modify the parameters of network requests made by thisRemoteResource
. If not set, the globalRequestConfiguration
will be used (seeRequestConfiguration.getGlobalRequestConfiguration()
).- Specified by:
setRequestConfiguration
in interfaceRemoteResource
- Parameters:
requestConfiguration
- the RequestConfiguration used to modify network requests
-
getUri
public String getUri()
Description copied from interface:RemoteResource
Gets the URI of thisRemoteResource
. Typically this is the URI used to instantiate the object.- Specified by:
getUri
in interfaceRemoteResource
- Returns:
- the URI of this RemoteResource
-
-