thinkgeo.mapsuite.core.transactionbuffer
Differences
This shows you the differences between two versions of the page.
| Both sides previous revision Previous revision Next revision | Previous revision | ||
|
thinkgeo.mapsuite.core.transactionbuffer [2015/09/17 10:41] admin |
— (current) | ||
|---|---|---|---|
| Line 1: | Line 1: | ||
| - | ====== ThinkGeo.MapSuite.Core.TransactionBuffer ====== | ||
| - | This class represents the holding place for transactions that have not yet been committed. | ||
| - | ===== Inheritance Hierarchy ===== | ||
| - | *System.Object | ||
| - | ***ThinkGeo.MapSuite.Core.TransactionBuffer** | ||
| - | ===== Members Summary ===== | ||
| - | === Public Constructors === | ||
| - | <div class_table> | ||
| - | **{{wiki:PublicMethod.gif|}}[[#TransactionBuffer()|TransactionBuffer]]** | ||
| - | * **Parameters**:N/A | ||
| - | * **DeclaringType**:N/A | ||
| - | * **Summary**:This is the class constructor. | ||
| - | </div> | ||
| - | |||
| - | <div class_table> | ||
| - | **{{wiki:PublicMethod.gif|}}[[#TransactionBuffer(Dictionary<String,Feature>,Collection<String>,Dictionary<String,Feature>)|TransactionBuffer]]** | ||
| - | * **Parameters**:Dictionary<String,[[ThinkGeo.MapSuite.Core.Feature|Feature]]>,Collection<String>,Dictionary<String,[[ThinkGeo.MapSuite.Core.Feature|Feature]]> | ||
| - | * **DeclaringType**:N/A | ||
| - | * **Summary**:N/A | ||
| - | </div> | ||
| - | |||
| - | === Protected Constructors === | ||
| - | === Public Methods === | ||
| - | <div class_table> | ||
| - | **{{wiki:PublicMethod.gif|}}[[#AddColumn(FeatureSourceColumn)|AddColumn]]** | ||
| - | * **Parameters**:[[ThinkGeo.MapSuite.Core.FeatureSourceColumn|FeatureSourceColumn]] | ||
| - | * **DeclaringType**:N/A | ||
| - | * **Summary**:N/A | ||
| - | </div> | ||
| - | |||
| - | <div class_table> | ||
| - | **{{wiki:PublicMethod.gif|}}[[#AddFeature(Feature)|AddFeature]]** | ||
| - | * **Parameters**:[[ThinkGeo.MapSuite.Core.Feature|Feature]] | ||
| - | * **DeclaringType**:N/A | ||
| - | * **Summary**:This method allows you to add InternalFeatures to the transaction buffer. | ||
| - | </div> | ||
| - | |||
| - | <div class_table> | ||
| - | **{{wiki:PublicMethod.gif|}}[[#AddFeature(BaseShape)|AddFeature]]** | ||
| - | * **Parameters**:[[ThinkGeo.MapSuite.Core.BaseShape|BaseShape]] | ||
| - | * **DeclaringType**:N/A | ||
| - | * **Summary**:This method allows you to add a shape into the buffer. | ||
| - | </div> | ||
| - | |||
| - | <div class_table> | ||
| - | **{{wiki:PublicMethod.gif|}}[[#AddFeature(BaseShape,Dictionary<String,String>)|AddFeature]]** | ||
| - | * **Parameters**:[[ThinkGeo.MapSuite.Core.BaseShape|BaseShape]],Dictionary<String,String> | ||
| - | * **DeclaringType**:N/A | ||
| - | * **Summary**:N/A | ||
| - | </div> | ||
| - | |||
| - | <div class_table> | ||
| - | **{{wiki:PublicMethod.gif|}}[[#Clear()|Clear]]** | ||
| - | * **Parameters**:N/A | ||
| - | * **DeclaringType**:N/A | ||
| - | * **Summary**:This method will clear all the items in AddBuffer, EditBuffer and DeleteBuffer. | ||
| - | </div> | ||
| - | |||
| - | <div class_table> | ||
| - | **{{wiki:PublicMethod.gif|}}[[#DeleteColumn(String)|DeleteColumn]]** | ||
| - | * **Parameters**:String | ||
| - | * **DeclaringType**:N/A | ||
| - | * **Summary**:N/A | ||
| - | </div> | ||
| - | |||
| - | <div class_table> | ||
| - | **{{wiki:PublicMethod.gif|}}[[#DeleteFeature(String)|DeleteFeature]]** | ||
| - | * **Parameters**:String | ||
| - | * **DeclaringType**:N/A | ||
| - | * **Summary**:This method allows you to add a placeholder to represent a Feature to be deleted. | ||
| - | </div> | ||
| - | |||
| - | <div class_table> | ||
| - | **{{wiki:PublicMethod.gif|}}[[#EditFeature(Feature)|EditFeature]]** | ||
| - | * **Parameters**:[[ThinkGeo.MapSuite.Core.Feature|Feature]] | ||
| - | * **DeclaringType**:N/A | ||
| - | * **Summary**:This method allows you to add a Feature to be updated. | ||
| - | </div> | ||
| - | |||
| - | <div class_table> | ||
| - | **{{wiki:PublicMethod.gif|}}[[#EditFeature(BaseShape)|EditFeature]]** | ||
| - | * **Parameters**:[[ThinkGeo.MapSuite.Core.BaseShape|BaseShape]] | ||
| - | * **DeclaringType**:N/A | ||
| - | * **Summary**:This method allows you to add a shape to be updated. | ||
| - | </div> | ||
| - | |||
| - | <div class_table> | ||
| - | **{{wiki:PublicMethod.gif|}}[[#EditFeature(BaseShape,Dictionary<String,String>)|EditFeature]]** | ||
| - | * **Parameters**:[[ThinkGeo.MapSuite.Core.BaseShape|BaseShape]],Dictionary<String,String> | ||
| - | * **DeclaringType**:N/A | ||
| - | * **Summary**:N/A | ||
| - | </div> | ||
| - | |||
| - | <div class_table> | ||
| - | **{{wiki:PublicMethod.gif|}}[[#Equals(Object)|Equals]]** | ||
| - | * **Parameters**:Object | ||
| - | * **DeclaringType**:Object | ||
| - | * **Summary**:N/A | ||
| - | </div> | ||
| - | |||
| - | <div class_table> | ||
| - | **{{wiki:PublicMethod.gif|}}[[#GetHashCode()|GetHashCode]]** | ||
| - | * **Parameters**:N/A | ||
| - | * **DeclaringType**:Object | ||
| - | * **Summary**:N/A | ||
| - | </div> | ||
| - | |||
| - | <div class_table> | ||
| - | **{{wiki:PublicMethod.gif|}}[[#GetType()|GetType]]** | ||
| - | * **Parameters**:N/A | ||
| - | * **DeclaringType**:Object | ||
| - | * **Summary**:N/A | ||
| - | </div> | ||
| - | |||
| - | <div class_table> | ||
| - | **{{wiki:PublicMethod.gif|}}[[#ToString()|ToString]]** | ||
| - | * **Parameters**:N/A | ||
| - | * **DeclaringType**:Object | ||
| - | * **Summary**:N/A | ||
| - | </div> | ||
| - | |||
| - | <div class_table> | ||
| - | **{{wiki:PublicMethod.gif|}}[[#UpdateColumn(String,FeatureSourceColumn)|UpdateColumn]]** | ||
| - | * **Parameters**:String,[[ThinkGeo.MapSuite.Core.FeatureSourceColumn|FeatureSourceColumn]] | ||
| - | * **DeclaringType**:N/A | ||
| - | * **Summary**:N/A | ||
| - | </div> | ||
| - | |||
| - | === Protected Methods === | ||
| - | <div class_table> | ||
| - | **{{wiki:ProtectedMethod.gif|}}[[#Finalize()|Finalize]]** | ||
| - | * **Parameters**:N/A | ||
| - | * **DeclaringType**:Object | ||
| - | * **Summary**:N/A | ||
| - | </div> | ||
| - | |||
| - | <div class_table> | ||
| - | **{{wiki:ProtectedMethod.gif|}}[[#MemberwiseClone()|MemberwiseClone]]** | ||
| - | * **Parameters**:N/A | ||
| - | * **DeclaringType**:Object | ||
| - | * **Summary**:N/A | ||
| - | </div> | ||
| - | |||
| - | === Public Properties === | ||
| - | **{{wiki:PublicProperty.gif|}}[[#AddBuffer|AddBuffer]]** | ||
| - | * **Return**:Dictionary<String,[[ThinkGeo.MapSuite.Core.Feature|Feature]]> | ||
| - | * **Summary**:This property gets the dictionary buffer that holds InternalFeatures to be added. | ||
| - | |||
| - | **{{wiki:PublicProperty.gif|}}[[#AddColumnBuffer|AddColumnBuffer]]** | ||
| - | * **Return**:Collection<[[ThinkGeo.MapSuite.Core.FeatureSourceColumn|FeatureSourceColumn]]> | ||
| - | * **Summary**:N/A | ||
| - | |||
| - | **{{wiki:PublicProperty.gif|}}[[#DeleteBuffer|DeleteBuffer]]** | ||
| - | * **Return**:Collection<String> | ||
| - | * **Summary**:This property gets the dictionary buffer that holds InternalFeatures to be deleted. | ||
| - | |||
| - | **{{wiki:PublicProperty.gif|}}[[#DeleteColumnBuffer|DeleteColumnBuffer]]** | ||
| - | * **Return**:Collection<String> | ||
| - | * **Summary**:N/A | ||
| - | |||
| - | **{{wiki:PublicProperty.gif|}}[[#EditBuffer|EditBuffer]]** | ||
| - | * **Return**:Dictionary<String,[[ThinkGeo.MapSuite.Core.Feature|Feature]]> | ||
| - | * **Summary**:This property gets the dictionary buffer that holds InternalFeatures to be updated. | ||
| - | |||
| - | **{{wiki:PublicProperty.gif|}}[[#UpdateColumnBuffer|UpdateColumnBuffer]]** | ||
| - | * **Return**:Dictionary<String,[[ThinkGeo.MapSuite.Core.FeatureSourceColumn|FeatureSourceColumn]]> | ||
| - | * **Summary**:N/A | ||
| - | |||
| - | === Protected Properties === | ||
| - | === Public Events === | ||
| - | ===== Public Constructors ===== | ||
| - | === TransactionBuffer() === | ||
| - | This is the class constructor. | ||
| - | ==== Remarks ==== | ||
| - | This is the default constructor and is typically not used. | ||
| - | ==== Parameters ==== | ||
| - | [[#Public Constructors|Go Back]] | ||
| - | === TransactionBuffer(Dictionary<String,Feature>,Collection<String>,Dictionary<String,Feature>) === | ||
| - | N/A | ||
| - | ==== Remarks ==== | ||
| - | N/A | ||
| - | ==== Parameters ==== | ||
| - | **addBuffer** | ||
| - | * **Type**:Dictionary<String,[[ThinkGeo.MapSuite.Core.Feature|Feature]]> | ||
| - | * **Description:N/A | ||
| - | |||
| - | **deleteBuffer** | ||
| - | * **Type**:Collection<String> | ||
| - | * **Description:N/A | ||
| - | |||
| - | **editBuffer** | ||
| - | * **Type**:Dictionary<String,[[ThinkGeo.MapSuite.Core.Feature|Feature]]> | ||
| - | * **Description:N/A | ||
| - | |||
| - | [[#Public Constructors|Go Back]] | ||
| - | ===== Protected Constructors ===== | ||
| - | ===== Public Methods ===== | ||
| - | === AddColumn(FeatureSourceColumn) === | ||
| - | N/A | ||
| - | ==== Remarks ==== | ||
| - | N/A | ||
| - | |||
| - | **Return Value** | ||
| - | * **Return Type**:Void | ||
| - | * **Description**:N/A | ||
| - | |||
| - | ==== Parameters ==== | ||
| - | **featureSourceColumn** | ||
| - | * **Type**:[[ThinkGeo.MapSuite.Core.FeatureSourceColumn|FeatureSourceColumn]] | ||
| - | * **Description**:N/A | ||
| - | |||
| - | [[#Public Methods|Go Back]] | ||
| - | === AddFeature(Feature) === | ||
| - | This method allows you to add InternalFeatures to the transaction buffer. | ||
| - | ==== Remarks ==== | ||
| - | None | ||
| - | |||
| - | **Return Value** | ||
| - | * **Return Type**:Void | ||
| - | * **Description**:None | ||
| - | |||
| - | ==== Parameters ==== | ||
| - | **feature** | ||
| - | * **Type**:[[ThinkGeo.MapSuite.Core.Feature|Feature]] | ||
| - | * **Description**:This parameter represents the Feature you are adding to the transaction buffer. | ||
| - | |||
| - | [[#Public Methods|Go Back]] | ||
| - | === AddFeature(BaseShape) === | ||
| - | This method allows you to add a shape into the buffer. | ||
| - | ==== Remarks ==== | ||
| - | None | ||
| - | |||
| - | **Return Value** | ||
| - | * **Return Type**:Void | ||
| - | * **Description**:None | ||
| - | |||
| - | ==== Parameters ==== | ||
| - | **baseShape** | ||
| - | * **Type**:[[ThinkGeo.MapSuite.Core.BaseShape|BaseShape]] | ||
| - | * **Description**:This parameter represents the shape to be added. | ||
| - | |||
| - | [[#Public Methods|Go Back]] | ||
| - | === AddFeature(BaseShape,Dictionary<String,String>) === | ||
| - | N/A | ||
| - | ==== Remarks ==== | ||
| - | N/A | ||
| - | |||
| - | **Return Value** | ||
| - | * **Return Type**:Void | ||
| - | * **Description**:N/A | ||
| - | |||
| - | ==== Parameters ==== | ||
| - | **baseShape** | ||
| - | * **Type**:[[ThinkGeo.MapSuite.Core.BaseShape|BaseShape]] | ||
| - | * **Description**:N/A | ||
| - | |||
| - | **columnValues** | ||
| - | * **Type**:Dictionary<String,String> | ||
| - | * **Description**:N/A | ||
| - | |||
| - | [[#Public Methods|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**:Void | ||
| - | * **Description**:None. | ||
| - | |||
| - | ==== Parameters ==== | ||
| - | [[#Public Methods|Go Back]] | ||
| - | === DeleteColumn(String) === | ||
| - | N/A | ||
| - | ==== Remarks ==== | ||
| - | N/A | ||
| - | |||
| - | **Return Value** | ||
| - | * **Return Type**:Void | ||
| - | * **Description**:N/A | ||
| - | |||
| - | ==== Parameters ==== | ||
| - | **columnName** | ||
| - | * **Type**:String | ||
| - | * **Description**:N/A | ||
| - | |||
| - | [[#Public Methods|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**:Void | ||
| - | * **Description**:None | ||
| - | |||
| - | ==== Parameters ==== | ||
| - | **featureId** | ||
| - | * **Type**:String | ||
| - | * **Description**:This parameter represents the unique Id for the specific Feature being passed in. | ||
| - | |||
| - | [[#Public Methods|Go Back]] | ||
| - | === EditFeature(Feature) === | ||
| - | This method allows you to add a Feature to be updated. | ||
| - | ==== Remarks ==== | ||
| - | None | ||
| - | |||
| - | **Return Value** | ||
| - | * **Return Type**:Void | ||
| - | * **Description**:None | ||
| - | |||
| - | ==== Parameters ==== | ||
| - | **feature** | ||
| - | * **Type**:[[ThinkGeo.MapSuite.Core.Feature|Feature]] | ||
| - | * **Description**:This parameter represents the Feature to be updated. | ||
| - | |||
| - | [[#Public Methods|Go Back]] | ||
| - | === EditFeature(BaseShape) === | ||
| - | This method allows you to add a shape to be updated. | ||
| - | ==== Remarks ==== | ||
| - | None | ||
| - | |||
| - | **Return Value** | ||
| - | * **Return Type**:Void | ||
| - | * **Description**:None | ||
| - | |||
| - | ==== Parameters ==== | ||
| - | **baseShape** | ||
| - | * **Type**:[[ThinkGeo.MapSuite.Core.BaseShape|BaseShape]] | ||
| - | * **Description**:This parameter represents the shape to be updated. The shape ID should be the same as the feature you are going to update. | ||
| - | |||
| - | [[#Public Methods|Go Back]] | ||
| - | === EditFeature(BaseShape,Dictionary<String,String>) === | ||
| - | N/A | ||
| - | ==== Remarks ==== | ||
| - | N/A | ||
| - | |||
| - | **Return Value** | ||
| - | * **Return Type**:Void | ||
| - | * **Description**:N/A | ||
| - | |||
| - | ==== Parameters ==== | ||
| - | **baseShape** | ||
| - | * **Type**:[[ThinkGeo.MapSuite.Core.BaseShape|BaseShape]] | ||
| - | * **Description**:N/A | ||
| - | |||
| - | **columnValues** | ||
| - | * **Type**:Dictionary<String,String> | ||
| - | * **Description**:N/A | ||
| - | |||
| - | [[#Public Methods|Go Back]] | ||
| - | === Equals(Object) === | ||
| - | N/A | ||
| - | ==== Remarks ==== | ||
| - | N/A | ||
| - | |||
| - | **Return Value** | ||
| - | * **Return Type**:Boolean | ||
| - | * **Description**:N/A | ||
| - | |||
| - | ==== Parameters ==== | ||
| - | **obj** | ||
| - | * **Type**:Object | ||
| - | * **Description**:N/A | ||
| - | |||
| - | [[#Public Methods|Go Back]] | ||
| - | === GetHashCode() === | ||
| - | N/A | ||
| - | ==== Remarks ==== | ||
| - | N/A | ||
| - | |||
| - | **Return Value** | ||
| - | * **Return Type**:Int32 | ||
| - | * **Description**:N/A | ||
| - | |||
| - | ==== Parameters ==== | ||
| - | [[#Public Methods|Go Back]] | ||
| - | === GetType() === | ||
| - | N/A | ||
| - | ==== Remarks ==== | ||
| - | N/A | ||
| - | |||
| - | **Return Value** | ||
| - | * **Return Type**:Type | ||
| - | * **Description**:N/A | ||
| - | |||
| - | ==== Parameters ==== | ||
| - | [[#Public Methods|Go Back]] | ||
| - | === ToString() === | ||
| - | N/A | ||
| - | ==== Remarks ==== | ||
| - | N/A | ||
| - | |||
| - | **Return Value** | ||
| - | * **Return Type**:String | ||
| - | * **Description**:N/A | ||
| - | |||
| - | ==== Parameters ==== | ||
| - | [[#Public Methods|Go Back]] | ||
| - | === UpdateColumn(String,FeatureSourceColumn) === | ||
| - | N/A | ||
| - | ==== Remarks ==== | ||
| - | N/A | ||
| - | |||
| - | **Return Value** | ||
| - | * **Return Type**:Void | ||
| - | * **Description**:N/A | ||
| - | |||
| - | ==== Parameters ==== | ||
| - | **columnName** | ||
| - | * **Type**:String | ||
| - | * **Description**:N/A | ||
| - | |||
| - | **newFeatureSourceColumn** | ||
| - | * **Type**:[[ThinkGeo.MapSuite.Core.FeatureSourceColumn|FeatureSourceColumn]] | ||
| - | * **Description**:N/A | ||
| - | |||
| - | [[#Public Methods|Go Back]] | ||
| - | ===== Protected Methods ===== | ||
| - | === Finalize() === | ||
| - | N/A | ||
| - | ==== Remarks ==== | ||
| - | N/A | ||
| - | |||
| - | **Return Value** | ||
| - | * **Return Type**:Void | ||
| - | * **Description**:N/A | ||
| - | |||
| - | ==== Parameters ==== | ||
| - | [[#Protected Methods|Go Back]] | ||
| - | === MemberwiseClone() === | ||
| - | N/A | ||
| - | ==== Remarks ==== | ||
| - | N/A | ||
| - | |||
| - | **Return Value** | ||
| - | * **Return Type**:Object | ||
| - | * **Description**:N/A | ||
| - | |||
| - | ==== Parameters ==== | ||
| - | [[#Protected Methods|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,[[ThinkGeo.MapSuite.Core.Feature|Feature]]> | ||
| - | |||
| - | [[#Public Properties|Go Back]] | ||
| - | === AddColumnBuffer === | ||
| - | N/A | ||
| - | ==== Remarks ==== | ||
| - | N/A | ||
| - | ==== Return Value ==== | ||
| - | **Return Type**:Collection<[[ThinkGeo.MapSuite.Core.FeatureSourceColumn|FeatureSourceColumn]]> | ||
| - | |||
| - | [[#Public Properties|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> | ||
| - | |||
| - | [[#Public Properties|Go Back]] | ||
| - | === DeleteColumnBuffer === | ||
| - | N/A | ||
| - | ==== Remarks ==== | ||
| - | N/A | ||
| - | ==== Return Value ==== | ||
| - | **Return Type**:Collection<String> | ||
| - | |||
| - | [[#Public Properties|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,[[ThinkGeo.MapSuite.Core.Feature|Feature]]> | ||
| - | |||
| - | [[#Public Properties|Go Back]] | ||
| - | === UpdateColumnBuffer === | ||
| - | N/A | ||
| - | ==== Remarks ==== | ||
| - | N/A | ||
| - | ==== Return Value ==== | ||
| - | **Return Type**:Dictionary<String,[[ThinkGeo.MapSuite.Core.FeatureSourceColumn|FeatureSourceColumn]]> | ||
| - | |||
| - | [[#Public Properties|Go Back]] | ||
| - | ===== Protected Properties ===== | ||
| - | ===== Public Events ===== | ||
thinkgeo.mapsuite.core.transactionbuffer.1442486491.txt.gz ยท Last modified: 2015/09/17 10:41 by admin
