DMCQueryControl

Overview

File

Class

Tree

Index

Help

PREV CLASS NEXT CLASS

FRAMES NO FRAMES

SUMMARY: FIELD | CONSTR | METHOD

DETAIL: FIELD | CONSTR | METHOD

Class DMCQueryControl

Object
   |
   +--DMCQueryControl

class DMCQueryControl

DMCQueryControl is a class that is used to query for information
Defined in APIJS.js

Constructor Summary
`DMCQueryControl(<string> queryServiceUrl, dataSourceName)` Creates a new DMCQueryControl instance that will be used to query for information

Method Summary
`void`	`execute(<object> observer, <string> onSuccessMethod, <string> onErrorMethod, <string> queryId )` Executes the query and notifies the observer success or error method when the results are returned.
`void`	`geocode( <object> observer, <string> onSuccessMethod, <string> onErrorMethod, location, <string> address, <string> city, <string> state, <string> zip, minScore, includeGeo)` Executes the query and notifies the observer success or error method when the results are returned.
`string`	`getDataSource()` Returns the name of the DataSource being queried on.
`String`	`getKeyField()` Returns the primary key field for the records
`Object`	`getQuery()` Returns the query that will be sent.
`string`	`getQueryServiceUrl()` Returns the url that will be queried on.
`string`	`getResourceName()` Returns the name of the DataSource being queried on.
`string`	`getSelectAttributes()` Returns the selected attributes.
`void`	`setAPNFilter(apn, fips)` Sets the APN and FIPS filter.
`string`	`setDataSource(d)` Sets the DataSource
`void`	`setGeometryBufferDistance(geometryBufferDistance)` Sets the buffer distance around the geometry.
`void`	`setGeometryFilter(geometryFilter)` Sets the geometry filter.
`void`	`setID(id)` Sets the ID filter.
`String`	`setKeyField(k)` Sets the the primary key field for the records.
`void`	`setMaxOutputRecords(maxOutputRecords)` Sets the maximum number of records the query will return.
`void`	`setOutputType(outputType)` Sets the type of the returned data.
`void`	`setReturnGeometryType(returnGeometryType)` Sets the type of the geometries returned.
`void`	`setSelectAttributes(selectAttributes)` Sets the selected attributes.

Constructor Detail

DMCQueryControl

DMCQueryControl(<string> queryServiceUrl, dataSourceName)

Creates a new DMCQueryControl instance that will be used to query for information

Parameters:

queryServiceUrl

DataSourceName

Method Detail

execute

void execute(<object> observer, <string> onSuccessMethod, <string> onErrorMethod, <string> queryId )

Parameters:
observer - The object that will be notified when the query returns

onSuccessMethod - The success method name in the observer to call

onErrorMethod - The error method name in the observer to call

queryId - An Id to give the query. Optional

geocode

void geocode( <object> observer, <string> onSuccessMethod, <string> onErrorMethod, location, <string> address, <string> city, <string> state, <string> zip, minScore, includeGeo)

Executes the query and notifies the observer success or error method when the results are returned.

Parameters:
observer - The object that will be notified when the query returns

onSuccessMethod - The success method name in the observer to call

onErrorMethod - The error method name in the observer to call

address - The address line which include . Optional

city - The city name of the address. Optional

state - The state of the address. Optional

zip - The zipcode of the addres Optional

Deprecated - parameter. Pass NULL.

getDataSource

string getDataSource()

Returns the name of the DataSource being queried on.

getKeyField

String getKeyField()

Returns the primary key field for the records

Returns:
the primary key field for the records

getQuery

Object getQuery()

Returns the query that will be sent.

Returns:
the query that will be sent.

getQueryServiceUrl

string getQueryServiceUrl()

Returns the url that will be queried on.

getResourceName

string getResourceName()

Returns the name of the DataSource being queried on.

Deprecated (Instead use getDataSource())

getSelectAttributes

string getSelectAttributes()

Returns the selected attributes. Default are all attributes of the record.

setAPNFilter

void setAPNFilter(apn, fips)

Sets the APN and FIPS filter. Setting this filter returns parcels that match this APN, FIPS

Deprecated

setDataSource

string setDataSource(d)

Sets the DataSource

setGeometryBufferDistance

void setGeometryBufferDistance(geometryBufferDistance)

Sets the buffer distance around the geometry. The query area will include the geometry plus the buffer distance.

setGeometryFilter

void setGeometryFilter(geometryFilter)

Sets the geometry filter. This should be a wkt string.

setID

void setID(id)

Sets the ID filter.

setKeyField

String setKeyField(k)

Sets the the primary key field for the records. Default is APN.

Returns:
The keyField of the layer.

setMaxOutputRecords

void setMaxOutputRecords(maxOutputRecords)

Sets the maximum number of records the query will return. Maximum is 500. Default is 200.

setOutputType

void setOutputType(outputType)

Sets the type of the returned data. Supported types are json and xml. Default is json.

setReturnGeometryType

void setReturnGeometryType(returnGeometryType)

Sets the type of the geometries returned. Default is centroid.

setSelectAttributes

void setSelectAttributes(selectAttributes)

Sets the selected attributes. Default are all attributes of the record.

Overview File Class Tree Index Help

PREV CLASS NEXT CLASS FRAMES NO FRAMES

SUMMARY: FIELD | CONSTR | METHOD DETAIL: FIELD | CONSTR | METHOD

Documentation generated by JSDoc on Mon Nov 24 17:54:35 2008