User Tools

Site Tools

Trace:

Sidebar

Products

Professional Services

Demos and Downloads

Help and Support

thinkgeo.mapsuite.portablecore.shapefilefeaturesource

This is an old revision of the document!

Table of Contents

ThinkGeo.MapSuite.Core.ShapeFileFeatureSource

This class represents a FeatureSource backed by ESRI a Shape File.

Inheritance Hierarchy

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

Members Summary

Public Constructors

ShapeFileFeatureSource()

  • This is the class constructor.
Remarks
  • None
Parameters

ShapeFileFeatureSource(String)

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

ShapeFileFeatureSource(String,ShapeFileReadWriteMode)

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

ShapeFileFeatureSource(String,String)

  • This is a constructor for the class.
Remarks
  • This constructor allows you to specify the shape file and the index file to use. In some cases you may want to build custom index files or want the index file to have a different name that the shape file.
Parameters
  • shapePathFilename
    • Type:String
    • Description:This parameter is the shape file name you want to load.
  • indexPathFilename
    • Type:String
    • Description:This parameter is the index file you want to use.

ShapeFileFeatureSource(String,String,ShapeFileReadWriteMode)

  • This is a constructor for the class.
Remarks
  • This constructor allows you to specify the shape file and the index file to use. In some cases you may want to build custom index files or want the index file to have a different name that the shape file. It also allows you to specify is you want to open the files for read or read and write. You will need to open the file for read and write if you plan on doing any editing to the files.
Parameters
  • shapePathFilename
    • Type:String
    • Description:This parameter is the shape file name you want to load.
  • indexPathFilename
    • Type:String
    • Description:This parameter is the index file you want to use.
  • readWriteMode
    • Type:ShapeFileReadWriteMode
    • Description:This parameter reflects if you want to open shape file and index for read or read write mode.

ShapeFileFeatureSource(String,String,ShapeFileReadWriteMode,Encoding)

  • This is a constructor for the class.
Remarks
  • This constructor allows you to specify the shape file and the index file to use. In some cases you may want to build custom index files or want the index file to have a different name that the shape file. It also allows you to specify is you want to open the files for read or read and write. You will need to open the file for read and write if you plan on doing any editing to the files.
Parameters
  • shapePathFilename
    • Type:String
    • Description:This parameter is the shape file name you want to load.
  • indexPathFilename
    • Type:String
    • Description:This parameter is the index file you want to use.
  • readWriteMode
    • Type:ShapeFileReadWriteMode
    • Description:This parameter reflects if you want to open shape file and index for read or read write mode.
  • encoding
    • Type:Encoding
    • Description:The encoding to read and write the dbf file.

Protected Constructors

Public Methods

AddColumnString(String,Int32)

  • This method adds a new String column to the DBF file associated with the shape file.
Remarks
  • This method adds a new String column to the DBF file associated with the shape file.
Return Value
  • Type:Void
  • Description:None
Parameters
  • columnName
    • Type:String
    • Description:This parameter is the column you want to add.
  • length
    • Type:Int32
    • Description:This parameter is the number of characters that the string can hold.

GetDataFromDbf(String,String)

  • This method gets data directly from the DBF file associated with the shape file.
Remarks
  • This method gets data directly from the DBF file associated with the shape file. When you specify the Id and column name it will get the decimalDegreesValue from the DBF.
Return Value
  • Type:String
  • Description:This method gets data directly from the DBF file associated with the shape file.
Parameters
  • id
    • Type:String
    • Description:This parameter is the Id for the Feature you want to find.
  • columnName
    • Type:String
    • Description:This parameter is the column name you want to return.

GetDataFromDbf(String)

  • This method gets data directly from the DBF file associated with the shape file.
Remarks
  • This method returns a dictionary holding all of the values from the DBF for the Id you specified. In the dictionary the key is the column name and values are the values from the DBF.
Return Value
  • Type:Dictionary<String,String>
  • Description:This method returns a dictionary holding all of the values from the DBF for the Id you specified.
Parameters
  • id
    • Type:String
    • Description:This parameter is the Id of the Feature you want.

GetDataFromDbf(String,IEnumerable<String>)

  • This method gets data directly from the DBF file associated with the shape file.
Remarks
  • This method returns a dictionary holding all of the values from the DBF for the Id you specified. In the dictionary the key is the column name and values are the values from the DBF.
Return Value
  • Type:Dictionary<String,String>
  • Description:This method returns a dictionary holding all of the values from the DBF for the Id you specified.
Parameters
  • id
    • Type:String
    • Description:This parameter is the Id of the Feature you want.
  • returningColumnNames
    • Type:IEnumerable<String>
    • Description:This parameter is the returning columns specified for the returning data.

GetDataFromDbf(String,ReturningColumnsType)

  • This method gets data directly from the DBF file associated with the shape file.
Remarks
  • This method returns a dictionary holding all of the values from the DBF for the Id you specified. In the dictionary the key is the column name and values are the values from the DBF.
Return Value
  • Type:Dictionary<String,String>
  • Description:This method returns a dictionary holding all of the values from the DBF for the Id you specified.
Parameters
  • id
    • Type:String
    • Description:This parameter is the Id of the Feature you want.
  • returningColumnNamesType
    • Type:ReturningColumnsType
    • Description:This parameter is the returningColumnType specified for the returning data.

GetDataFromDbf(IEnumerable<String>)

  • This method gets data directly from the DBF file associated with the shape file.
Remarks
  • This method returns a collection of dictionary holding all of the values from the DBF for the Ids you specified. In the dictionary the key is the column name and values are the values from the DBF.
Return Value
  • Type:Collection<Dictionary<String,String»
  • Description:This method returns a collection of dictionary holding all of the values from the DBF for the Ids you specified.
Parameters
  • ids
    • Type:IEnumerable<String>
    • Description:This parameter is the Ids of the Features you want.

GetDataFromDbf(IEnumerable<String>,String)

  • This method gets data directly from the DBF file associated with the shape file.
Remarks
  • This method returns a collection of dictionary holding all of the values from the DBF for the Ids you specified. In the dictionary the key is the column name and values are the values from the DBF.
Return Value
  • Type:Collection<Dictionary<String,String»
  • Description:This method returns a collection of dictionary holding all of the values from the DBF for the Ids you specified.
Parameters
  • ids
    • Type:IEnumerable<String>
    • Description:This parameter is the Ids of the Features you want.
  • columnName
    • Type:String
    • Description:This parameter is the returning columnName of the Features you want.

GetDataFromDbf(IEnumerable<String>,IEnumerable<String>)

  • This method gets data directly from the DBF file associated with the shape file.
Remarks
  • This method returns a collection of dictionary holding all of the values from the DBF for the Ids you specified. In the dictionary the key is the column name and values are the values from the DBF.
Return Value
  • Type:Collection<Dictionary<String,String»
  • Description:This method returns a collection of dictionary holding all of the values from the DBF for the Ids you specified.
Parameters
  • ids
    • Type:IEnumerable<String>
    • Description:This parameter is the Ids of the Features you want.
  • columnNames
    • Type:IEnumerable<String>
    • Description:This parameter is the returning columnNames of the Features you want.

GetDataFromDbf(IEnumerable<String>,ReturningColumnsType)

  • This method gets data directly from the DBF file associated with the shape file.
Remarks
  • This method returns a collection of dictionary holding all of the values from the DBF for the Ids you specified. In the dictionary the key is the column name and values are the values from the DBF.
Return Value
  • Type:Collection<Dictionary<String,String»
  • Description:This method returns a collection of dictionary holding all of the values from the DBF for the Ids you specified.
Parameters
  • ids
    • Type:IEnumerable<String>
    • Description:This parameter is the Ids of the Features you want.
  • returningColumnNamesType
    • Type:ReturningColumnsType
    • Description:This parameter is the returning column type of the Features you want.

UpdateDbfData(String,String,String)

  • This method updates data in the DBF file associated with the shape file.
Remarks
  • None
Return Value
  • Type:Void
  • Description:None
Parameters
  • id
    • Type:String
    • Description:This parameter is the Id of the feature you want to update.
  • columnName
    • Type:String
    • Description:This parameter is the column name you want to update.
  • value
    • Type:String
    • Description:This parameter is the decimalDegreesValue you want to set.

UpdateDbfData(String,IEnumerable<String>,IEnumerable<String>)

  • This method updates data in the DBF file associated with the shape file.
Remarks
  • None
Return Value
  • Type:Void
  • Description:None
Parameters
  • id
    • Type:String
    • Description:This parameter is the Id of the feature you want to update.
  • columnNames
    • Type:IEnumerable<String>
    • Description:This parameter is the columnNames you want to update.
  • values
    • Type:IEnumerable<String>
    • Description:This parameter is the target values you want to set.

GetShapeFileType()

  • Get shape file type for the shape file featureSource.
Remarks
  • N/A
Return Value
  • Type:ShapeFileType
  • Description:The shapeFileType for the ShapeFileFeatureSource.
Parameters

GetFeatureIdsForDrawing(RectangleShape,Double,Double)

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

GetDbfColumns()

  • Get the dbf columns out from the shape file featureSource.
Remarks
  • N/A
Return Value
  • Type:Collection<DbfColumn>
  • Description:The dbfColumns in the shape file FeatureSource.
Parameters

Validate()

  • This method checks all features in a shapefile is supported by Mapsuite or not.
Remarks
  • N/A
Return Value
  • Type:Dictionary<String,String>
  • Description:A dictionary which contains all the unsupported features. The key is the Indexs which failed to pass the check, the value contains the reason for its failure.
Parameters

AddColumnBoolean(String)

  • This method adds a new Boolean column to the DBF file associated with the shape file.
Remarks
  • None
Return Value
  • Type:Void
  • Description:None
Parameters
  • columnName
    • Type:String
    • Description:This parameter is the column you want to add.

AddColumnDate(String)

  • This method adds a new Date column to the DBF file associated with the shape file.
Remarks
  • None
Return Value
  • Type:Void
  • Description:None
Parameters
  • columnName
    • Type:String
    • Description:This parameter is the column you want to add.

AddColumnDouble(String,Int32,Int32)

  • This method adds a new Double column to the DBF file associated with the shape file.
Remarks
  • None
Return Value
  • Type:Void
  • Description:None
Parameters
  • columnName
    • Type:String
    • Description:This parameter is the column you want to add.
  • totalLength
    • Type:Int32
    • Description:This is the total length of the field including both the digits to the left and right of the decimal point.
  • precisionLength
    • Type:Int32
    • Description:This parameter specifies how many digits after the decimal point you need to support.

AddColumnInteger(String,Int32)

  • This method adds a new Integer column to the DBF file associated with the shape file.
Remarks
  • None
Return Value
  • Type:Void
  • Description:None
Parameters
  • columnName
    • Type:String
    • Description:This parameter is the column you want to add.
  • length
    • Type:Int32
    • Description:This parameter specifies the length of the integer.

AddColumnMemo(String)

  • This method adds a new Memo column to the DBF file associated with the shape file.
Remarks
  • This method adds a new Memo column to the DBF file associated with the shape file. Internally the DBF holds an integer column that is a pointer to the data in the memo file. The pointer is measured in 512 byte chunks. Our default decimalDegreesValue for the size of the pointer column is 10 which means you can have 9,999,999,999 pointers to the 512 byte blocks. The ramification of this is that if you have more than this many records and each record uses more then 512 bytes as part of its memo then there will not be enough space for storage. If you have special needs for this please use the other overload that allows you to specify the number of digits you can use for the pointer.
Return Value
  • Type:Void
  • Description:None
Parameters
  • columnName
    • Type:String
    • Description:This parameter is the column you want to add.

AddColumnMemo(String,Int32)

  • This method adds a new Memo column to the DBF file associated with the shape file.
Remarks
  • This method adds a new Memo column to the DBF file associated with the shape file. Internally the DBF holds an integer column that is a pointer to the data in the memo file. The pointer is measured in 512 byte chunks. Our default decimalDegreesValue for the size of the pointer column is 10 which means you can have 9,999,999,999 pointers to the 512 byte blocks. The ramification of this is that if you have more than this many records and each record uses more than 512 bytes as part of its memo then there will not be enough space for storage. Conversely if you know you have few records then you can decrease this number. A good rule of thumb is to multiply the number of records by the number of 512 byte chunks you expect each record to use and then get the resulting number of digits resulting for the multiplication. Example You have 1,000,000 records and expect to have 4K, 8 chunks of 512 bytes, of memo data for each record. This means you will use multiple 1,000,000 * 8 which is 8,000,000 and then total the number of digits which in this case is 7. Assuming the numbers above a length of 7 will support your needs.
Return Value
  • Type:Void
  • Description:None
Parameters
  • columnName
    • Type:String
    • Description:This parameter is the column you want to add.
  • memoValueLength
    • Type:Int32
    • Description:This parameter is the number of digits you need to hold the pointers to the data in the memo file.

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

BuildRecordIdColumn(String,String,BuildRecordIdMode)

  • Static API used to build RecordId, the id should start from 0 by default.
Remarks
  • N/A
Return Value
  • Type:Void
  • Description:N/A
Parameters
  • shapeFilename
    • Type:String
    • Description:The target shape file name to build record id based on.
  • fieldname
    • Type:String
    • Description:The fild name for the record id.

BuildRecordIdColumn(String,String,BuildRecordIdMode,Int32)

  • Static API used to build RecordId from the specified starting id number.
Remarks
  • N/A
Return Value
  • Type:Void
  • Description:N/A
Parameters
  • shapeFilename
    • Type:String
    • Description:The target shape file name to build record id based on.
  • fieldname
    • Type:String
    • Description:The fild name for the record id.
  • startNumber
    • Type:Int32
    • Description:The starting id number of the record id.

BuildRecordIdColumn(String,String,BuildRecordIdMode,Int32,Encoding)

  • Static API used to build RecordId from the specified starting id number.
Remarks
  • N/A
Return Value
  • Type:Void
  • Description:N/A
Parameters
  • shapeFilename
    • Type:String
    • Description:The target shape file name to build record id based on.
  • fieldname
    • Type:String
    • Description:The fild name for the record id.
  • startNumber
    • Type:Int32
    • Description:The starting id number of the record id.
  • encoding
    • Type:Encoding
    • Description:This parameter specified the encoding information in dbf.

SaveToProjection(String,String,Projection,OverwriteMode)

  • This API provide a easy way to project features in a shape file into another projection and save it to shape file.
Remarks
  • N/A
Return Value
  • Type:Void
  • Description:N/A
Parameters
  • sourceShapeFile
    • Type:String
    • Description:This parameter specifies the source shape file to be projected.
  • targetShapeFile
    • Type:String
    • Description:This parameter specifies the target shape file to be saved for the projected features.
  • projection
    • Type:Projection
    • Description:This parameter is the projection to project the source shape file to target shape file. The source Shape file should be in the FromProjection of the Projection prameter, and the targetShapeFile will be in the ToProjection of the Projection.
  • overwriteMode
    • Type:OverwriteMode
    • Description:This parameter specifies the override mode when the target shape file exists.

Rebuild(String)

  • This method rebuilds the SHP, SHX, DBF, IDX and IDS files for the given shape file.
Remarks
  • This method rebuilds the SHP, SHX, DBF, IDX and IDS files for the given shape file. When we do editing we have optimized the updates so that we do not need to rebuild the entire shape file. This leads to the shape file being out of order which may cause it not to open in other tools. One optimization is if you update a record instead of rebuilding a new shape file we mark the old record as null and add the edited record at the end of the shape file. This greatly increases the speed of committing shape file changes but will over time unorder the shape file. In addition we do a delete the DBF file will simply mark the record deleted and not compact the space. Rebuilding the shape file will correctly order the SPX and SHX along with compacting the DBF file and rebuild any index with the same any of the shape file if it exists. Note that if you have build custom index files where the name of the index differs from that of the shape file you will need to rebuild those manually using the BuildIndex methods.
Return Value
  • Type:Void
  • Description:None
Parameters
  • shapePathFilename
    • Type:String
    • Description:This parameter is the shape file you want to rebuild.

BuildIndexFile(String)

  • This method build a spatial index for the shape file which increases access speed.
Remarks
  • This overload builds an index file with the same name as the shape file with only the extension being different. It will not do a rebuild if there is an existing index.
Return Value
  • Type:Void
  • Description:None
Parameters
  • shapePathFilename
    • Type:String
    • Description:This parameter is the shape file name and path that you want to build an index for.

BuildIndexFile(String,BuildIndexMode)

  • This method build a spatial index for the shape file which increases access speed.
Remarks
  • This overload builds an index file with the same name as the shape file with only the extension being different. You can also specify if you want to rebuild an existing index file.
Return Value
  • Type:Void
  • Description:None
Parameters
  • shapePathFilename
    • Type:String
    • Description:This parameter is the shape file name and path that you want to build an index for.
  • buildIndexMode
    • Type:BuildIndexMode
    • Description:This parameter determines what will happen if there is an existing index file.

BuildIndexFile(String,String,BuildIndexMode)

  • This method build a spatial index for the shape file which increases access speed.
Remarks
  • This overload builds an index file with the same name as the shape file with only the extension being different. You can also specify if you want to rebuild an existing index file.
Return Value
  • Type:Void
  • Description:None
Parameters
  • shapePathFilename
    • Type:String
    • Description:This parameter is the shape file name and path that you want to build an index for.
  • indexPathFilename
    • Type:String
    • Description:This parameter specifies the index file name.
  • buildIndexMode
    • Type:BuildIndexMode
    • Description:This parameter determines what will happen if there is an existing index file.

BuildIndexFile(String,String,Projection,BuildIndexMode)

  • This method build a spatial index for the shape file which increases access speed.
Remarks
  • This overload builds an index file with the specified index file name and only build Index for those records satisfied the regularExpression. You can also specify if you want to rebuild an existing index file.
Return Value
  • Type:Void
  • Description:None
Parameters
  • shapePathFilename
    • Type:String
    • Description:This parameter is the shape file name and path that you want to build an index for.
  • indexPathFilename
    • Type:String
    • Description:This parameter specifies the index file name.
  • projection
    • Type:Projection
    • Description:This parameter specifies the projection used to build index file.
  • buildIndexMode
    • Type:BuildIndexMode
    • Description:This parameter determines what will happen if there is an existing index file.

BuildIndexFile(String,String,String,String,BuildIndexMode)

  • This method build a spatial index for the shape file which increases access speed.
Remarks
  • This overload builds an index file with the specified index file name and only build Index for those records satisfied the regularExpression. You can also specify if you want to rebuild an existing index file.
Return Value
  • Type:Void
  • Description:None
Parameters
  • shapePathFilename
    • Type:String
    • Description:This parameter is the shape file name and path that you want to build an index for.
  • indexPathFilename
    • Type:String
    • Description:This parameter specifies the index file name.
  • columnName
    • Type:String
    • Description:The columnName to be used to get the value to match the regex expression.
  • regularExpression
    • Type:String
    • Description:This parameter specifies the regex expression to filter out thoese records to build index with.
  • buildIndexMode
    • Type:BuildIndexMode
    • Description:This parameter determines what will happen if there is an existing index file.

BuildIndexFile(String,String,Projection,String,String,BuildIndexMode)

  • This method build a spatial index for the shape file which increases access speed.
Remarks
  • This overload builds an index file with the specified index file name and only build Index for those records satisfied the regularExpression. You can also specify if you want to rebuild an existing index file.
Return Value
  • Type:Void
  • Description:None
Parameters
  • shapePathFilename
    • Type:String
    • Description:This parameter is the shape file name and path that you want to build an index for.
  • indexPathFilename
    • Type:String
    • Description:This parameter specifies the index file name.
  • projection
    • Type:Projection
    • Description:This parameter specifies the projection used to build index file.
  • columnName
    • Type:String
    • Description:The columnName to be used to get the value to match the regex expression.
  • regularExpression
    • Type:String
    • Description:This parameter specifies the regex expression to filter out thoese records to build index with.
  • buildIndexMode
    • Type:BuildIndexMode
    • Description:This parameter determines what will happen if there is an existing index file.

BuildIndexFile(String,String,Projection,String,String,BuildIndexMode,Encoding)

  • This method build a spatial index for the shape file which increases access speed.
Remarks
  • This overload builds an index file with the specified index file name and only build Index for those records satisfied the regularExpression. You can also specify if you want to rebuild an existing index file.
Return Value
  • Type:Void
  • Description:None
Parameters
  • shapePathFilename
    • Type:String
    • Description:This parameter is the shape file name and path that you want to build an index for.
  • indexPathFilename
    • Type:String
    • Description:This parameter specifies the index file name.
  • projection
    • Type:Projection
    • Description:This parameter specifies the projection used to build index file.
  • columnName
    • Type:String
    • Description:The columnName to be used to get the value to match the regex expression.
  • regularExpression
    • Type:String
    • Description:This parameter specifies the regular expression pattern to filter out thoese records to build index with.
  • buildIndexMode
    • Type:BuildIndexMode
    • Description:This parameter determines what will happen if there is an existing index file.
  • encoding
    • Type:Encoding
    • Description:This parameter determines the Enconding system used in the dbf, and this will be used if the dbf is encoded in a different encoding with default.

BuildIndexFile(IEnumerable<Feature>,String)

  • This method build a spatial index for a passed group of featurs which increases access speed.
Remarks
  • This overload builds an index file with the specified index file name for a group of passed in features.
Return Value
  • Type:Void
  • Description:None
Parameters
  • features
    • Type:IEnumerable<Feature>
    • Description:This parameter specifies the target group of features that you want to build an index for.
  • indexPathFilename
    • Type:String
    • Description:This parameter specifies the index file name.

BuildIndexFile(IEnumerable<Feature>,String,Projection)

  • This method build a spatial index for a passed group of featurs using the specified projection which increases access speed.
Remarks
  • This overload builds an index file with the specified index file name for a group of passed in features.
Return Value
  • Type:Void
  • Description:None
Parameters
  • features
    • Type:IEnumerable<Feature>
    • Description:This parameter specifies the target group of features that you want to build an index for.
  • indexPathFilename
    • Type:String
    • Description:This parameter specifies the index file name.
  • projection
    • Type:Projection
    • Description:This parameter specifies the projection used to build index file.

BuildIndexFile(IEnumerable<Feature>,String,BuildIndexMode)

  • This method build a spatial index for a passed group of featurs which increases access speed.
Remarks
  • This overload builds an index file with the specified index file name for a group of passed in features.
Return Value
  • Type:Void
  • Description:None
Parameters
  • features
    • Type:IEnumerable<Feature>
    • Description:This parameter specifies the target group of features that you want to build an index for.
  • indexPathFilename
    • Type:String
    • Description:This parameter specifies the index file name.
  • buildIndexMode
    • Type:BuildIndexMode
    • Description:This parameter determines what will happen if there is an existing index file.

BuildIndexFile(IEnumerable<Feature>,String,Projection,BuildIndexMode)

  • This method build a spatial index for a passed group of featurs which increases access speed.
Remarks
  • This overload builds an index file with the specified index file name for a group of passed in features.
Return Value
  • Type:Void
  • Description:None
Parameters
  • features
    • Type:IEnumerable<Feature>
    • Description:This parameter specifies the target group of features that you want to build an index for.
  • indexPathFilename
    • Type:String
    • Description:This parameter specifies the index file name.
  • projection
    • Type:Projection
    • Description:This parameter specifies the projection used to build index file.
  • buildIndexMode
    • Type:BuildIndexMode
    • Description:This parameter determines what will happen if there is an existing index file.

GetValidColumns(IEnumerable<DbfColumn>)

  • N/A
Remarks
  • N/A
Return Value
Parameters
  • columns
    • Type:IEnumerable<DbfColumn>
    • Description:N/A

GetValidColumns(IEnumerable<DbfColumn>,Encoding)

  • N/A
Remarks
  • N/A
Return Value
Parameters
  • columns
    • Type:IEnumerable<DbfColumn>
    • Description:N/A
  • encoding
    • Type:Encoding
    • Description:N/A

GetValidColumnNames(IEnumerable<String>)

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

GetValidColumnNames(IEnumerable<String>,Encoding)

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

CreateShapeFile(ShapeFileType,String,IEnumerable<DbfColumn>)

  • Static API to create a new shape file.
Remarks
  • N/A
Return Value
  • Type:Void
  • Description:N/A
Parameters
  • shapeType
    • Type:ShapeFileType
    • Description:This parameter specifies the the shape file type for the target shape file.
  • pathFilename
    • Type:String
    • Description:This parameter specifies the shape file name for the target shape file.
  • databaseColumns
    • Type:IEnumerable<DbfColumn>
    • Description:This parameter specifies the dbf column information for the target shape file.

CreateShapeFile(ShapeFileType,String,IEnumerable<DbfColumn>,Encoding)

  • Static API to create a new shape file.
Remarks
  • N/A
Return Value
  • Type:Void
  • Description:N/A
Parameters
  • shapeType
    • Type:ShapeFileType
    • Description:This parameter specifies the the shape file type for the target shape file.
  • pathFilename
    • Type:String
    • Description:This parameter specifies the shape file name for the target shape file.
  • databaseColumns
    • Type:IEnumerable<DbfColumn>
    • Description:This parameter specifies the dbf column information for the target shape file.
  • encoding
    • Type:Encoding
    • Description:This parameter specifies the dbf encoding infromation for the target shape file.

CreateShapeFile(ShapeFileType,String,IEnumerable<DbfColumn>,Encoding,OverwriteMode)

  • Static API to create a new shape file.
Remarks
  • Exception will be thown when the target shape file exist while the override mode is set to DoNotOverwrite.
Return Value
  • Type:Void
  • Description:N/A
Parameters
  • shapeType
    • Type:ShapeFileType
    • Description:This parameter specifies the the shape file type for the target shape file.
  • pathFilename
    • Type:String
    • Description:This parameter specifies the shape file name for the target shape file.
  • databaseColumns
    • Type:IEnumerable<DbfColumn>
    • Description:This parameter specifies the dbf column information for the target shape file.
  • encoding
    • Type:Encoding
    • Description:This parameter specifies the dbf encoding infromation for the target shape file.
  • overwriteMode
    • Type:OverwriteMode
    • Description:This parameter specifies the override mode when the target shape file exists.

CloneShapeFileStructure(String,String)

  • Clone out the structure from the source shape file to the target shape file. After cloning the structure, the targetShapeFile has the same type and same dbf columns with the source shape file but without any records in it.
Remarks
  • N/A
Return Value
  • Type:Void
  • Description:N/A
Parameters
  • sourceShapePathFilename
    • Type:String
    • Description:The source shape file to be cloned.
  • targetShapePathFilename
    • Type:String
    • Description:The target shape file with same structure with the source one after the structure cloned.

CloneShapeFileStructure(String,String,OverwriteMode)

  • Clone out the structure from the source shape file to the target shape file. After cloning the structure, the targetShapeFile has the same type and same dbf columns with the source shape file but without any records in it.
Remarks
  • Exception will be thown when the target shape file not extis while the override mode is set to DoNotOverwrite.
Return Value
  • Type:Void
  • Description:N/A
Parameters
  • sourceShapePathFilename
    • Type:String
    • Description:The source shape file to be cloned.
  • targetShapePathFilename
    • Type:String
    • Description:The target shape file with same structure with the source one after the structure cloned.
  • overwriteMode
    • Type:OverwriteMode
    • Description:This parameter specifies the override mode when the target shape file exists.

CloneShapeFileStructure(String,String,OverwriteMode,Encoding)

  • Clone out the structure from the source shape file to the target shape file. After cloning the structure, the targetShapeFile has the same type and same dbf columns with the source shape file but without any records in it.
Remarks
  • Exception will be thown when the target shape file not extis while the override mode is set to DoNotOverwrite.
Return Value
  • Type:Void
  • Description:N/A
Parameters
  • sourceShapePathFilename
    • Type:String
    • Description:The source shape file to be cloned.
  • targetShapePathFilename
    • Type:String
    • Description:The target shape file with same structure with the source one after the structure cloned.
  • overwriteMode
    • Type:OverwriteMode
    • Description:This parameter specifies the override mode when the target shape file exists.
  • encoding
    • Type:Encoding
    • Description:This parameter specifies the encoding information in the source shape file.

Protected Methods

ExecuteNonQueryCore(String)

  • This method executes a SQL query that does returns only a result of the number of record affected.
Remarks
  • This method executes a SQL query that does returns only a result of the number of record affected. Note that for the table name in the SQL query you need to use the shape file name without the SHP extension.
Return Value
  • Type:Int32
  • Description:This method returns the number of record affected by the SQL query.
Parameters
  • sqlStatement
    • Type:String
    • Description:This parameter is the SQL statement to execute.

ExecuteScalarCore(String)

  • Executes the query and returns the first column of the first row in the result set returned by the query. All other columns and rows are ignored.
Remarks
  • Use the ExcuteScalar method to retrieve a single value from the database. This reaquires less code than use the ExcuteQuery method and performing the operations necessary to generate the single value using the data.
Return Value
  • Type:Object
  • Description:The first column of the first row in the result set.
Parameters
  • sqlStatement
    • Type:String
    • Description:The sqlStatement to be excuted.

ExecuteQueryCore(String)

  • This method returns a DataTable based on the SQL statement you provided.
Remarks
  • This method returns a DataTable based on the SQL statement you provided.
Return Value
  • Type:GeoDataTable
  • Description:This method returns a DataTable based on the SQL statement you provided. Note that for the table name in the SQL query you need to use the shape file name without the SHP extension.
Parameters
  • sqlStatement
    • Type:String
    • Description:This parameter is the SQL state you want to execute.

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

CommitTransactionCore(TransactionBuffer)

  • This method will commit the existing transaction to its underlying source of data.
Remarks
  • This method will commit the existing transaction to its underlying source of data. It will pass back the results of how the commit went to include any error received. If you are implementing your own FeatureSource then this is one of the crucial methods you must create. It should be fairly straight forward that you will loop through the transaction buffer and add, edit or delete the InternalFeatures in your underlying data source. Remember to build and pass back the TransactionResult class so that users of your FeatureSource can respond to failures you may encounter committing the InternalFeatures. We will handle the end of the transaction and also the cleanup of the transaction buffer. Your task will be to commit the records and produce a TransactionResult return.The Transaction SystemThe transaction system of a FeatureSource sits on top of the inherited implementation of any specific source such as Oracle Spatial or Shape files. In this way it functions the same way for every FeatureSource. You start by calling the BeginTransaction. This allocates a collection of in memory change buffers that are used to store changes until you commit the transaction. So for example when you call the Add, Delete or Update method the changes to the feature are stored in memory only. If for any reason you choose to abandon the transaction you can call RollbackTransaction at any time and the in memory buffer will be deleted and the changes will be lost. When you are ready to commit the transaction you call the CommitTransaction and the collections of changes are then passed to the CommitTransactionCore method and the implementer of the specific FeatureSource is responsible for integrating your changes into the underlying FeatureSource. By default the IsLiveTransaction property is set to false which means that until you commit the changes the FeatureSource API will not reflect any changes that are in the temporary editing buffer.In the case where the IsLiveTransaction is set to true then things function slightly differently. The live transaction concept means that all of the modification you perform during a transaction are live from the standpoint of the querying methods on the object.To setup an example imagine that you have a FeatureSource that has 10 records in it. Next you begin a transaction and then call GetAllFeatures, the result would be 10 records. After that you call a delete on one of the records and call the GetAllFeatures again, this time you only get nine records. You receive nine records even though the transaction has not yet been committed. In the same sense you could have added a new record or modified an existing one and those changes are considered live though not committed.In the case where you modify records such as expanding the size of a polygon those changes as well are reflected. So for example you expand a polygon by doubling its size and then do a spatial query that would not normally return the smaller record but would return the larger records, in this case the larger record is returned. You can set this property to be false as well in which case all of the spatial related methods would ignore anything that is currently in the transaction buffer waiting to be committed. In this case only after committing the transaction would the FeatureSource reflect the changes.
Return Value
  • Type:TransactionResult
  • Description:The return decimalDegreesValue of this method is a TransactionResult class which gives you the status of the transaction you just committed. It includes how many of the updates, adds, and deletes were successful and any error that were encountered during the committing of the transaction.
Parameters
  • transactions
    • Type:TransactionBuffer
    • Description:This parameter encapsulates all of the adds, edits and deleted that make up the transaction. You will use this data to write the changes to your underlying data source.

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.

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

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
  • Type:RectangleShape
  • Description:This method returns the bounding box which encompasses all of the features in the FeatureSource.
Parameters

GetBoundingBoxByIdCore(String)

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

GetFeaturesOutsideBoundingBoxCore(RectangleShape,IEnumerable<String>)

  • This method returns all of the InternalFeatures of this FeatureSource outside of the specified bounding box.
Remarks
  • This method returns all of the InternalFeatures of this FeatureSource outside of the specified bounding box. If you are in a transaction and that transaction is live then it will also take that into consideration. The default implementation of GetFeaturesOutsideBoundingBoxCore uses the GetAllRecordsCore method to determine which InternalFeatures are outside of the bounding box. We strongly recommend that you provide your own implementation for this method that will be more efficient
Return Value
  • Type:Collection<Feature>
  • Description:This method returns all of the InternalFeatures of this FeatureSource outside of the specified bounding box.
Parameters
  • boundingBox
    • Type:RectangleShape
    • Description:This parameter represents the bounding box you with to find InternalFeatures outside 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.

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
    • Type:RectangleShape
    • 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.

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

GetFeatureIdsForDrawingCore(RectangleShape,Double,Double)

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

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

  • This method returns the InternalFeatures that will be used for drawing.
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 GetFeaturesForDrawingCore uses the GetFeaturesInsodeBoundingBoxCore with some optimizations based on the screen width and height. For example we can determine is a feature is going to draw in only one to four pixels and in that case we may not draw the entire feature but just a subset.
Return Value
  • Type:Collection<Feature>
  • Description:This method returns the InternalFeatures that will be used for drawing.
Parameters
  • boundingBox
    • Type:RectangleShape
    • Description:This parameter is the bounding box of the InternalFeatures you want to draw.
  • screenWidth
    • Type:Double
    • Description:This parameter is the width in screen pixels of the canvas you will draw on.
  • screenHeight
    • Type:Double
    • Description:This parameter is the height in screen pixels of the canvas you will draw on.
  • 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.

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. Because of this if you want an efficient version of this method then we high suggest you override the GetFeaturesByIdsCore method and provide a fast way to find a group of InternalFeatures by their Id.
Return Value
  • Type:Collection<Feature>
  • Description:This method returns a collection of InternalFeatures by providing a group of Ids.
Parameters
  • ids
    • Type:IEnumerable<String>
    • Description:This parameter represents the group of Ids which uniquely identified the InternalFeatures in the FeatureSource.
  • 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.

GetCountCore()

  • This method returns the count of the number of records in this FeatureSource.
Remarks
  • This protected virtual method is called from the concreate public method GetCount. It does not take into account any transaction activity as this is the responsibility of the concreate public method GetCount. 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 GetCountCore uses the GetAllRecordsCore method to calculate how many records there are in 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 count is by calling the GetAllFeatureCore method and counting each feature. This is a very inefficient way to get the count 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 record count is in the main header of the file. Similarly if you are using Oracle Spatial you can execute a simple query to get the count of all of the record without returning them. In these ways you can greatly improve the performance of this method.
Return Value
  • Type:Int32
  • Description:This method returns the count of the number of records in this FeatureSource.
Parameters

CanGetCountQuicklyCore()

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

GetFirstFeaturesWellKnownTypeCore()

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

GetDistinctColumnValuesCore(String)

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

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

CanGetBoundingBoxQuicklyCore()

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

CloneDeepCore()

  • N/A
Remarks
  • N/A
Return Value
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
    • Type:StreamLoadingEventArgs
    • Description:This parameter represents the event arguments you want to raise the StreamLoading event with.

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

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

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

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

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

OnBuildingIndex(BuildingIndexShapeFileFeatureSourceEventArgs)

  • This method allows you to raise the BuildingIndex event.
Remarks
  • This method allows you to raise the BuildingIndex 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

OnRebuilding(RebuildingShapeFileFeatureSourceEventArgs)

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

Public Properties

ShapePathFileName

  • This property returns the path and file of the shape 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.shp” 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

IndexPathFileName

  • This property gets and sets the path and file of the index 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.idx” 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

ReadWriteMode

  • N/A
Remarks
  • N/A
Return Value

IsEditable

  • This property returns if the FeatureSource allows edits or is read only.
Remarks
  • This property is useful to check if a specific FeatureSource accepts editing. If you call the BeginTransaction and this property is false then an exception will be raised. For developers who are creating or extending a FeatureSource it is expected that you override this virtual method if the new FeatureSource you are creating allows edits. By default the decimalDegreesValue if false meaning that if you want to allow edits you must override this method and return true.
Return Value
  • Type:Boolean

UsingSpatialIndex

  • This property gets the shape file feature source with index or not.
Remarks
  • N/A
Return Value
  • Type:Boolean

RequireIndex

  • This property gets and sets the requirement of index when reading data. The default value is true.
Remarks
  • N/A
Return Value
  • Type:Boolean

Encoding

  • This property get and set the encoding information for the dbf.
Remarks
  • N/A
Return Value
  • Type:Encoding

SimplificationAreaInPixel

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

SimplifiedAreas

  • N/A
Remarks
  • N/A
Return Value

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

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

  • This property specifies the FeatureSource can excute sql query or not. If it is false, then it will throw exception when called the APIs:ExecuteScalar,ExecuteNonQuery,ExecuteQuery This orverides will make it true.
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 PathFileName property.

Event Arguments:StreamLoadingEventArgs

BuildingIndex

  • This event will be fired each time a record was built the rtree index. You can choose to use this event to build the build index progess bar.
Remarks
  • N/A

Event Arguments:BuildingIndexShapeFileFeatureSourceEventArgs

Rebuilding

  • N/A
Remarks
  • N/A

Event Arguments:RebuildingShapeFileFeatureSourceEventArgs

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.shapefilefeaturesource.1442972462.txt.gz · Last modified: 2015/09/23 01:41 by admin

Page Tools