User Tools

Site Tools


thinkgeo.mapsuite.portablecore.tinygeofeaturesource

ThinkGeo.MapSuite.Core.TinyGeoFeatureSource

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.

This class represents a FeatureSource of TinyGeo File by ThinkGeo.

Inheritance Hierarchy

  • System.Object
    • ThinkGeo.MapSuite.Core.FeatureSource
      • ThinkGeo.MapSuite.Core.TinyGeoFeatureSource

Members Summary

Public Constructors

TinyGeoFeatureSource()

  • This is the class constructor.
Remarks
  • None
Parameters

TinyGeoFeatureSource(String)

  • This is the class constructor.
Remarks
  • None
Parameters
  • tinyGeoPathFileName
    • Type:String
    • Description:This parameter represents the path and file name to the .tgeo file.

TinyGeoFeatureSource(String,String)

  • This is the class constructor.
Remarks
  • None
Parameters
  • tinyGeoPathFileName
    • Type:String
    • Description:This parameter represents the path and file name to the .tgeo file.
  • password
    • Type:String
    • Description:This parameter represents the password to the .tgeo file.

Protected Constructors

Public Methods

GetTinyGeoFileType()

  • N/A
Remarks
  • N/A
Return Value
Parameters

GetBoundingBoxByIds(IEnumerable<String>)

  • N/A
Remarks
  • N/A
Return Value
Parameters
  • ids
    • Type:IEnumerable<String>
    • Description:N/A

GetBoundingBoxesByIds(IEnumerable<String>)

  • N/A
Remarks
  • N/A
Return Value
Parameters
  • ids
    • Type:IEnumerable<String>
    • Description:N/A

GetFirstFeaturesWellKnownType()

  • N/A
Remarks
  • N/A
Return Value
Parameters

CanGetBoundingBoxQuickly()

  • N/A
Remarks
  • N/A
Return Value
  • Type:Boolean
  • Description:N/A
Parameters

CanGetCountQuickly()

  • N/A
Remarks
  • N/A
Return Value
  • Type:Boolean
  • Description:N/A
Parameters

GetDistinctColumnValues(String)

  • N/A
Remarks
  • N/A
Return Value
Parameters
  • columnName
    • Type:String
    • Description:N/A

GetAllFeatures(ReturningColumnsType,Int32)

  • N/A
Remarks
  • N/A
Return Value
  • Type:Collection<Feature>
  • Description:N/A
Parameters
  • startIndex
    • Type:Int32
    • Description:N/A

GetAllFeatures(ReturningColumnsType,Int32,Int32)

  • N/A
Remarks
  • N/A
Return Value
  • Type:Collection<Feature>
  • Description:N/A
Parameters
  • startIndex
    • Type:Int32
    • Description:N/A
  • takeCount
    • Type:Int32
    • Description:N/A

GetAllFeatures(IEnumerable<String>,Int32,Int32)

  • N/A
Remarks
  • N/A
Return Value
  • Type:Collection<Feature>
  • Description:N/A
Parameters
  • returningColumnNames
    • Type:IEnumerable<String>
    • Description:N/A
  • startIndex
    • Type:Int32
    • Description:N/A
  • takeCount
    • Type:Int32
    • Description:N/A

Close()

  • N/A
Remarks
  • N/A
Return Value
  • Type:Void
  • Description:N/A
Parameters

BeginTransaction()

  • N/A
Remarks
  • N/A
Return Value
  • Type:Void
  • Description:N/A
Parameters

AddFeature(Feature)

  • N/A
Remarks
  • N/A
Return Value
  • Type:String
  • Description:N/A
Parameters
  • feature

AddFeature(BaseShape)

  • N/A
Remarks
  • N/A
Return Value
  • Type:String
  • Description:N/A
Parameters

AddFeature(BaseShape,IDictionary<String,String>)

  • N/A
Remarks
  • N/A
Return Value
  • Type:String
  • Description:N/A
Parameters
  • columnValues
    • Type:IDictionary<String,String>
    • Description:N/A

DeleteFeature(String)

  • N/A
Remarks
  • N/A
Return Value
  • Type:Void
  • Description:N/A
Parameters
  • id
    • Type:String
    • Description:N/A

UpdateFeature(Feature)

  • N/A
Remarks
  • N/A
Return Value
  • Type:Void
  • Description:N/A
Parameters
  • feature

UpdateFeature(BaseShape)

  • N/A
Remarks
  • N/A
Return Value
  • Type:Void
  • Description:N/A
Parameters

UpdateFeature(BaseShape,IDictionary<String,String>)

  • N/A
Remarks
  • N/A
Return Value
  • Type:Void
  • Description:N/A
Parameters
  • columnValues
    • Type:IDictionary<String,String>
    • Description:N/A

RollbackTransaction()

  • N/A
Remarks
  • N/A
Return Value
  • Type:Void
  • Description:N/A
Parameters

CommitTransaction()

  • N/A
Remarks
  • N/A
Return Value
Parameters

AddColumn(FeatureSourceColumn)

  • N/A
Remarks
  • N/A
Return Value
  • Type:Void
  • Description:N/A
Parameters

DeleteColumn(String)

  • N/A
Remarks
  • N/A
Return Value
  • Type:Void
  • Description:N/A
Parameters
  • columnName
    • Type:String
    • Description:N/A

UpdateColumn(String,FeatureSourceColumn)

  • N/A
Remarks
  • N/A
Return Value
  • Type:Void
  • Description:N/A
Parameters
  • columnName
    • Type:String
    • Description:N/A

GetAllFeatures(IEnumerable<String>)

  • N/A
Remarks
  • N/A
Return Value
  • Type:Collection<Feature>
  • Description:N/A
Parameters
  • returningColumnNames
    • Type:IEnumerable<String>
    • Description:N/A

GetAllFeatures(ReturningColumnsType)

  • N/A
Remarks
  • N/A
Return Value
  • Type:Collection<Feature>
  • Description:N/A
Parameters

GetFeaturesOutsideBoundingBox(RectangleShape,IEnumerable<String>)

  • N/A
Remarks
  • N/A
Return Value
  • Type:Collection<Feature>
  • Description:N/A
Parameters
  • returningColumnNames
    • Type:IEnumerable<String>
    • Description:N/A

GetFeaturesOutsideBoundingBox(RectangleShape,ReturningColumnsType)

  • N/A
Remarks
  • N/A
Return Value
  • Type:Collection<Feature>
  • Description:N/A
Parameters

GetFeaturesInsideBoundingBox(RectangleShape,IEnumerable<String>)

  • N/A
Remarks
  • N/A
Return Value
  • Type:Collection<Feature>
  • Description:N/A
Parameters
  • returningColumnNames
    • Type:IEnumerable<String>
    • Description:N/A

GetFeaturesInsideBoundingBox(RectangleShape,ReturningColumnsType)

  • N/A
Remarks
  • N/A
Return Value
  • Type:Collection<Feature>
  • Description:N/A
Parameters

GetFeaturesForDrawing(RectangleShape,Double,Double,IEnumerable<String>)

  • N/A
Remarks
  • N/A
Return Value
  • Type:Collection<Feature>
  • Description:N/A
Parameters
  • screenWidth
    • Type:Double
    • Description:N/A
  • screenHeight
    • Type:Double
    • Description:N/A
  • returningColumnNames
    • Type:IEnumerable<String>
    • Description:N/A

GetFeaturesForDrawing(RectangleShape,Double,Double,ReturningColumnsType)

  • N/A
Remarks
  • N/A
Return Value
  • Type:Collection<Feature>
  • Description:N/A
Parameters
  • screenWidth
    • Type:Double
    • Description:N/A
  • screenHeight
    • Type:Double
    • Description:N/A

SpatialQuery(BaseShape,QueryType,IEnumerable<String>)

  • N/A
Remarks
  • N/A
Return Value
  • Type:Collection<Feature>
  • Description:N/A
Parameters
  • returningColumnNames
    • Type:IEnumerable<String>
    • Description:N/A

SpatialQuery(BaseShape,QueryType,ReturningColumnsType)

  • N/A
Remarks
  • N/A
Return Value
  • Type:Collection<Feature>
  • Description:N/A
Parameters

SpatialQuery(Feature,QueryType,IEnumerable<String>)

  • N/A
Remarks
  • N/A
Return Value
  • Type:Collection<Feature>
  • Description:N/A
Parameters
  • feature
  • returningColumnNames
    • Type:IEnumerable<String>
    • Description:N/A

SpatialQuery(Feature,QueryType,ReturningColumnsType)

  • N/A
Remarks
  • N/A
Return Value
  • Type:Collection<Feature>
  • Description:N/A
Parameters
  • feature

GetFeaturesNearestTo(BaseShape,GeographyUnit,Int32,IEnumerable<String>)

  • N/A
Remarks
  • N/A
Return Value
  • Type:Collection<Feature>
  • Description:N/A
Parameters
  • maxItemsToFind
    • Type:Int32
    • Description:N/A
  • returningColumnNames
    • Type:IEnumerable<String>
    • Description:N/A

GetFeaturesNearestTo(BaseShape,GeographyUnit,Int32,ReturningColumnsType)

  • N/A
Remarks
  • N/A
Return Value
  • Type:Collection<Feature>
  • Description:N/A
Parameters
  • maxItemsToFind
    • Type:Int32
    • Description:N/A

GetFeaturesNearestTo(Feature,GeographyUnit,Int32,IEnumerable<String>)

  • N/A
Remarks
  • N/A
Return Value
  • Type:Collection<Feature>
  • Description:N/A
Parameters
  • targetFeature
  • maxItemsToFind
    • Type:Int32
    • Description:N/A
  • returningColumnNames
    • Type:IEnumerable<String>
    • Description:N/A

GetFeaturesNearestTo(Feature,GeographyUnit,Int32,ReturningColumnsType)

  • N/A
Remarks
  • N/A
Return Value
  • Type:Collection<Feature>
  • Description:N/A
Parameters
  • targetFeature
  • maxItemsToFind
    • Type:Int32
    • Description:N/A

GetFeaturesNearestTo(BaseShape,GeographyUnit,Int32,IEnumerable<String>,Double,DistanceUnit)

  • N/A
Remarks
  • N/A
Return Value
  • Type:Collection<Feature>
  • Description:N/A
Parameters
  • maxItemsToFind
    • Type:Int32
    • Description:N/A
  • returningColumnNames
    • Type:IEnumerable<String>
    • Description:N/A
  • searchRadius
    • Type:Double
    • Description:N/A

GetFeaturesNearestTo(Feature,GeographyUnit,Int32,IEnumerable<String>,Double,DistanceUnit)

  • N/A
Remarks
  • N/A
Return Value
  • Type:Collection<Feature>
  • Description:N/A
Parameters
  • targetFeature
  • maxItemsToFind
    • Type:Int32
    • Description:N/A
  • returningColumnNames
    • Type:IEnumerable<String>
    • Description:N/A
  • searchRadius
    • Type:Double
    • Description:N/A

GetFeaturesWithinDistanceOf(BaseShape,GeographyUnit,DistanceUnit,Double,IEnumerable<String>)

  • N/A
Remarks
  • N/A
Return Value
  • Type:Collection<Feature>
  • Description:N/A
Parameters
  • distance
    • Type:Double
    • Description:N/A
  • returningColumnNames
    • Type:IEnumerable<String>
    • Description:N/A

GetFeaturesWithinDistanceOf(BaseShape,GeographyUnit,DistanceUnit,Double,ReturningColumnsType)

  • N/A
Remarks
  • N/A
Return Value
  • Type:Collection<Feature>
  • Description:N/A
Parameters
  • distance
    • Type:Double
    • Description:N/A

GetFeaturesWithinDistanceOf(Feature,GeographyUnit,DistanceUnit,Double,IEnumerable<String>)

  • N/A
Remarks
  • N/A
Return Value
  • Type:Collection<Feature>
  • Description:N/A
Parameters
  • targetFeature
  • distance
    • Type:Double
    • Description:N/A
  • returningColumnNames
    • Type:IEnumerable<String>
    • Description:N/A

GetFeaturesWithinDistanceOf(Feature,GeographyUnit,DistanceUnit,Double,ReturningColumnsType)

  • N/A
Remarks
  • N/A
Return Value
  • Type:Collection<Feature>
  • Description:N/A
Parameters
  • targetFeature
  • distance
    • Type:Double
    • Description:N/A

GetFeatureById(String,IEnumerable<String>)

  • N/A
Remarks
  • N/A
Return Value
Parameters
  • id
    • Type:String
    • Description:N/A
  • returningColumnNames
    • Type:IEnumerable<String>
    • Description:N/A

GetFeatureById(String,ReturningColumnsType)

  • N/A
Remarks
  • N/A
Return Value
Parameters
  • id
    • Type:String
    • Description:N/A

GetFeaturesByIds(IEnumerable<String>,IEnumerable<String>)

  • N/A
Remarks
  • N/A
Return Value
  • Type:Collection<Feature>
  • Description:N/A
Parameters
  • ids
    • Type:IEnumerable<String>
    • Description:N/A
  • returningColumnNames
    • Type:IEnumerable<String>
    • Description:N/A

GetFeaturesByIds(IEnumerable<String>,ReturningColumnsType)

  • N/A
Remarks
  • N/A
Return Value
  • Type:Collection<Feature>
  • Description:N/A
Parameters
  • ids
    • Type:IEnumerable<String>
    • Description:N/A

GetBoundingBoxById(String)

  • N/A
Remarks
  • N/A
Return Value
Parameters
  • id
    • Type:String
    • Description:N/A

ExecuteNonQuery(String)

  • N/A
Remarks
  • N/A
Return Value
  • Type:Int32
  • Description:N/A
Parameters
  • sqlStatement
    • Type:String
    • Description:N/A

GetFeaturesByColumnValue(String,String,ReturningColumnsType)

  • N/A
Remarks
  • N/A
Return Value
  • Type:Collection<Feature>
  • Description:N/A
Parameters
  • columnName
    • Type:String
    • Description:N/A
  • columnValue
    • Type:String
    • Description:N/A

GetFeaturesByColumnValue(String,String,IEnumerable<String>)

  • N/A
Remarks
  • N/A
Return Value
  • Type:Collection<Feature>
  • Description:N/A
Parameters
  • columnName
    • Type:String
    • Description:N/A
  • columnValue
    • Type:String
    • Description:N/A
  • returningColumnNames
    • Type:IEnumerable<String>
    • Description:N/A

GetFeaturesByColumnValue(String,String)

  • N/A
Remarks
  • N/A
Return Value
  • Type:Collection<Feature>
  • Description:N/A
Parameters
  • columnName
    • Type:String
    • Description:N/A
  • columnValue
    • Type:String
    • Description:N/A

ExecuteScalar(String)

  • N/A
Remarks
  • N/A
Return Value
  • Type:Object
  • Description:N/A
Parameters
  • sqlStatement
    • Type:String
    • Description:N/A

ExecuteQuery(String)

  • N/A
Remarks
  • N/A
Return Value
Parameters
  • sqlStatement
    • Type:String
    • Description:N/A

GetColumns()

  • N/A
Remarks
  • N/A
Return Value
Parameters

RefreshColumns()

  • N/A
Remarks
  • N/A
Return Value
  • Type:Void
  • Description:N/A
Parameters

GetCount()

  • N/A
Remarks
  • N/A
Return Value
  • Type:Int32
  • Description:N/A
Parameters

GetBoundingBox()

  • N/A
Remarks
  • N/A
Return Value
Parameters

CloneDeep()

  • N/A
Remarks
  • N/A
Return Value
Parameters

Open()

  • N/A
Remarks
  • N/A
Return Value
  • Type:Void
  • Description:N/A
Parameters

ToString()

  • N/A
Remarks
  • N/A
Return Value
  • Type:String
  • Description:N/A
Parameters

Equals(Object)

  • N/A
Remarks
  • N/A
Return Value
  • Type:Boolean
  • Description:N/A
Parameters
  • obj
    • Type:Object
    • Description:N/A

GetHashCode()

  • N/A
Remarks
  • N/A
Return Value
  • Type:Int32
  • Description:N/A
Parameters

GetType()

  • N/A
Remarks
  • N/A
Return Value
  • Type:Type
  • Description:N/A
Parameters

CreateTinyGeoFile(String,String,GeographyUnit,ReturningColumnsType)

  • Static API to create a new TinyGeo file from an existed shape file.
Remarks
  • N/A
Return Value
  • Type:Void
  • Description:N/A
Parameters
  • tinyGeoPathFileName
    • Type:String
    • Description:This parameter specifies the file name for the target TinyGeo file.
  • shapePathFileName
    • Type:String
    • Description:This parameter specifies the file name for the existed shape file.
  • unitOfData
    • Description:This parameter specifies the Geography Unit of the data.
  • returningColumnType
    • Description:This parameter specifies whether the columns info in shape file will be copied to TinyGeo file.

CreateTinyGeoFile(String,String,GeographyUnit,ReturningColumnsType,Double)

  • Static API to create a new TinyGeo file from an existed shape file.
Remarks
  • N/A
Return Value
  • Type:Void
  • Description:N/A
Parameters
  • tinyGeoPathFileName
    • Type:String
    • Description:This parameter specifies the file name for the target TinyGeo file.
  • shapePathFileName
    • Type:String
    • Description:This parameter specifies the file name for the existed shape file.
  • unitOfData
    • Description:This parameter specifies the Geography Unit of the data.
  • returningColumnType
    • Description:This parameter specifies whether the columns info in shape file will be copied to TinyGeo file.
  • precisionInMeter
    • Type:Double
    • Description:This parameter spcifies in double what is the precision in Meter of the target TinyGeo file.

CreateTinyGeoFile(String,String,GeographyUnit,ReturningColumnsType,String)

  • Static API to create a new TinyGeo file from an existed shape file.
Remarks
  • N/A
Return Value
  • Type:Void
  • Description:N/A
Parameters
  • tinyGeoPathFileName
    • Type:String
    • Description:This parameter specifies the file name for the target TinyGeo file.
  • shapePathFileName
    • Type:String
    • Description:This parameter specifies the file name for the existed shape file.
  • unitOfData
    • Description:This parameter specifies the Geography Unit of the data.
  • returningColumnType
    • Description:This parameter specifies whether the columns info in shape file will be copied to TinyGeo file.
  • password
    • Type:String
    • Description:This parameter spcifies the password of the target TinyGeo file.

CreateTinyGeoFile(String,String,GeographyUnit,ReturningColumnsType,String,Double)

  • Static API to create a new TinyGeo file from an existed shape file.
Remarks
  • N/A
Return Value
  • Type:Void
  • Description:N/A
Parameters
  • tinyGeoPathFileName
    • Type:String
    • Description:This parameter specifies the file name for the target TinyGeo file.
  • shapePathFileName
    • Type:String
    • Description:This parameter specifies the file name for the existed shape file.
  • unitOfData
    • Description:This parameter specifies the Geography Unit of the data.
  • returningColumnType
    • Description:This parameter specifies whether the columns info in shape file will be copied to TinyGeo file.
  • password
    • Type:String
    • Description:This parameter spcifies the password of the target TinyGeo file.
  • precisionInMeter
    • Type:Double
    • Description:This parameter spcifies in double what is the precision in Meter of the target TinyGeo file.

CreateTinyGeoFile(String,String,GeographyUnit,IEnumerable<String>)

  • Static API to create a new TinyGeo file from an existed shape file.
Remarks
  • N/A
Return Value
  • Type:Void
  • Description:N/A
Parameters
  • tinyGeoPathFileName
    • Type:String
    • Description:This parameter specifies the file name for the target TinyGeo file.
  • shapePathFileName
    • Type:String
    • Description:This parameter specifies the file name for the existed shape file.
  • unitOfData
    • Description:This parameter specifies the Geography Unit of the data.
  • columnNames
    • Type:IEnumerable<String>
    • Description:This parameter specifies the columns in shape file which will be copied to TinyGeo file.

CreateTinyGeoFile(String,String,GeographyUnit,IEnumerable<String>,Double)

  • Static API to create a new TinyGeo file from an existed shape file.
Remarks
  • N/A
Return Value
  • Type:Void
  • Description:N/A
Parameters
  • tinyGeoPathFileName
    • Type:String
    • Description:This parameter specifies the file name for the target TinyGeo file.
  • shapePathFileName
    • Type:String
    • Description:This parameter specifies the file name for the existed shape file.
  • unitOfData
    • Description:This parameter specifies the Geography Unit of the data.
  • columnNames
    • Type:IEnumerable<String>
    • Description:This parameter specifies the columns in shape file which will be copied to TinyGeo file.
  • precisionInMeter
    • Type:Double
    • Description:This parameter spcifies in double what is the precision in Meter of the target TinyGeo file.

CreateTinyGeoFile(String,String,GeographyUnit,IEnumerable<String>,String)

  • Static API to create a new TinyGeo file from an existed shape file.
Remarks
  • N/A
Return Value
  • Type:Void
  • Description:N/A
Parameters
  • tinyGeoPathFileName
    • Type:String
    • Description:This parameter specifies the file name for the target TinyGeo file.
  • shapePathFileName
    • Type:String
    • Description:This parameter specifies the file name for the existed shape file.
  • unitOfData
    • Description:This parameter specifies the Geography Unit of the data.
  • columnNames
    • Type:IEnumerable<String>
    • Description:This parameter specifies the columns in shape file which will be copied to TinyGeo file.
  • password
    • Type:String
    • Description:This parameter spcifies the password of the target TinyGeo file.

CreateTinyGeoFile(String,String,GeographyUnit,IEnumerable<String>,String,Double)

  • Static API to create a new TinyGeo file from an existed shape file.
Remarks
  • N/A
Return Value
  • Type:Void
  • Description:N/A
Parameters
  • tinyGeoPathFileName
    • Type:String
    • Description:This parameter specifies the file name for the target TinyGeo file.
  • shapePathFileName
    • Type:String
    • Description:This parameter specifies the file name for the existed shape file.
  • unitOfData
    • Description:This parameter specifies the Geography Unit of the data.
  • columnNames
    • Type:IEnumerable<String>
    • Description:This parameter specifies the columns in shape file which will be copied to TinyGeo file.
  • password
    • Type:String
    • Description:This parameter spcifies the password of the target TinyGeo file.
  • precisionInMeter
    • Type:Double
    • Description:This parameter spcifies in double what is the precision in Meter of the target TinyGeo file.

CreateTinyGeoFile(String,String,GeographyUnit,IEnumerable<String>,String,Double,Encoding)

  • Static API to create a new TinyGeo file from an existed shape file.
Remarks
  • N/A
Return Value
  • Type:Void
  • Description:N/A
Parameters
  • tinyGeoPathFileName
    • Type:String
    • Description:This parameter specifies the file name for the target TinyGeo file.
  • shapePathFileName
    • Type:String
    • Description:This parameter specifies the file name for the existed shape file.
  • unitOfData
    • Description:This parameter specifies the Geography Unit of the data.
  • columnNames
    • Type:IEnumerable<String>
    • Description:This parameter specifies the columns in shape file which will be copied to TinyGeo file.
  • password
    • Type:String
    • Description:This parameter spcifies the password of the target TinyGeo file.
  • precisionInMeter
    • Type:Double
    • Description:This parameter spcifies in double what is the precision in Meter of the target TinyGeo file.
  • shapeEncoding
    • Type:Encoding
    • Description:This parameter specifies the encoding of the existed shape file.

CreateTinyGeoFile(String,FeatureLayer,GeographyUnit,IEnumerable<String>,String,Double,Encoding,WellKnownType)

  • N/A
Remarks
  • N/A
Return Value
  • Type:Void
  • Description:N/A
Parameters
  • tinyGeoPathFilename
    • Type:String
    • Description:N/A
  • columnNames
    • Type:IEnumerable<String>
    • Description:N/A
  • password
    • Type:String
    • Description:N/A
  • precisionInMeter
    • Type:Double
    • Description:N/A
  • shapeEncoding
    • Type:Encoding
    • Description:N/A

GetOptimalPrecision(FeatureLayer,GeographyUnit,DistanceUnit,TinyGeoPrecisionMode)

  • N/A
Remarks
  • N/A
Return Value
  • Type:Double
  • Description:N/A
Parameters

GetOptimalPrecision(String,GeographyUnit,DistanceUnit,TinyGeoPrecisionMode)

  • Get the precision of a shape file for creating a tinyGeo file.
Remarks
  • N/A
Return Value
  • Type:Double
  • Description:N/A
Parameters
  • shapePathFileName
    • Type:String
    • Description:This parameter specifies the file name for the shape file.
  • unitOfData
    • Description:This parameter specifies the Geography Unit for the shape file.
  • returningDistanceUnit
    • Description:This parameter specifies the Distance Unit for the return precision.
  • precisionMode
    • Description:This parameter specifies the mode of getting the return precision.

EncryptTinyGeoFile(String,String,String)

  • Encrypt an existed TinyGeo File and save it as a new TinyGeo File.
Remarks
  • N/A
Return Value
  • Type:Void
  • Description:N/A
Parameters
  • unencryptedTinyGeoPathFileName
    • Type:String
    • Description:This parameter specifies the file name for the source unencrypted TinyGeo file.
  • encryptedTinyGeoPathFileName
    • Type:String
    • Description:This parameter specifies the file name for the target encrypted TinyGeo file.
  • password
    • Type:String
    • Description:This parameter specified the password of the target encrypted TinyGeo file.

DecryptTinyGeoFile(String,String,String)

  • Decrypt an existed encrypted TinyGeo File and save it as a new TinyGeo File.
Remarks
  • N/A
Return Value
  • Type:Void
  • Description:N/A
Parameters
  • encryptedTinyGeoPathFileName
    • Type:String
    • Description:This parameter specifies the file name for the source encrypted TinyGeo file.
  • decryptedTinyGeoPathFileName
    • Type:String
    • Description:This parameter specifies the file name for the target decrypted TinyGeo file.
  • password
    • Type:String
    • Description:This parameter specified the password of the source encrypted TinyGeo file.

Protected Methods

CanGetCountQuicklyCore()

  • N/A
Remarks
  • N/A
Return Value
  • Type:Boolean
  • Description:N/A
Parameters

OnStreamLoading(StreamLoadingEventArgs)

  • This method allows you to raise the StreamLoading event.
Remarks
  • This method allows you to raise the StreamLoading event. Normally events are not accessible to derived classes so we exposed a way to raise the event is necessary through this protected method.
Return Value
  • Type:Void
  • Description:None
Parameters
  • e
    • Description:This parameter represents the event arguments you want to raise the StreamLoading event with.

OpenCore()

  • This method opens the FeatureSource so that it is initialized and ready to use.
Remarks
  • This protected virtual method is called from the concreate public method Open. The open method play 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 abstract method consider opening files for file based source, 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
  • Type:Void
  • Description:None
Parameters

CloseCore()

  • This method opens the FeatureSource so that it is initialized and ready to use.
Remarks
  • This protected virtual method is called from the concreate 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. It is recommended that if you override this method that you take the following things into account. This method may be called multiple times so we suggest you write the 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
  • Type:Void
  • Description:None
Parameters

GetBoundingBoxCore()

  • This method returns the bounding box which encompasses all of the features in the FeatureSource.
Remarks
  • This protected virtual method is called from the concreate public method GetBoundingBox. It does not take into account any transaction activity as this is the responsibility of the concreate public method GetBoundingBox. In this way as a developer if you choose to override this method you do not have to consider transaction 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 means it gets the BoundingBox is by calling the GetAllFeatureCore method and deriving 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 record without returning them. In these ways you can greatly improve the performance of this method.
Return Value
  • Description:This method returns the bounding box which encompasses all of the features in the FeatureSource.
Parameters

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 of all of our default virtual implementations within this class. We wanted as the framework developers 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 want 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 case we just discussed about finding all of the InternalFeatures in a bounding box we would not want to look at every record to fulfil 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 see the specific API to determine what method it uses.
Return Value
  • Type:Collection<Feature>
  • Description:The return decimalDegreesValue is a collection of all of the InternalFeatures in the FeatureSource.
Parameters
  • returningColumnNames
    • Type:IEnumerable<String>
    • Description:This parameter allows you to select the field names of the column data you wish to return with each Feature.

GetFeaturesInsideBoundingBoxCore(RectangleShape,IEnumerable<String>)

  • This method returns all of the InternalFeatures of this FeatureSource inside of the specified bounding box.
Remarks
  • This method returns all of the InternalFeatures of this FeatureSource 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 concreate 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. It 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
  • Type:Collection<Feature>
  • Description:The return decimalDegreesValue is a collection of all of the InternalFeatures that are inside of the bounding box.
Parameters
  • boundingBox
    • Description:This parameter represents the bounding box you with to find InternalFeatures inside of.
  • returningColumnNames
    • Type:IEnumerable<String>
    • Description:This parameter allows you to select the field names of the column data you wish to return with each Feature.

GetAllFeaturesCore(IEnumerable<String>,Int32,Int32)

  • N/A
Remarks
  • N/A
Return Value
  • Type:Collection<Feature>
  • Description:N/A
Parameters
  • returningColumnNames
    • Type:IEnumerable<String>
    • Description:N/A
  • startIndex
    • Type:Int32
    • Description:N/A
  • takeCount
    • Type:Int32
    • Description:N/A

GetFeaturesByIdsCore(IEnumerable<String>,IEnumerable<String>)

  • N/A
Remarks
  • N/A
Return Value
  • Type:Collection<Feature>
  • Description:N/A
Parameters
  • ids
    • Type:IEnumerable<String>
    • Description:N/A
  • returningColumnNames
    • Type:IEnumerable<String>
    • Description:N/A

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 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 and 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. In this way we can strip out custom columns before calling other Core methods which are only responsible for returning data in the FeatureSource. For more information on custom fields you can see the documentation on the OnCustomFieldsFetch.
Return Value
  • Type:Collection<FeatureSourceColumn>
  • Description:This method returns the columns available for the FeatureSource.
Parameters

CanGetBoundingBoxQuicklyCore()

  • N/A
Remarks
  • N/A
Return Value
  • Type:Boolean
  • Description:N/A
Parameters

GetBoundingBoxByIdCore(String)

  • N/A
Remarks
  • N/A
Return Value
Parameters
  • id
    • Type:String
    • Description:N/A

GetFirstFeaturesWellKnownTypeCore()

  • N/A
Remarks
  • N/A
Return Value
Parameters

ConvertToExternalProjection(IEnumerable<RectangleShape>)

  • N/A
Remarks
  • N/A
Return Value
Parameters

ConvertToInternalProjection(IEnumerable<RectangleShape>)

  • N/A
Remarks
  • N/A
Return Value
Parameters

ConvertToExternalProjection(RectangleShape)

  • N/A
Remarks
  • N/A
Return Value
Parameters

ConvertToInternalProjection(RectangleShape)

  • N/A
Remarks
  • N/A
Return Value
Parameters

ConvertToInternalProjectionCall(RectangleShape)

  • N/A
Remarks
  • N/A
Return Value
Parameters

ConvertToInternalProjection(BaseShape)

  • N/A
Remarks
  • N/A
Return Value
Parameters

ConvertToExternalProjection(IEnumerable<Feature>)

  • N/A
Remarks
  • N/A
Return Value
  • Type:Collection<Feature>
  • Description:N/A
Parameters
  • features
    • Type:IEnumerable<Feature>
    • Description:N/A

ConvertToInternalProjection(IEnumerable<Feature>)

  • N/A
Remarks
  • N/A
Return Value
  • Type:Collection<Feature>
  • Description:N/A
Parameters
  • features
    • Type:IEnumerable<Feature>
    • Description:N/A

ConvertToExternalProjection(Feature)

  • N/A
Remarks
  • N/A
Return Value
Parameters
  • feature

ConvertToInternalProjection(Feature)

  • N/A
Remarks
  • N/A
Return Value
Parameters
  • feature

GetColumnNamesInsideFeatureSource(IEnumerable<String>)

  • N/A
Remarks
  • N/A
Return Value
  • Type:Collection<String>
  • Description:N/A
Parameters
  • returningColumnNames
    • Type:IEnumerable<String>
    • Description:N/A

GetColumnNamesOutsideFeatureSource(IEnumerable<String>)

  • N/A
Remarks
  • N/A
Return Value
  • Type:Collection<String>
  • Description:N/A
Parameters
  • returningColumnNames
    • Type:IEnumerable<String>
    • Description:N/A

GetReturningColumnNames(ReturningColumnsType)

  • N/A
Remarks
  • N/A
Return Value
  • Type:Collection<String>
  • Description:N/A
Parameters

RemoveEmptyAndExcludeFeatures(Collection<Feature>)

  • N/A
Remarks
  • N/A
Return Value
  • Type:Void
  • Description:N/A
Parameters
  • sourceFeatures
    • Type:Collection<Feature>
    • Description:N/A

OnDrawingProgressChanged(DrawingProgressChangedEventArgs)

  • N/A
Remarks
  • N/A
Return Value
  • Type:Void
  • Description:N/A
Parameters

GetColumnNamesOutsideFeatureSourceCall(IEnumerable<String>)

  • N/A
Remarks
  • N/A
Return Value
  • Type:Collection<String>
  • Description:N/A
Parameters
  • returningColumnNames
    • Type:IEnumerable<String>
    • Description:N/A

GetDistinctColumnValuesCore(String)

  • N/A
Remarks
  • N/A
Return Value
Parameters
  • columnName
    • Type:String
    • Description:N/A

CommitTransactionCore(TransactionBuffer)

  • N/A
Remarks
  • N/A
Return Value
Parameters

RaiseCustomColumnFetchEvent(Collection<Feature>,Collection<String>,Boolean)

  • N/A
Remarks
  • N/A
Return Value
  • Type:Collection<Feature>
  • Description:N/A
Parameters
  • sourceFeatures
    • Type:Collection<Feature>
    • Description:N/A
  • fieldNamesOutsideOfSource
    • Type:Collection<String>
    • Description:N/A
  • forceRaiseEvent
    • Type:Boolean
    • Description:N/A

GetFeaturesOutsideBoundingBoxCore(RectangleShape,IEnumerable<String>)

  • N/A
Remarks
  • N/A
Return Value
  • Type:Collection<Feature>
  • Description:N/A
Parameters
  • returningColumnNames
    • Type:IEnumerable<String>
    • Description:N/A

ConvertToExternalProjectionIfNecessary(Collection<Feature>)

  • N/A
Remarks
  • N/A
Return Value
  • Type:Collection<Feature>
  • Description:N/A
Parameters
  • returnFeatures
    • Type:Collection<Feature>
    • Description:N/A

ProcessTransaction(RectangleShape,Collection<Feature>,Boolean)

  • N/A
Remarks
  • N/A
Return Value
  • Type:Void
  • Description:N/A
Parameters
  • returnFeatures
    • Type:Collection<Feature>
    • Description:N/A
  • needUpdateProjection
    • Type:Boolean
    • Description:N/A

GetWrappingFeaturesLeft(RectangleShape,Double,Double,IEnumerable<String>,RectangleShape)

  • N/A
Remarks
  • N/A
Return Value
  • Type:Collection<Feature>
  • Description:N/A
Parameters
  • screenWidth
    • Type:Double
    • Description:N/A
  • screenHeight
    • Type:Double
    • Description:N/A
  • returningColumnNames
    • Type:IEnumerable<String>
    • Description:N/A

GetWrappingFeaturesRight(RectangleShape,Double,Double,IEnumerable<String>,RectangleShape)

  • N/A
Remarks
  • N/A
Return Value
  • Type:Collection<Feature>
  • Description:N/A
Parameters
  • screenWidth
    • Type:Double
    • Description:N/A
  • screenHeight
    • Type:Double
    • Description:N/A
  • returningColumnNames
    • Type:IEnumerable<String>
    • Description:N/A

GetFeaturesForDrawingCore(RectangleShape,Double,Double,IEnumerable<String>)

  • N/A
Remarks
  • N/A
Return Value
  • Type:Collection<Feature>
  • Description:N/A
Parameters
  • screenWidth
    • Type:Double
    • Description:N/A
  • screenHeight
    • Type:Double
    • Description:N/A
  • returningColumnNames
    • Type:IEnumerable<String>
    • Description:N/A

SpatialQueryCore(BaseShape,QueryType,IEnumerable<String>)

  • N/A
Remarks
  • N/A
Return Value
  • Type:Collection<Feature>
  • Description:N/A
Parameters
  • returningColumnNames
    • Type:IEnumerable<String>
    • Description:N/A

GetFeaturesNearestToCore(BaseShape,GeographyUnit,Int32,IEnumerable<String>)

  • N/A
Remarks
  • N/A
Return Value
  • Type:Collection<Feature>
  • Description:N/A
Parameters
  • maxItemsToFind
    • Type:Int32
    • Description:N/A
  • returningColumnNames
    • Type:IEnumerable<String>
    • Description:N/A

GetFeaturesWithinDistanceOfCore(BaseShape,GeographyUnit,DistanceUnit,Double,IEnumerable<String>)

  • N/A
Remarks
  • N/A
Return Value
  • Type:Collection<Feature>
  • Description:N/A
Parameters
  • distance
    • Type:Double
    • Description:N/A
  • returningColumnNames
    • Type:IEnumerable<String>
    • Description:N/A

OnCustomColumnFetch(CustomColumnFetchEventArgs)

  • N/A
Remarks
  • N/A
Return Value
  • Type:Void
  • Description:N/A
Parameters

OnCommittingTransaction(CommittingTransactionEventArgs)

  • N/A
Remarks
  • N/A
Return Value
  • Type:Void
  • Description:N/A
Parameters

OnCommittedTransaction(CommittedTransactionEventArgs)

  • N/A
Remarks
  • N/A
Return Value
  • Type:Void
  • Description:N/A
Parameters

OnOpeningFeatureSource(OpeningFeatureSourceEventArgs)

  • N/A
Remarks
  • N/A
Return Value
  • Type:Void
  • Description:N/A
Parameters

OnOpenedFeatureSource(OpenedFeatureSourceEventArgs)

  • N/A
Remarks
  • N/A
Return Value
  • Type:Void
  • Description:N/A
Parameters

OnClosingFeatureSource(ClosingFeatureSourceEventArgs)

  • N/A
Remarks
  • N/A
Return Value
  • Type:Void
  • Description:N/A
Parameters

OnClosedFeatureSource(ClosedFeatureSourceEventArgs)

  • N/A
Remarks
  • N/A
Return Value
  • Type:Void
  • Description:N/A
Parameters

ExecuteNonQueryCore(String)

  • N/A
Remarks
  • N/A
Return Value
  • Type:Int32
  • Description:N/A
Parameters
  • sqlStatement
    • Type:String
    • Description:N/A

GetFeaturesByColumnValueCore(String,String,IEnumerable<String>)

  • N/A
Remarks
  • N/A
Return Value
  • Type:Collection<Feature>
  • Description:N/A
Parameters
  • columnName
    • Type:String
    • Description:N/A
  • columnValue
    • Type:String
    • Description:N/A
  • returningColumnNames
    • Type:IEnumerable<String>
    • Description:N/A

ExecuteScalarCore(String)

  • N/A
Remarks
  • N/A
Return Value
  • Type:Object
  • Description:N/A
Parameters
  • sqlStatement
    • Type:String
    • Description:N/A

ExecuteQueryCore(String)

  • N/A
Remarks
  • N/A
Return Value
Parameters
  • sqlStatement
    • Type:String
    • Description:N/A

GetCountCore()

  • N/A
Remarks
  • N/A
Return Value
  • Type:Int32
  • Description:N/A
Parameters

CloneDeepCore()

  • N/A
Remarks
  • N/A
Return Value
Parameters

Finalize()

  • N/A
Remarks
  • N/A
Return Value
  • Type:Void
  • Description:N/A
Parameters

MemberwiseClone()

  • N/A
Remarks
  • N/A
Return Value
  • Type:Object
  • Description:N/A
Parameters

Public Properties

Password

  • This property gets or sets the password of the TinyGeo file.
Remarks
  • N/A
Return Value
  • Type:String

TinyGeoPathFileName

  • This property returns the path and file of the TinyGeo file you want to use.
Remarks
  • When you specify the path and file name it should be in the correct format as such however the file does not need to exists on the file system. This is to allow us to accept streams supplied by the developer at runtime. If you choose to provide a file that exists then we will attempt to use it. If we cannot find it then we will raise the SteamLoading event and allow you to supply the stream. For example you can pass in “C:\NotARealPath\File1.tgeo” which does not exists on the file system. When we raise the event for you to supply a stream we will pass to you the path and file name for you to differentiate the files.
Return Value
  • Type:String

Id

  • N/A
Remarks
  • N/A
Return Value
  • Type:String

CanExecuteSqlQuery

  • N/A
Remarks
  • N/A
Return Value
  • Type:Boolean

IsOpen

  • N/A
Remarks
  • N/A
Return Value
  • Type:Boolean

CanModifyColumnStructure

  • N/A
Remarks
  • N/A
Return Value
  • Type:Boolean

IsInTransaction

  • N/A
Remarks
  • N/A
Return Value
  • Type:Boolean

IsTransactionLive

  • N/A
Remarks
  • N/A
Return Value
  • Type:Boolean

IsEditable

  • N/A
Remarks
  • N/A
Return Value
  • Type:Boolean

Projection

  • N/A
Remarks
  • N/A
Return Value

GeoCache

  • N/A
Remarks
  • N/A
Return Value

FeatureIdsToExclude

  • N/A
Remarks
  • N/A
Return Value
  • Type:Collection<String>

TransactionBuffer

  • N/A
Remarks
  • N/A
Return Value

MaxRecordsToDraw

  • N/A
Remarks
  • N/A
Return Value
  • Type:Int32

Protected Properties

CanExecuteSqlQueryCore

  • N/A
Remarks
  • N/A
Return Value
  • Type:Boolean

IsOpenCore

  • N/A
Remarks
  • N/A
Return Value
  • Type:Boolean

CanModifyColumnStructureCore

  • N/A
Remarks
  • N/A
Return Value
  • Type:Boolean

FeatureSourceColumns

  • N/A
Remarks
  • N/A
Return Value

Public Events

StreamLoading

  • This event allows you to pass in your own stream to represent the files.
Remarks
  • If you choose you can pass in your own stream to represent the file. The stream can come from a variety of places such as isolated storage, a compressed file, and encrypted stream. When the Image is finished with the stream it will dispose of it so be sure to keep this in mind when passing the stream in. If you do not pass in a alternate stream the class will attempt to load the file from the file system using the TinyGeoPathFileName property.

Event Arguments:StreamLoadingEventArgs

DrawingProgressChanged

  • N/A
Remarks
  • N/A

Event Arguments:DrawingProgressChangedEventArgs

CustomColumnFetch

  • N/A
Remarks
  • N/A

Event Arguments:CustomColumnFetchEventArgs

CommittingTransaction

  • N/A
Remarks
  • N/A

Event Arguments:CommittingTransactionEventArgs

CommittedTransaction

  • N/A
Remarks
  • N/A

Event Arguments:CommittedTransactionEventArgs

OpeningFeatureSource

  • N/A
Remarks
  • N/A

Event Arguments:OpeningFeatureSourceEventArgs

OpenedFeatureSource

  • N/A
Remarks
  • N/A

Event Arguments:OpenedFeatureSourceEventArgs

ClosingFeatureSource

  • N/A
Remarks
  • N/A

Event Arguments:ClosingFeatureSourceEventArgs

ClosedFeatureSource

  • N/A
Remarks
  • N/A

Event Arguments:ClosedFeatureSourceEventArgs

thinkgeo.mapsuite.portablecore.tinygeofeaturesource.txt · Last modified: 2017/03/16 21:59 (external edit)