org.openjump.core.ui.io.file

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.

Field Summary

Fields

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

Method Summary

Methods

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

Field Detail

KEY

static final java.lang.String KEY

The key in the registry where loaders are registered.

Method Detail

getFileExtensions

java.util.Collection<java.lang.String> getFileExtensions()

Get the list of file extensions supported by the plug-in.

Returns:

The list of file extensions.

getDescription

java.lang.String getDescription()

Get the descriptive name of the file format (e.g. ESRI Shapefile).

Returns:

The file format name.

open

boolean open(TaskMonitor monitor,
           java.net.URI uri,
           java.util.Map<java.lang.String,java.lang.Object> options)
             throws java.lang.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:

java.lang.Exception

getOptionMetadata

java.util.List<Option> getOptionMetadata()

Get the list of Options supported by the plug-in.

Returns:

The list of Options.