Class SymbolStyle

  • All Implemented Interfaces:
    Loadable
    Direct Known Subclasses:
    DictionarySymbolStyle

    public class SymbolStyle
    extends Object
    implements Loadable
    Defines a mechanism to obtain unique multi-layer CIM symbols from a given specification, such as mil2525d.

    A SymbolStyle is made up of a *.stylx file (a sqlite database from ArcGIS Pro), which contains the symbol primitives for a given symbology specification (such as mil2525d), as well as a rule engine that parses input fields. The SymbolStyle assembles new symbols from the input attributes, and can also apply geometry manipulations to the symbols in the case of multipoint geometries.

    A SymbolStyle can be used in conjunction with a DictionaryRenderer applied to a FeatureLayer or GraphicsOverlay.

    When used by itself, the SymbolStyle supports two key workflows. The first is to find a symbol with provided key values. This is done by creating a list of key fields, and passing those into getSymbolAsync(List), which returns a new Symbol. In this case, the key is the value associated to the symbol in the *.stylx file. You might use this symbol to create a new Graphic.

    You can also use a standalone SymbolStyle to search for symbol primitives. Symbol primitives are the individual symbols that make up more complex symbols. This is achieved using searchSymbolsAsync(SymbolStyleSearchParameters). You could create a symbol picker app that searches for all symbols that have the tag "maritime" in it. The search results contain symbols which you could then either use as they are or extract from them different individual symbols to create a new composite symbol.

    Since:
    100.0.0 for JavaSE and 100.2.0 for Android
    • Constructor Detail

      • SymbolStyle

        public SymbolStyle​(String stylePath)
        Creates a new symbol style instance from a *.stylx file located at the given path. This constructor is intended for use with mobile style files. To use a dictionary style file (e.g. for military symbols) use DictionarySymbolStyle instead.
        Parameters:
        stylePath - the full path to a *.stylx file
        Since:
        100.5.0
    • Method Detail

      • getSymbolAsync

        public ListenableFuture<Symbol> getSymbolAsync​(List<String> keys)
        Finds a Symbol, as defined by the input keys.

        Obtains a single, multilayer symbol using a list of one or more keys and provides a convenient way to create symbols and graphics on-the-fly. Each symbol in a mobile style file (.stylx) has a unique key. If you need one symbol from the file, you can provide a list with just the single key. If you want to combine several symbols from the file into one multilayer symbol, however, you can provide a list with all keys for symbols to be combined.

        For example, assume an XYZ.stylx file has a symbol with key "abc" which is the central symbol and another symbol with key "pqr", which could be the modifier/echelon placed at some offset from the central geometry. If you provide these two keys as attributes, then the symbol style will find and assemble a symbol accordingly. Once you have that symbol, you can apply it to a Graphic or Renderer, obtain its swatch image, or serialize it to JSON.

        If the mobile style is not loaded, making this call will start the load cycle.

        Parameters:
        keys - symbol keys
        Returns:
        a Future that represents a symbol based on keys
        Throws:
        IllegalArgumentException - if keys is null
        Since:
        100.0.0 for JavaSE and 100.2.0 for Android
      • searchSymbolsAsync

        public ListenableFuture<List<SymbolStyleSearchResult>> searchSymbolsAsync​(SymbolStyleSearchParameters styleSymbolSearchParameters)
        Searches for symbol primitives using searchParameters.

        This asynchronous task searches for symbol primitives in the symbol dictionary. The input searchParameters define what is searched for. For example, you could search for all symbols that have the tag "airspace". You can also set the match to be strict or not, which will determine if the search uses "=" or "LIKE" for each parameter.

        Parameters:
        styleSymbolSearchParameters - search parameters for the symbol style
        Returns:
        a Future that represents a list of SymbolStyleSearchResult based on search parameters
        Throws:
        IllegalArgumentException - if styleSymbolSearchParameters is null
        Since:
        100.0.0 for JavaSE and 100.2.0 for Android
      • getDefaultSearchParametersAsync

        public ListenableFuture<SymbolStyleSearchParameters> getDefaultSearchParametersAsync()
        Gets the default symbol style search parameters async.

        Retrieves all of the valid SymbolStyleSearchParameters for the SymbolStyle. This asynchronous task retrieves all the valid input search parameters in the symbol dictionary. This means you get all of the possible input values for categories, keys, names, symbol classes, and tags. This is an expensive task that should be used sparingly.

        Returns:
        a listenable future containing the resulting search parameters
        Since:
        100.0.0 for JavaSE and 100.2.0 for Android
      • 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 loadAsync or retryLoadAsync.

        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.
      • 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
        Tries to reload the metadata of the loadable resource asynchronously, but only if the resource failed to load previously (LoadStatus.FAILED_TO_LOAD state) or wasn't loaded to begin with ( LoadStatus.NOT_LOADED state).

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

        Specified by:
        retryLoadAsync in interface Loadable
      • cancelLoad

        public void cancelLoad()
        Description copied from interface: Loadable
        Cancels a pending load operation.

        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
      • 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 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