Package hec.externalplugin

Interface ExternalDataPlugin

All Known Implementing Classes:
SelfRegisteringExternalDataPlugin
public interface ExternalDataPlugin
An ExternalDataPlugin provides a mechanism to select data from a source, and a location within that source. This is intended to be highly flexible, but the basic example is a source as a file, and a location as a location within that file.

  • Method Details

    • getName

      String getName()
      Returns a unique name of the plugin, for use when registering with ExternalDataPlugin
      Returns:

    • getDescription

      String getDescription()
      Returns a description to explain the purpose of this plugin
      Returns:

    • getSupportedSourceType

      String getSupportedSourceType()
      returns the type of source for the data. This is typically the file type the plugin can read.
      Returns:

    • getSupportedDataTypes

      List<ExternalDataType> getSupportedDataTypes()
      Returns the ExternalDataTypes that this plugin supports
      Returns:

    • selectSourceAndDataLocation

      ExternalDataLocation selectSourceAndDataLocation(ExternalDataType definition, ExternalDataLocation location)
      Returns an ExternalDataLocation for and ExternalDataDefinition

      ExternalDataLocation may be passed in if editing an existing location, but should be prepared to receive a null location

      This is expected to launch a UI component to selected the location

      Parameters:
      definition - - the type of the external data
      location - - the location (potentially null) of the existing data
      Returns:
      ExternalDataLocation