DB String Map

DB String Map
Prev	maps	Next

Name

map

DB String Map — DB String Map

<map class="xms.dataservices.map.DBStringMap" name="name" … />

Table 41. Attributes for map tag (for xms.dataservices.map.DBStringMap)

Name	Description	Type	Default Value	Required
cache	Enable caching for returned query data	boolean true or false	true	no
cacheTimeout	The period between cache refreshes in ms	int any integer	0 (cache is never refreshed)	no
datasourceName	The name of a datasource declared in DataSourceService	DataSource Name of a DataSource as defined in DataSourceService	none	yes
keyColumn	The table column containing map keys	String any character combination	none	yes
readOnly	Disables write access	boolean true or false	false	no
table	The table in the datasource	String any character combination	none	yes
timeout	The timeout for queries to the database in ms	int any integer	60000	no
valueColumn	The table column containing map values	String any character combination	none	yes

Service Dependencies

This tag depends on the following services (or a service that extends or implements these classes)

xms.thread.ThreadPoolService
- XMS Thread Pool Service
xms.dataservices.DataSourceService
- XMS Data Source Service

Example 46. Example configuration for DB String Map

Required attributes are marked with a bold typeface

<map class="xms.dataservices.map.DBStringMap" name="name"
      cache="cache"
      cacheTimeout="cacheTimeout"
      datasourceName="datasourceName"
      keyColumn="keyColumn"
      readOnly="readOnly"
      table="table"
      timeout="timeout"
      valueColumn="valueColumn" />