de.cismet.cismap.commons.gui.shapeexport

Class ShapeExport

java.lang.Object

de.cismet.cismap.commons.gui.shapeexport.ShapeExport

All Implemented Interfaces:

ToolbarComponentsProvider, de.cismet.tools.configuration.Configurable, de.cismet.tools.gui.menu.CidsUiComponent

public class ShapeExport
extends Object
implements de.cismet.tools.configuration.Configurable, ToolbarComponentsProvider, de.cismet.tools.gui.menu.CidsUiComponent

This class configures the shape export functionality in cismap. Therefore it reads the corresponding part of defaultCismapProperties.xml and provides the buttons for cismap's toolbar.

Version:

$Revision$, $Date$

Author:

jweintraut

Nested Class Summary

Nested classes/interfaces inherited from interface de.cismet.cismap.commons.gui.ToolbarComponentsProvider

ToolbarComponentsProvider.ToolbarPositionHint

Field Summary

Fields inherited from interface de.cismet.tools.gui.menu.CidsUiComponent

CIDS_ACTION_KEY

Constructor Summary

Constructors

Constructor and Description
ShapeExport()

Method Summary

Modifier and Type	Method and Description
void	configure(org.jdom.Element parent)
static String	getBboxToken() Returns the string which serves as a replacement token to put a bounding box in the configured WFS queries.
Component	getComponent()
org.jdom.Element	getConfiguration()
static String	getDestinationDirectory() Shape exports shall be saved in a directory somewhere in user's home directory.
static String	getDestinationFile() Returns a String object which denotes the file name which is to be used for shape exports.
static String	getDestinationFileExtension() Returns the configured extension for shape exports.
String	getPluginName() DOCUMENT ME!
Collection<ToolbarComponentDescription>	getToolbarComponents() DOCUMENT ME!
String	getValue(String key)
static Set<ExportWFS>	getWFSList() Returns a Set of all configured export topics.
void	masterConfigure(org.jdom.Element parent)

Methods inherited from class java.lang.Object

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

Methods inherited from interface de.cismet.tools.configuration.Configurable

configure, masterConfigure

Constructor Detail

ShapeExport

public ShapeExport()

Method Detail

getWFSList

public static Set<ExportWFS> getWFSList()

Returns a Set of all configured export topics. The Set is ordered by the appearance of the topics in the config file. The Set contains a copy of the wfs list. Any change to a wfs won't affect the list this ShapeExport object manages.

Returns:

A Set of available topics.

getBboxToken

public static String getBboxToken()

Returns the string which serves as a replacement token to put a bounding box in the configured WFS queries. This token is later replaced by a XBoundingBox's GML string.

Returns:

The replacement token for a bounding box in a WFS query.

getDestinationDirectory

public static String getDestinationDirectory()

Shape exports shall be saved in a directory somewhere in user's home directory. This method will return a file object pointing to that directory. This directory is already tested for existence and, if necessary, created.

Returns:

A file object pointing to the directory where to place exports.

getDestinationFile

public static String getDestinationFile()

Returns a String object which denotes the file name which is to be used for shape exports.

Returns:

The file name for shape exports.

getDestinationFileExtension

public static String getDestinationFileExtension()

Returns the configured extension for shape exports. Usually it is set to ".zip".

Returns:

The file extension for shape exports.

configure

public void configure(org.jdom.Element parent)

Specified by:

configure in interface de.cismet.tools.configuration.Configurable

masterConfigure

public void masterConfigure(org.jdom.Element parent)

Specified by:

masterConfigure in interface de.cismet.tools.configuration.Configurable

getConfiguration

public org.jdom.Element getConfiguration()
                                  throws de.cismet.tools.configuration.NoWriteError

Specified by:

getConfiguration in interface de.cismet.tools.configuration.Configurable

Throws:

de.cismet.tools.configuration.NoWriteError

getPluginName

public String getPluginName()

Description copied from interface: ToolbarComponentsProvider

DOCUMENT ME!

Specified by:

getPluginName in interface ToolbarComponentsProvider

Returns:

DOCUMENT ME!

getToolbarComponents

public Collection<ToolbarComponentDescription> getToolbarComponents()

Description copied from interface: ToolbarComponentsProvider

DOCUMENT ME!

Specified by:

getToolbarComponents in interface ToolbarComponentsProvider

Returns:

DOCUMENT ME!

getValue

public String getValue(String key)

Specified by:

getValue in interface de.cismet.tools.gui.menu.CidsUiComponent

getComponent

public Component getComponent()

Specified by:

getComponent in interface de.cismet.tools.gui.menu.CidsUiComponent