org.openjump.core.ui.io.file

Class DataSourceFileLayerLoader

java.lang.Object

org.openjump.core.ui.io.file.AbstractFileLayerLoader

org.openjump.core.ui.io.file.DataSourceFileLayerLoader

All Implemented Interfaces:

Recordable, FileLayerLoader

public class DataSourceFileLayerLoader
extends AbstractFileLayerLoader
implements Recordable

The DataSourceFileLayerLoader is an implementation of FileLayerLoader that wraps an existing file based DataSource class.

Field Summary

Fields inherited from class org.openjump.core.ui.io.file.AbstractFileLayerLoader

PRIO_COMPARATOR

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

KEY

Constructor Summary

Constructors

Constructor and Description
DataSourceFileLayerLoader() No parameter constuctor for xml persitence.
DataSourceFileLayerLoader(WorkbenchContext workbenchContext, java.lang.Class dataSourceClass, java.lang.String description, java.util.List<java.lang.String> extensions) Construct a new DataSourceFileLayerLoader.

Method Summary

Methods

Modifier and Type	Method and Description
void	addParameter(java.lang.String name, java.lang.Object value)
java.lang.Boolean	getBooleanParam(java.lang.String name)
java.lang.Double	getDoubleParam(java.lang.String name)
java.lang.Integer	getIntegerParam(java.lang.String name)
java.lang.Object	getParameter(java.lang.String name)
java.util.Map<java.lang.String,java.lang.Object>	getParameters()
java.lang.String	getStringParam(java.lang.String name)
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.
java.lang.Object	process(TaskMonitor monitor)
void	setContext(WorkbenchContext context)
void	setParameters(java.util.Map<java.lang.String,java.lang.Object> map) Set parameters with which to execute a plugin.
protected java.util.Map<java.lang.String,java.lang.Object>	toProperties(java.net.URI uri, java.util.Map<java.lang.String,java.lang.Object> options) Convert the URI and map of options for the data source.

Methods inherited from class org.openjump.core.ui.io.file.AbstractFileLayerLoader

addFileExtensions, addOption, addOption, getDescription, getFileExtensions, getOptionMetadata, removeOption, removeOption, toString

Methods inherited from class java.lang.Object

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

Constructor Detail

DataSourceFileLayerLoader

public DataSourceFileLayerLoader()

No parameter constuctor for xml persitence.

DataSourceFileLayerLoader

public DataSourceFileLayerLoader(WorkbenchContext workbenchContext,
                         java.lang.Class dataSourceClass,
                         java.lang.String description,
                         java.util.List<java.lang.String> extensions)

Construct a new DataSourceFileLayerLoader.

Parameters:

workbenchContext - The workbench context.

dataSourceClass - The DataSource class.

description - The file format name.

extensions - The list of supported extensions.

Method Detail

addParameter

public void addParameter(java.lang.String name,
                java.lang.Object value)

getParameter

public java.lang.Object getParameter(java.lang.String name)

getBooleanParam

public java.lang.Boolean getBooleanParam(java.lang.String name)

getIntegerParam

public java.lang.Integer getIntegerParam(java.lang.String name)

getDoubleParam

public java.lang.Double getDoubleParam(java.lang.String name)

getStringParam

public java.lang.String getStringParam(java.lang.String name)

setParameters

public void setParameters(java.util.Map<java.lang.String,java.lang.Object> map)

Description copied from interface: Recordable

Set parameters with which to execute a plugin.

Specified by:

setParameters in interface Recordable

Parameters:

map - a map of parameters

getParameters

public java.util.Map<java.lang.String,java.lang.Object> getParameters()

setContext

public void setContext(WorkbenchContext context)

process

public java.lang.Object process(TaskMonitor monitor)
                         throws java.lang.ClassNotFoundException,
                                java.net.URISyntaxException

Throws:

java.lang.ClassNotFoundException

java.net.URISyntaxException

open

public 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.

Specified by:

open in interface FileLayerLoader

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.

toProperties

protected java.util.Map<java.lang.String,java.lang.Object> toProperties(java.net.URI uri,
                                                            java.util.Map<java.lang.String,java.lang.Object> options)

Convert the URI and map of options for the data source. If the URI is a ZIP uri the File option will be set to the ZIP file name and the CompressedFile set to the entry in the ZIP file.

Parameters:

uri - The URI to the file.

options - The selected options.

Returns:

The options.