org.geotools.data.geomedia
Class GeoMediaDataStoreFactory

java.lang.Object
  org.geotools.data.geomedia.GeoMediaDataStoreFactory

All Implemented Interfaces:

DataStoreFactorySpi, Factory

public class GeoMediaDataStoreFactory

extends java.lang.Object

implements DataStoreFactorySpi

Creates a GeoMediaDataStoreFactoru based on the correct params.

This factory should be registered in the META-INF/ folder, under services/ in the DataStoreFactorySpi file.

Author:

Jody Garnett, Refractions Research, Sean Geoghegan, Defence Science and Technology Organisation

Nested Class Summary

Nested classes inherited from class org.geotools.data.DataStoreFactorySpi

DataStoreFactorySpi.Param

Constructor Summary

GeoMediaDataStoreFactory()
Creates a new instance of GeoMediaDataStoreFactory

Method Summary

boolean	canProcess(java.util.Map params) Determines whether DataStore created by this factory can process the parameters.
DataStore	createDataStore(java.util.Map params) Construct a postgis data store using the params.
DataStore	createNewDataStore(java.util.Map params) Oracle cannot create a new database.
GeoMediaConnectionParam[]	getConnectionParams() DOCUMENT ME!
java.lang.String	getDescription() Describe the nature of the datastore constructed by this factory.
java.lang.String	getDisplayName() Name suitable for display to end user.
java.util.Map	getImplementationHints() Returns the implementation hints.
DataStoreFactorySpi.Param[]	getParametersInfo() Describe parameters.
boolean	isAvailable() Test to see if this datastore is available, if it has all the appropriate libraries to construct a datastore.
void	setConnectionParams(GeoMediaConnectionParam[] params) DOCUMENT ME!

Methods inherited from class java.lang.Object

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

Constructor Detail

GeoMediaDataStoreFactory

public GeoMediaDataStoreFactory()

Creates a new instance of GeoMediaDataStoreFactory

Method Detail

setConnectionParams

public void setConnectionParams(GeoMediaConnectionParam[] params)

DOCUMENT ME!

Parameters:

params - DOCUMENT ME!

getConnectionParams

public GeoMediaConnectionParam[] getConnectionParams()

DOCUMENT ME!

Returns:

DOCUMENT ME!

canProcess

public boolean canProcess(java.util.Map params)

Determines whether DataStore created by this factory can process the parameters.

Required Parameters are:

• dbtype - must equal "oracle"
• host
• port
• user
• passwd
• instance

There are no defaults since each parameter must be explicitly defined by the user, or another DataSourceFactorySpi should be used. This behaviour is defined in the DataStoreFactorySpi contract.

Specified by:

canProcess in interface DataStoreFactorySpi

Parameters:

params - The parameter to check.

Returns:

True if all the required parameters are supplied.

createDataStore

public DataStore createDataStore(java.util.Map params)
                          throws java.io.IOException

Construct a postgis data store using the params.

Specified by:

createDataStore in interface DataStoreFactorySpi

Parameters:

params - The full set of information needed to construct a live data source. Should have dbtype equal to geomedia, as well as host, user, passwd, database, dbkey.

Returns:

The created DataSource, this may be null if the required resource was not found or if insufficent parameters were given. Note that canProcess() should have returned false if the problem is to do with insufficent parameters.

Throws:

java.io.IOException - DOCUMENT ME!

DataSourceException - Thrown if there were any problems creating or connecting the datasource.

createNewDataStore

public DataStore createNewDataStore(java.util.Map params)
                             throws java.io.IOException

Oracle cannot create a new database.

Specified by:

createNewDataStore in interface DataStoreFactorySpi

Parameters:

params -

Returns:

Throws:

java.io.IOException - DOCUMENT ME!

java.lang.UnsupportedOperationException - Cannot create new database

getDisplayName

public java.lang.String getDisplayName()

Description copied from interface: DataStoreFactorySpi

Name suitable for display to end user.

A non localized display name for this data store type.

Specified by:

getDisplayName in interface DataStoreFactorySpi

Returns:

A short name suitable for display in a user interface.

getDescription

public java.lang.String getDescription()

Describe the nature of the datastore constructed by this factory.

Specified by:

getDescription in interface DataStoreFactorySpi

Returns:

A human readable description that is suitable for inclusion in a list of available datasources.

isAvailable

public boolean isAvailable()

Test to see if this datastore is available, if it has all the appropriate libraries to construct a datastore. This datastore just returns true for now. This method is used for gui apps, so as to not advertise data store capabilities they don't actually have.

Specified by:

isAvailable in interface DataStoreFactorySpi

Returns:

true if and only if this factory is available to create DataStores.

Task:

REVISIT: I'm just adding this method to compile, maintainer should revisit to check for any libraries that may be necessary for datastore creations. ch.

getParametersInfo

public DataStoreFactorySpi.Param[] getParametersInfo()

Describe parameters.

Specified by:

getParametersInfo in interface DataStoreFactorySpi

Returns:

See Also:

org.geolbs.data.DataStoreFactorySpi#getParametersInfo()

getImplementationHints

public java.util.Map getImplementationHints()

Returns the implementation hints. The default implementation returns en empty map.

Specified by:

getImplementationHints in interface Factory

Returns:

The map of hints, or an empty map if none.