Package org.openjump.core.ui.io.file

Class AbstractFileLayerSaver

java.lang.Object

org.openjump.core.ui.io.file.AbstractFileLayerSaver

All Implemented Interfaces:

FileLayerSaver

Direct Known Subclasses:

DataSourceFileLayerSaver

public abstract class AbstractFileLayerSaver
extends Object
implements FileLayerSaver

Field Summary

Fields inherited from interface org.openjump.core.ui.io.file.FileLayerSaver

KEY

Constructor Summary

Constructors

Constructor	Description
AbstractFileLayerSaver(String description, List<String> extensions)

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.
abstract boolean	write(TaskMonitor monitor, URI uri, Map<String,Object> options)	Write the file specified by the URI with the map of option values.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

AbstractFileLayerSaver

public AbstractFileLayerSaver(String description,
                              List<String> extensions)

Method Detail

getFileExtensions

public Collection<String> getFileExtensions()

Description copied from interface: FileLayerSaver

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

Specified by:

getFileExtensions in interface FileLayerSaver

Returns:

The list of file extensions.

getDescription

public String getDescription()

Description copied from interface: FileLayerSaver

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

Specified by:

getDescription in interface FileLayerSaver

Returns:

The file format name.

write

public abstract boolean write(TaskMonitor monitor,
                              URI uri,
                              Map<String,Object> options)
                       throws Exception

Description copied from interface: FileLayerSaver

Write the file specified by the URI with the map of option values.

Specified by:

write in interface FileLayerSaver

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

public List<Option> getOptionMetadata()

Description copied from interface: FileLayerSaver

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

Specified by:

getOptionMetadata in interface FileLayerSaver

Returns:

The list of Options.