thinkgeo.mapsuite.core.transactionbuffer
Differences
This shows you the differences between two versions of the page.
| Both sides previous revision Previous revision | |||
|
thinkgeo.mapsuite.core.transactionbuffer [2015/09/22 08:29] 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 ==== | ||
| - | ** {{wiki:PublicMethod.gif|}} TransactionBuffer() ** | ||
| - | |||
| - | * //This is the class constructor.// | ||
| - | == Remarks == | ||
| - | * //This is the default constructor and is typically not used.// | ||
| - | == Parameters == | ||
| - | <div newline></div> | ||
| - | ** {{wiki:PublicMethod.gif|}} 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 | ||
| - | |||
| - | <div newline></div> | ||
| - | ==== Protected Constructors ==== | ||
| - | ==== Public Methods ==== | ||
| - | ** {{wiki:PublicMethod.gif|}} 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 == | ||
| - | * Type:Void | ||
| - | * Description:None. | ||
| - | |||
| - | == Parameters == | ||
| - | <div newline></div> | ||
| - | ** {{wiki:PublicMethod.gif|}} AddFeature(Feature) ** | ||
| - | |||
| - | * //This method allows you to add InternalFeatures to the transaction buffer.// | ||
| - | == Remarks == | ||
| - | * //None// | ||
| - | |||
| - | == Return Value == | ||
| - | * 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. | ||
| - | |||
| - | <div newline></div> | ||
| - | ** {{wiki:PublicMethod.gif|}} AddFeature(BaseShape) ** | ||
| - | |||
| - | * //This method allows you to add a shape into the buffer.// | ||
| - | == Remarks == | ||
| - | * //None// | ||
| - | |||
| - | == Return Value == | ||
| - | * Type:Void | ||
| - | * Description:None | ||
| - | |||
| - | == Parameters == | ||
| - | * //baseShape// | ||
| - | * Type:[[ThinkGeo.MapSuite.Core.BaseShape|BaseShape]] | ||
| - | * Description:This parameter represents the shape to be added. | ||
| - | |||
| - | <div newline></div> | ||
| - | ** {{wiki:PublicMethod.gif|}} AddFeature(BaseShape,Dictionary<String,String>) ** | ||
| - | |||
| - | * //N/A// | ||
| - | == Remarks == | ||
| - | * //N/A// | ||
| - | |||
| - | == Return Value == | ||
| - | * Type:Void | ||
| - | * Description:N/A | ||
| - | |||
| - | == Parameters == | ||
| - | * //baseShape// | ||
| - | * Type:[[ThinkGeo.MapSuite.Core.BaseShape|BaseShape]] | ||
| - | * Description:N/A | ||
| - | |||
| - | * //columnValues// | ||
| - | * Type:Dictionary<String,String> | ||
| - | * Description:N/A | ||
| - | |||
| - | <div newline></div> | ||
| - | ** {{wiki:PublicMethod.gif|}} 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 == | ||
| - | * Type:Void | ||
| - | * Description:None | ||
| - | |||
| - | == Parameters == | ||
| - | * //featureId// | ||
| - | * Type:String | ||
| - | * Description:This parameter represents the unique Id for the specific Feature being passed in. | ||
| - | |||
| - | <div newline></div> | ||
| - | ** {{wiki:PublicMethod.gif|}} EditFeature(Feature) ** | ||
| - | |||
| - | * //This method allows you to add a Feature to be updated.// | ||
| - | == Remarks == | ||
| - | * //None// | ||
| - | |||
| - | == Return Value == | ||
| - | * Type:Void | ||
| - | * Description:None | ||
| - | |||
| - | == Parameters == | ||
| - | * //feature// | ||
| - | * Type:[[ThinkGeo.MapSuite.Core.Feature|Feature]] | ||
| - | * Description:This parameter represents the Feature to be updated. | ||
| - | |||
| - | <div newline></div> | ||
| - | ** {{wiki:PublicMethod.gif|}} EditFeature(BaseShape) ** | ||
| - | |||
| - | * //This method allows you to add a shape to be updated.// | ||
| - | == Remarks == | ||
| - | * //None// | ||
| - | |||
| - | == Return Value == | ||
| - | * 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. | ||
| - | |||
| - | <div newline></div> | ||
| - | ** {{wiki:PublicMethod.gif|}} EditFeature(BaseShape,Dictionary<String,String>) ** | ||
| - | |||
| - | * //N/A// | ||
| - | == Remarks == | ||
| - | * //N/A// | ||
| - | |||
| - | == Return Value == | ||
| - | * Type:Void | ||
| - | * Description:N/A | ||
| - | |||
| - | == Parameters == | ||
| - | * //baseShape// | ||
| - | * Type:[[ThinkGeo.MapSuite.Core.BaseShape|BaseShape]] | ||
| - | * Description:N/A | ||
| - | |||
| - | * //columnValues// | ||
| - | * Type:Dictionary<String,String> | ||
| - | * Description:N/A | ||
| - | |||
| - | <div newline></div> | ||
| - | ** {{wiki:PublicMethod.gif|}} AddColumn(FeatureSourceColumn) ** | ||
| - | |||
| - | * //N/A// | ||
| - | == Remarks == | ||
| - | * //N/A// | ||
| - | |||
| - | == Return Value == | ||
| - | * Type:Void | ||
| - | * Description:N/A | ||
| - | |||
| - | == Parameters == | ||
| - | * //featureSourceColumn// | ||
| - | * Type:[[ThinkGeo.MapSuite.Core.FeatureSourceColumn|FeatureSourceColumn]] | ||
| - | * Description:N/A | ||
| - | |||
| - | <div newline></div> | ||
| - | ** {{wiki:PublicMethod.gif|}} DeleteColumn(String) ** | ||
| - | |||
| - | * //N/A// | ||
| - | == Remarks == | ||
| - | * //N/A// | ||
| - | |||
| - | == Return Value == | ||
| - | * Type:Void | ||
| - | * Description:N/A | ||
| - | |||
| - | == Parameters == | ||
| - | * //columnName// | ||
| - | * Type:String | ||
| - | * Description:N/A | ||
| - | |||
| - | <div newline></div> | ||
| - | ** {{wiki:PublicMethod.gif|}} UpdateColumn(String,FeatureSourceColumn) ** | ||
| - | |||
| - | * //N/A// | ||
| - | == Remarks == | ||
| - | * //N/A// | ||
| - | |||
| - | == Return Value == | ||
| - | * Type:Void | ||
| - | * Description:N/A | ||
| - | |||
| - | == Parameters == | ||
| - | * //columnName// | ||
| - | * Type:String | ||
| - | * Description:N/A | ||
| - | |||
| - | * //newFeatureSourceColumn// | ||
| - | * Type:[[ThinkGeo.MapSuite.Core.FeatureSourceColumn|FeatureSourceColumn]] | ||
| - | * Description:N/A | ||
| - | |||
| - | <div newline></div> | ||
| - | ** {{wiki:PublicMethod.gif|}} ToString() ** | ||
| - | |||
| - | * //N/A// | ||
| - | == Remarks == | ||
| - | * //N/A// | ||
| - | |||
| - | == Return Value == | ||
| - | * Type:String | ||
| - | * Description:N/A | ||
| - | |||
| - | == Parameters == | ||
| - | <div newline></div> | ||
| - | ** {{wiki:PublicMethod.gif|}} Equals(Object) ** | ||
| - | |||
| - | * //N/A// | ||
| - | == Remarks == | ||
| - | * //N/A// | ||
| - | |||
| - | == Return Value == | ||
| - | * Type:Boolean | ||
| - | * Description:N/A | ||
| - | |||
| - | == Parameters == | ||
| - | * //obj// | ||
| - | * Type:Object | ||
| - | * Description:N/A | ||
| - | |||
| - | <div newline></div> | ||
| - | ** {{wiki:PublicMethod.gif|}} GetHashCode() ** | ||
| - | |||
| - | * //N/A// | ||
| - | == Remarks == | ||
| - | * //N/A// | ||
| - | |||
| - | == Return Value == | ||
| - | * Type:Int32 | ||
| - | * Description:N/A | ||
| - | |||
| - | == Parameters == | ||
| - | <div newline></div> | ||
| - | ** {{wiki:PublicMethod.gif|}} GetType() ** | ||
| - | |||
| - | * //N/A// | ||
| - | == Remarks == | ||
| - | * //N/A// | ||
| - | |||
| - | == Return Value == | ||
| - | * Type:Type | ||
| - | * Description:N/A | ||
| - | |||
| - | == Parameters == | ||
| - | <div newline></div> | ||
| - | ==== Protected Methods ==== | ||
| - | ** {{wiki:ProtectedMethod.gif|}} Finalize() ** | ||
| - | |||
| - | * //N/A// | ||
| - | == Remarks == | ||
| - | * //N/A// | ||
| - | |||
| - | == Return Value == | ||
| - | * Type:Void | ||
| - | * Description:N/A | ||
| - | |||
| - | == Parameters == | ||
| - | <div newline></div> | ||
| - | ** {{wiki:ProtectedMethod.gif|}} MemberwiseClone() ** | ||
| - | |||
| - | * //N/A// | ||
| - | == Remarks == | ||
| - | * //N/A// | ||
| - | |||
| - | == Return Value == | ||
| - | * Type:Object | ||
| - | * Description:N/A | ||
| - | |||
| - | == Parameters == | ||
| - | <div newline></div> | ||
| - | ==== Public Properties ==== | ||
| - | ** {{wiki:PublicProperty.gif|}} 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 == | ||
| - | * Type:Dictionary<String,[[ThinkGeo.MapSuite.Core.Feature|Feature]]> | ||
| - | |||
| - | ** {{wiki:PublicProperty.gif|}} 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 == | ||
| - | * Type:Collection<String> | ||
| - | |||
| - | ** {{wiki:PublicProperty.gif|}} 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 == | ||
| - | * Type:Dictionary<String,[[ThinkGeo.MapSuite.Core.Feature|Feature]]> | ||
| - | |||
| - | ** {{wiki:PublicProperty.gif|}} AddColumnBuffer ** | ||
| - | |||
| - | N/A | ||
| - | == Remarks == | ||
| - | N/A | ||
| - | == Return Value == | ||
| - | * Type:Collection<[[ThinkGeo.MapSuite.Core.FeatureSourceColumn|FeatureSourceColumn]]> | ||
| - | |||
| - | ** {{wiki:PublicProperty.gif|}} DeleteColumnBuffer ** | ||
| - | |||
| - | N/A | ||
| - | == Remarks == | ||
| - | N/A | ||
| - | == Return Value == | ||
| - | * Type:Collection<String> | ||
| - | |||
| - | ** {{wiki:PublicProperty.gif|}} UpdateColumnBuffer ** | ||
| - | |||
| - | N/A | ||
| - | == Remarks == | ||
| - | N/A | ||
| - | == Return Value == | ||
| - | * Type:Dictionary<String,[[ThinkGeo.MapSuite.Core.FeatureSourceColumn|FeatureSourceColumn]]> | ||
| - | |||
| - | ==== Protected Properties ==== | ||
| - | ==== Public Events ==== | ||
thinkgeo.mapsuite.core.transactionbuffer.1442910591.txt.gz ยท Last modified: 2015/09/22 08:29 by admin
