...
- The user enters the search parameters and submits the search
- The server searches for the source entities that match the search parameters
- The geometry of the found source entities are then used in a spatial search for the target entities
- The selection for the target entities is then updated based on the results of the spatial search
| 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
Tags
spatial
Properties
Name | Type | Required | Description |
id | string | yes | unique identifier for this search |
entity | yes | The id of the entity that this search will be searching for | |
sourceEntity (or sourceentity) | yes | The id of the entity that the search parameters apply to | |
displayName (or displayname) | string | yes | Text to be displayed to the user to represent this search |
description | string | no | Description of the search that could be displayed to the user to explain this search |
acl | no | A reference to an ACL to attach to the search |
Sub-tags
Name | Type | Cardinality |
parameter | urn:com.cohga.server.search.database#1.0:parameter | 1..n |
acl | 0..1 | |
cache | 0..1 |
Content
None
Notes
An ACL can either be defined in-line or referenced indirectly, but only one should be used (the in-line version will take priority)
parameter
Properties
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 |
Notes
- If the controltype is listbox then a dataset must be provided. This dataset will provide the values to be displayed in the listbox.
- If the listbox dataset only contains 1 column then that column will supply both the label and the value, if it contains two values then the first column will supply the label and the second the value.
- If a parameter contains another parameter then you are defining a cascading parameter, where setting the first sub-parameter will enable, and filter, the second parameter, and setting the second parameter will do the same for the third, etc.
- In a cascading parameter all sub-parameters must be of listbox type, and the dataset should be set in the outer parameter, not the sub parameters.
- In a cascading parameter only one level of nesting should be used.
- In a cascading parameter the dataset should supply the columns for all of the parameters, and valuecolumn properties should be set for each sub-parameter, and labelcolumn should be also set for all parameters if a different label is to be displayed to the user.
...
| Code Block | ||||||
|---|---|---|---|---|---|---|
| ||||||
<data:datadefinition id="dd_wards"> <datasourcedataconnection datasource="datasource.main" table="WARDS" prefix="DISTINCT"> <parameter name="name" column="WARD_NAME"/> <parameter name="code" column="WARD_CODE"/> </datasourcedataconnection> </data:datadefinition> <search:spatial id="property.byward"> <displayname>by Ward Boundary</displayname> <description>Locate a property or properties by ward</description> <entity>property</entity> <sourceentity>ward</sourceentity> <parameter id="ward"> <dataset>dd_wards</dataset> <label>Road<label>Ward Name</label> <controltype>listbox</controltype> <column>CODE</column> <valuecolumn>code</valuecolumn> <labelcolumn>name</labelcolumn> </parameter> </search:spatial> |
...
| Code Block | ||||||||
|---|---|---|---|---|---|---|---|---|
| ||||||||
<search:spatial id="property.byward"> <displayname>by Ward Boundary</displayname> <description>Locate a property or properties by ward</description> <entity>property</entity> <sourceentity>ward</sourceentity> <parameter id="ward"> <dataset>dd_wards</dataset> <label>Road<label>Ward Name</label> <controltype>listbox</controltype> <column>CODE</column> <valuecolumn>code</valuecolumn> <labelcolumn>name</labelcolumn> </parameter> <options:options> <!-- version 1.4.105 of com.cohga.server.search.database and earlier --> <buffer:distance>-10</buffer:distance> <!-- version 1.5.105 of com.cohga.server.search.database and later --> <buffer>-10</buffer> <bufferUnits>m</bufferUnits> </options:options> </search:spatial> |
| Code Block | ||||||
|---|---|---|---|---|---|---|
| ||||||
<search:spatial id="property.byward"> <displayname>by Ward Boundary</displayname> <description>Locate a property or properties by ward</description> <entity>property</entity> <sourceentity>ward</sourceentity> <parameter id="ward"> <dataset>dd_wards</dataset> <label>Road<label>Ward Name</label> <controltype>listbox</controltype> <column>CODE</column> <valuecolumn>code</valuecolumn> <labelcolumn>name</labelcolumn> </parameter> <options:options> <spatialOperation>within</spatialOperation> </options:options> </search:spatial> |
| Code Block | ||||||
|---|---|---|---|---|---|---|
| ||||||
<search:spatial id="ward"> <displayname>by Ward Name</displayname> <description>Locate a ward by name</description> <entity>ward</entity> <parameter id="ward"> <dataset>dd_wards</dataset> <label>Ward Name</label> <controltype>listbox</controltype> <column>CODE</column> <valuecolumn>code</valuecolumn> <labelcolumn>name</labelcolumn> </parameter> </search:spatial> |