Skip to content

InMemoryFeatureSource

Inheritance Hierarchy

Members Summary

Public Constructors Summary

Name
InMemoryFeatureSource()
InMemoryFeatureSource(IEnumerable<FeatureSourceColumn>)
InMemoryFeatureSource(IEnumerable<FeatureSourceColumn>,IEnumerable<Feature>)
InMemoryFeatureSource(IEnumerable<FeatureSourceColumn>,IEnumerable<BaseShape>)

Protected Constructors Summary

Name
N/A

Public Properties Summary

Name Return Type Description
CanExecuteSqlQuery Boolean N/A
CanModifyColumnStructure Boolean N/A
FeatureIdsToExclude Collection<String> N/A
GeoCache FeatureCache N/A
Id String N/A
InternalFeatures GeoCollection<Feature> This property returns the underlying InternalFeatures stored in memory.
IsEditable Boolean This property returns if the FeatureSource allows edits or is read only.
IsInTransaction Boolean N/A
IsOpen Boolean N/A
IsTransactionLive Boolean N/A
MaxRecordsToDraw Int32 N/A
Projection Projection N/A
ProjectionConverter ProjectionConverter N/A
TransactionBuffer TransactionBuffer N/A

Protected Properties Summary

Name Return Type Description
CanExecuteSqlQueryCore Boolean N/A
CanModifyColumnStructureCore Boolean N/A
Columns Collection<FeatureSourceColumn> This property gets the columns of data for the InternalFeatures in this Layer.
FeatureSourceColumns Collection<FeatureSourceColumn> N/A
IsOpenCore Boolean N/A

Public Methods Summary

Name
AddColumn(FeatureSourceColumn)
AddFeature(Feature)
AddFeature(BaseShape)
AddFeature(BaseShape,IDictionary<String,String>)
BeginTransaction()
BuildIndex()
CanGetBoundingBoxQuickly()
CanGetCountQuickly()
Clear()
CloneDeep()
Close()
CommitTransaction()
DeleteColumn(String)
DeleteFeature(String)
Equals(Object)
ExecuteNonQuery(String)
ExecuteQuery(String)
ExecuteScalar(String)
GetAllFeatures(ReturningColumnsType,Int32)
GetAllFeatures(ReturningColumnsType,Int32,Int32)
GetAllFeatures(IEnumerable<String>,Int32,Int32)
GetAllFeatures(IEnumerable<String>)
GetAllFeatures(ReturningColumnsType)
GetBoundingBox()
GetBoundingBoxById(String)
GetBoundingBoxByIds(IEnumerable<String>)
GetBoundingBoxesByIds(IEnumerable<String>)
GetColumnNamesOutsideFeatureSource(IEnumerable<String>)
GetColumns()
GetCount()
GetDistinctColumnValues(String)
GetFeatureById(String,IEnumerable<String>)
GetFeatureById(String,ReturningColumnsType)
GetFeatureIds()
GetFeatureIdsInsideBoundingBox(RectangleShape)
GetFeaturesByColumnValue(String,String,ReturningColumnsType)
GetFeaturesByColumnValue(String,String,IEnumerable<String>)
GetFeaturesByColumnValue(String,String)
GetFeaturesByIds(IEnumerable<String>,IEnumerable<String>)
GetFeaturesByIds(IEnumerable<String>,ReturningColumnsType)
GetFeaturesForDrawing(RectangleShape,Double,Double,IEnumerable<String>)
GetFeaturesForDrawing(RectangleShape,Double,Double,ReturningColumnsType)
GetFeaturesInsideBoundingBox(RectangleShape,IEnumerable<String>)
GetFeaturesInsideBoundingBox(RectangleShape,ReturningColumnsType)
GetFeaturesNearestTo(BaseShape,GeographyUnit,Int32,IEnumerable<String>)
GetFeaturesNearestTo(BaseShape,GeographyUnit,Int32,ReturningColumnsType)
GetFeaturesNearestTo(Feature,GeographyUnit,Int32,IEnumerable<String>)
GetFeaturesNearestTo(Feature,GeographyUnit,Int32,ReturningColumnsType)
GetFeaturesNearestTo(BaseShape,GeographyUnit,Int32,IEnumerable<String>,Double,DistanceUnit)
GetFeaturesNearestTo(Feature,GeographyUnit,Int32,IEnumerable<String>,Double,DistanceUnit)
GetFeaturesOutsideBoundingBox(RectangleShape,IEnumerable<String>)
GetFeaturesOutsideBoundingBox(RectangleShape,ReturningColumnsType)
GetFeaturesWithinDistanceOf(BaseShape,GeographyUnit,DistanceUnit,Double,IEnumerable<String>)
GetFeaturesWithinDistanceOf(BaseShape,GeographyUnit,DistanceUnit,Double,ReturningColumnsType)
GetFeaturesWithinDistanceOf(Feature,GeographyUnit,DistanceUnit,Double,IEnumerable<String>)
GetFeaturesWithinDistanceOf(Feature,GeographyUnit,DistanceUnit,Double,ReturningColumnsType)
GetFirstFeaturesWellKnownType()
GetHashCode()
GetType()
Open()
RefreshColumns()
RemoveEmptyAndExcludedFeatures(Collection<Feature>)
RollbackTransaction()
SpatialQuery(BaseShape,QueryType,IEnumerable<String>)
SpatialQuery(BaseShape,QueryType,ReturningColumnsType)
SpatialQuery(Feature,QueryType,IEnumerable<String>)
SpatialQuery(Feature,QueryType,ReturningColumnsType)
ToString()
UpdateColumn(String,FeatureSourceColumn)
UpdateFeature(Feature)
UpdateFeature(BaseShape)
UpdateFeature(BaseShape,IDictionary<String,String>)

Protected Methods Summary

Name
CanGetBoundingBoxQuicklyCore()
CanGetCountQuicklyCore()
CloneDeepCore()
CloseCore()
CommitTransactionCore(TransactionBuffer)
ExecuteNonQueryCore(String)
ExecuteQueryCore(String)
ExecuteScalarCore(String)
Finalize()
GetAllFeaturesCore(IEnumerable<String>)
GetAllFeaturesCore(IEnumerable<String>,Int32,Int32)
GetBoundingBoxByIdCore(String)
GetBoundingBoxCore()
GetColumnNamesInsideFeatureSource(IEnumerable<String>)
GetColumnNamesOutsideFeatureSourceCall(IEnumerable<String>)
GetColumnsCore()
GetCountCore()
GetDistinctColumnValuesCore(String)
GetFeatureIdsCore()
GetFeatureIdsInsideBoundingBoxCore(RectangleShape)
GetFeaturesByColumnValueCore(String,String,IEnumerable<String>)
GetFeaturesByIdsCore(IEnumerable<String>,IEnumerable<String>)
GetFeaturesForDrawingCore(RectangleShape,Double,Double,IEnumerable<String>)
GetFeaturesInsideBoundingBoxByReference(RectangleShape,IEnumerable<String>)
GetFeaturesInsideBoundingBoxCore(RectangleShape,IEnumerable<String>)
GetFeaturesNearestToCore(BaseShape,GeographyUnit,Int32,IEnumerable<String>)
GetFeaturesOutsideBoundingBoxCore(RectangleShape,IEnumerable<String>)
GetFeaturesWithinDistanceOfCore(BaseShape,GeographyUnit,DistanceUnit,Double,IEnumerable<String>)
GetFirstFeaturesWellKnownTypeCore()
GetReturningColumnNames(ReturningColumnsType)
MemberwiseClone()
OnClosedFeatureSource(ClosedFeatureSourceEventArgs)
OnClosingFeatureSource(ClosingFeatureSourceEventArgs)
OnCommittedTransaction(CommittedTransactionEventArgs)
OnCommittingTransaction(CommittingTransactionEventArgs)
OnCustomColumnFetch(CustomColumnFetchEventArgs)
OnDrawingProgressChanged(DrawingProgressChangedEventArgs)
OnGettingColumns(GettingColumnsFeatureSourceEventArgs)
OnGettingFeaturesByIds(GettingFeaturesByIdsFeatureSourceEventArgs)
OnGettingFeaturesForDrawing(GettingFeaturesForDrawingFeatureSourceEventArgs)
OnGottenColumns(GottenColumnsFeatureSourceEventArgs)
OnOpenedFeatureSource(OpenedFeatureSourceEventArgs)
OnOpeningFeatureSource(OpeningFeatureSourceEventArgs)
OpenCore()
ProcessTransaction(RectangleShape,Collection<Feature>,Boolean)
RaiseCustomColumnFetchEvent(Collection<Feature>,Collection<String>)
SpatialQueryCore(BaseShape,QueryType,IEnumerable<String>)

Public Events Summary

Name Event Arguments Description
DrawingProgressChanged DrawingProgressChangedEventArgs N/A
GettingColumns GettingColumnsFeatureSourceEventArgs N/A
GottenColumns GottenColumnsFeatureSourceEventArgs N/A
GettingFeaturesByIds GettingFeaturesByIdsFeatureSourceEventArgs N/A
GettingFeaturesForDrawing GettingFeaturesForDrawingFeatureSourceEventArgs N/A
CustomColumnFetch CustomColumnFetchEventArgs N/A
CommittingTransaction CommittingTransactionEventArgs N/A
CommittedTransaction CommittedTransactionEventArgs N/A
OpeningFeatureSource OpeningFeatureSourceEventArgs N/A
OpenedFeatureSource OpenedFeatureSourceEventArgs N/A
ClosingFeatureSource ClosingFeatureSourceEventArgs N/A
ClosedFeatureSource ClosedFeatureSourceEventArgs N/A

Members Detail

Public Constructors

Name
InMemoryFeatureSource()
InMemoryFeatureSource(IEnumerable<FeatureSourceColumn>)
InMemoryFeatureSource(IEnumerable<FeatureSourceColumn>,IEnumerable<Feature>)
InMemoryFeatureSource(IEnumerable<FeatureSourceColumn>,IEnumerable<BaseShape>)

Protected Constructors

Public Properties

CanExecuteSqlQuery

Summary

N/A

Remarks

N/A

Return Value

Boolean


CanModifyColumnStructure

Summary

N/A

Remarks

N/A

Return Value

Boolean


FeatureIdsToExclude

Summary

N/A

Remarks

N/A

Return Value

Collection<String>


GeoCache

Summary

N/A

Remarks

N/A

Return Value

FeatureCache


Id

Summary

N/A

Remarks

N/A

Return Value

String


InternalFeatures

Summary

This property returns the underlying InternalFeatures stored in memory.

Remarks

This property allows you to modify and inspect the InternalFeatures held by this FeatureSource in memory. You can use this as a quick way to add, update or remove InternalFeatures.

Return Value

GeoCollection<Feature>


IsEditable

Summary

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

Boolean


IsInTransaction

Summary

N/A

Remarks

N/A

Return Value

Boolean


IsOpen

Summary

N/A

Remarks

N/A

Return Value

Boolean


IsTransactionLive

Summary

N/A

Remarks

N/A

Return Value

Boolean


MaxRecordsToDraw

Summary

N/A

Remarks

N/A

Return Value

Int32


Projection

Summary

N/A

Remarks

N/A

Return Value

Projection


ProjectionConverter

Summary

N/A

Remarks

N/A

Return Value

ProjectionConverter


TransactionBuffer

Summary

N/A

Remarks

N/A

Return Value

TransactionBuffer


Protected Properties

CanExecuteSqlQueryCore

Summary

N/A

Remarks

N/A

Return Value

Boolean


CanModifyColumnStructureCore

Summary

N/A

Remarks

N/A

Return Value

Boolean


Columns

Summary

This property gets the columns of data for the InternalFeatures in this Layer.

Remarks

You should set the column names for the data that the InternalFeatures will hold. For example, if you have some features that represent road signs, then one column you may want to add is "Sign Type". Then, for every Feature you add to the layer, you need to add the "Sign Type" and a value to the InternalFeatures' ColumnValues dictionary. If you provide this information, then you can use things like ValueStyles, Labeling, etc. based on the columns you have defined.

Return Value

Collection<FeatureSourceColumn>


FeatureSourceColumns

Summary

N/A

Remarks

N/A

Return Value

Collection<FeatureSourceColumn>


IsOpenCore

Summary

N/A

Remarks

N/A

Return Value

Boolean


Public Methods

AddColumn(FeatureSourceColumn)

Summary

N/A

Remarks

N/A

Return Value

Type Description
Void N/A

Parameters

Name Type Description
featureSourceColumn FeatureSourceColumn N/A

AddFeature(Feature)

Summary

N/A

Remarks

N/A

Return Value

Type Description
String N/A

Parameters

Name Type Description
feature Feature N/A

AddFeature(BaseShape)

Summary

N/A

Remarks

N/A

Return Value

Type Description
String N/A

Parameters

Name Type Description
shape BaseShape N/A

AddFeature(BaseShape,IDictionary<String,String>)

Summary

N/A

Remarks

N/A

Return Value

Type Description
String N/A

Parameters

Name Type Description
shape BaseShape N/A
columnValues IDictionary<String,String> N/A

BeginTransaction()

Summary

N/A

Remarks

N/A

Return Value

Type Description
Void N/A

Parameters

Name Type Description
N/A N/A N/A

BuildIndex()

Summary

This method build a spatial index for a passed group of featurs which increases access speed.

Remarks

N/A

Return Value

Type Description
Void N/A

Parameters

Name Type Description
N/A N/A N/A

CanGetBoundingBoxQuickly()

Summary

N/A

Remarks

N/A

Return Value

Type Description
Boolean N/A

Parameters

Name Type Description
N/A N/A N/A

CanGetCountQuickly()

Summary

N/A

Remarks

N/A

Return Value

Type Description
Boolean N/A

Parameters

Name Type Description
N/A N/A N/A

Clear()

Summary

This method will clear all the features included in the feature source.

Remarks

N/A

Return Value

Type Description
Void N/A

Parameters

Name Type Description
N/A N/A N/A

CloneDeep()

Summary

N/A

Remarks

N/A

Return Value

Type Description
FeatureSource N/A

Parameters

Name Type Description
N/A N/A N/A

Close()

Summary

N/A

Remarks

N/A

Return Value

Type Description
Void N/A

Parameters

Name Type Description
N/A N/A N/A

CommitTransaction()

Summary

N/A

Remarks

N/A

Return Value

Type Description
TransactionResult N/A

Parameters

Name Type Description
N/A N/A N/A

DeleteColumn(String)

Summary

N/A

Remarks

N/A

Return Value

Type Description
Void N/A

Parameters

Name Type Description
columnName String N/A

DeleteFeature(String)

Summary

N/A

Remarks

N/A

Return Value

Type Description
Void N/A

Parameters

Name Type Description
id String N/A

Equals(Object)

Summary

N/A

Remarks

N/A

Return Value

Type Description
Boolean N/A

Parameters

Name Type Description
obj Object N/A

ExecuteNonQuery(String)

Summary

N/A

Remarks

N/A

Return Value

Type Description
Int32 N/A

Parameters

Name Type Description
sqlStatement String N/A

ExecuteQuery(String)

Summary

N/A

Remarks

N/A

Return Value

Type Description
DataTable N/A

Parameters

Name Type Description
sqlStatement String N/A

ExecuteScalar(String)

Summary

N/A

Remarks

N/A

Return Value

Type Description
Object N/A

Parameters

Name Type Description
sqlStatement String N/A

GetAllFeatures(ReturningColumnsType,Int32)

Summary

N/A

Remarks

N/A

Return Value

Type Description
Collection<Feature> N/A

Parameters

Name Type Description
returningColumnTypes ReturningColumnsType N/A
startIndex Int32 N/A

GetAllFeatures(ReturningColumnsType,Int32,Int32)

Summary

N/A

Remarks

N/A

Return Value

Type Description
Collection<Feature> N/A

Parameters

Name Type Description
returningColumnTypes ReturningColumnsType N/A
startIndex Int32 N/A
takeCount Int32 N/A

GetAllFeatures(IEnumerable<String>,Int32,Int32)

Summary

N/A

Remarks

N/A

Return Value

Type Description
Collection<Feature> N/A

Parameters

Name Type Description
returningColumnNames IEnumerable<String> N/A
startIndex Int32 N/A
takeCount Int32 N/A

GetAllFeatures(IEnumerable<String>)

Summary

N/A

Remarks

N/A

Return Value

Type Description
Collection<Feature> N/A

Parameters

Name Type Description
returningColumnNames IEnumerable<String> N/A

GetAllFeatures(ReturningColumnsType)

Summary

N/A

Remarks

N/A

Return Value

Type Description
Collection<Feature> N/A

Parameters

Name Type Description
returningColumnNamesType ReturningColumnsType N/A

GetBoundingBox()

Summary

N/A

Remarks

N/A

Return Value

Type Description
RectangleShape N/A

Parameters

Name Type Description
N/A N/A N/A

GetBoundingBoxById(String)

Summary

N/A

Remarks

N/A

Return Value

Type Description
RectangleShape N/A

Parameters

Name Type Description
id String N/A

GetBoundingBoxByIds(IEnumerable<String>)

Summary

N/A

Remarks

N/A

Return Value

Type Description
RectangleShape N/A

Parameters

Name Type Description
ids IEnumerable<String> N/A

GetBoundingBoxesByIds(IEnumerable<String>)

Summary

N/A

Remarks

N/A

Return Value

Type Description
Collection<RectangleShape> N/A

Parameters

Name Type Description
ids IEnumerable<String> N/A

GetColumnNamesOutsideFeatureSource(IEnumerable<String>)

Summary

N/A

Remarks

N/A

Return Value

Type Description
Collection<String> N/A

Parameters

Name Type Description
returningColumnNames IEnumerable<String> N/A

GetColumns()

Summary

N/A

Remarks

N/A

Return Value

Type Description
Collection<FeatureSourceColumn> N/A

Parameters

Name Type Description
N/A N/A N/A

GetCount()

Summary

N/A

Remarks

N/A

Return Value

Type Description
Int64 N/A

Parameters

Name Type Description
N/A N/A N/A

GetDistinctColumnValues(String)

Summary

N/A

Remarks

N/A

Return Value

Type Description
Collection<DistinctColumnValue> N/A

Parameters

Name Type Description
columnName String N/A

GetFeatureById(String,IEnumerable<String>)

Summary

N/A

Remarks

N/A

Return Value

Type Description
Feature N/A

Parameters

Name Type Description
id String N/A
returningColumnNames IEnumerable<String> N/A

GetFeatureById(String,ReturningColumnsType)

Summary

N/A

Remarks

N/A

Return Value

Type Description
Feature N/A

Parameters

Name Type Description
id String N/A
returningColumnNamesType ReturningColumnsType N/A

GetFeatureIds()

Summary

N/A

Remarks

N/A

Return Value

Type Description
Collection<String> N/A

Parameters

Name Type Description
N/A N/A N/A

GetFeatureIdsInsideBoundingBox(RectangleShape)

Summary

N/A

Remarks

N/A

Return Value

Type Description
Collection<String> N/A

Parameters

Name Type Description
boundingBox RectangleShape N/A

GetFeaturesByColumnValue(String,String,ReturningColumnsType)

Summary

N/A

Remarks

N/A

Return Value

Type Description
Collection<Feature> N/A

Parameters

Name Type Description
columnName String N/A
columnValue String N/A
returningColumnType ReturningColumnsType N/A

GetFeaturesByColumnValue(String,String,IEnumerable<String>)

Summary

N/A

Remarks

N/A

Return Value

Type Description
Collection<Feature> N/A

Parameters

Name Type Description
columnName String N/A
columnValue String N/A
returningColumnNames IEnumerable<String> N/A

GetFeaturesByColumnValue(String,String)

Summary

N/A

Remarks

N/A

Return Value

Type Description
Collection<Feature> N/A

Parameters

Name Type Description
columnName String N/A
columnValue String N/A

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

Summary

N/A

Remarks

N/A

Return Value

Type Description
Collection<Feature> N/A

Parameters

Name Type Description
ids IEnumerable<String> N/A
returningColumnNames IEnumerable<String> N/A

GetFeaturesByIds(IEnumerable<String>,ReturningColumnsType)

Summary

N/A

Remarks

N/A

Return Value

Type Description
Collection<Feature> N/A

Parameters

Name Type Description
ids IEnumerable<String> N/A
returningColumnNamesType ReturningColumnsType N/A

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

Summary

N/A

Remarks

N/A

Return Value

Type Description
Collection<Feature> N/A

Parameters

Name Type Description
boundingBox RectangleShape N/A
screenWidth Double N/A
screenHeight Double N/A
returningColumnNames IEnumerable<String> N/A

GetFeaturesForDrawing(RectangleShape,Double,Double,ReturningColumnsType)

Summary

N/A

Remarks

N/A

Return Value

Type Description
Collection<Feature> N/A

Parameters

Name Type Description
boundingBox RectangleShape N/A
screenWidth Double N/A
screenHeight Double N/A
returningColumnNamesType ReturningColumnsType N/A

GetFeaturesInsideBoundingBox(RectangleShape,IEnumerable<String>)

Summary

N/A

Remarks

N/A

Return Value

Type Description
Collection<Feature> N/A

Parameters

Name Type Description
boundingBox RectangleShape N/A
returningColumnNames IEnumerable<String> N/A

GetFeaturesInsideBoundingBox(RectangleShape,ReturningColumnsType)

Summary

N/A

Remarks

N/A

Return Value

Type Description
Collection<Feature> N/A

Parameters

Name Type Description
boundingBox RectangleShape N/A
returningColumnNamesType ReturningColumnsType N/A

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

Summary

N/A

Remarks

N/A

Return Value

Type Description
Collection<Feature> N/A

Parameters

Name Type Description
targetShape BaseShape N/A
unitOfFeatureSource GeographyUnit N/A
maxItemsToFind Int32 N/A
returningColumnNames IEnumerable<String> N/A

GetFeaturesNearestTo(BaseShape,GeographyUnit,Int32,ReturningColumnsType)

Summary

N/A

Remarks

N/A

Return Value

Type Description
Collection<Feature> N/A

Parameters

Name Type Description
targetShape BaseShape N/A
unitOfData GeographyUnit N/A
maxItemsToFind Int32 N/A
returningColumnNamesType ReturningColumnsType N/A

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

Summary

N/A

Remarks

N/A

Return Value

Type Description
Collection<Feature> N/A

Parameters

Name Type Description
targetFeature Feature N/A
unitOfData GeographyUnit N/A
maxItemsToFind Int32 N/A
returningColumnNames IEnumerable<String> N/A

GetFeaturesNearestTo(Feature,GeographyUnit,Int32,ReturningColumnsType)

Summary

N/A

Remarks

N/A

Return Value

Type Description
Collection<Feature> N/A

Parameters

Name Type Description
targetFeature Feature N/A
unitOfData GeographyUnit N/A
maxItemsToFind Int32 N/A
returningColumnNamesType ReturningColumnsType N/A

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

Summary

N/A

Remarks

N/A

Return Value

Type Description
Collection<Feature> N/A

Parameters

Name Type Description
targetShape BaseShape N/A
unitOfData GeographyUnit N/A
maxItemsToFind Int32 N/A
returningColumnNames IEnumerable<String> N/A
searchRadius Double N/A
unitOfSearchRadius DistanceUnit N/A

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

Summary

N/A

Remarks

N/A

Return Value

Type Description
Collection<Feature> N/A

Parameters

Name Type Description
targetFeature Feature N/A
unitOfData GeographyUnit N/A
maxItemsToFind Int32 N/A
returningColumnNames IEnumerable<String> N/A
searchRadius Double N/A
unitOfSearchRadius DistanceUnit N/A

GetFeaturesOutsideBoundingBox(RectangleShape,IEnumerable<String>)

Summary

N/A

Remarks

N/A

Return Value

Type Description
Collection<Feature> N/A

Parameters

Name Type Description
boundingBox RectangleShape N/A
returningColumnNames IEnumerable<String> N/A

GetFeaturesOutsideBoundingBox(RectangleShape,ReturningColumnsType)

Summary

N/A

Remarks

N/A

Return Value

Type Description
Collection<Feature> N/A

Parameters

Name Type Description
boundingBox RectangleShape N/A
returningColumnNamesType ReturningColumnsType N/A

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

Summary

N/A

Remarks

N/A

Return Value

Type Description
Collection<Feature> N/A

Parameters

Name Type Description
targetShape BaseShape N/A
unitOfData GeographyUnit N/A
distanceUnit DistanceUnit N/A
distance Double N/A
returningColumnNames IEnumerable<String> N/A

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

Summary

N/A

Remarks

N/A

Return Value

Type Description
Collection<Feature> N/A

Parameters

Name Type Description
targetShape BaseShape N/A
unitOfData GeographyUnit N/A
distanceUnit DistanceUnit N/A
distance Double N/A
returningColumnNamesType ReturningColumnsType N/A

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

Summary

N/A

Remarks

N/A

Return Value

Type Description
Collection<Feature> N/A

Parameters

Name Type Description
targetFeature Feature N/A
unitOfData GeographyUnit N/A
distanceUnit DistanceUnit N/A
distance Double N/A
returningColumnNames IEnumerable<String> N/A

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

Summary

N/A

Remarks

N/A

Return Value

Type Description
Collection<Feature> N/A

Parameters

Name Type Description
targetFeature Feature N/A
unitOfData GeographyUnit N/A
distanceUnit DistanceUnit N/A
distance Double N/A
returningColumnNamesType ReturningColumnsType N/A

GetFirstFeaturesWellKnownType()

Summary

N/A

Remarks

N/A

Return Value

Type Description
WellKnownType N/A

Parameters

Name Type Description
N/A N/A N/A

GetHashCode()

Summary

N/A

Remarks

N/A

Return Value

Type Description
Int32 N/A

Parameters

Name Type Description
N/A N/A N/A

GetType()

Summary

N/A

Remarks

N/A

Return Value

Type Description
Type N/A

Parameters

Name Type Description
N/A N/A N/A

Open()

Summary

N/A

Remarks

N/A

Return Value

Type Description
Void N/A

Parameters

Name Type Description
N/A N/A N/A

RefreshColumns()

Summary

N/A

Remarks

N/A

Return Value

Type Description
Void N/A

Parameters

Name Type Description
N/A N/A N/A

RemoveEmptyAndExcludedFeatures(Collection<Feature>)

Summary

N/A

Remarks

N/A

Return Value

Type Description
Void N/A

Parameters

Name Type Description
features Collection<Feature> N/A

RollbackTransaction()

Summary

N/A

Remarks

N/A

Return Value

Type Description
Void N/A

Parameters

Name Type Description
N/A N/A N/A

SpatialQuery(BaseShape,QueryType,IEnumerable<String>)

Summary

N/A

Remarks

N/A

Return Value

Type Description
Collection<Feature> N/A

Parameters

Name Type Description
targetShape BaseShape N/A
queryType QueryType N/A
returningColumnNames IEnumerable<String> N/A

SpatialQuery(BaseShape,QueryType,ReturningColumnsType)

Summary

N/A

Remarks

N/A

Return Value

Type Description
Collection<Feature> N/A

Parameters

Name Type Description
targetShape BaseShape N/A
queryType QueryType N/A
returningColumnNamesType ReturningColumnsType N/A

SpatialQuery(Feature,QueryType,IEnumerable<String>)

Summary

N/A

Remarks

N/A

Return Value

Type Description
Collection<Feature> N/A

Parameters

Name Type Description
feature Feature N/A
queryType QueryType N/A
returningColumnNames IEnumerable<String> N/A

SpatialQuery(Feature,QueryType,ReturningColumnsType)

Summary

N/A

Remarks

N/A

Return Value

Type Description
Collection<Feature> N/A

Parameters

Name Type Description
feature Feature N/A
queryType QueryType N/A
returningColumnNamesType ReturningColumnsType N/A

ToString()

Summary

N/A

Remarks

N/A

Return Value

Type Description
String N/A

Parameters

Name Type Description
N/A N/A N/A

UpdateColumn(String,FeatureSourceColumn)

Summary

N/A

Remarks

N/A

Return Value

Type Description
Void N/A

Parameters

Name Type Description
columnName String N/A
newFeatureSourceColumn FeatureSourceColumn N/A

UpdateFeature(Feature)

Summary

N/A

Remarks

N/A

Return Value

Type Description
Void N/A

Parameters

Name Type Description
feature Feature N/A

UpdateFeature(BaseShape)

Summary

N/A

Remarks

N/A

Return Value

Type Description
Void N/A

Parameters

Name Type Description
shape BaseShape N/A

UpdateFeature(BaseShape,IDictionary<String,String>)

Summary

N/A

Remarks

N/A

Return Value

Type Description
Void N/A

Parameters

Name Type Description
shape BaseShape N/A
columnValues IDictionary<String,String> N/A

Protected Methods

CanGetBoundingBoxQuicklyCore()

Summary

N/A

Remarks

N/A

Return Value

Type Description
Boolean N/A

Parameters

Name Type Description
N/A N/A N/A

CanGetCountQuicklyCore()

Summary

N/A

Remarks

N/A

Return Value

Type Description
Boolean N/A

Parameters

Name Type Description
N/A N/A N/A

CloneDeepCore()

Summary

N/A

Remarks

N/A

Return Value

Type Description
FeatureSource N/A

Parameters

Name Type Description
N/A N/A N/A

CloseCore()

Summary

N/A

Remarks

N/A

Return Value

Type Description
Void N/A

Parameters

Name Type Description
N/A N/A N/A

CommitTransactionCore(TransactionBuffer)

Summary

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 Description
TransactionResult 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

Name Type Description
transactions TransactionBuffer 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.

ExecuteNonQueryCore(String)

Summary

N/A

Remarks

N/A

Return Value

Type Description
Int32 N/A

Parameters

Name Type Description
sqlStatement String N/A

ExecuteQueryCore(String)

Summary

N/A

Remarks

N/A

Return Value

Type Description
DataTable N/A

Parameters

Name Type Description
sqlStatement String N/A

ExecuteScalarCore(String)

Summary

N/A

Remarks

N/A

Return Value

Type Description
Object N/A

Parameters

Name Type Description
sqlStatement String N/A

Finalize()

Summary

N/A

Remarks

N/A

Return Value

Type Description
Void N/A

Parameters

Name Type Description
N/A N/A N/A

GetAllFeaturesCore(IEnumerable<String>)

Summary

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 Description
Collection<Feature> The return decimalDegreesValue is a collection of all of the InternalFeatures in the FeatureSource.

Parameters

Name Type Description
returningColumnNames IEnumerable<String> 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)

Summary

N/A

Remarks

N/A

Return Value

Type Description
Collection<Feature> N/A

Parameters

Name Type Description
returningColumnNames IEnumerable<String> N/A
startIndex Int32 N/A
takeCount Int32 N/A

GetBoundingBoxByIdCore(String)

Summary

N/A

Remarks

N/A

Return Value

Type Description
RectangleShape N/A

Parameters

Name Type Description
id String N/A

GetBoundingBoxCore()

Summary

N/A

Remarks

N/A

Return Value

Type Description
RectangleShape N/A

Parameters

Name Type Description
N/A N/A N/A

GetColumnNamesInsideFeatureSource(IEnumerable<String>)

Summary

N/A

Remarks

N/A

Return Value

Type Description
Collection<String> N/A

Parameters

Name Type Description
returningColumnNames IEnumerable<String> N/A

GetColumnNamesOutsideFeatureSourceCall(IEnumerable<String>)

Summary

N/A

Remarks

N/A

Return Value

Type Description
Collection<String> N/A

Parameters

Name Type Description
returningColumnNames IEnumerable<String> N/A

GetColumnsCore()

Summary

This method returns the columns available for the FeatureSource.

Remarks

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 Description
Collection<FeatureSourceColumn> This method returns the columns available for the FeatureSource.

Parameters

Name Type Description
N/A N/A N/A

GetCountCore()

Summary

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 Description
Int64 This method returns the count of the number of records in this FeatureSource.

Parameters

Name Type Description
N/A N/A N/A

GetDistinctColumnValuesCore(String)

Summary

N/A

Remarks

N/A

Return Value

Type Description
Collection<DistinctColumnValue> N/A

Parameters

Name Type Description
columnName String N/A

GetFeatureIdsCore()

Summary

N/A

Remarks

N/A

Return Value

Type Description
Collection<String> N/A

Parameters

Name Type Description
N/A N/A N/A

GetFeatureIdsInsideBoundingBoxCore(RectangleShape)

Summary

N/A

Remarks

N/A

Return Value

Type Description
Collection<String> N/A

Parameters

Name Type Description
boundingBox RectangleShape N/A

GetFeaturesByColumnValueCore(String,String,IEnumerable<String>)

Summary

N/A

Remarks

N/A

Return Value

Type Description
Collection<Feature> N/A

Parameters

Name Type Description
columnName String N/A
columnValue String N/A
returningColumnNames IEnumerable<String> N/A

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

Summary

N/A

Remarks

N/A

Return Value

Type Description
Collection<Feature> N/A

Parameters

Name Type Description
ids IEnumerable<String> N/A
returningColumnNames IEnumerable<String> N/A

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

Summary

N/A

Remarks

N/A

Return Value

Type Description
Collection<Feature> N/A

Parameters

Name Type Description
boundingBox RectangleShape N/A
screenWidth Double N/A
screenHeight Double N/A
returningColumnNames IEnumerable<String> N/A

GetFeaturesInsideBoundingBoxByReference(RectangleShape,IEnumerable<String>)

Summary

N/A

Remarks

N/A

Return Value

Type Description
Collection<Feature> N/A

Parameters

Name Type Description
boundingBox RectangleShape N/A
returningColumnNames IEnumerable<String> N/A

GetFeaturesInsideBoundingBoxCore(RectangleShape,IEnumerable<String>)

Summary

This method returns all of the InternalFeatures of this FeatureSource that are inside of the specified bounding box.

Remarks

This method returns all of the InternalFeatures of this FeatureSource that are inside of the specified bounding box. If you are overriding this method you will not need to consider anything about transactions, as this is handled by the concrete version of this method. The default implementation of GetFeaturesInsideBoundingBoxCore uses the GetAllRecordsCore method to determine which InternalFeatures are inside of the bounding box. We strongly recommend that you provide your own implementation for this method that will be more efficient. That is especially important for this method, as many other default virtual methods use this for their calculations. When you override this method, we highly recommend that you use any spatial indexes you have at your disposal to make this method as fast as possible.

Return Value

Type Description
Collection<Feature> The returned decimalDegreesValue is a collection of all of the InternalFeatures that are inside of the bounding box.

Parameters

Name Type Description
boundingBox RectangleShape This parameter represents the bounding box that you wish to find InternalFeatures inside of.
returningColumnNames IEnumerable<String> This parameter allows you to select the field names of the column data that you wish to return with each Feature.

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

Summary

N/A

Remarks

N/A

Return Value

Type Description
Collection<Feature> N/A

Parameters

Name Type Description
targetShape BaseShape N/A
unitOfData GeographyUnit N/A
maxItemsToFind Int32 N/A
returningColumnNames IEnumerable<String> N/A

GetFeaturesOutsideBoundingBoxCore(RectangleShape,IEnumerable<String>)

Summary

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, this method 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 Description
Collection<Feature> This method returns all of the InternalFeatures of this FeatureSource outside of the specified bounding box.

Parameters

Name Type Description
boundingBox RectangleShape This parameter represents the bounding box that you wish to find InternalFeatures outside of.
returningColumnNames IEnumerable<String> This parameter allows you to select the field names of the column data you wish to return with each Feature.

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

Summary

N/A

Remarks

N/A

Return Value

Type Description
Collection<Feature> N/A

Parameters

Name Type Description
targetShape BaseShape N/A
unitOfData GeographyUnit N/A
distanceUnit DistanceUnit N/A
distance Double N/A
returningColumnNames IEnumerable<String> N/A

GetFirstFeaturesWellKnownTypeCore()

Summary

N/A

Remarks

N/A

Return Value

Type Description
WellKnownType N/A

Parameters

Name Type Description
N/A N/A N/A

GetReturningColumnNames(ReturningColumnsType)

Summary

N/A

Remarks

N/A

Return Value

Type Description
Collection<String> N/A

Parameters

Name Type Description
returningColumnNamesType ReturningColumnsType N/A

MemberwiseClone()

Summary

N/A

Remarks

N/A

Return Value

Type Description
Object N/A

Parameters

Name Type Description
N/A N/A N/A

OnClosedFeatureSource(ClosedFeatureSourceEventArgs)

Summary

N/A

Remarks

N/A

Return Value

Type Description
Void N/A

Parameters

Name Type Description
e ClosedFeatureSourceEventArgs N/A

OnClosingFeatureSource(ClosingFeatureSourceEventArgs)

Summary

N/A

Remarks

N/A

Return Value

Type Description
Void N/A

Parameters

Name Type Description
e ClosingFeatureSourceEventArgs N/A

OnCommittedTransaction(CommittedTransactionEventArgs)

Summary

N/A

Remarks

N/A

Return Value

Type Description
Void N/A

Parameters

Name Type Description
e CommittedTransactionEventArgs N/A

OnCommittingTransaction(CommittingTransactionEventArgs)

Summary

N/A

Remarks

N/A

Return Value

Type Description
Void N/A

Parameters

Name Type Description
e CommittingTransactionEventArgs N/A

OnCustomColumnFetch(CustomColumnFetchEventArgs)

Summary

N/A

Remarks

N/A

Return Value

Type Description
Void N/A

Parameters

Name Type Description
e CustomColumnFetchEventArgs N/A

OnDrawingProgressChanged(DrawingProgressChangedEventArgs)

Summary

N/A

Remarks

N/A

Return Value

Type Description
Void N/A

Parameters

Name Type Description
e DrawingProgressChangedEventArgs N/A

OnGettingColumns(GettingColumnsFeatureSourceEventArgs)

Summary

N/A

Remarks

N/A

Return Value

Type Description
Void N/A

Parameters

Name Type Description
e GettingColumnsFeatureSourceEventArgs N/A

OnGettingFeaturesByIds(GettingFeaturesByIdsFeatureSourceEventArgs)

Summary

N/A

Remarks

N/A

Return Value

Type Description
Void N/A

Parameters

Name Type Description
e GettingFeaturesByIdsFeatureSourceEventArgs N/A

OnGettingFeaturesForDrawing(GettingFeaturesForDrawingFeatureSourceEventArgs)

Summary

N/A

Remarks

N/A

Return Value

Type Description
Void N/A

Parameters

Name Type Description
e GettingFeaturesForDrawingFeatureSourceEventArgs N/A

OnGottenColumns(GottenColumnsFeatureSourceEventArgs)

Summary

N/A

Remarks

N/A

Return Value

Type Description
Void N/A

Parameters

Name Type Description
e GottenColumnsFeatureSourceEventArgs N/A

OnOpenedFeatureSource(OpenedFeatureSourceEventArgs)

Summary

N/A

Remarks

N/A

Return Value

Type Description
Void N/A

Parameters

Name Type Description
e OpenedFeatureSourceEventArgs N/A

OnOpeningFeatureSource(OpeningFeatureSourceEventArgs)

Summary

N/A

Remarks

N/A

Return Value

Type Description
Void N/A

Parameters

Name Type Description
e OpeningFeatureSourceEventArgs N/A

OpenCore()

Summary

N/A

Remarks

N/A

Return Value

Type Description
Void N/A

Parameters

Name Type Description
N/A N/A N/A

ProcessTransaction(RectangleShape,Collection<Feature>,Boolean)

Summary

N/A

Remarks

N/A

Return Value

Type Description
Void N/A

Parameters

Name Type Description
boundingBox RectangleShape N/A
returnFeatures Collection<Feature> N/A
needUpdateProjection Boolean N/A

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

Summary

N/A

Remarks

N/A

Return Value

Type Description
Collection<Feature> N/A

Parameters

Name Type Description
sourceFeatures Collection<Feature> N/A
fieldNamesOutsideOfSource Collection<String> N/A

SpatialQueryCore(BaseShape,QueryType,IEnumerable<String>)

Summary

N/A

Remarks

N/A

Return Value

Type Description
Collection<Feature> N/A

Parameters

Name Type Description
targetShape BaseShape N/A
queryType QueryType N/A
returningColumnNames IEnumerable<String> N/A

Public Events

DrawingProgressChanged

N/A

Remarks

N/A

Event Arguments

DrawingProgressChangedEventArgs

GettingColumns

N/A

Remarks

N/A

Event Arguments

GettingColumnsFeatureSourceEventArgs

GottenColumns

N/A

Remarks

N/A

Event Arguments

GottenColumnsFeatureSourceEventArgs

GettingFeaturesByIds

N/A

Remarks

N/A

Event Arguments

GettingFeaturesByIdsFeatureSourceEventArgs

GettingFeaturesForDrawing

N/A

Remarks

N/A

Event Arguments

GettingFeaturesForDrawingFeatureSourceEventArgs

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