User Tools

Site Tools


thinkgeo.mapsuite.portablecore.transactionbuffer

This is an old revision of the document!


ThinkGeo.MapSuite.PortableCore.TransactionBuffer

<!– Class –> This class represents the holding place for transactions that have not yet been committed.

Inheritance Hierarchy

Members Summary

Public Constructors

Name Parameters DeclaringType Summary
Public MethodTransactionBuffer This is the class constructor.
Public MethodTransactionBuffer Dictionary<String, Feature>, Collection<String>, Dictionary<String, Feature> This is the class constructor.

Protected Constructors

Name Parameters DeclaringType Summary

Public Methods

Name Parameters DeclaringType Summary
Public MethodAddColumn FeatureSourceColumn
Public MethodAddFeature Feature This method allows you to add InternalFeatures to the transaction buffer.
Public MethodAddFeature BaseShape This method allows you to add a shape into the buffer.
Public MethodAddFeature BaseShape, Dictionary<String, String> This method allows you to add a shape into the buffer.
Public MethodClear This method will clear all the items in AddBuffer, EditBuffer and DeleteBuffer.
Public MethodDeleteColumn String
Public MethodDeleteFeature String This method allows you to add a placeholder to represent a Feature to be deleted.
Public MethodEditFeature Feature This method allows you to add a Feature to be updated.
Public MethodEditFeature BaseShape This method allows you to add a shape to be updated.
Public MethodEditFeature BaseShape, Dictionary<String, String> This method allows you to add a shape to be updated.
Public MethodEquals Object Object
Public MethodGetHashCode Object
Public MethodGetType Object
Public MethodToString Object
Public MethodUpdateColumn String, FeatureSourceColumn

Protected Methods

Name Parameters DeclaringType Summary
Protected MethodFinalize Object
Protected MethodMemberwiseClone Object

Public Properties

Name Return DeclaringType Summary
Public PropertyAddBuffer Dictionary<String,Feature> This property gets the dictionary buffer that holds InternalFeatures to be added.
Public PropertyAddColumnBuffer Collection<FeatureSourceColumn>
Public PropertyDeleteBuffer Collection<String> This property gets the dictionary buffer that holds InternalFeatures to be deleted.
Public PropertyDeleteColumnBuffer Collection<String>
Public PropertyEditBuffer Dictionary<String,Feature> This property gets the dictionary buffer that holds InternalFeatures to be updated.
Public PropertyUpdateColumnBuffer Dictionary<String,FeatureSourceColumn>

Protected Properties

Name Return DeclaringType Summary

Public Events

Name Event Arguments DeclaringType Summary

Public Constructors

TransactionBuffer()

This is the class constructor.

Overloads

This is the default constructor and is typically not used.

Remarks

This is the default constructor and is typically not used.

Parameters

Name Type Description

Go Back

TransactionBuffer(Dictionary<String, Feature>, Collection<String>, Dictionary<String, Feature>)

This is the class constructor.

Overloads

This is the constructor for this class allows you pass in the necessary properties in the class.

Parameters

Name Type Description
addBuffer Dictionary<String,Feature><!– System.Collections.Generic.Dictionary{System.String,ThinkGeo.MapSuite.PortableCore.Feature} –>
deleteBuffer Collection<String><!– System.Collections.ObjectModel.Collection{System.String} –>
editBuffer Dictionary<String,Feature><!– System.Collections.Generic.Dictionary{System.String,ThinkGeo.MapSuite.PortableCore.Feature} –>

Go Back

Protected Constructors

Public Methods

AddColumn(FeatureSourceColumn)

Return Value

Return Type Description
Void<!– System.Void –>

Parameters

Name Type Description
featureSourceColumn FeatureSourceColumn<!– ThinkGeo.MapSuite.PortableCore.FeatureSourceColumn –>

<!– ThinkGeo.MapSuite.PortableCore.TransactionBuffer –> Go Back

AddFeature(Feature)

This method allows you to add InternalFeatures to the transaction buffer.

Return Value

Return Type Description
Void<!– System.Void –>

Parameters

Name Type Description
feature Feature<!– ThinkGeo.MapSuite.PortableCore.Feature –> This parameter represents the Feature you are adding to the transaction buffer.

<!– ThinkGeo.MapSuite.PortableCore.TransactionBuffer –> Go Back

AddFeature(BaseShape)

This method allows you to add a shape into the buffer.

Return Value

Return Type Description
Void<!– System.Void –>

Parameters

Name Type Description
baseShape BaseShape<!– ThinkGeo.MapSuite.PortableCore.BaseShape –> This parameter represents the shape to be added.

<!– ThinkGeo.MapSuite.PortableCore.TransactionBuffer –> Go Back

AddFeature(BaseShape, Dictionary<String, String>)

This method allows you to add a shape into the buffer.

Return Value

Return Type Description
Void<!– System.Void –>

Parameters

Name Type Description
baseShape BaseShape<!– ThinkGeo.MapSuite.PortableCore.BaseShape –> This parameter represents the shape to be added.
columnValues Dictionary<String,String><!– System.Collections.Generic.Dictionary{System.String,System.String} –> This parameter represents the feature value to be added.

<!– ThinkGeo.MapSuite.PortableCore.TransactionBuffer –> Go Back

Clear()

This method will clear all the items in AddBuffer, EditBuffer and DeleteBuffer.

Remarks

This method will clear all the items in AddBuffer, EditBuffer and DeleteBuffer.

Return Value

Return Type Description
Void<!– System.Void –>

Parameters

Name Type Description

<!– ThinkGeo.MapSuite.PortableCore.TransactionBuffer –> Go Back

DeleteColumn(String)

Return Value

Return Type Description
Void<!– System.Void –>

Parameters

Name Type Description
columnName String<!– System.String –>

<!– ThinkGeo.MapSuite.PortableCore.TransactionBuffer –> Go Back

DeleteFeature(String)

This method allows you to add a placeholder to represent a Feature to be deleted.

Remarks

This does not remove a feature from the TransactionBuffer but rather it add a “to be deleted record”. In this way when the TransactionBuffer if processed we know what records need to be deleted.

Return Value

Return Type Description
Void<!– System.Void –>

Parameters

Name Type Description
featureId String<!– System.String –> This parameter represents the unique Id for the specific Feature being passed in.

<!– ThinkGeo.MapSuite.PortableCore.TransactionBuffer –> Go Back

EditFeature(Feature)

This method allows you to add a Feature to be updated.

Return Value

Return Type Description
Void<!– System.Void –>

Parameters

Name Type Description
feature Feature<!– ThinkGeo.MapSuite.PortableCore.Feature –> This parameter represents the Feature to be updated.

<!– ThinkGeo.MapSuite.PortableCore.TransactionBuffer –> Go Back

EditFeature(BaseShape)

This method allows you to add a shape to be updated.

Return Value

Return Type Description
Void<!– System.Void –>

Parameters

Name Type Description
baseShape BaseShape<!– ThinkGeo.MapSuite.PortableCore.BaseShape –> This parameter represents the shape to be updated. The shape ID should be the same as the feature you are going to update.

<!– ThinkGeo.MapSuite.PortableCore.TransactionBuffer –> Go Back

EditFeature(BaseShape, Dictionary<String, String>)

This method allows you to add a shape to be updated.

Return Value

Return Type Description
Void<!– System.Void –>

Parameters

Name Type Description
baseShape BaseShape<!– ThinkGeo.MapSuite.PortableCore.BaseShape –> This parameter represents the shape to be updated. The shape ID should be the same as the feature you are going to update.
columnValues Dictionary<String,String><!– System.Collections.Generic.Dictionary{System.String,System.String} –> This parameter represents the feature value to be updated. The shape ID should be the same as the feature you are going to update.

<!– ThinkGeo.MapSuite.PortableCore.TransactionBuffer –> Go Back

Equals(Object)

Return Value

Return Type Description
Boolean<!– System.Boolean –>

Parameters

Name Type Description
obj Object<!– System.Object –>

<!– System.Object –> Go Back

GetHashCode()

Return Value

Return Type Description
Int32<!– System.Int32 –>

Parameters

Name Type Description

<!– System.Object –> Go Back

GetType()

Return Value

Return Type Description
Type<!– System.Type –>

Parameters

Name Type Description

<!– System.Object –> Go Back

ToString()

Return Value

Return Type Description
String<!– System.String –>

Parameters

Name Type Description

<!– System.Object –> Go Back

UpdateColumn(String, FeatureSourceColumn)

Return Value

Return Type Description
Void<!– System.Void –>

Parameters

Name Type Description
columnName String<!– System.String –>
newFeatureSourceColumn FeatureSourceColumn<!– ThinkGeo.MapSuite.PortableCore.FeatureSourceColumn –>

<!– ThinkGeo.MapSuite.PortableCore.TransactionBuffer –> Go Back

Protected Methods

Finalize()

Return Value

Return Type Description
Void<!– System.Void –>

Parameters

Name Type Description

<!– System.Object –> Go Back

MemberwiseClone()

Return Value

Return Type Description
Object<!– System.Object –>

Parameters

Name Type Description

<!– System.Object –> Go Back

Public Properties

AddBuffer

This property gets the dictionary buffer that holds InternalFeatures to be added.

Remarks

It is recommended that you use this dictionary for reviewing and not for adding new items. The reason is that the Add, Delete and Edit methods to various validation checks. For example if you call the DeleteFeature twice it will handle the case that you really only want to delete the record once. Another example is if you edit a record twice it will replace the existing edit with the new one.

Return Value

Return Type
Dictionary<String,Feature><!– System.Collections.Generic.Dictionary{System.String,ThinkGeo.MapSuite.PortableCore.Feature} –>

<!– ThinkGeo.MapSuite.PortableCore.TransactionBuffer –> Go Back

AddColumnBuffer

Return Value

Return Type
Collection<FeatureSourceColumn><!– System.Collections.ObjectModel.Collection{ThinkGeo.MapSuite.PortableCore.FeatureSourceColumn} –>

<!– ThinkGeo.MapSuite.PortableCore.TransactionBuffer –> Go Back

DeleteBuffer

This property gets the dictionary buffer that holds InternalFeatures to be deleted.

Remarks

It is recommended that you use this dictionary for reviewing and not for adding new items. The reason is that the Add, Delete and Edit methods to various validation checks. For example if you call the DeleteFeature twice it will handle the case that you really only want to delete the record once. Another example is if you edit a record twice it will replace the existing edit with the new one.

Return Value

Return Type
Collection<String><!– System.Collections.ObjectModel.Collection{System.String} –>

<!– ThinkGeo.MapSuite.PortableCore.TransactionBuffer –> Go Back

DeleteColumnBuffer

Return Value

Return Type
Collection<String><!– System.Collections.ObjectModel.Collection{System.String} –>

<!– ThinkGeo.MapSuite.PortableCore.TransactionBuffer –> Go Back

EditBuffer

This property gets the dictionary buffer that holds InternalFeatures to be updated.

Remarks

It is recommended that you use this dictionary for reviewing and not for adding new items. The reason is that the Add, Delete and Edit methods to various validation checks. For example if you call the DeleteFeature twice it will handle the case that you really only want to delete the record once. Another example is if you edit a record twice it will replace the existing edit with the new one.

Return Value

Return Type
Dictionary<String,Feature><!– System.Collections.Generic.Dictionary{System.String,ThinkGeo.MapSuite.PortableCore.Feature} –>

<!– ThinkGeo.MapSuite.PortableCore.TransactionBuffer –> Go Back

UpdateColumnBuffer

Return Value

Return Type
Dictionary<String,FeatureSourceColumn><!– System.Collections.Generic.Dictionary{System.String,ThinkGeo.MapSuite.PortableCore.FeatureSourceColumn} –>

<!– ThinkGeo.MapSuite.PortableCore.TransactionBuffer –> Go Back

Protected Properties

Public Events

thinkgeo.mapsuite.portablecore.transactionbuffer.1440040133.txt.gz · Last modified: 2015/09/21 08:20 (external edit)