org.geotools.data.mongodb

Class MongoDataStoreFactory

Object

AbstractDataStoreFactory

MongoDataStoreFactory

All Implemented Interfaces:

DataAccessFactory, DataStoreFactorySpi, Factory

public class MongoDataStoreFactory
extends AbstractDataStoreFactory

Nested Class Summary

Nested classes/interfaces inherited from interface DataAccessFactory

DataAccessFactory.Param

Field Summary

Fields

Modifier and Type	Field and Description
static DataAccessFactory.Param	DATASTORE_URI
static DataAccessFactory.Param	NAMESPACE
static DataAccessFactory.Param	SCHEMASTORE_URI

Constructor Summary

Constructors

Constructor and Description
MongoDataStoreFactory()

Method Summary

Modifier and Type	Method and Description
MongoDataStore	createDataStore(Map<String,Serializable> params) Construct a live data source using the params specifed.
DataStore	createNewDataStore(Map<String,Serializable> params)
String	getDescription() Describe the nature of the datasource constructed by this factory.
String	getDisplayName() Default Implementation abuses the naming convention.
DataAccessFactory.Param[]	getParametersInfo() MetaData about the required Parameters (for createDataStore).

Methods inherited from class AbstractDataStoreFactory

canProcess, getImplementationHints, getParameters, isAvailable

Methods inherited from class Object

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

Field Detail

NAMESPACE

public static final DataAccessFactory.Param NAMESPACE

DATASTORE_URI

public static final DataAccessFactory.Param DATASTORE_URI

SCHEMASTORE_URI

public static final DataAccessFactory.Param SCHEMASTORE_URI

Constructor Detail

MongoDataStoreFactory

public MongoDataStoreFactory()

Method Detail

getDisplayName

public String getDisplayName()

Description copied from class: AbstractDataStoreFactory

Default Implementation abuses the naming convention.

Will return Foo for org.geotools.data.foo.FooFactory.

Specified by:

getDisplayName in interface DataAccessFactory

Overrides:

getDisplayName in class AbstractDataStoreFactory

Returns:

return display name based on class name

getDescription

public String getDescription()

Description copied from interface: DataAccessFactory

Describe the nature of the datasource constructed by this factory.

A non localized description of this data store type.

Returns:

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

getParametersInfo

public DataAccessFactory.Param[] getParametersInfo()

Description copied from interface: DataAccessFactory

MetaData about the required Parameters (for createDataStore).

Interpretation of FeatureDescriptor values:

• getDisplayName(): Gets the localized display name of this feature.
• getName(): Gets the programmatic name of this feature (used as the key in params)
• getShortDescription(): Gets the short description of this feature.

This should be the same as:

 Object params = factory.getParameters();
 BeanInfo info = getBeanInfo( params );

 return info.getPropertyDescriptors();
 

Returns:

Param array describing the Map for createDataStore

createDataStore

public MongoDataStore createDataStore(Map<String,Serializable> params)
                               throws IOException

Description copied from interface: DataStoreFactorySpi

Construct a live data source using the params specifed.

You can think of this as setting up a connection to the back end data source.

Magic Params: the following params are magic and are honoured by convention by the GeoServer and uDig application.

• "user": is taken to be the user name
• "passwd": is taken to be the password
• "namespace": is taken to be the namespace prefix (and will be kept in sync with GeoServer namespace management.

When we eventually move over to the use of OpperationalParam we will have to find someway to codify this convention.

Parameters:

params - The full set of information needed to construct a live data store. Typical key values for the map include: url - location of a resource, used by file reading datasources. dbtype - the type of the database to connect to, e.g. postgis, mysql

Returns:

The created DataStore, 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 insuficent parameters.

Throws:

IOException - if there were any problems setting up (creating or connecting) the datasource.

createNewDataStore

public DataStore createNewDataStore(Map<String,Serializable> params)
                             throws IOException

Throws:

IOException