Interface FileLayerLoader

All Known Implementing Classes:
AbstractFileLayerLoader, DataSourceFileLayerLoader, GeoImageFactoryFileLayerLoader, ReferencedImageFactoryFileLayerLoader
public interface FileLayerLoader

The FileLayerLoader defines the interface for plug-ins that can load files into the current Task.

A file loader has a getDescription() used in the GUI and a list of getFileExtensions() that it can be used to load.

The getOptionMetadata() can be used to define a list of Options that a user can/must provide when loading the file. These will be used by the GUI to create fields for entry of these options.

Author:
Paul Austin

  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    static final String
    KEY
    The key in the registry where loaders are registered.

  • Method Summary

    Modifier and Type
    Method
    Description
    String
    getDescription()
    Get the descriptive name of the file format (e.g.
    Collection<String>
    getFileExtensions()
    Get the list of file extensions supported by the plug-in.
    List<Option>
    getOptionMetadata()
    Get the list of Options supported by the plug-in.
    boolean
    open(TaskMonitor monitor, URI uri, Map<String,Object> options)
    Open the file specified by the URI with the map of option values.

  • Field Details

    • KEY

      static final String KEY
      The key in the registry where loaders are registered.

  • Method Details

    • getFileExtensions

      Collection<String> getFileExtensions()
      Get the list of file extensions supported by the plug-in.
      Returns:
      The list of file extensions.

    • getDescription

      String getDescription()
      Get the descriptive name of the file format (e.g. ESRI Shapefile).
      Returns:
      The file format name.

    • open

      boolean open(TaskMonitor monitor, URI uri, Map<String,Object> options) throws Exception
      Open the file specified by the URI with the map of option values.
      Parameters:
      monitor - The TaskMonitor.
      uri - The URI to the file to load.
      options - The map of options.
      Returns:
      True if the file could be loaded false otherwise.
      Throws:
      Exception - if an Exception occurred

    • getOptionMetadata

      List<Option> getOptionMetadata()
      Get the list of Options supported by the plug-in.
      Returns:
      The list of Options.