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 Details

    • VERSION

      public static final String VERSION

    • errorMessage

      protected String errorMessage

    • driver

      protected DataStoreDriver driver

    • dsDriverClasses

      protected Class[] dsDriverClasses

    • classNameToJarName

      protected Map<String,String> classNameToJarName

  • Constructor Details

    • 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 Details

    • 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