AGSWebMapQueryParameter Class Reference
Description
Instances of this class can be used to construct a predicate for AGSWebMapQuery::whereClause. The application should provide UI to capture input from the user for each AGSWebMapQueryParameter object in AGSWebMapQuery::parameters. This input can then be combined with the remaining information in the object to construct a predicate.
For example, suppose the value of field is "Magnitude", paramOperator is "=", and the value entered by a user is 2. This information can be combined into a string "Magnitude = 2" which can then be used in a whereClause to query for earthqukes with a magnitude of 2.
- Since:
- 2.2
Public Member Functions | |
| (void) | - decodeWithJSON: |
| (NSDictionary *) | - encodeToJSON |
| (id) | - initWithJSON: |
| (id) | - initWithPrompt:field:defaultValue:paramOperator:helpTip: |
Properties | |
| NSString * | defaultValue |
| NSString * | field |
| NSString * | helpTip |
| NSString * | paramOperator |
| NSString * | prompt |
Member Function Documentation
| - (void) decodeWithJSON: | (NSDictionary *) | json | [optional, inherited] |
Decode object from JSON representation.
- Parameters:
-
json The JSON representation of the object to be decoded.
- Since:
- 1.0
| - (NSDictionary *) encodeToJSON | [optional, inherited] |
Encode and return JSON representation for object.
- Returns:
- JSON representation of object.
- Since:
- 1.0
| - (id) initWithJSON: | (NSDictionary *) | json | [optional, inherited] |
Initialize and return object from JSON representation.
- Parameters:
-
json The JSON representation of the object to be created.
- Returns:
- Object decoded from JSON representation.
- Since:
- 1.0
Reimplemented in AGSWebMapFeatureCollection.
| - (id) initWithPrompt: | (NSString *) | p | ||
| field: | (NSString *) | f | ||
| defaultValue: | (NSString *) | dv | ||
| paramOperator: | (NSString *) | op | ||
| helpTip: | (NSString *) | h | ||
- Since:
- 2.2
Property Documentation
- (NSString*) defaultValue [read, retain] |
The default value to compare with the field's value in the event that a user does not provide another value.
- Since:
- 2.2
- (NSString*) field [read, retain] |
The name of the field (attribute) on which the query will be executed.
- Since:
- 2.2
- (NSString*) helpTip [read, retain] |
A tip explaining what input would be valid. For example, "A value between 0 and 10".
- Since:
- 2.2
- (NSString*) paramOperator [read, retain] |
The operator (<, >, =, etc) to be used to compare the field's value.
- Since:
- 2.2
- (NSString*) prompt [read, retain] |
The message to be displayed to the user to indicate what the user input represents. For example, "Earthquake Magnitude:". This message should usually be displayed adjacent to the textfield.
- Since:
- 2.2