- All Implemented Interfaces:
Loadable
ArcadeExpression
under a given ArcadeProfile
.
This Object allows you to set up, execute and query information about an Arcade script. For more general information on
Arcade and its usages we refer you to the Arcade online documentation.
To construct the ArcadeEvaluator object you need to supply an
ArcadeExpression
along with an ArcadeProfile
. ArcadeExpression
is an object that contains the Arcade script plus some additional
metadata while ArcadeProfile
specifies availability of profile
variables and limits what functions are available.
The basic workflow is:
- Construct an ArcadeEvaluator object using
ArcadeExpression
andArcadeProfile
. - Query information about a script.
- Insert the required profile values into a dictionary.
- Call ArcadeEvaluator.evaluateAsync.
- Use the returned
ArcadeEvaluationResult
.
- Which profile variables are accessed by the script.
- Which attributes are used by a particular profile variable.
- If the script is considered stable.
getProfileVariablesUsed()
returns an
array of the names of the profile variables used in the current script. Possible uses include:
- Informing dependency analysis to determine which scripts need to run when a value of a profile variable changes.
- Minimizing expensive calculation of unneeded profile variables.
getAttributesAsync(String, FeatureTable)
lets you dig deeper to determine
which attributes are required on a specific profile variable. If you are
querying a subset of attributes when querying a feature, use this information
to ensure the profile variable will have the attributes it requires.
isStable()
property indicates if the given script will
return the same value for an identical set of profile variables. For
this to be true a script must avoid using unstable builtin
functions such as now() or random().
ArcadeEvaluator.isStable()
can be combined with the knowledge of the used profile variables
to construct caches of results. This lets you avoid running scripts when
repeated calls with the same profiles variables will not alter the evaluation result.- Since:
- 100.14.0
-
Property Summary
TypePropertyDescriptionThe load error.The load status. -
Constructor Summary
ConstructorDescriptionArcadeEvaluator
(ArcadeExpression expression, ArcadeProfile profile) Creates an ArcadeEvaluator object. -
Method Summary
Modifier and TypeMethodDescriptionvoid
addDoneLoadingListener
(Runnable runner) Adds a listener to the loadable resource that is invoked when loading has completed.void
Adds aLoadStatusChangedListener
to the loadable resource that is invoked whenever the load status changes.void
Cancels loading metadata for the object.evaluateAsync
(Map<String, Object> profileVariables) Evaluate the script using the supplied profile variables.getAttributesAsync
(String variableName, FeatureTable attributeNameSource) Return an array of attributes used in the script for a given profile variable.getAttributesAsync
(String variableName, GeoElement attributeNameSource) Return an array of attributes used in the script for a given profile variable.Gets the Arcade expression of the Arcade evaluator.Gets the value of theloadError
property.Gets the value of theloadStatus
property.Gets the Arcade profile under which the script should evaluate.Gets an array of strings containing the names of all profile variables used in the script.boolean
isStable()
Returns whether a script is considered stable.void
Loads the metadata of the loadable resource asynchronously.The load error.The load status.boolean
removeDoneLoadingListener
(Runnable runner) Removes a done loading listener from the loadable resource.boolean
Removes aLoadStatusChangedListener
from the loadable resource.void
Loads or retries loading metadata for the object asynchronously.
-
Property Details
-
loadStatus
- Specified by:
loadStatusProperty
in interfaceLoadable
- See Also:
-
loadError
- Specified by:
loadErrorProperty
in interfaceLoadable
- See Also:
-
-
Constructor Details
-
ArcadeEvaluator
Creates an ArcadeEvaluator object.- Parameters:
expression
- arcade expression you want to evaluateprofile
- theArcadeProfile
context the expression should be evaluated under- Throws:
IllegalArgumentException
- if expression is nullIllegalArgumentException
- if profile is null- Since:
- 100.14.0
-
-
Method Details
-
getExpression
Gets the Arcade expression of the Arcade evaluator.- Returns:
- the Arcade expression of the Arcade evaluator
- Since:
- 100.14.0
-
getProfileVariablesUsed
Gets an array of strings containing the names of all profile variables used in the script.- Returns:
- an array of strings containing the names of all profile variables used in the script
- Since:
- 100.14.0
-
isStable
public boolean isStable()Returns whether a script is considered stable.A script is considered stable if the script will return the same result given the same inputs. There are certain functions listed below that will return different values on each evaluation. Use of these functions means the script is not considered stable. Arcade functions that stop a script being considered stable:
- Now.
- Today.
- TimeStamp.
- Random.
- Guid.
- NextSequence.
- Returns:
- returns whether a script is considered stable
- Since:
- 100.14.0
-
getProfile
Gets the Arcade profile under which the script should evaluate.- Returns:
- the Arcade profile under which the script should evaluate
- Since:
- 100.14.0
-
evaluateAsync
Evaluate the script using the supplied profile variables.Each entry of the profileVariables dictionary is placed into the interpreter as a value accessible throughout the script. The name and type of these should comply with the profile the Arcade evaluator has been constructed with. Values are not persisted across evaluations, meaning all required profile variables must be supplied with each evaluation. Each value of a key/value pair in the dictionary is converted to a type understood by the interpreter. Values in the dictionary can be any of the following types:
-
String
. - Numbers, integer and floating point types of various sizes. Arcade uses doubles for all internal calculations.
- Boolean.
-
Calendar
. -
LocalDate
-
LocalTime
-
OffsetDateTime
-
Geometry
. -
GeoElement
(or anything derived from it such asFeature
,EncFeature
). -
FeatureTable
. -
Map
, String to supported type. -
Geodatabase
. -
GeoModel
(or anything derived from it such asArcGISMap
orArcGISScene
). -
LocationDataSource.Location
.
-
GeoElement
types are converted to Arcade Feature type. -
Location
is converted to an Arcade Feature type. -
FeatureTable
types are converted to Arcade FeatureSet type. -
Geodatabase
is converted to Arcade FeatureSetCollection type. -
ServiceGeodatabase
is converted to Arcade FeatureSetCollection type. -
GeoModel
is converted to Arcade FeatureSetCollection type.
- Parameters:
profileVariables
- the profile variables for the script as key/value pairs- Returns:
- the task object representing the asynchronous evaluation of an Arcade
script. The value of the task result is an
ArcadeEvaluationResult
object. - Throws:
IllegalArgumentException
- if profileVariables is null- Since:
- 100.14.0
-
-
getAttributesAsync
public ListenableFuture<List<String>> getAttributesAsync(String variableName, FeatureTable attributeNameSource) Return an array of attributes used in the script for a given profile variable.To fully support the wildcard expansion in the expects statement, calculation of used attributes on a profile variable requires an object that can supply a full set of attribute names.
- Parameters:
variableName
- the name of the profile variable whose used attributes are requiredattributeNameSource
- aFeatureTable
from which we can obtain a list of all attribute names for the profile variable- Returns:
- the task object representing the asynchronous retrieval of the attributes looked up on a profile variable in the script.
The value of the task result is a
List<String>
. - Throws:
IllegalArgumentException
- if variableName is nullIllegalArgumentException
- if attributeNameSource is null- Since:
- 100.14.0
-
getAttributesAsync
public ListenableFuture<List<String>> getAttributesAsync(String variableName, GeoElement attributeNameSource) Return an array of attributes used in the script for a given profile variable.To fully support the wildcard expansion in the expects statement, calculation of used attributes on a profile variable requires an object that can supply a full set of attribute names.
- Parameters:
variableName
- the name of the profile variable whose used attributes are requiredattributeNameSource
- aGeoElement
from which we can obtain a list of all attribute names for the profile variable- Returns:
- the task object representing the asynchronous retrieval of the attributes looked up on a profile variable in the script.
The value of the task result is a
List<String>
. - Throws:
IllegalArgumentException
- if variableName is nullIllegalArgumentException
- if attributeNameSource is null- Since:
- 100.14.0
-
getLoadError
Gets the value of theloadError
property.- Specified by:
getLoadError
in interfaceLoadable
- Property description:
- Returns:
- the value of the
loadError
property - See Also:
-
getLoadStatus
Gets the value of theloadStatus
property.- Specified by:
getLoadStatus
in interfaceLoadable
- Property description:
- Returns:
- the value of the
loadStatus
property - See Also:
-
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
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 interfaceLoadable
- Parameters:
runner
- a Runnable that is invoked upon completion of the load operation
-
removeDoneLoadingListener
Description copied from interface:Loadable
Removes a done loading listener from the loadable resource.- Specified by:
removeDoneLoadingListener
in interfaceLoadable
- Parameters:
runner
- the listener to be removed- Returns:
- true if the listener was removed, otherwise false
-
addLoadStatusChangedListener
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
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
-
loadStatusProperty
Description copied from interface:Loadable
The load status.- Specified by:
loadStatusProperty
in interfaceLoadable
- Returns:
- the
loadStatus
property - See Also:
-
loadErrorProperty
Description copied from interface:Loadable
The load error.- Specified by:
loadErrorProperty
in interfaceLoadable
- Returns:
- the
loadError
property - See Also:
-