Package com.here.sdk.core.engine

Class CatalogConfiguration

java.lang.Object
com.here.sdk.core.engine.CatalogConfiguration
public final class CatalogConfiguration extends Object

Using this class you can configure in the SDKOptions, how the SDKNativeEngine should access, use and store the data for the desired catalog.

Using this class, you can access default catalogs on the HERE platform and also custom catalogs such as for self-hosted or BYOD (bring your own data) use cases.

For information on how the user can identify a catalog on the HERE platform, see DesiredCatalog For further information about catalogs and related concepts see CatalogIdentifier.

Note: This API is only applicable for the Navigate license.

  • Field Details

    • catalog

      @NonNull public DesiredCatalog catalog

      The identifier for the desired catalog to be accessed on the HERE platform. See DesiredCatalog.

    • patchHrn

      @Nullable public String patchHrn

      Some catalogs may have additional modifications to their data contained in an entirely separate catalog, called the patch catalog. This field indicates the HERE Resource Name (HRN) for the patch catalog. When this field is present, the catalog's data as referenced by catalog is merged with data from the patch catalog. If this field is null, then incremental updates are disabled.

    • cacheExpirationPeriod

      @Nullable public Duration cacheExpirationPeriod

      Expiration time in seconds for how long the catalog data is retained in the map cache before it is removed. Cache path is specified by SDKOptions.cachePath. If not set, the cache will be deleted on a Least Recently Used (LRU) basis.

    • allowDownload

      public boolean allowDownload

      A flag to indicate if the data for this catalog is allowed to be stored in persistent storage for use with offline maps. The storage path is specified in SDKOptions.persistentMapStoragePath. If set to false, the data is not stored in persistent storage and is only retained in the cache for a limited time (see cacheExpirationPeriod). Defaults to true.

  • Constructor Details

    • CatalogConfiguration

      public CatalogConfiguration(@NonNull DesiredCatalog catalog)

      Creates a new instance.

      Parameters:
      catalog -

      The identifier for the desired catalog to be accessed on the HERE platform. See DesiredCatalog.

  • Method Details

    • equals

      public boolean equals(Object obj)
      Overrides:
      equals in class Object

    • hashCode

      public int hashCode()
      Overrides:
      hashCode in class Object

    • getDefault

      @NonNull public static CatalogConfiguration getDefault(@NonNull CatalogType catalogType)

      Gets the default catalog configuration for the specified catalog type. It uses the catalog version that was the latest at the time when the HERE SDK was built.

      Parameters:
      catalogType -

      Catalog type

      Returns:

      Instance of CatalogConfiguration.