|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
ObjectParameter
DataAccessFactory.Param
public static class DataAccessFactory.Param
Data class used to capture Parameter requirements.
Subclasses may provide specific setAsText()/getAsText() requirements
Field Summary |
---|
Fields inherited from class Parameter |
---|
CRS, description, ELEMENT, EXT, FEATURE_TYPE, IS_LARGE_TEXT, IS_PASSWORD, key, LENGTH, LEVEL, MAX, maxOccurs, metadata, MIN, minOccurs, OPTIONS, required, sample, title, type |
Constructor Summary | |
---|---|
DataAccessFactory.Param(String key)
Provides support for text representations The parameter type of String is assumed. |
|
DataAccessFactory.Param(String key,
Class<?> type)
Provides support for text representations. |
|
DataAccessFactory.Param(String key,
Class<?> type,
InternationalString description,
boolean required,
Object sample)
Provides support for text representations |
|
DataAccessFactory.Param(String key,
Class<?> type,
InternationalString description,
boolean required,
Object sample,
Map<String,?> metadata)
Provides support for text representations |
|
DataAccessFactory.Param(String key,
Class<?> type,
String description)
Provides support for text representations |
|
DataAccessFactory.Param(String key,
Class<?> type,
String description,
boolean required)
Provides support for text representations |
|
DataAccessFactory.Param(String key,
Class<?> type,
String description,
boolean required,
Object sample)
Provides support for text representations |
|
DataAccessFactory.Param(String key,
Class<?> type,
String description,
boolean required,
Object sample,
Map<String,?> metadata)
Provides support for text representations |
|
DataAccessFactory.Param(String key,
Class<?> type,
String description,
boolean required,
Object sample,
Object... metadata)
|
Method Summary | |
---|---|
Object |
handle(String text)
Handle text in a sensible manner. |
Object |
lookUp(Map<String,?> map)
Lookup Param in a user supplied map. |
Object |
parse(String text)
Provides support for text representations Provides basic support for common types using reflection. |
String |
text(Object value)
Convert value to text representation for this Parameter |
String |
toString()
key=Type description |
Methods inherited from class Parameter |
---|
getDefaultValue, getDescription, getLevel, getMaxOccurs, getMinOccurs, getName, getTitle, getType, isPassword, isRequired |
Methods inherited from class Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait |
Constructor Detail |
---|
public DataAccessFactory.Param(String key)
The parameter type of String is assumed.
key
- Key used to file this Param in the Parameter Map for
createDataStorepublic DataAccessFactory.Param(String key, Class<?> type)
You may specify a type
for this Param.
key
- Key used to file this Param in the Parameter Map for
createDataStoretype
- Class type intended for this Parampublic DataAccessFactory.Param(String key, Class<?> type, String description)
key
- Key used to file this Param in the Parameter Map for
createDataStoretype
- Class type intended for this Paramdescription
- User description of Param (40 chars or less)public DataAccessFactory.Param(String key, Class<?> type, String description, boolean required)
key
- Key used to file this Param in the Parameter Map for
createDataStoretype
- Class type intended for this Paramdescription
- User description of Param (40 chars or less)required
- true
is param is requiredpublic DataAccessFactory.Param(String key, Class<?> type, String description, boolean required, Object sample)
key
- Key used to file this Param in the Parameter Map for
createDataStoretype
- Class type intended for this Paramdescription
- User description of Param (40 chars or less)required
- true
is param is requiredsample
- Sample value as an example for user inputpublic DataAccessFactory.Param(String key, Class<?> type, InternationalString description, boolean required, Object sample)
key
- Key used to file this Param in the Parameter Map for
createDataStoretype
- Class type intended for this Paramdescription
- User description of Param (40 chars or less)required
- true
is param is requiredsample
- Sample value as an example for user inputpublic DataAccessFactory.Param(String key, Class<?> type, String description, boolean required, Object sample, Map<String,?> metadata)
key
- Key used to file this Param in the Parameter Map for
createDataStoretype
- Class type intended for this Paramdescription
- User description of Param (40 chars or less)required
- true
is param is requiredsample
- Sample value as an example for user inputextra
- metadata information, preferably keyed by known identifiers
like Parameter.IS_PASSWORD
public DataAccessFactory.Param(String key, Class<?> type, String description, boolean required, Object sample, Object... metadata)
public DataAccessFactory.Param(String key, Class<?> type, InternationalString description, boolean required, Object sample, Map<String,?> metadata)
key
- Key used to file this Param in the Parameter Map for
createDataStoretype
- Class type intended for this Paramdescription
- User description of Param (40 chars or less)required
- true
is param is requiredsample
- Sample value as an example for user inputextra
- metadata information, preferably keyed by known identifiers
like Parameter.IS_PASSWORD
Method Detail |
---|
public Object lookUp(Map<String,?> map) throws IOException
Type conversion will occur if required, this may result in an IOException. An IOException will be throw in the Param is required and the Map does not contain the Map.
The handle method is used to process the user's value.
map
- Map of user input
IOException
- if parse could not handle valuepublic String text(Object value)
value
- DOCUMENT ME!
public Object handle(String text) throws IOException
Performs the most common way of handling text value:
text
-
IOException
- If text could not be parsedpublic Object parse(String text) throws Throwable
Provides basic support for common types using reflection.
If needed you may extend this class to handle your own custome types.
text
- Text representation of type should not be null or empty
Throwable
- DOCUMENT ME!
IOException
- If text could not be parsed
DataSourceException
- DOCUMENT ME!public String toString()
toString
in class Parameter
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |