AGSFeatureSet Class Reference


Description

Instances of this class respresent a feature set. A feature set is simply a collection of features. Each feature is represented as an AGSGraphic object. They may contain geometry, attributes, and symbology. If the features contain only attributes but no geometry, the feature set can be considered a simple table where each feature is a row object.

A feature set can be the result of a task or used as an input to a task. Tasks that return a feature set include AGSQueryTask and AGSGeoprocessor. In addition, AGSGeoprocessor may require a feature set as input.

Defined in:
AGSFeatureSet.h ( ArcGIS library)
Since:
1.0
Inheritance diagram for AGSFeatureSet:
<AGSCoding>

List of all members.

Public Member Functions

(void) - decodeWithJSON:
(NSDictionary *) - encodeToJSON
(id) - initWithDisplayFieldName:features:fieldAliases:spatialReference:geometryType:
(id) - initWithFeatures:
(id) - initWithJSON:

Static Public Member Functions

(id) + featureSetWithFeatures:

Properties

NSString * displayFieldName
NSArray * features
NSDictionary * fieldAliases
AGSGeometryType geometryType
AGSSpatialReferencespatialReference

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) featureSetWithFeatures: (NSArray *)  features  

Initializes a new, autoreleased AGSFeatureSet. All features must contain a single type of geometry, all having the same spatial reference.

Parameters:
features The features to be used to initialize the set.
Returns:
An initialized AGSFeatureSet with the specified features.
Since:
1.8
- (id) initWithDisplayFieldName: (NSString *)  displayFieldName
features: (NSArray *)  features
fieldAliases: (NSDictionary *)  fieldAliases
spatialReference: (AGSSpatialReference *)  spatialReference
geometryType: (AGSGeometryType geometryType 

Initializes a new AGSFeatureSet.

Parameters:
displayFieldName The name of the primary display field.
features The features to be used to initialize the set.
fieldAliases The user-friendly values associated with field names.
spatialReference The spatial reference for each object in the feature set.
geometryType The type of geometry for the features in the set.
Returns:
An initialized AGSFeatureSet with the given parameters.
Since:
1.0
- (id) initWithFeatures: (NSArray *)  features  

Initializes a new AGSFeatureSet. All features must contain a single type of geometry, all having the same spatial reference.

Parameters:
features The features to be used to initialize the set.
Returns:
An initialized AGSFeatureSet with the specified features.
Since:
1.8
- (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

Property Documentation

- (NSString*) displayFieldName [read, copy]

The name of the primary display field.

Since:
1.0
- (NSArray*) features [read, write, retain]

The features in the feature set as an array of AGSGraphic objects.

Since:
1.0
- (NSDictionary*) fieldAliases [read, retain]

Set of key-value pairs of field-name and field-alias. Field aliases are usually more user friendly than actual field names which may use underlying datasource naming conventions. The feature attributes use actual field names.

Since:
1.0
- (AGSGeometryType) geometryType [read, assign]

The geometry type of features in the feature set. All features in the feature set must have the same geometry type. Possible types include

  • AGSGeometryTypePoint
  • AGSGeometryTypePolyline
  • AGSGeometryTypePolygon
  • AGSGeometryTypeMultipoint
  • AGSGeometryTypeEnvelope
Since:
1.0
- (AGSSpatialReference*) spatialReference [read, retain]

The spatial reference of features in the feature set. All features in the feature set must have the same spatial reference.

Since:
1.0