Class STACDataStoreFactory
- Object
-
- STACDataStoreFactory
-
- All Implemented Interfaces:
DataAccessFactory
,DataStoreFactorySpi
,Factory
public class STACDataStoreFactory extends Object implements DataStoreFactorySpi
-
-
Nested Class Summary
-
Nested classes/interfaces inherited from interface DataAccessFactory
DataAccessFactory.Param
-
-
Field Summary
Fields Modifier and Type Field Description static DataAccessFactory.Param
CONNECTION_TIMEOUT
static DataAccessFactory.Param
DBTYPE
static DataAccessFactory.Param
FEATURE_TYPE_ITEMS
static DataAccessFactory.Param
FETCH_SIZE
static DataAccessFactory.Param
HARD_LIMIT
static DataAccessFactory.Param
LANDING_PAGE
static DataAccessFactory.Param
MAX_CONNECTIONS
static DataAccessFactory.Param
NAMESPACE
static DataAccessFactory.Param
PASSWORD
static DataAccessFactory.Param
READ_TIMEOUT
static DataAccessFactory.Param
SEARCH_MODE
static DataAccessFactory.Param
TRY_GZIP
static DataAccessFactory.Param
USE_CONNECTION_POOLING
static DataAccessFactory.Param
USERNAME
-
Constructor Summary
Constructors Constructor Description STACDataStoreFactory()
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description DataStore
createDataStore(Map<String,?> params)
Construct a live data source using the params specifed.DataStore
createNewDataStore(Map<String,?> params)
String
getDescription()
Describe the nature of the datasource constructed by this factory.String
getDisplayName()
Name suitable for display to end user.DataAccessFactory.Param[]
getParametersInfo()
MetaData about the required Parameters (for createDataStore).boolean
isAvailable()
Test to see if the implementation is available for use.-
Methods inherited from class Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
-
Methods inherited from interface DataAccessFactory
canProcess
-
Methods inherited from interface Factory
getImplementationHints
-
-
-
-
Field Detail
-
DBTYPE
public static final DataAccessFactory.Param DBTYPE
-
LANDING_PAGE
public static final DataAccessFactory.Param LANDING_PAGE
-
NAMESPACE
public static final DataAccessFactory.Param NAMESPACE
-
SEARCH_MODE
public static final DataAccessFactory.Param SEARCH_MODE
-
FETCH_SIZE
public static final DataAccessFactory.Param FETCH_SIZE
-
FEATURE_TYPE_ITEMS
public static final DataAccessFactory.Param FEATURE_TYPE_ITEMS
-
HARD_LIMIT
public static final DataAccessFactory.Param HARD_LIMIT
-
USE_CONNECTION_POOLING
public static final DataAccessFactory.Param USE_CONNECTION_POOLING
-
MAX_CONNECTIONS
public static final DataAccessFactory.Param MAX_CONNECTIONS
-
TRY_GZIP
public static final DataAccessFactory.Param TRY_GZIP
-
USERNAME
public static final DataAccessFactory.Param USERNAME
-
PASSWORD
public static final DataAccessFactory.Param PASSWORD
-
CONNECTION_TIMEOUT
public static final DataAccessFactory.Param CONNECTION_TIMEOUT
-
READ_TIMEOUT
public static final DataAccessFactory.Param READ_TIMEOUT
-
-
Method Detail
-
getDisplayName
public String getDisplayName()
Description copied from interface:DataAccessFactory
Name suitable for display to end user.A non localized display name for this data store type.
- Specified by:
getDisplayName
in interfaceDataAccessFactory
- Returns:
- A short name suitable for display in a user interface.
-
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.
- Specified by:
getDescription
in interfaceDataAccessFactory
- 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();
- Specified by:
getParametersInfo
in interfaceDataAccessFactory
- Returns:
- Param array describing the Map for createDataStore
-
isAvailable
public boolean isAvailable()
Description copied from interface:DataAccessFactory
Test to see if the implementation is available for use. This method ensures all the appropriate libraries to construct the DataAccess are available.Most factories will simply return
true
as GeoTools will distribute the appropriate libraries. Though it's not a bad idea for DataStoreFactories to check to make sure that the libraries are there.OracleDataStoreFactory is an example of one that may generally return
false
, since GeoTools can not distribute the oracle jars. (they must be added by the client.)One may ask how this is different than canProcess, and basically available is used by the DataStoreFinder getAvailableDataStore method, so that DataStores that can not even be used do not show up as options in gui applications.
- Specified by:
isAvailable
in interfaceDataAccessFactory
- Returns:
- true if and only if this factory has all the appropriate jars on the classpath to create DataStores.
-
createDataStore
public DataStore createDataStore(Map<String,?> 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.
- Specified by:
createDataStore
in interfaceDataAccessFactory
- Specified by:
createDataStore
in interfaceDataStoreFactorySpi
- 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,?> params) throws IOException
- Specified by:
createNewDataStore
in interfaceDataStoreFactorySpi
- Throws:
IOException
-
-