org.vfny.geoserver.global
Class DataStoreInfo

java.lang.Object
  extended byorg.vfny.geoserver.global.GlobalLayerSupertype
      extended byorg.vfny.geoserver.global.DataStoreInfo
All Implemented Interfaces:
org.geotools.data.DataStoreMetaData, org.geotools.data.MetaData

public class DataStoreInfo
extends org.vfny.geoserver.global.GlobalLayerSupertype
implements org.geotools.data.DataStoreMetaData

This is the configuration iformation for one DataStore. This class can also generate real datastores.


Constructor Summary
DataStoreInfo(DataStoreInfoDTO config, Data data)
          DataStoreInfo constructor.
 
Method Summary
 boolean containsMetaData(java.lang.String key)
          Implement containsMetaData.
static java.lang.String get(java.util.Map map, java.lang.String key)
          get purpose.
static boolean get(java.util.Map map, java.lang.String key, boolean defaultValue)
          get purpose.
static java.nio.charset.Charset get(java.util.Map map, java.lang.String key, java.nio.charset.Charset defaultCharSet)
          get purpose.
static java.lang.Class get(java.util.Map map, java.lang.String key, java.lang.Class defaultType)
          get purpose.
static java.io.File get(java.util.Map map, java.lang.String key, java.io.File defaultFile)
          get purpose.
static int get(java.util.Map map, java.lang.String key, int defaultValue)
          get purpose.
static java.util.logging.Level get(java.util.Map map, java.lang.String key, java.util.logging.Level defaultLevel)
          get purpose.
static java.util.List get(java.util.Map map, java.lang.String key, java.util.List defaultList)
          get purpose.
static java.util.Map get(java.util.Map map, java.lang.String key, java.util.Map defaultMap)
          get purpose.
static java.lang.String get(java.util.Map map, java.lang.String key, java.lang.String defaultValue)
          get purpose.
static java.net.URL get(java.util.Map map, java.lang.String key, java.net.URL defaultUrl)
          get purpose.
 java.lang.String getAbstract()
          getAbstract purpose.
 org.geotools.data.DataStore getDataStore()
          By now just uses DataStoreFinder to find a new instance of a DataStoreInfo capable of process connectionParams.
 java.lang.String getId()
          getId purpose.
 java.lang.Object getMetaData(java.lang.String key)
          Implement getMetaData.
 NameSpaceInfo getNameSpace()
          getNameSpace purpose.
 java.lang.String getNamesSpacePrefix()
          Access namespace id
protected  java.util.Map getParams()
          Get Connect params.
 java.lang.String getTitle()
          getTitle purpose.
 boolean isEnabled()
          isEnabled purpose.
protected  java.lang.String notNull(java.lang.String s)
          checks s for nullity and if so, returns an empty String, else just returns s
 void putMetaData(java.lang.String key, java.lang.Object value)
          Implement putMetaData.
 java.lang.String toString()
          Implement toString.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Constructor Detail

DataStoreInfo

public DataStoreInfo(DataStoreInfoDTO config,
                     Data data)
DataStoreInfo constructor.

Stores the specified data for later use.

Parameters:
config - DataStoreInfoDTO the current configuration to use.
data - Data a ref to use later to look up related informtion
Method Detail

getId

public java.lang.String getId()
getId purpose.

Returns the dataStore's id.

Returns:
String the id.

getParams

protected java.util.Map getParams()
Get Connect params.

This is used to smooth any relative path kind of issues for any file URLS. This code should be expanded to deal with any other context sensitve isses dataStores tend to have.


getDataStore

public org.geotools.data.DataStore getDataStore()
                                         throws java.lang.IllegalStateException,
                                                java.util.NoSuchElementException
By now just uses DataStoreFinder to find a new instance of a DataStoreInfo capable of process connectionParams. In the future we can see if it is better to cache or pool DataStores for performance, but definitely we shouldn't maintain a single DataStoreInfo as instance variable for synchronizing reassons

JG: Umm we actually require a single DataStoreInfo for for locking & transaction support to work. DataStoreInfo is expected to be thread aware (that is why it has Transaction Support).

Specified by:
getDataStore in interface org.geotools.data.DataStoreMetaData
Returns:
DataStore
Throws:
java.lang.IllegalStateException - if this DataStoreInfo is disabled by configuration
java.util.NoSuchElementException - if no DataStoreInfo is found

getTitle

public java.lang.String getTitle()
getTitle purpose.

Returns the dataStore's title.

Returns:
String the title.

getAbstract

public java.lang.String getAbstract()
getAbstract purpose.

Returns the dataStore's abstract.

Returns:
String the abstract.

isEnabled

public boolean isEnabled()
isEnabled purpose.

Returns true when the data store is enabled.

Returns:
true when the data store is enabled.

getNameSpace

public NameSpaceInfo getNameSpace()
getNameSpace purpose.

Returns the namespace for this datastore.

Returns:
NameSpaceInfo the namespace for this datastore.

getNamesSpacePrefix

public java.lang.String getNamesSpacePrefix()
Access namespace id

Returns:
DOCUMENT ME!

toString

public java.lang.String toString()
Implement toString.

Returns:
String
See Also:
Object.toString()

containsMetaData

public boolean containsMetaData(java.lang.String key)
Implement containsMetaData.

Specified by:
containsMetaData in interface org.geotools.data.MetaData
Parameters:
key -
Returns:
See Also:
MetaData.containsMetaData(java.lang.String)

putMetaData

public void putMetaData(java.lang.String key,
                        java.lang.Object value)
Implement putMetaData.

Specified by:
putMetaData in interface org.geotools.data.MetaData
Parameters:
key -
value -
See Also:
MetaData.putMetaData(java.lang.String, java.lang.Object)

getMetaData

public java.lang.Object getMetaData(java.lang.String key)
Implement getMetaData.

Specified by:
getMetaData in interface org.geotools.data.MetaData
Parameters:
key -
Returns:
See Also:
MetaData.getMetaData(java.lang.String)

notNull

protected java.lang.String notNull(java.lang.String s)
checks s for nullity and if so, returns an empty String, else just returns s

Parameters:
s - String
Returns:
String non-null String (null -> "")

get

public static java.lang.String get(java.util.Map map,
                                   java.lang.String key)
get purpose.

Gets a String from a map of Strings

Parameters:
map - Map the map to extract the string from
key - String the key for the map.
Returns:
String the value in the map.
See Also:
Map

get

public static java.io.File get(java.util.Map map,
                               java.lang.String key,
                               java.io.File defaultFile)
get purpose.

Gets a File from a map given the specified key. If the file is not found the default file is returned.

Parameters:
map - Map the map to extract the file from
key - String the key to extract the value for
defaultFile - The default value should the key not exist.
Returns:
File a File as described above.

get

public static java.lang.String get(java.util.Map map,
                                   java.lang.String key,
                                   java.lang.String defaultValue)
get purpose.

Gets a String from a map of Strings, and returns the default if the string does not exist.

Parameters:
map - Map the map to extract the string from
key - String the key for the map.
defaultValue - The default value should the key not exist.
Returns:
String the value in the map.
See Also:
Map

get

public static java.util.List get(java.util.Map map,
                                 java.lang.String key,
                                 java.util.List defaultList)
get purpose.

Gets a List from a map given the specified key. If the list is not found the default list is returned.

Parameters:
map - Map the map to extract the file from
key - String the key to extract the value for
defaultList - The default value should the key not exist.
Returns:
List a List as described above.

get

public static java.util.Map get(java.util.Map map,
                                java.lang.String key,
                                java.util.Map defaultMap)
get purpose.

Gets a Map from a map given the specified key. If the map is not found the default map is returned.

Parameters:
map - Map the map to extract the file from
key - String the key to extract the value for
defaultMap - The default value should the key not exist.
Returns:
Map a Map as described above.

get

public static int get(java.util.Map map,
                      java.lang.String key,
                      int defaultValue)
get purpose.

Gets a int from a map given the specified key. If the int is not found the default int is returned.

Parameters:
map - Map the map to extract the file from
key - String the key to extract the value for
defaultValue - The default value should the key not exist.
Returns:
int an int as described above.

get

public static boolean get(java.util.Map map,
                          java.lang.String key,
                          boolean defaultValue)
get purpose.

Gets a boolean from a map given the specified key. If the boolean is not found the default boolean is returned.

Parameters:
map - Map the map to extract the file from
key - String the key to extract the value for
defaultValue - The default value should the key not exist.
Returns:
boolean an boolean as described above.

get

public static java.nio.charset.Charset get(java.util.Map map,
                                           java.lang.String key,
                                           java.nio.charset.Charset defaultCharSet)
get purpose.

Gets a Charset from a map given the specified key. If the Charset is not found the default Charset is returned.

Parameters:
map - Map the map to extract the file from
key - String the key to extract the value for
defaultCharSet - The default value should the key not exist.
Returns:
Charset an boolean as described above.

get

public static java.util.logging.Level get(java.util.Map map,
                                          java.lang.String key,
                                          java.util.logging.Level defaultLevel)
get purpose.

Gets a Level from a map given the specified key. If the Level is not found the default Level is returned.

Parameters:
map - Map the map to extract the file from
key - String the key to extract the value for
defaultLevel - The default value should the key not exist.
Returns:
Level an boolean as described above.

get

public static java.net.URL get(java.util.Map map,
                               java.lang.String key,
                               java.net.URL defaultUrl)
get purpose.

Gets a URL from a map given the specified key. If the URL is not found the default URL is returned.

Parameters:
map - Map the map to extract the file from
key - String the key to extract the value for
defaultUrl - The default value should the key not exist.
Returns:
URL an boolean as described above.

get

public static java.lang.Class get(java.util.Map map,
                                  java.lang.String key,
                                  java.lang.Class defaultType)
get purpose.

Gets a Class from a map given the specified key. If the Class is not found the default Class is returned.

Parameters:
map - Map the map to extract the file from
key - String the key to extract the value for
defaultType - The default value should the key not exist.
Returns:
Class an boolean as described above.