...
| Note |
|---|
The spatial search has been extended to provide support for performing an attribute search against a spatial engine. None of the operations outlined above in "So a spatial search works like this" is performed, instead the operation more closely follows what an attribute search performs, i.e. finding rows in a layer that have attributes that match what a user has entered. The configuration of the spatial attribute search follows more closely that of the attribute search. Because it is using the underlying API of the spatial engine, rather than SQL as the attribute search does (although some spatial engines also use SQL as their API), the support and configuration may be different depending upon the level of support provided by the underlying spatial engine. For example, a spatial search operating on a spatial engine that is pointing to a directory of shapefiles may operate differently from one that is pointing to ArcSDE. This is similar to the differences in an attribute search that is pointing to an Oracle database compared to one that is pointing to SQL Server. |
Namespace
urn:com.cohga.server.search.spatial#1.0
...
Name | Type | Required | Default | Description | |
id | string | yes |
| A unique identifier for the parameter | |
label | string | yes | The prompt text displayed when user input the parameter value | ||
column | string | yes |
| The name of the column within the table that this parameter references | |
displayname | string | no | label | Provides a user-friendly name for the element | |
helptext | string | no | Additional text to display for the parameter to explain how to use the parameter | ||
hidden | boolean | no | false | Hides the parameter from the parameter UI | |
alignment | 'left', 'center', 'right', 'auto' | no | 'auto' | How the items should appear in the UI | |
controltype | 'listbox', 'checkbox', 'radiobutton', 'textbox' | no | 'textbox' | The suggested type of UI control to use when displaying the parameter | |
datatype | 'any', 'boolean', 'datetime', 'decimal', 'float', 'integer', 'string' | no | 'string' | The data type for the parameter | |
allownull | boolean | no | false | Whether a null value is allowed for this parameter | |
allowblank | boolean | no | true | Give the user the choice of an empty value in the listbox (as opposed to a null value) | |
allownewvalues | boolean | no | false | Allow the user to enter values not in the listbox already | |
defaultvalue | any | no | The default value of the parameter | ||
displayformat | string | no |
| The formatting instructions for the parameter value within the parameter UI | |
dataset | no | Where to get the values for a listbox | |||
labelcolumn | string | no |
| Column in the datadefinition that supplies the label of the value to show the user | |
valuecolumn | string | no | Column in the datadefinition that supplies the value of the value to use in the SQL | ||
uppercase | boolean | no | false | Should the value be converted to upper case in the generated SQL | |
| autoSelect | boolean | no | true | Should the first value in a list be pre-selected |
Sub-tags
Name | Type | Cardinality |
parameter | urn:com.cohga.server.data.database#1.0:parameter | 0..n |
...