Package com.vividsolutions.jump.datastore.spatialdatabases

Class AbstractSpatialDatabasesDSExtension

java.lang.Object

com.vividsolutions.jump.workbench.plugin.Extension

com.vividsolutions.jump.datastore.spatialdatabases.AbstractSpatialDatabasesDSExtension

All Implemented Interfaces:

Configuration

Direct Known Subclasses:

H2DataStoreExtension, MariadbDataStoreExtension, MysqlDataStoreExtension, OracleDataStoreExtension, PostgisDSExtension, SpatialiteDataStoreExtension

public abstract class AbstractSpatialDatabasesDSExtension
extends Extension

basic implementation for db datastore extensions

Field Summary

Fields

Modifier and Type	Field	Description
protected Map<String,String>	classNameToJarName
protected DataStoreDriver	driver
protected Class[]	dsDriverClasses
protected String	errorMessage

Constructor Summary

Constructors

Constructor	Description
AbstractSpatialDatabasesDSExtension(Class[] dsDriverClasses, Map<String,String> classesToJar)	instantiate a new extension capable of registering a database datastore driver
AbstractSpatialDatabasesDSExtension(Class dsDriverClass, Map<String,String> classesToJar)	convenience method for AbstractSpatialDatabasesDSExtension(Class[], Map)

Method Summary

Modifier and Type	Method	Description
void	configure(PlugInContext context)	installs the database datastore driver defined as first parameter in AbstractSpatialDatabasesDSExtension(Class, Map) if isAvailable() returns an empty String
String	getMessage()	by default show error messages or loaded JDBC driver versions
abstract String	getName()	implement to assign a readable name to the datastore driver extension
String	getVersion()	the default version is 'svn revision (build date)'
protected String	isAvailable()	override to check dependencies on your own

Methods inherited from class java.lang.Object

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

Field Detail

errorMessage

protected String errorMessage

driver

protected DataStoreDriver driver

dsDriverClasses

protected Class[] dsDriverClasses

classNameToJarName

protected Map<String,String> classNameToJarName

Constructor Detail

AbstractSpatialDatabasesDSExtension

public AbstractSpatialDatabasesDSExtension(Class[] dsDriverClasses,
                                           Map<String,String> classesToJar)

instantiate a new extension capable of registering a database datastore driver

Parameters:

dsDriverClasses - - the class implementing DataStoreDriver

classesToJar - - a map with class name entries mapping to jar file names eg. "oracle.jdbc.driver.OracleDriver"->"ojdb6.jar"

AbstractSpatialDatabasesDSExtension

public AbstractSpatialDatabasesDSExtension(Class dsDriverClass,
                                           Map<String,String> classesToJar)

convenience method for AbstractSpatialDatabasesDSExtension(Class[], Map)

Parameters:

dsDriverClass - the Dadabase Driver Class

classesToJar - a map containing driver class names as keys and the jar containing the class as values

Method Detail

getName

public abstract String getName()

implement to assign a readable name to the datastore driver extension

Overrides:

getName in class Extension

Returns:

the name of this SpatialDatabase

getVersion

public String getVersion()

the default version is 'svn revision (build date)'

Overrides:

getVersion in class Extension

isAvailable

protected String isAvailable()

override to check dependencies on your own

Returns:

"" on success, "errormessage" on failure

getMessage

public String getMessage()

by default show error messages or loaded JDBC driver versions

Overrides:

getMessage in class Extension

configure

public void configure(PlugInContext context)
               throws Exception

installs the database datastore driver defined as first parameter in AbstractSpatialDatabasesDSExtension(Class, Map) if isAvailable() returns an empty String

Throws:

Exception