org.geotools.data
Class DataStoreFactorySpi.Param

java.lang.Object
  org.geotools.data.DataStoreFactorySpi.Param

Enclosing class:

DataStoreFactorySpi

public static class DataStoreFactorySpi.Param

extends java.lang.Object

Data class used to capture Parameter requirements.

Subclasses may provide specific setAsText()/getAsText() requirements

Field Summary

java.lang.String	description Short description (less then 40 characters)
java.lang.String	key Key used in Parameter map
boolean	required True if Param is required
java.lang.Class	type Type of information required

Constructor Summary

DataStoreFactorySpi.Param(java.lang.String key)
Provides support for text representations

DataStoreFactorySpi.Param(java.lang.String key, java.lang.Class type)
Provides support for text representations.

DataStoreFactorySpi.Param(java.lang.String key, java.lang.Class type, java.lang.String description)
Provides support for text representations

DataStoreFactorySpi.Param(java.lang.String key, java.lang.Class type, java.lang.String description, boolean required)
Provides support for text representations

Method Summary

java.lang.String	getAsText(java.lang.Object value)
java.lang.Object	setAsText(java.lang.String text) Provides support for text representations

Methods inherited from class java.lang.Object

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

Field Detail

required

public final boolean required

True if Param is required

key

public final java.lang.String key

Key used in Parameter map

type

public final java.lang.Class type

Type of information required

description

public final java.lang.String description

Short description (less then 40 characters)

Constructor Detail

DataStoreFactorySpi.Param

public DataStoreFactorySpi.Param(java.lang.String key)

Provides support for text representations

The parameter type of String is assumed.

Parameters:

key - Key used to file this Param in the Parameter Map for createDataStore

DataStoreFactorySpi.Param

public DataStoreFactorySpi.Param(java.lang.String key,
                                 java.lang.Class type)

Provides support for text representations.

You may specify a type for this Param.

Parameters:

key - Key used to file this Param in the Parameter Map for createDataStore

type - Class type intended for this Param

DataStoreFactorySpi.Param

public DataStoreFactorySpi.Param(java.lang.String key,
                                 java.lang.Class type,
                                 java.lang.String description)

Provides support for text representations

Parameters:

key - Key used to file this Param in the Parameter Map for createDataStore

type - Class type intended for this Param

description - User description of Param (40 chars or less)

DataStoreFactorySpi.Param

public DataStoreFactorySpi.Param(java.lang.String key,
                                 java.lang.Class type,
                                 java.lang.String description,
                                 boolean required)

Provides support for text representations

Parameters:

key - Key used to file this Param in the Parameter Map for createDataStore

type - Class type intended for this Param

description - User description of Param (40 chars or less)

required - true is param is required

Method Detail

getAsText

public java.lang.String getAsText(java.lang.Object value)

setAsText

public java.lang.Object setAsText(java.lang.String text)

Provides support for text representations

Provides basic support for common types using reflection.

If needed you may extend this class to handle your own custome types.

Parameters:

text - Text representation

Returns:

Object converted from text representation, or null if unsuccessful