Package nz.org.riskscape.engine.data

Interface BookmarkResolver

All Superinterfaces:
Identified
public interface BookmarkResolver extends Identified

A BookmarkResolver can access the data that is being pointed to by a Bookmark. It works with the ResolvedBookmark interface to return data and error messages to the user.

  • Method Details

    • resolve

      Optional<ResolvedBookmark> resolve(Bookmark bookmark, BindingContext context) throws IOException
      Parameters:
      bookmark - to resolve
      context - to bind any bookmark parameters with
      Returns:
      a ResolvedBookmark capable of returning the data being referred to, or empty if this resolver can not open the given bookmark.
      Throws:
      IOException

    • getFormats

      Set<String> getFormats()
      Returns:
      a set of formats that allows a user to find out what sort of resources this resolver can turn in to Coverages or Relations

    • getExtensions

      List<String> getExtensions(String format)
      Returns:
      a list of file extensions that are supported by the given format.

    • getParameterSet

      ParameterSet getParameterSet()
      Returns:
      a list of Parameters that are accepted by this BookmarkResolver which configure the resulting data that comes from the ResolvedBookmark that this resolver produces. Each Parameters name maps to an unparsed option contained by the Bookmark.getUnparsed() map.

    • supportedParameters

      @Deprecated default List<Parameter> supportedParameters()
      Deprecated.

    • getName

      default String getName()
      Returns:
      an informative name for the resolver for users to identify it in debugging messages.

    • getId

      default String getId()
      Specified by:
      getId in interface Identified
      Returns:
      id