ThinkGeo Cloud
ThinkGeo UI Controls
ThinkGeo Open Source
Help and Support
External Resources
Sidebar
thinkgeo.mapsuite.core.arcsdefeaturesource
Table of Contents
ThinkGeo.MapSuite.Core.ArcSdeFeatureSource
Note: The page was created before Map Suite 10. Map Suite 10.0 organized many classes into new namespaces and assemblies as well as had a few minor breaks in compatibility. The majority of previously built code should work without modification assuming the new namespaces are added. For guidance on upgrading your existing code, please check out MapSuite 10 Upgrade Guide.
<!– Class –> This class represents a FeatureSource backed by an ArcSDE server.
Inheritance Hierarchy
Members Summary
Public Constructors
| Name | Parameters | DeclaringType | Summary |
|---|---|---|---|
 ArcSdeFeatureSource | This is the class constructor. | ||
| ArcSdeFeatureSource | String, String, String, String, String, String, String, String, String | This is the class constructor. |
Protected Constructors
| Name | Parameters | DeclaringType | Summary |
|---|
Public Methods
Protected Methods
Public Properties
| Name | Return | DeclaringType | Summary |
|---|---|---|---|
 CanExecuteSqlQuery | Boolean | FeatureSource | |
| CanModifyColumnStructure | Boolean | FeatureSource | |
| ConnectionString | String | This property gets and sets the connection string used to connect to the ArcSDE server. | |
| Datastore | String | This property gets and sets the datastore of the ArcSDE server. | |
| FeatureClassName | String | This property gets and sets the name of the feature class in the feature schema. | |
| FeatureIdsToExclude | Collection<String> | FeatureSource | |
| FeatureSchemaName | String | This property gets and sets the name of the feature schema in the datastore. | |
| GeoCache | FeatureCache | FeatureSource | |
| GeometryColumnName | String | This property gets and sets the name of the column that holds the geometry. | |
| IdColumnName | String | This property gets and sets the name of the column that holds the unique feature Id. | |
| Instance | String | This property gets and sets the port of the ArcSDE server. | |
| IsEditable | Boolean | FeatureSource | |
| IsInTransaction | Boolean | FeatureSource | |
| IsOpen | Boolean | FeatureSource | |
| IsTransactionLive | Boolean | FeatureSource | |
| MaxRecordsToDraw | Int32 | FeatureSource | |
| Password | String | This property gets and sets the password for the ArcSDE server. | |
| Projection | Projection | FeatureSource | |
| ProviderName | String | This property gets the name of the provider for ArcSDE, which used by FDO. | |
| Server | String | This property gets and sets the machine name or IP address of the ArcSDE server. | |
| TransactionBuffer | TransactionBuffer | FeatureSource | |
| Username | String | This property gets and sets the username for the ArcSDE server. |
Protected Properties
| Name | Return | DeclaringType | Summary |
|---|---|---|---|
 CanExecuteSqlQueryCore | Boolean | FeatureSource(overriden) | This property specifies whether the FeatureSource can execute a SQL query or not. If it is false, then it will throw an exception when you call the APIs ExecuteScalar, ExecuteNonQuery or ExecuteQuery. This override will make it true. |
| CanModifyColumnStructureCore | Boolean | FeatureSource | |
| FeatureSourceColumns | Collection<FeatureSourceColumn> | FeatureSource | |
| IsOpenCore | Boolean | FeatureSource |
Public Events
Public Constructors
ArcSdeFeatureSource()
This is the class constructor.
Overloads
This is the default constructor, which requires you to set the properties after you create the class.
Parameters
| Name | Type | Description |
|---|
ArcSdeFeatureSource(String, String, String, String, String, String, String, String, String)
This is the class constructor.
Overloads
This constructor allows you to input all required information to create an ArcSdeFeatureSource.
Parameters
| Name | Type | Description |
|---|---|---|
| server | String<!– System.String –> | This parameter represents the machine name or IP address of the ArcSDE server. |
| instance | String<!– System.String –> | This parameter represents the port of the server. |
| username | String<!– System.String –> | This parameter represents the username for the ArcSDE server. |
| password | String<!– System.String –> | This parameter represents the password for the ArcSDE server. |
| datastore | String<!– System.String –> | This parameter represents the datastore of the ArcSDE server. |
| idColumnName | String<!– System.String –> | This parameter represents the name of the column that holds the unique feature Id. |
| featureSchemaName | String<!– System.String –> | This parameter represents the name of the feature schema in the datastore. |
| featureClassName | String<!– System.String –> | This parameter represents the name of the feature class in the feature schema. |
| geometryColumnName | String<!– System.String –> | This parameter represents the name of the column that holds the geometry. |
Protected Constructors
Public Methods
AddColumn(FeatureSourceColumn)
Return Value
| Return Type | Description |
|---|---|
| Void<!– System.Void –> |
Parameters
| Name | Type | Description |
|---|---|---|
| featureSourceColumn | FeatureSourceColumn<!– ThinkGeo.MapSuite.Core.FeatureSourceColumn –> |
<!– ThinkGeo.MapSuite.Core.FeatureSource –> Go Back
AddFeature(Feature)
Return Value
| Return Type | Description |
|---|---|
| String<!– System.String –> |
Parameters
| Name | Type | Description |
|---|---|---|
| feature | Feature<!– ThinkGeo.MapSuite.Core.Feature –> |
<!– ThinkGeo.MapSuite.Core.FeatureSource –> Go Back
AddFeature(BaseShape)
Return Value
| Return Type | Description |
|---|---|
| String<!– System.String –> |
Parameters
| Name | Type | Description |
|---|---|---|
| shape | BaseShape<!– ThinkGeo.MapSuite.Core.BaseShape –> |
<!– ThinkGeo.MapSuite.Core.FeatureSource –> Go Back
AddFeature(BaseShape, IDictionary<String, String>)
Return Value
| Return Type | Description |
|---|---|
| String<!– System.String –> |
Parameters
| Name | Type | Description |
|---|---|---|
| shape | BaseShape<!– ThinkGeo.MapSuite.Core.BaseShape –> | |
| columnValues | IDictionary<String,String><!– System.Collections.Generic.IDictionary{System.String,System.String} –> |
<!– ThinkGeo.MapSuite.Core.FeatureSource –> Go Back
BeginTransaction()
Return Value
| Return Type | Description |
|---|---|
| Void<!– System.Void –> |
Parameters
| Name | Type | Description |
|---|
<!– ThinkGeo.MapSuite.Core.FeatureSource –> Go Back
CloneDeep()
Return Value
| Return Type | Description |
|---|---|
| FeatureSource<!– ThinkGeo.MapSuite.Core.FeatureSource –> |
Parameters
| Name | Type | Description |
|---|
<!– ThinkGeo.MapSuite.Core.FeatureSource –> Go Back
Close()
Return Value
| Return Type | Description |
|---|---|
| Void<!– System.Void –> |
Parameters
| Name | Type | Description |
|---|
<!– ThinkGeo.MapSuite.Core.FeatureSource –> Go Back
CommitTransaction()
Return Value
| Return Type | Description |
|---|---|
| TransactionResult<!– ThinkGeo.MapSuite.Core.TransactionResult –> |
Parameters
| Name | Type | Description |
|---|
<!– ThinkGeo.MapSuite.Core.FeatureSource –> Go Back
DeleteColumn(String)
Return Value
| Return Type | Description |
|---|---|
| Void<!– System.Void –> |
Parameters
| Name | Type | Description |
|---|---|---|
| columnName | String<!– System.String –> |
<!– ThinkGeo.MapSuite.Core.FeatureSource –> Go Back
DeleteFeature(String)
Return Value
| Return Type | Description |
|---|---|
| Void<!– System.Void –> |
Parameters
| Name | Type | Description |
|---|---|---|
| id | String<!– System.String –> |
<!– ThinkGeo.MapSuite.Core.FeatureSource –> Go Back
Equals(Object)
Return Value
| Return Type | Description |
|---|---|
| Boolean<!– System.Boolean –> |
Parameters
| Name | Type | Description |
|---|---|---|
| obj | Object<!– System.Object –> |
<!– System.Object –> Go Back
ExecuteNonQuery(String)
Return Value
| Return Type | Description |
|---|---|
| Int32<!– System.Int32 –> |
Parameters
| Name | Type | Description |
|---|---|---|
| sqlStatement | String<!– System.String –> |
<!– ThinkGeo.MapSuite.Core.FeatureSource –> Go Back
ExecuteQuery(String)
Return Value
| Return Type | Description |
|---|---|
| DataTable<!– System.Data.DataTable –> |
Parameters
| Name | Type | Description |
|---|---|---|
| sqlStatement | String<!– System.String –> |
<!– ThinkGeo.MapSuite.Core.FeatureSource –> Go Back
ExecuteScalar(String)
Return Value
| Return Type | Description |
|---|---|
| Object<!– System.Object –> |
Parameters
| Name | Type | Description |
|---|---|---|
| sqlStatement | String<!– System.String –> |
<!– ThinkGeo.MapSuite.Core.FeatureSource –> Go Back
GetAllFeatures(ReturningColumnsType)
Return Value
| Return Type | Description |
|---|---|
| Collection<Feature><!– System.Collections.ObjectModel.Collection{ThinkGeo.MapSuite.Core.Feature} –> |
Parameters
| Name | Type | Description |
|---|---|---|
| returningColumnNamesType | ReturningColumnsType<!– ThinkGeo.MapSuite.Core.ReturningColumnsType –> |
<!– ThinkGeo.MapSuite.Core.FeatureSource –> Go Back
GetAllFeatures(IEnumerable<String>)
Return Value
| Return Type | Description |
|---|---|
| Collection<Feature><!– System.Collections.ObjectModel.Collection{ThinkGeo.MapSuite.Core.Feature} –> |
Parameters
| Name | Type | Description |
|---|---|---|
| returningColumnNames | IEnumerable<String><!– System.Collections.Generic.IEnumerable{System.String} –> |
<!– ThinkGeo.MapSuite.Core.FeatureSource –> Go Back
GetBoundingBox()
Return Value
| Return Type | Description |
|---|---|
| RectangleShape<!– ThinkGeo.MapSuite.Core.RectangleShape –> |
Parameters
| Name | Type | Description |
|---|
<!– ThinkGeo.MapSuite.Core.FeatureSource –> Go Back
GetBoundingBoxById(String)
Return Value
| Return Type | Description |
|---|---|
| RectangleShape<!– ThinkGeo.MapSuite.Core.RectangleShape –> |
Parameters
| Name | Type | Description |
|---|---|---|
| id | String<!– System.String –> |
<!– ThinkGeo.MapSuite.Core.FeatureSource –> Go Back
GetBoundingBoxByIds(IEnumerable<String>)
Return Value
| Return Type | Description |
|---|---|
| RectangleShape<!– ThinkGeo.MapSuite.Core.RectangleShape –> |
Parameters
| Name | Type | Description |
|---|---|---|
| ids | IEnumerable<String><!– System.Collections.Generic.IEnumerable{System.String} –> |
<!– ThinkGeo.MapSuite.Core.FeatureSource –> Go Back
GetBoundingBoxesByIds(IEnumerable<String>)
Return Value
| Return Type | Description |
|---|---|
| Collection<RectangleShape><!– System.Collections.ObjectModel.Collection{ThinkGeo.MapSuite.Core.RectangleShape} –> |
Parameters
| Name | Type | Description |
|---|---|---|
| ids | IEnumerable<String><!– System.Collections.Generic.IEnumerable{System.String} –> |
<!– ThinkGeo.MapSuite.Core.FeatureSource –> Go Back
GetColumns()
Return Value
| Return Type | Description |
|---|---|
| Collection<FeatureSourceColumn><!– System.Collections.ObjectModel.Collection{ThinkGeo.MapSuite.Core.FeatureSourceColumn} –> |
Parameters
| Name | Type | Description |
|---|
<!– ThinkGeo.MapSuite.Core.FeatureSource –> Go Back
GetCount()
Return Value
| Return Type | Description |
|---|---|
| Int32<!– System.Int32 –> |
Parameters
| Name | Type | Description |
|---|
<!– ThinkGeo.MapSuite.Core.FeatureSource –> Go Back
GetFeatureById(String, IEnumerable<String>)
Return Value
| Return Type | Description |
|---|---|
| Feature<!– ThinkGeo.MapSuite.Core.Feature –> |
Parameters
| Name | Type | Description |
|---|---|---|
| id | String<!– System.String –> | |
| returningColumnNames | IEnumerable<String><!– System.Collections.Generic.IEnumerable{System.String} –> |
<!– ThinkGeo.MapSuite.Core.FeatureSource –> Go Back
GetFeatureById(String, ReturningColumnsType)
Return Value
| Return Type | Description |
|---|---|
| Feature<!– ThinkGeo.MapSuite.Core.Feature –> |
Parameters
| Name | Type | Description |
|---|---|---|
| id | String<!– System.String –> | |
| returningColumnNamesType | ReturningColumnsType<!– ThinkGeo.MapSuite.Core.ReturningColumnsType –> |
<!– ThinkGeo.MapSuite.Core.FeatureSource –> Go Back
GetFeatureClassNamesBySchema(String)
This method is used to get a list of feature class names in the specified feature schema name.
Return Value
| Return Type | Description |
|---|---|
| Collection<String><!– System.Collections.ObjectModel.Collection{System.String} –> |
Parameters
| Name | Type | Description |
|---|---|---|
| featureSchemaName | String<!– System.String –> | This parameter represents the feature schema name whose feature class names you want to list. |
<!– ThinkGeo.MapSuite.Core.ArcSdeFeatureSource –> Go Back
GetFeatureSchemaNames()
This method is used to get a list of feature schema names in the current datastore.
Return Value
| Return Type | Description |
|---|---|
| Collection<String><!– System.Collections.ObjectModel.Collection{System.String} –> | A list of schema names in the current datastore. |
Parameters
| Name | Type | Description |
|---|
<!– ThinkGeo.MapSuite.Core.ArcSdeFeatureSource –> Go Back
GetFeaturesByColumnValue(String, String, ReturningColumnsType)
Return Value
| Return Type | Description |
|---|---|
| Collection<Feature><!– System.Collections.ObjectModel.Collection{ThinkGeo.MapSuite.Core.Feature} –> |
Parameters
| Name | Type | Description |
|---|---|---|
| columnName | String<!– System.String –> | |
| columnValue | String<!– System.String –> | |
| returningColumnType | ReturningColumnsType<!– ThinkGeo.MapSuite.Core.ReturningColumnsType –> |
<!– ThinkGeo.MapSuite.Core.FeatureSource –> Go Back
GetFeaturesByColumnValue(String, String)
Return Value
| Return Type | Description |
|---|---|
| Collection<Feature><!– System.Collections.ObjectModel.Collection{ThinkGeo.MapSuite.Core.Feature} –> |
Parameters
| Name | Type | Description |
|---|---|---|
| columnName | String<!– System.String –> | |
| columnValue | String<!– System.String –> |
<!– ThinkGeo.MapSuite.Core.FeatureSource –> Go Back
GetFeaturesByColumnValue(String, String, IEnumerable<String>)
Return Value
| Return Type | Description |
|---|---|
| Collection<Feature><!– System.Collections.ObjectModel.Collection{ThinkGeo.MapSuite.Core.Feature} –> |
Parameters
| Name | Type | Description |
|---|---|---|
| columnName | String<!– System.String –> | |
| columnValue | String<!– System.String –> | |
| returningColumnNames | IEnumerable<String><!– System.Collections.Generic.IEnumerable{System.String} –> |
<!– ThinkGeo.MapSuite.Core.FeatureSource –> Go Back
GetFeaturesByIds(IEnumerable<String>, IEnumerable<String>)
Return Value
| Return Type | Description |
|---|---|
| Collection<Feature><!– System.Collections.ObjectModel.Collection{ThinkGeo.MapSuite.Core.Feature} –> |
Parameters
| Name | Type | Description |
|---|---|---|
| ids | IEnumerable<String><!– System.Collections.Generic.IEnumerable{System.String} –> | |
| returningColumnNames | IEnumerable<String><!– System.Collections.Generic.IEnumerable{System.String} –> |
<!– ThinkGeo.MapSuite.Core.FeatureSource –> Go Back
GetFeaturesByIds(IEnumerable<String>, ReturningColumnsType)
Return Value
| Return Type | Description |
|---|---|
| Collection<Feature><!– System.Collections.ObjectModel.Collection{ThinkGeo.MapSuite.Core.Feature} –> |
Parameters
| Name | Type | Description |
|---|---|---|
| ids | IEnumerable<String><!– System.Collections.Generic.IEnumerable{System.String} –> | |
| returningColumnNamesType | ReturningColumnsType<!– ThinkGeo.MapSuite.Core.ReturningColumnsType –> |
<!– ThinkGeo.MapSuite.Core.FeatureSource –> Go Back
GetFeaturesForDrawing(RectangleShape, Double, Double, ReturningColumnsType)
Return Value
| Return Type | Description |
|---|---|
| Collection<Feature><!– System.Collections.ObjectModel.Collection{ThinkGeo.MapSuite.Core.Feature} –> |
Parameters
| Name | Type | Description |
|---|---|---|
| boundingBox | RectangleShape<!– ThinkGeo.MapSuite.Core.RectangleShape –> | |
| screenWidth | Double<!– System.Double –> | |
| screenHeight | Double<!– System.Double –> | |
| returningColumnNamesType | ReturningColumnsType<!– ThinkGeo.MapSuite.Core.ReturningColumnsType –> |
<!– ThinkGeo.MapSuite.Core.FeatureSource –> Go Back
GetFeaturesForDrawing(RectangleShape, Double, Double, IEnumerable<String>)
Return Value
| Return Type | Description |
|---|---|
| Collection<Feature><!– System.Collections.ObjectModel.Collection{ThinkGeo.MapSuite.Core.Feature} –> |
Parameters
| Name | Type | Description |
|---|---|---|
| boundingBox | RectangleShape<!– ThinkGeo.MapSuite.Core.RectangleShape –> | |
| screenWidth | Double<!– System.Double –> | |
| screenHeight | Double<!– System.Double –> | |
| returningColumnNames | IEnumerable<String><!– System.Collections.Generic.IEnumerable{System.String} –> |
<!– ThinkGeo.MapSuite.Core.FeatureSource –> Go Back
GetFeaturesInsideBoundingBox(RectangleShape, IEnumerable<String>)
Return Value
| Return Type | Description |
|---|---|
| Collection<Feature><!– System.Collections.ObjectModel.Collection{ThinkGeo.MapSuite.Core.Feature} –> |
Parameters
| Name | Type | Description |
|---|---|---|
| boundingBox | RectangleShape<!– ThinkGeo.MapSuite.Core.RectangleShape –> | |
| returningColumnNames | IEnumerable<String><!– System.Collections.Generic.IEnumerable{System.String} –> |
<!– ThinkGeo.MapSuite.Core.FeatureSource –> Go Back
GetFeaturesInsideBoundingBox(RectangleShape, ReturningColumnsType)
Return Value
| Return Type | Description |
|---|---|
| Collection<Feature><!– System.Collections.ObjectModel.Collection{ThinkGeo.MapSuite.Core.Feature} –> |
Parameters
| Name | Type | Description |
|---|---|---|
| boundingBox | RectangleShape<!– ThinkGeo.MapSuite.Core.RectangleShape –> | |
| returningColumnNamesType | ReturningColumnsType<!– ThinkGeo.MapSuite.Core.ReturningColumnsType –> |
<!– ThinkGeo.MapSuite.Core.FeatureSource –> Go Back
GetFeaturesNearestTo(BaseShape, GeographyUnit, Int32, IEnumerable<String>)
Return Value
| Return Type | Description |
|---|---|
| Collection<Feature><!– System.Collections.ObjectModel.Collection{ThinkGeo.MapSuite.Core.Feature} –> |
Parameters
| Name | Type | Description |
|---|---|---|
| targetShape | BaseShape<!– ThinkGeo.MapSuite.Core.BaseShape –> | |
| unitOfFeatureSource | GeographyUnit<!– ThinkGeo.MapSuite.Core.GeographyUnit –> | |
| maxItemsToFind | Int32<!– System.Int32 –> | |
| returningColumnNames | IEnumerable<String><!– System.Collections.Generic.IEnumerable{System.String} –> |
<!– ThinkGeo.MapSuite.Core.FeatureSource –> Go Back
GetFeaturesNearestTo(BaseShape, GeographyUnit, Int32, IEnumerable<String>, Double, DistanceUnit)
Return Value
| Return Type | Description |
|---|---|
| Collection<Feature><!– System.Collections.ObjectModel.Collection{ThinkGeo.MapSuite.Core.Feature} –> |
Parameters
| Name | Type | Description |
|---|---|---|
| targetShape | BaseShape<!– ThinkGeo.MapSuite.Core.BaseShape –> | |
| unitOfData | GeographyUnit<!– ThinkGeo.MapSuite.Core.GeographyUnit –> | |
| maxItemsToFind | Int32<!– System.Int32 –> | |
| returningColumnNames | IEnumerable<String><!– System.Collections.Generic.IEnumerable{System.String} –> | |
| searchRadius | Double<!– System.Double –> | |
| unitOfSearchRadius | DistanceUnit<!– ThinkGeo.MapSuite.Core.DistanceUnit –> |
<!– ThinkGeo.MapSuite.Core.FeatureSource –> Go Back
GetFeaturesNearestTo(Feature, GeographyUnit, Int32, IEnumerable<String>)
Return Value
| Return Type | Description |
|---|---|
| Collection<Feature><!– System.Collections.ObjectModel.Collection{ThinkGeo.MapSuite.Core.Feature} –> |
Parameters
| Name | Type | Description |
|---|---|---|
| targetFeature | Feature<!– ThinkGeo.MapSuite.Core.Feature –> | |
| unitOfData | GeographyUnit<!– ThinkGeo.MapSuite.Core.GeographyUnit –> | |
| maxItemsToFind | Int32<!– System.Int32 –> | |
| returningColumnNames | IEnumerable<String><!– System.Collections.Generic.IEnumerable{System.String} –> |
<!– ThinkGeo.MapSuite.Core.FeatureSource –> Go Back
GetFeaturesNearestTo(Feature, GeographyUnit, Int32, IEnumerable<String>, Double, DistanceUnit)
Return Value
| Return Type | Description |
|---|---|
| Collection<Feature><!– System.Collections.ObjectModel.Collection{ThinkGeo.MapSuite.Core.Feature} –> |
Parameters
| Name | Type | Description |
|---|---|---|
| targetFeature | Feature<!– ThinkGeo.MapSuite.Core.Feature –> | |
| unitOfData | GeographyUnit<!– ThinkGeo.MapSuite.Core.GeographyUnit –> | |
| maxItemsToFind | Int32<!– System.Int32 –> | |
| returningColumnNames | IEnumerable<String><!– System.Collections.Generic.IEnumerable{System.String} –> | |
| searchRadius | Double<!– System.Double –> | |
| unitOfSearchRadius | DistanceUnit<!– ThinkGeo.MapSuite.Core.DistanceUnit –> |
<!– ThinkGeo.MapSuite.Core.FeatureSource –> Go Back
GetFeaturesNearestTo(Feature, GeographyUnit, Int32, ReturningColumnsType)
Return Value
| Return Type | Description |
|---|---|
| Collection<Feature><!– System.Collections.ObjectModel.Collection{ThinkGeo.MapSuite.Core.Feature} –> |
Parameters
| Name | Type | Description |
|---|---|---|
| targetFeature | Feature<!– ThinkGeo.MapSuite.Core.Feature –> | |
| unitOfData | GeographyUnit<!– ThinkGeo.MapSuite.Core.GeographyUnit –> | |
| maxItemsToFind | Int32<!– System.Int32 –> | |
| returningColumnNamesType | ReturningColumnsType<!– ThinkGeo.MapSuite.Core.ReturningColumnsType –> |
<!– ThinkGeo.MapSuite.Core.FeatureSource –> Go Back
GetFeaturesNearestTo(BaseShape, GeographyUnit, Int32, ReturningColumnsType)
Return Value
| Return Type | Description |
|---|---|
| Collection<Feature><!– System.Collections.ObjectModel.Collection{ThinkGeo.MapSuite.Core.Feature} –> |
Parameters
| Name | Type | Description |
|---|---|---|
| targetShape | BaseShape<!– ThinkGeo.MapSuite.Core.BaseShape –> | |
| unitOfData | GeographyUnit<!– ThinkGeo.MapSuite.Core.GeographyUnit –> | |
| maxItemsToFind | Int32<!– System.Int32 –> | |
| returningColumnNamesType | ReturningColumnsType<!– ThinkGeo.MapSuite.Core.ReturningColumnsType –> |
<!– ThinkGeo.MapSuite.Core.FeatureSource –> Go Back
GetFeaturesOutsideBoundingBox(RectangleShape, IEnumerable<String>)
Return Value
| Return Type | Description |
|---|---|
| Collection<Feature><!– System.Collections.ObjectModel.Collection{ThinkGeo.MapSuite.Core.Feature} –> |
Parameters
| Name | Type | Description |
|---|---|---|
| boundingBox | RectangleShape<!– ThinkGeo.MapSuite.Core.RectangleShape –> | |
| returningColumnNames | IEnumerable<String><!– System.Collections.Generic.IEnumerable{System.String} –> |
<!– ThinkGeo.MapSuite.Core.FeatureSource –> Go Back
GetFeaturesOutsideBoundingBox(RectangleShape, ReturningColumnsType)
Return Value
| Return Type | Description |
|---|---|
| Collection<Feature><!– System.Collections.ObjectModel.Collection{ThinkGeo.MapSuite.Core.Feature} –> |
Parameters
| Name | Type | Description |
|---|---|---|
| boundingBox | RectangleShape<!– ThinkGeo.MapSuite.Core.RectangleShape –> | |
| returningColumnNamesType | ReturningColumnsType<!– ThinkGeo.MapSuite.Core.ReturningColumnsType –> |
<!– ThinkGeo.MapSuite.Core.FeatureSource –> Go Back
GetFeaturesWithinDistanceOf(Feature, GeographyUnit, DistanceUnit, Double, IEnumerable<String>)
Return Value
| Return Type | Description |
|---|---|
| Collection<Feature><!– System.Collections.ObjectModel.Collection{ThinkGeo.MapSuite.Core.Feature} –> |
Parameters
| Name | Type | Description |
|---|---|---|
| targetFeature | Feature<!– ThinkGeo.MapSuite.Core.Feature –> | |
| unitOfData | GeographyUnit<!– ThinkGeo.MapSuite.Core.GeographyUnit –> | |
| distanceUnit | DistanceUnit<!– ThinkGeo.MapSuite.Core.DistanceUnit –> | |
| distance | Double<!– System.Double –> | |
| returningColumnNames | IEnumerable<String><!– System.Collections.Generic.IEnumerable{System.String} –> |
<!– ThinkGeo.MapSuite.Core.FeatureSource –> Go Back
GetFeaturesWithinDistanceOf(Feature, GeographyUnit, DistanceUnit, Double, ReturningColumnsType)
Return Value
| Return Type | Description |
|---|---|
| Collection<Feature><!– System.Collections.ObjectModel.Collection{ThinkGeo.MapSuite.Core.Feature} –> |
Parameters
| Name | Type | Description |
|---|---|---|
| targetFeature | Feature<!– ThinkGeo.MapSuite.Core.Feature –> | |
| unitOfData | GeographyUnit<!– ThinkGeo.MapSuite.Core.GeographyUnit –> | |
| distanceUnit | DistanceUnit<!– ThinkGeo.MapSuite.Core.DistanceUnit –> | |
| distance | Double<!– System.Double –> | |
| returningColumnNamesType | ReturningColumnsType<!– ThinkGeo.MapSuite.Core.ReturningColumnsType –> |
<!– ThinkGeo.MapSuite.Core.FeatureSource –> Go Back
GetFeaturesWithinDistanceOf(BaseShape, GeographyUnit, DistanceUnit, Double, IEnumerable<String>)
Return Value
| Return Type | Description |
|---|---|
| Collection<Feature><!– System.Collections.ObjectModel.Collection{ThinkGeo.MapSuite.Core.Feature} –> |
Parameters
| Name | Type | Description |
|---|---|---|
| targetShape | BaseShape<!– ThinkGeo.MapSuite.Core.BaseShape –> | |
| unitOfData | GeographyUnit<!– ThinkGeo.MapSuite.Core.GeographyUnit –> | |
| distanceUnit | DistanceUnit<!– ThinkGeo.MapSuite.Core.DistanceUnit –> | |
| distance | Double<!– System.Double –> | |
| returningColumnNames | IEnumerable<String><!– System.Collections.Generic.IEnumerable{System.String} –> |
<!– ThinkGeo.MapSuite.Core.FeatureSource –> Go Back
GetFeaturesWithinDistanceOf(BaseShape, GeographyUnit, DistanceUnit, Double, ReturningColumnsType)
Return Value
| Return Type | Description |
|---|---|
| Collection<Feature><!– System.Collections.ObjectModel.Collection{ThinkGeo.MapSuite.Core.Feature} –> |
Parameters
| Name | Type | Description |
|---|---|---|
| targetShape | BaseShape<!– ThinkGeo.MapSuite.Core.BaseShape –> | |
| unitOfData | GeographyUnit<!– ThinkGeo.MapSuite.Core.GeographyUnit –> | |
| distanceUnit | DistanceUnit<!– ThinkGeo.MapSuite.Core.DistanceUnit –> | |
| distance | Double<!– System.Double –> | |
| returningColumnNamesType | ReturningColumnsType<!– ThinkGeo.MapSuite.Core.ReturningColumnsType –> |
<!– ThinkGeo.MapSuite.Core.FeatureSource –> Go Back
GetFirstFeaturesWellKnownType()
Return Value
| Return Type | Description |
|---|---|
| WellKnownType<!– ThinkGeo.MapSuite.Core.WellKnownType –> |
Parameters
| Name | Type | Description |
|---|
<!– ThinkGeo.MapSuite.Core.FeatureSource –> Go Back
GetHashCode()
Return Value
| Return Type | Description |
|---|---|
| Int32<!– System.Int32 –> |
Parameters
| Name | Type | Description |
|---|
<!– System.Object –> Go Back
GetType()
Return Value
| Return Type | Description |
|---|---|
| Type<!– System.Type –> |
Parameters
| Name | Type | Description |
|---|
<!– System.Object –> Go Back
Open()
Return Value
| Return Type | Description |
|---|---|
| Void<!– System.Void –> |
Parameters
| Name | Type | Description |
|---|
<!– ThinkGeo.MapSuite.Core.FeatureSource –> Go Back
RefreshColumns()
Return Value
| Return Type | Description |
|---|---|
| Void<!– System.Void –> |
Parameters
| Name | Type | Description |
|---|
<!– ThinkGeo.MapSuite.Core.FeatureSource –> Go Back
RollbackTransaction()
Return Value
| Return Type | Description |
|---|---|
| Void<!– System.Void –> |
Parameters
| Name | Type | Description |
|---|
<!– ThinkGeo.MapSuite.Core.FeatureSource –> Go Back
SpatialQuery(Feature, QueryType, ReturningColumnsType)
Return Value
| Return Type | Description |
|---|---|
| Collection<Feature><!– System.Collections.ObjectModel.Collection{ThinkGeo.MapSuite.Core.Feature} –> |
Parameters
| Name | Type | Description |
|---|---|---|
| feature | Feature<!– ThinkGeo.MapSuite.Core.Feature –> | |
| queryType | QueryType<!– ThinkGeo.MapSuite.Core.QueryType –> | |
| returningColumnNamesType | ReturningColumnsType<!– ThinkGeo.MapSuite.Core.ReturningColumnsType –> |
<!– ThinkGeo.MapSuite.Core.FeatureSource –> Go Back
SpatialQuery(Feature, QueryType, IEnumerable<String>)
Return Value
| Return Type | Description |
|---|---|
| Collection<Feature><!– System.Collections.ObjectModel.Collection{ThinkGeo.MapSuite.Core.Feature} –> |
Parameters
| Name | Type | Description |
|---|---|---|
| feature | Feature<!– ThinkGeo.MapSuite.Core.Feature –> | |
| queryType | QueryType<!– ThinkGeo.MapSuite.Core.QueryType –> | |
| returningColumnNames | IEnumerable<String><!– System.Collections.Generic.IEnumerable{System.String} –> |
<!– ThinkGeo.MapSuite.Core.FeatureSource –> Go Back
SpatialQuery(BaseShape, QueryType, ReturningColumnsType)
Return Value
| Return Type | Description |
|---|---|
| Collection<Feature><!– System.Collections.ObjectModel.Collection{ThinkGeo.MapSuite.Core.Feature} –> |
Parameters
| Name | Type | Description |
|---|---|---|
| targetShape | BaseShape<!– ThinkGeo.MapSuite.Core.BaseShape –> | |
| queryType | QueryType<!– ThinkGeo.MapSuite.Core.QueryType –> | |
| returningColumnNamesType | ReturningColumnsType<!– ThinkGeo.MapSuite.Core.ReturningColumnsType –> |
<!– ThinkGeo.MapSuite.Core.FeatureSource –> Go Back
SpatialQuery(BaseShape, QueryType, IEnumerable<String>)
Return Value
| Return Type | Description |
|---|---|
| Collection<Feature><!– System.Collections.ObjectModel.Collection{ThinkGeo.MapSuite.Core.Feature} –> |
Parameters
| Name | Type | Description |
|---|---|---|
| targetShape | BaseShape<!– ThinkGeo.MapSuite.Core.BaseShape –> | |
| queryType | QueryType<!– ThinkGeo.MapSuite.Core.QueryType –> | |
| returningColumnNames | IEnumerable<String><!– System.Collections.Generic.IEnumerable{System.String} –> |
<!– ThinkGeo.MapSuite.Core.FeatureSource –> Go Back
ToString()
Return Value
| Return Type | Description |
|---|---|
| String<!– System.String –> |
Parameters
| Name | Type | Description |
|---|
<!– System.Object –> Go Back
UpdateColumn(String, FeatureSourceColumn)
Return Value
| Return Type | Description |
|---|---|
| Void<!– System.Void –> |
Parameters
| Name | Type | Description |
|---|---|---|
| columnName | String<!– System.String –> | |
| newFeatureSourceColumn | FeatureSourceColumn<!– ThinkGeo.MapSuite.Core.FeatureSourceColumn –> |
<!– ThinkGeo.MapSuite.Core.FeatureSource –> Go Back
UpdateFeature(Feature)
Return Value
| Return Type | Description |
|---|---|
| Void<!– System.Void –> |
Parameters
| Name | Type | Description |
|---|---|---|
| feature | Feature<!– ThinkGeo.MapSuite.Core.Feature –> |
<!– ThinkGeo.MapSuite.Core.FeatureSource –> Go Back
UpdateFeature(BaseShape, IDictionary<String, String>)
Return Value
| Return Type | Description |
|---|---|
| Void<!– System.Void –> |
Parameters
| Name | Type | Description |
|---|---|---|
| shape | BaseShape<!– ThinkGeo.MapSuite.Core.BaseShape –> | |
| columnValues | IDictionary<String,String><!– System.Collections.Generic.IDictionary{System.String,System.String} –> |
<!– ThinkGeo.MapSuite.Core.FeatureSource –> Go Back
UpdateFeature(BaseShape)
Return Value
| Return Type | Description |
|---|---|
| Void<!– System.Void –> |
Parameters
| Name | Type | Description |
|---|---|---|
| shape | BaseShape<!– ThinkGeo.MapSuite.Core.BaseShape –> |
<!– ThinkGeo.MapSuite.Core.FeatureSource –> Go Back
Protected Methods
CloneDeepCore()
Return Value
| Return Type | Description |
|---|---|
| FeatureSource<!– ThinkGeo.MapSuite.Core.FeatureSource –> |
Parameters
| Name | Type | Description |
|---|
<!– ThinkGeo.MapSuite.Core.FeatureSource –> Go Back
CloseCore()
This method closes the FeatureSource and releases any resources it was using.
Remarks
This protected virtual method is called from the concrete public method Close. The close method plays an important role in the life cycle of the FeatureSource. It may be called after drawing to release any memory and other resources that were allocated since the Open method was called.
If you override this method, it is recommended that you take the following things into account: This method may be called multiple times, so we suggest you write the method so that that a call to a closed FeatureSource is ignored and does not generate an error. We also suggest that in the Close you free all resources that have been opened. Remember that the object will not be destroyed, but will be re-opened possibly in the near future.
Return Value
| Return Type | Description |
|---|---|
| Void<!– System.Void –> |
Parameters
| Name | Type | Description |
|---|
<!– ThinkGeo.MapSuite.Core.FeatureSource(overriden) –> Go Back
CommitTransactionCore(TransactionBuffer)
Return Value
| Return Type | Description |
|---|---|
| TransactionResult<!– ThinkGeo.MapSuite.Core.TransactionResult –> |
Parameters
| Name | Type | Description |
|---|---|---|
| transactions | TransactionBuffer<!– ThinkGeo.MapSuite.Core.TransactionBuffer –> |
<!– ThinkGeo.MapSuite.Core.FeatureSource –> Go Back
ConvertToExternalProjection(IEnumerable<RectangleShape>)
Return Value
| Return Type | Description |
|---|---|
| Collection<RectangleShape><!– System.Collections.ObjectModel.Collection{ThinkGeo.MapSuite.Core.RectangleShape} –> |
Parameters
| Name | Type | Description |
|---|---|---|
| rectangles | IEnumerable<RectangleShape><!– System.Collections.Generic.IEnumerable{ThinkGeo.MapSuite.Core.RectangleShape} –> |
<!– ThinkGeo.MapSuite.Core.FeatureSource –> Go Back
ConvertToExternalProjection(RectangleShape)
Return Value
| Return Type | Description |
|---|---|
| RectangleShape<!– ThinkGeo.MapSuite.Core.RectangleShape –> |
Parameters
| Name | Type | Description |
|---|---|---|
| rectangle | RectangleShape<!– ThinkGeo.MapSuite.Core.RectangleShape –> |
<!– ThinkGeo.MapSuite.Core.FeatureSource –> Go Back
ConvertToExternalProjection(Feature)
Return Value
| Return Type | Description |
|---|---|
| Feature<!– ThinkGeo.MapSuite.Core.Feature –> |
Parameters
| Name | Type | Description |
|---|---|---|
| feature | Feature<!– ThinkGeo.MapSuite.Core.Feature –> |
<!– ThinkGeo.MapSuite.Core.FeatureSource –> Go Back
ConvertToExternalProjection(IEnumerable<Feature>)
Return Value
| Return Type | Description |
|---|---|
| Collection<Feature><!– System.Collections.ObjectModel.Collection{ThinkGeo.MapSuite.Core.Feature} –> |
Parameters
| Name | Type | Description |
|---|---|---|
| features | IEnumerable<Feature><!– System.Collections.Generic.IEnumerable{ThinkGeo.MapSuite.Core.Feature} –> |
<!– ThinkGeo.MapSuite.Core.FeatureSource –> Go Back
ConvertToInternalProjection(RectangleShape)
Return Value
| Return Type | Description |
|---|---|
| RectangleShape<!– ThinkGeo.MapSuite.Core.RectangleShape –> |
Parameters
| Name | Type | Description |
|---|---|---|
| rectangle | RectangleShape<!– ThinkGeo.MapSuite.Core.RectangleShape –> |
<!– ThinkGeo.MapSuite.Core.FeatureSource –> Go Back
ConvertToInternalProjection(IEnumerable<RectangleShape>)
Return Value
| Return Type | Description |
|---|---|
| Collection<RectangleShape><!– System.Collections.ObjectModel.Collection{ThinkGeo.MapSuite.Core.RectangleShape} –> |
Parameters
| Name | Type | Description |
|---|---|---|
| rectangles | IEnumerable<RectangleShape><!– System.Collections.Generic.IEnumerable{ThinkGeo.MapSuite.Core.RectangleShape} –> |
<!– ThinkGeo.MapSuite.Core.FeatureSource –> Go Back
ConvertToInternalProjection(IEnumerable<Feature>)
Return Value
| Return Type | Description |
|---|---|
| Collection<Feature><!– System.Collections.ObjectModel.Collection{ThinkGeo.MapSuite.Core.Feature} –> |
Parameters
| Name | Type | Description |
|---|---|---|
| features | IEnumerable<Feature><!– System.Collections.Generic.IEnumerable{ThinkGeo.MapSuite.Core.Feature} –> |
<!– ThinkGeo.MapSuite.Core.FeatureSource –> Go Back
ConvertToInternalProjection(BaseShape)
Return Value
| Return Type | Description |
|---|---|
| BaseShape<!– ThinkGeo.MapSuite.Core.BaseShape –> |
Parameters
| Name | Type | Description |
|---|---|---|
| baseShape | BaseShape<!– ThinkGeo.MapSuite.Core.BaseShape –> |
<!– ThinkGeo.MapSuite.Core.FeatureSource –> Go Back
ConvertToInternalProjection(Feature)
Return Value
| Return Type | Description |
|---|---|
| Feature<!– ThinkGeo.MapSuite.Core.Feature –> |
Parameters
| Name | Type | Description |
|---|---|---|
| feature | Feature<!– ThinkGeo.MapSuite.Core.Feature –> |
<!– ThinkGeo.MapSuite.Core.FeatureSource –> Go Back
ExecuteNonQueryCore(String)
Executes a SQL statement against a connection object.
Remarks
You can use ExecuteNonQuery to perform catalog operations (for example, querying the structure of a database or creating database objects such as tables), or to change the data in a database by executing UPDATE, INSERT, or DELETE statements. Although ExecuteNonQuery does not return any rows, any output parameters or return values mapped to parameters are populated with data. For UPDATE, INSERT, and DELETE statements, the return value is the number of rows affected by the command.
Return Value
| Return Type | Description |
|---|---|
| Int32<!– System.Int32 –> | The number of rows affected. |
Parameters
| Name | Type | Description |
|---|---|---|
| sqlStatement | String<!– System.String –> | The sqlStatement to be executed. |
<!– ThinkGeo.MapSuite.Core.FeatureSource(overriden) –> Go Back
ExecuteQueryCore(String)
Executes the query and returns the result returned by the query.
Remarks
Uses the executeScalar method to retrieve a single value from the database. This requires less code than using the executeQuery method and then performing the operations necessary to generate the single value using the data.
Return Value
| Return Type | Description |
|---|---|
| DataTable<!– System.Data.DataTable –> | The result set in the format of a dataTable. |
Parameters
| Name | Type | Description |
|---|---|---|
| sqlStatement | String<!– System.String –> | The sqlStatement to be executed. |
<!– ThinkGeo.MapSuite.Core.FeatureSource(overriden) –> Go Back
ExecuteScalarCore(String)
Return Value
| Return Type | Description |
|---|---|
| Object<!– System.Object –> |
Parameters
| Name | Type | Description |
|---|---|---|
| sqlStatement | String<!– System.String –> |
<!– ThinkGeo.MapSuite.Core.FeatureSource –> Go Back
Finalize()
Return Value
| Return Type | Description |
|---|---|
| Void<!– System.Void –> |
Parameters
| Name | Type | Description |
|---|
<!– System.Object –> Go Back
GetAllFeaturesCore(IEnumerable<String>)
This method returns all of the InternalFeatures in the FeatureSource.
Remarks
This method returns all of the InternalFeatures in the FeatureSource. You will not need to consider anything about pending transactions as this will be handled in the non-Core version of the method.
The main purpose of this method is to be the anchor for all of our default virtual implementations within this class. As the framework developers, we wanted to provide you the user with as much default virtual implementation as possible. To do this, we needed a way to get access to all of the features. For example, we wanted to create a default implementation for finding all of the InternalFeatures in a bounding box. Because this is an abstract class, we do not know the specifics of the underlying data or how its spatial indexes work. What we do know is that if we get all the records then we can brute force the answer. In this way, if you inherited form this class and only implemented this one method, we can provide default implementations for virtually every other API.
While this is nice for you the developer, if you decide to create your own FeatureSource it comes with a price. The price is that it is very inefficient. In the example we just discussed about finding all of the InternalFeatures in a bounding box, we would not want to look at every record to fulfill this method. Instead, we would want to override the GetFeaturesInsideBoundingBoxCore and implement specific code that would be fast. For example, in Oracle Spatial there is a specific SQL statement to do this operation very quickly. The same holds true with other specific FeatureSource examples.
Most default implementations in the FeatureSource call the GetFeaturesInsideBoundingBoxCore, which by default calls the GetAllFeaturesCore. It is our advice that if you create your own FeatureSource that you ALWAYS override the GetFeatureInsideBoundingBox. It will ensure that nearly every other API will operate efficiently. Please refer to the documentation on the specific API to determine what method it uses.
Return Value
| Return Type | Description |
|---|---|
| Collection<Feature><!– System.Collections.ObjectModel.Collection{ThinkGeo.MapSuite.Core.Feature} –> | The return value is a collection of all of the InternalFeatures in the FeatureSource. |
Parameters
| Name | Type | Description |
|---|---|---|
| returningColumnNames | IEnumerable<String><!– System.Collections.Generic.IEnumerable{System.String} –> | This parameter allows you to select the field names of the column data you wish to return with each Feature. |
<!– ThinkGeo.MapSuite.Core.FeatureSource(overriden) –> Go Back
GetBoundingBoxByIdCore(String)
Return Value
| Return Type | Description |
|---|---|
| RectangleShape<!– ThinkGeo.MapSuite.Core.RectangleShape –> |
Parameters
| Name | Type | Description |
|---|---|---|
| id | String<!– System.String –> |
<!– ThinkGeo.MapSuite.Core.FeatureSource –> Go Back
GetBoundingBoxCore()
This method returns the bounding box that encompasses all of the features in the FeatureSource.
Remarks
This protected virtual method is called from the concrete public method GetBoundingBox. It does not take into account any transaction activity, as this is the responsibility of the concrete public method GetBoundingBox. In this way, as a developer, if you choose to override this method you do not have to consider transactions at all.
The default implementation of GetBoundingBoxCore uses the GetAllRecordsCore method to calculate the bounding box of the FeatureSource. We strongly recommend that you provide your own implementation for this method that will be more efficient.
If you do not override this method, the method it will use to get the BoundingBox is to call the GetAllFeatureCore method and derive it from each feature. This is a very inefficient way to get the BoundingBox in most data sources. It is highly recommended that you override this method and replace it with a highly optimized version. For example, in a ShapeFile, the BoundingBox is in the main header of the file. Similarly, if you are using Oracle Spatial, you can execute a simple query to get the BoundingBox of all of the records without actually returning them. In these ways you can greatly improve the performance of this method.
Return Value
| Return Type | Description |
|---|---|
| RectangleShape<!– ThinkGeo.MapSuite.Core.RectangleShape –> | This method returns the bounding box that encompasses all of the features in the FeatureSource. |
Parameters
| Name | Type | Description |
|---|
<!– ThinkGeo.MapSuite.Core.FeatureSource(overriden) –> Go Back
GetColumnNamesInsideFeatureSource(IEnumerable<String>)
Return Value
| Return Type | Description |
|---|---|
| Collection<String><!– System.Collections.ObjectModel.Collection{System.String} –> |
Parameters
| Name | Type | Description |
|---|---|---|
| returningColumnNames | IEnumerable<String><!– System.Collections.Generic.IEnumerable{System.String} –> |
<!– ThinkGeo.MapSuite.Core.FeatureSource –> Go Back
GetColumnNamesOutsideFeatureSource(IEnumerable<String>)
Return Value
| Return Type | Description |
|---|---|
| Collection<String><!– System.Collections.ObjectModel.Collection{System.String} –> |
Parameters
| Name | Type | Description |
|---|---|---|
| returningColumnNames | IEnumerable<String><!– System.Collections.Generic.IEnumerable{System.String} –> |
<!– ThinkGeo.MapSuite.Core.FeatureSource –> Go Back
GetColumnsCore()
This method returns the columns available for the FeatureSource.
Remarks
As this is the abstract core version of the Columns method, it is intended to be overridden in an inherited version of the class. When overriding, you will be responsible for getting a list of all of the columns supported by the FeatureSource. In this way, the FeatureSource will know what columns are available and will remove any extra columns when making calls to other core methods. For example, if you have a FeatureSource that has three columns of information and the user calls a method that requests four columns of information (something they can do with custom fields), we will first compare what they are asking for to the results of the GetColumnsCore. This way we can strip out custom columns before calling other Core methods that are only responsible for returning data in the FeatureSource. For more information on custom fields, please see the documentation on the OnCustomFieldsFetch.
Return Value
| Return Type | Description |
|---|---|
| Collection<FeatureSourceColumn><!– System.Collections.ObjectModel.Collection{ThinkGeo.MapSuite.Core.FeatureSourceColumn} –> | This method returns the columns available for the FeatureSource. |
Parameters
| Name | Type | Description |
|---|
<!– ThinkGeo.MapSuite.Core.FeatureSource(overriden) –> Go Back
GetCountCore()
Return Value
| Return Type | Description |
|---|---|
| Int32<!– System.Int32 –> |
Parameters
| Name | Type | Description |
|---|
<!– ThinkGeo.MapSuite.Core.FeatureSource –> Go Back
GetFeaturesByColumnValueCore(String, String, IEnumerable<String>)
Return Value
| Return Type | Description |
|---|---|
| Collection<Feature><!– System.Collections.ObjectModel.Collection{ThinkGeo.MapSuite.Core.Feature} –> |
Parameters
| Name | Type | Description |
|---|---|---|
| columnName | String<!– System.String –> | |
| columnValue | String<!– System.String –> | |
| returningColumnNames | IEnumerable<String><!– System.Collections.Generic.IEnumerable{System.String} –> |
<!– ThinkGeo.MapSuite.Core.FeatureSource –> Go Back
GetFeaturesByIdsCore(IEnumerable<String>, IEnumerable<String>)
This method returns a collection of InternalFeatures by providing a group of Ids.
Remarks
This method returns a collection of InternalFeatures by providing a group of Ids. The internal implementation calls the GetAllFeaturesCore. For this reason, if you want an efficient version of this method then we highly suggest you override the GetFeaturesByIdsCore method and provide an optimized way to find a group of InternalFeatures by their Ids.
Return Value
| Return Type | Description |
|---|---|
| Collection<Feature><!– System.Collections.ObjectModel.Collection{ThinkGeo.MapSuite.Core.Feature} –> | This method returns a collection of InternalFeatures by providing a group of Ids. |
Parameters
| Name | Type | Description |
|---|---|---|
| ids | IEnumerable<String><!– System.Collections.Generic.IEnumerable{System.String} –> | This parameter represents the group of Ids that uniquely identify the InternalFeatures in the FeatureSource. |
| returningColumnNames | IEnumerable<String><!– System.Collections.Generic.IEnumerable{System.String} –> | This parameter allows you to select the field names of the column data you wish to return with each Feature. |
<!– ThinkGeo.MapSuite.Core.FeatureSource(overriden) –> Go Back
GetFeaturesForDrawingCore(RectangleShape, Double, Double, IEnumerable<String>)
Return Value
| Return Type | Description |
|---|---|
| Collection<Feature><!– System.Collections.ObjectModel.Collection{ThinkGeo.MapSuite.Core.Feature} –> |
Parameters
| Name | Type | Description |
|---|---|---|
| boundingBox | RectangleShape<!– ThinkGeo.MapSuite.Core.RectangleShape –> | |
| screenWidth | Double<!– System.Double –> | |
| screenHeight | Double<!– System.Double –> | |
| returningColumnNames | IEnumerable<String><!– System.Collections.Generic.IEnumerable{System.String} –> |
<!– ThinkGeo.MapSuite.Core.FeatureSource –> Go Back
GetFeaturesInsideBoundingBoxCore(RectangleShape, IEnumerable<String>)
This method returns all of the InternalFeatures of this FeatureSource that are inside of the specified bounding box.
Remarks
This method returns all of the InternalFeatures of this FeatureSource that are inside of the specified bounding box. If you are overriding this method, you will not need to consider anything about transactions as this is handled by the concrete version of this method.
The default implementation of GetFeaturesInsideBoundingBoxCore uses the GetAllRecordsCore method to determine which InternalFeatures are inside of the bounding box. We strongly recommend that you provide your own implementation for this method that will be more efficient. This is especially important for this method, as many other default virtual methods use this for their calculations. We highly recommend when you override this method that you use any spatial indexes you have at your disposal to make this method as fast as possible.
Return Value
| Return Type | Description |
|---|---|
| Collection<Feature><!– System.Collections.ObjectModel.Collection{ThinkGeo.MapSuite.Core.Feature} –> | The return value is a collection of all of the InternalFeatures that are inside of the bounding box. |
Parameters
| Name | Type | Description |
|---|---|---|
| boundingBox | RectangleShape<!– ThinkGeo.MapSuite.Core.RectangleShape –> | This parameter represents the bounding box you wish to find InternalFeatures inside of. |
| returningColumnNames | IEnumerable<String><!– System.Collections.Generic.IEnumerable{System.String} –> | This parameter allows you to select the field names of the column data you wish to return with each Feature. |
<!– ThinkGeo.MapSuite.Core.FeatureSource(overriden) –> Go Back
GetFeaturesNearestToCore(BaseShape, GeographyUnit, Int32, IEnumerable<String>)
Return Value
| Return Type | Description |
|---|---|
| Collection<Feature><!– System.Collections.ObjectModel.Collection{ThinkGeo.MapSuite.Core.Feature} –> |
Parameters
| Name | Type | Description |
|---|---|---|
| targetShape | BaseShape<!– ThinkGeo.MapSuite.Core.BaseShape –> | |
| unitOfData | GeographyUnit<!– ThinkGeo.MapSuite.Core.GeographyUnit –> | |
| maxItemsToFind | Int32<!– System.Int32 –> | |
| returningColumnNames | IEnumerable<String><!– System.Collections.Generic.IEnumerable{System.String} –> |
<!– ThinkGeo.MapSuite.Core.FeatureSource –> Go Back
GetFeaturesOutsideBoundingBoxCore(RectangleShape, IEnumerable<String>)
Return Value
| Return Type | Description |
|---|---|
| Collection<Feature><!– System.Collections.ObjectModel.Collection{ThinkGeo.MapSuite.Core.Feature} –> |
Parameters
| Name | Type | Description |
|---|---|---|
| boundingBox | RectangleShape<!– ThinkGeo.MapSuite.Core.RectangleShape –> | |
| returningColumnNames | IEnumerable<String><!– System.Collections.Generic.IEnumerable{System.String} –> |
<!– ThinkGeo.MapSuite.Core.FeatureSource –> Go Back
GetFeaturesWithinDistanceOfCore(BaseShape, GeographyUnit, DistanceUnit, Double, IEnumerable<String>)
Return Value
| Return Type | Description |
|---|---|
| Collection<Feature><!– System.Collections.ObjectModel.Collection{ThinkGeo.MapSuite.Core.Feature} –> |
Parameters
| Name | Type | Description |
|---|---|---|
| targetShape | BaseShape<!– ThinkGeo.MapSuite.Core.BaseShape –> | |
| unitOfData | GeographyUnit<!– ThinkGeo.MapSuite.Core.GeographyUnit –> | |
| distanceUnit | DistanceUnit<!– ThinkGeo.MapSuite.Core.DistanceUnit –> | |
| distance | Double<!– System.Double –> | |
| returningColumnNames | IEnumerable<String><!– System.Collections.Generic.IEnumerable{System.String} –> |
<!– ThinkGeo.MapSuite.Core.FeatureSource –> Go Back
GetFirstFeaturesWellKnownTypeCore()
Gets the shape type of the first record.
Return Value
| Return Type | Description |
|---|---|
| WellKnownType<!– ThinkGeo.MapSuite.Core.WellKnownType –> | The shape type of the first record. |
Parameters
| Name | Type | Description |
|---|
<!– ThinkGeo.MapSuite.Core.FeatureSource(overriden) –> Go Back
GetReturningColumnNames(ReturningColumnsType)
Return Value
| Return Type | Description |
|---|---|
| Collection<String><!– System.Collections.ObjectModel.Collection{System.String} –> |
Parameters
| Name | Type | Description |
|---|---|---|
| returningColumnNamesType | ReturningColumnsType<!– ThinkGeo.MapSuite.Core.ReturningColumnsType –> |
<!– ThinkGeo.MapSuite.Core.FeatureSource –> Go Back
MemberwiseClone()
Return Value
| Return Type | Description |
|---|---|
| Object<!– System.Object –> |
Parameters
| Name | Type | Description |
|---|
<!– System.Object –> Go Back
OnClosedFeatureSource(ClosedFeatureSourceEventArgs)
Return Value
| Return Type | Description |
|---|---|
| Void<!– System.Void –> |
Parameters
| Name | Type | Description |
|---|---|---|
| e | ClosedFeatureSourceEventArgs<!– ThinkGeo.MapSuite.Core.ClosedFeatureSourceEventArgs –> |
<!– ThinkGeo.MapSuite.Core.FeatureSource –> Go Back
OnClosingFeatureSource(ClosingFeatureSourceEventArgs)
Return Value
| Return Type | Description |
|---|---|
| Void<!– System.Void –> |
Parameters
| Name | Type | Description |
|---|---|---|
| e | ClosingFeatureSourceEventArgs<!– ThinkGeo.MapSuite.Core.ClosingFeatureSourceEventArgs –> |
<!– ThinkGeo.MapSuite.Core.FeatureSource –> Go Back
OnCommittedTransaction(CommittedTransactionEventArgs)
Return Value
| Return Type | Description |
|---|---|
| Void<!– System.Void –> |
Parameters
| Name | Type | Description |
|---|---|---|
| e | CommittedTransactionEventArgs<!– ThinkGeo.MapSuite.Core.CommittedTransactionEventArgs –> |
<!– ThinkGeo.MapSuite.Core.FeatureSource –> Go Back
OnCommittingTransaction(CommittingTransactionEventArgs)
Return Value
| Return Type | Description |
|---|---|
| Void<!– System.Void –> |
Parameters
| Name | Type | Description |
|---|---|---|
| e | CommittingTransactionEventArgs<!– ThinkGeo.MapSuite.Core.CommittingTransactionEventArgs –> |
<!– ThinkGeo.MapSuite.Core.FeatureSource –> Go Back
OnCustomColumnFetch(CustomColumnFetchEventArgs)
Return Value
| Return Type | Description |
|---|---|
| Void<!– System.Void –> |
Parameters
| Name | Type | Description |
|---|---|---|
| e | CustomColumnFetchEventArgs<!– ThinkGeo.MapSuite.Core.CustomColumnFetchEventArgs –> |
<!– ThinkGeo.MapSuite.Core.FeatureSource –> Go Back
OnDrawingProgressChanged(DrawingProgressChangedEventArgs)
Return Value
| Return Type | Description |
|---|---|
| Void<!– System.Void –> |
Parameters
| Name | Type | Description |
|---|---|---|
| e | DrawingProgressChangedEventArgs<!– ThinkGeo.MapSuite.Core.DrawingProgressChangedEventArgs –> |
<!– ThinkGeo.MapSuite.Core.FeatureSource –> Go Back
OnOpenedFeatureSource(OpenedFeatureSourceEventArgs)
Return Value
| Return Type | Description |
|---|---|
| Void<!– System.Void –> |
Parameters
| Name | Type | Description |
|---|---|---|
| e | OpenedFeatureSourceEventArgs<!– ThinkGeo.MapSuite.Core.OpenedFeatureSourceEventArgs –> |
<!– ThinkGeo.MapSuite.Core.FeatureSource –> Go Back
OnOpeningFeatureSource(OpeningFeatureSourceEventArgs)
Return Value
| Return Type | Description |
|---|---|
| Void<!– System.Void –> |
Parameters
| Name | Type | Description |
|---|---|---|
| e | OpeningFeatureSourceEventArgs<!– ThinkGeo.MapSuite.Core.OpeningFeatureSourceEventArgs –> |
<!– ThinkGeo.MapSuite.Core.FeatureSource –> Go Back
OpenCore()
This method opens the FeatureSource so that it is initialized and ready to use.
Remarks
This protected virtual method is called from the concrete public method Open. The Open method plays an important role, as it is responsible for initializing the FeatureSource. Most methods on the FeatureSource will throw an exception if the state of the FeatureSource is not opened. When the map draws each layer, it will open the FeatureSource as one of its first steps, then after it is finished drawing with that layer it will close it. In this way we are sure to release all resources used by the FeatureSource.
When implementing this virtual method, consider opening files for file-based sources, connecting to databases in the database-based sources and so on. You will get a chance to close these in the Close method of the FeatureSource.
Return Value
| Return Type | Description |
|---|---|
| Void<!– System.Void –> |
Parameters
| Name | Type | Description |
|---|
<!– ThinkGeo.MapSuite.Core.FeatureSource(overriden) –> Go Back
SpatialQueryCore(BaseShape, QueryType, IEnumerable<String>)
Return Value
| Return Type | Description |
|---|---|
| Collection<Feature><!– System.Collections.ObjectModel.Collection{ThinkGeo.MapSuite.Core.Feature} –> |
Parameters
| Name | Type | Description |
|---|---|---|
| targetShape | BaseShape<!– ThinkGeo.MapSuite.Core.BaseShape –> | |
| queryType | QueryType<!– ThinkGeo.MapSuite.Core.QueryType –> | |
| returningColumnNames | IEnumerable<String><!– System.Collections.Generic.IEnumerable{System.String} –> |
<!– ThinkGeo.MapSuite.Core.FeatureSource –> Go Back
Public Properties
CanExecuteSqlQuery
Return Value
| Return Type |
|---|
| Boolean<!– System.Boolean –> |
<!– ThinkGeo.MapSuite.Core.FeatureSource –> Go Back
CanModifyColumnStructure
Return Value
| Return Type |
|---|
| Boolean<!– System.Boolean –> |
<!– ThinkGeo.MapSuite.Core.FeatureSource –> Go Back
ConnectionString
This property gets and sets the connection string used to connect to the ArcSDE server.
Return Value
| Return Type |
|---|
| String<!– System.String –> |
<!– ThinkGeo.MapSuite.Core.ArcSdeFeatureSource –> Go Back
Datastore
This property gets and sets the datastore of the ArcSDE server.
Return Value
| Return Type |
|---|
| String<!– System.String –> |
<!– ThinkGeo.MapSuite.Core.ArcSdeFeatureSource –> Go Back
FeatureClassName
This property gets and sets the name of the feature class in the feature schema.
Return Value
| Return Type |
|---|
| String<!– System.String –> |
<!– ThinkGeo.MapSuite.Core.ArcSdeFeatureSource –> Go Back
FeatureIdsToExclude
Return Value
| Return Type |
|---|
| Collection<String><!– System.Collections.ObjectModel.Collection{System.String} –> |
<!– ThinkGeo.MapSuite.Core.FeatureSource –> Go Back
FeatureSchemaName
This property gets and sets the name of the feature schema in the datastore.
Return Value
| Return Type |
|---|
| String<!– System.String –> |
<!– ThinkGeo.MapSuite.Core.ArcSdeFeatureSource –> Go Back
GeoCache
Return Value
| Return Type |
|---|
| FeatureCache<!– ThinkGeo.MapSuite.Core.FeatureCache –> |
<!– ThinkGeo.MapSuite.Core.FeatureSource –> Go Back
GeometryColumnName
This property gets and sets the name of the column that holds the geometry.
Return Value
| Return Type |
|---|
| String<!– System.String –> |
<!– ThinkGeo.MapSuite.Core.ArcSdeFeatureSource –> Go Back
IdColumnName
This property gets and sets the name of the column that holds the unique feature Id.
Return Value
| Return Type |
|---|
| String<!– System.String –> |
<!– ThinkGeo.MapSuite.Core.ArcSdeFeatureSource –> Go Back
Instance
This property gets and sets the port of the ArcSDE server.
Return Value
| Return Type |
|---|
| String<!– System.String –> |
<!– ThinkGeo.MapSuite.Core.ArcSdeFeatureSource –> Go Back
IsEditable
Return Value
| Return Type |
|---|
| Boolean<!– System.Boolean –> |
<!– ThinkGeo.MapSuite.Core.FeatureSource –> Go Back
IsInTransaction
Return Value
| Return Type |
|---|
| Boolean<!– System.Boolean –> |
<!– ThinkGeo.MapSuite.Core.FeatureSource –> Go Back
IsOpen
Return Value
| Return Type |
|---|
| Boolean<!– System.Boolean –> |
<!– ThinkGeo.MapSuite.Core.FeatureSource –> Go Back
IsTransactionLive
Return Value
| Return Type |
|---|
| Boolean<!– System.Boolean –> |
<!– ThinkGeo.MapSuite.Core.FeatureSource –> Go Back
MaxRecordsToDraw
Return Value
| Return Type |
|---|
| Int32<!– System.Int32 –> |
<!– ThinkGeo.MapSuite.Core.FeatureSource –> Go Back
Password
This property gets and sets the password for the ArcSDE server.
Return Value
| Return Type |
|---|
| String<!– System.String –> |
<!– ThinkGeo.MapSuite.Core.ArcSdeFeatureSource –> Go Back
Projection
Return Value
| Return Type |
|---|
| Projection<!– ThinkGeo.MapSuite.Core.Projection –> |
<!– ThinkGeo.MapSuite.Core.FeatureSource –> Go Back
ProviderName
This property gets the name of the provider for ArcSDE, which used by FDO.
Return Value
| Return Type |
|---|
| String<!– System.String –> |
<!– ThinkGeo.MapSuite.Core.ArcSdeFeatureSource –> Go Back
Server
This property gets and sets the machine name or IP address of the ArcSDE server.
Return Value
| Return Type |
|---|
| String<!– System.String –> |
<!– ThinkGeo.MapSuite.Core.ArcSdeFeatureSource –> Go Back
TransactionBuffer
Return Value
| Return Type |
|---|
| TransactionBuffer<!– ThinkGeo.MapSuite.Core.TransactionBuffer –> |
<!– ThinkGeo.MapSuite.Core.FeatureSource –> Go Back
Username
This property gets and sets the username for the ArcSDE server.
Return Value
| Return Type |
|---|
| String<!– System.String –> |
<!– ThinkGeo.MapSuite.Core.ArcSdeFeatureSource –> Go Back
Protected Properties
CanExecuteSqlQueryCore
This property specifies whether the FeatureSource can execute a SQL query or not. If it is false, then it will throw an exception when you call the APIs ExecuteScalar, ExecuteNonQuery or ExecuteQuery. This override will make it true.
Return Value
| Return Type |
|---|
| Boolean<!– System.Boolean –> |
<!– ThinkGeo.MapSuite.Core.FeatureSource(overriden) –> Go Back
CanModifyColumnStructureCore
Return Value
| Return Type |
|---|
| Boolean<!– System.Boolean –> |
<!– ThinkGeo.MapSuite.Core.FeatureSource –> Go Back
FeatureSourceColumns
Return Value
| Return Type |
|---|
| Collection<FeatureSourceColumn><!– System.Collections.ObjectModel.Collection{ThinkGeo.MapSuite.Core.FeatureSourceColumn} –> |
<!– ThinkGeo.MapSuite.Core.FeatureSource –> Go Back
IsOpenCore
Return Value
| Return Type |
|---|
| Boolean<!– System.Boolean –> |
<!– ThinkGeo.MapSuite.Core.FeatureSource –> Go Back
Public Events
ClosedFeatureSource
Event Arguments
| Event Arguments |
|---|
| ClosedFeatureSourceEventArgs<!– ThinkGeo.MapSuite.Core.ClosedFeatureSourceEventArgs –> |
<!– ThinkGeo.MapSuite.Core.FeatureSource –> Go Back
ClosingFeatureSource
Event Arguments
| Event Arguments |
|---|
| ClosingFeatureSourceEventArgs<!– ThinkGeo.MapSuite.Core.ClosingFeatureSourceEventArgs –> |
<!– ThinkGeo.MapSuite.Core.FeatureSource –> Go Back
CommittedTransaction
Event Arguments
| Event Arguments |
|---|
| CommittedTransactionEventArgs<!– ThinkGeo.MapSuite.Core.CommittedTransactionEventArgs –> |
<!– ThinkGeo.MapSuite.Core.FeatureSource –> Go Back
CommittingTransaction
Event Arguments
| Event Arguments |
|---|
| CommittingTransactionEventArgs<!– ThinkGeo.MapSuite.Core.CommittingTransactionEventArgs –> |
<!– ThinkGeo.MapSuite.Core.FeatureSource –> Go Back
CustomColumnFetch
Event Arguments
| Event Arguments |
|---|
| CustomColumnFetchEventArgs<!– ThinkGeo.MapSuite.Core.CustomColumnFetchEventArgs –> |
<!– ThinkGeo.MapSuite.Core.FeatureSource –> Go Back
DrawingProgressChanged
Event Arguments
| Event Arguments |
|---|
| DrawingProgressChangedEventArgs<!– ThinkGeo.MapSuite.Core.DrawingProgressChangedEventArgs –> |
<!– ThinkGeo.MapSuite.Core.FeatureSource –> Go Back
OpenedFeatureSource
Event Arguments
| Event Arguments |
|---|
| OpenedFeatureSourceEventArgs<!– ThinkGeo.MapSuite.Core.OpenedFeatureSourceEventArgs –> |
<!– ThinkGeo.MapSuite.Core.FeatureSource –> Go Back
OpeningFeatureSource
Event Arguments
| Event Arguments |
|---|
| OpeningFeatureSourceEventArgs<!– ThinkGeo.MapSuite.Core.OpeningFeatureSourceEventArgs –> |
<!– ThinkGeo.MapSuite.Core.FeatureSource –> Go Back
NOTOC MapSuiteSpatialDataExtension ThinkGeo.MapSuite.Core UpdateDocumentation
thinkgeo.mapsuite.core.arcsdefeaturesource.txt · Last modified: 2017/03/16 21:59 (external edit)