thinkgeo.mapsuite.portablecore.gridfeaturesource
Differences
This shows you the differences between two versions of the page.
| Next revision | Previous revision | ||
|
thinkgeo.mapsuite.portablecore.gridfeaturesource [2015/08/20 03:08] 127.0.0.1 external edit |
thinkgeo.mapsuite.portablecore.gridfeaturesource [2017/03/16 21:59] (current) |
||
|---|---|---|---|
| Line 1: | Line 1: | ||
| - | ====== ThinkGeo.MapSuite.PortableCore.GridFeatureSource ====== | + | ====== ThinkGeo.MapSuite.Core.GridFeatureSource ====== |
| + | {{section>upgrade_map_suite_to_10.0}} | ||
| - | |||
| - | <!-- Class --> | ||
| Reads cell data from a grid file and displays them in appropriate colors based on their values. | Reads cell data from a grid file and displays them in appropriate colors based on their values. | ||
| - | === Remarks === | ||
| - | The <strong>GridFeatureSource</strong> displays cells with different colors in a rectangle area of map. The color of a cell depends on the cell value in the grid file. The grid file provides information about the grid, such as rows and columns number, cordinate of lower left corner, cell size, and values of cells. | ||
| ===== Inheritance Hierarchy ===== | ===== Inheritance Hierarchy ===== | ||
| - | *System.Object | + | *System.Object |
| - | **[[ThinkGeo.MapSuite.PortableCore.FeatureSource]] | + | *ThinkGeo.MapSuite.Core.FeatureSource |
| - | ***[[ThinkGeo.MapSuite.PortableCore.GridFeatureSource]] | + | ***ThinkGeo.MapSuite.Core.GridFeatureSource** |
| ===== Members Summary ===== | ===== Members Summary ===== | ||
| ==== Public Constructors ==== | ==== Public Constructors ==== | ||
| - | ^ Name ^ Parameters ^ DeclaringType ^ Summary ^ | + | ** {{wiki:PublicMethod.gif|}} GridFeatureSource() ** |
| - | | {{wiki:PublicMethod.gif|Public Method}}[[#GridFeatureSource()|GridFeatureSource]] | | | This is the constructor the for the class. If you use this constructor then you need to set the required properties manually. | | + | |
| - | | {{wiki:PublicMethod.gif|Public Method}}[[#GridFeatureSource(String)|GridFeatureSource]] | String | | This is the class constructor. | | + | |
| + | * //This is the constructor the for the class. If you use this constructor then you need to set the required properties manually.// | ||
| + | == Remarks == | ||
| + | * //None// | ||
| + | == Parameters == | ||
| + | <div newline></div> | ||
| + | ** {{wiki:PublicMethod.gif|}} GridFeatureSource(String) ** | ||
| + | |||
| + | * //This is the class constructor.// | ||
| + | == Remarks == | ||
| + | * //None// | ||
| + | == Parameters == | ||
| + | * //gridPathFilename// | ||
| + | * Type:String | ||
| + | * Description:This parameter represents the path and file name to the grid file. | ||
| + | |||
| + | <div newline></div> | ||
| ==== Protected Constructors ==== | ==== Protected Constructors ==== | ||
| - | ^ Name ^ Parameters ^ DeclaringType ^ Summary ^ | ||
| - | |||
| ==== Public Methods ==== | ==== Public Methods ==== | ||
| - | ^ Name ^ Parameters ^ DeclaringType ^ Summary ^ | + | ** {{wiki:PublicMethod.gif|}} GenerateGridMatrix() ** |
| - | | {{wiki:PublicMethod.gif|Public Method}}[[#AddColumn(FeatureSourceColumn)|AddColumn]] | [[ThinkGeo.MapSuite.PortableCore.FeatureSourceColumn|FeatureSourceColumn]] | [[ThinkGeo.MapSuite.PortableCore.FeatureSource|FeatureSource]] | | | + | |
| - | | {{wiki:PublicMethod.gif|Public Method}}[[#AddFeature(BaseShape)|AddFeature]] | [[ThinkGeo.MapSuite.PortableCore.BaseShape|BaseShape]] | [[ThinkGeo.MapSuite.PortableCore.FeatureSource|FeatureSource]] | This method adds a new Feature (composed of the passed-in BaseShape) to an existing transaction. | | + | |
| - | | {{wiki:PublicMethod.gif|Public Method}}[[#AddFeature(Feature)|AddFeature]] | [[ThinkGeo.MapSuite.PortableCore.Feature|Feature]] | [[ThinkGeo.MapSuite.PortableCore.FeatureSource|FeatureSource]] | This method adds a new Feature to an existing transaction. | | + | |
| - | | {{wiki:PublicMethod.gif|Public Method}}[[#AddFeature(BaseShape, IDictionary<String, String>)|AddFeature]] | [[ThinkGeo.MapSuite.PortableCore.BaseShape|BaseShape]], IDictionary<String, String> | [[ThinkGeo.MapSuite.PortableCore.FeatureSource|FeatureSource]] | This method adds a new Feature composes of the passed in BaseShape to an existing transaction. | | + | |
| - | | {{wiki:PublicMethod.gif|Public Method}}[[#BeginTransaction()|BeginTransaction]] | | [[ThinkGeo.MapSuite.PortableCore.FeatureSource|FeatureSource]] | This method starts a new transaction if the FeasuteSource allows editing | | + | |
| - | | {{wiki:PublicMethod.gif|Public Method}}[[#CanGetBoundingBoxQuickly()|CanGetBoundingBoxQuickly]] | | [[ThinkGeo.MapSuite.PortableCore.FeatureSource|FeatureSource]] | | | + | |
| - | | {{wiki:PublicMethod.gif|Public Method}}[[#CanGetCountQuickly()|CanGetCountQuickly]] | | [[ThinkGeo.MapSuite.PortableCore.FeatureSource|FeatureSource]] | | | + | |
| - | | {{wiki:PublicMethod.gif|Public Method}}[[#CloneDeep()|CloneDeep]] | | [[ThinkGeo.MapSuite.PortableCore.FeatureSource|FeatureSource]] | Create a copy of a FeatureSource using the deep clone process. | | + | |
| - | | {{wiki:PublicMethod.gif|Public Method}}[[#Close()|Close]] | | [[ThinkGeo.MapSuite.PortableCore.FeatureSource|FeatureSource]] | This method closes the FeatureSource and releases any resources it was using. | | + | |
| - | | {{wiki:PublicMethod.gif|Public Method}}[[#CommitTransaction()|CommitTransaction]] | | [[ThinkGeo.MapSuite.PortableCore.FeatureSource|FeatureSource]] | This method will commit the existing transaction to its underlying source of data. | | + | |
| - | | {{wiki:PublicMethod.gif|Public Method}}[[#DeleteColumn(String)|DeleteColumn]] | String | [[ThinkGeo.MapSuite.PortableCore.FeatureSource|FeatureSource]] | | | + | |
| - | | {{wiki:PublicMethod.gif|Public Method}}[[#DeleteFeature(String)|DeleteFeature]] | String | [[ThinkGeo.MapSuite.PortableCore.FeatureSource|FeatureSource]] | This method deletes a Feature from an existing transaction. | | + | |
| - | | {{wiki:PublicMethod.gif|Public Method}}[[#Equals(Object)|Equals]] | Object | Object | | | + | |
| - | | {{wiki:PublicMethod.gif|Public Method}}[[#ExecuteNonQuery(String)|ExecuteNonQuery]] | String | [[ThinkGeo.MapSuite.PortableCore.FeatureSource|FeatureSource]] | Executes a SQL statement against a connection object. | | + | |
| - | | {{wiki:PublicMethod.gif|Public Method}}[[#ExecuteQuery(String)|ExecuteQuery]] | String | [[ThinkGeo.MapSuite.PortableCore.FeatureSource|FeatureSource]] | Executes the query and returns the result returned by the query. | | + | |
| - | | {{wiki:PublicMethod.gif|Public Method}}[[#ExecuteScalar(String)|ExecuteScalar]] | String | [[ThinkGeo.MapSuite.PortableCore.FeatureSource|FeatureSource]] | 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. | | + | |
| - | | {{wiki:PublicMethod.gif|Public Method}}{{wiki:Static.gif|Static Member}}[[#GenerateGrid(GridDefinition, GridInterpolationModel, Stream)|GenerateGrid]] | [[ThinkGeo.MapSuite.PortableCore.GridDefinition|GridDefinition]], [[ThinkGeo.MapSuite.PortableCore.GridInterpolationModel|GridInterpolationModel]], Stream | | This method calculates all the cells in the grid and write the value of them into the grid file associates with the stream. | | + | |
| - | | {{wiki:PublicMethod.gif|Public Method}}[[#GenerateGridMatrix()|GenerateGridMatrix]] | | | This method generates the cell matrix based on NumberOfColumns and NumberOfRows of current grid. | | + | |
| - | | {{wiki:PublicMethod.gif|Public Method}}{{wiki:Static.gif|Static Member}}[[#GenerateGridMatrix(GridDefinition, GridInterpolationModel)|GenerateGridMatrix]] | [[ThinkGeo.MapSuite.PortableCore.GridDefinition|GridDefinition]], [[ThinkGeo.MapSuite.PortableCore.GridInterpolationModel|GridInterpolationModel]] | | This method calculates all the cells in the grid and returns the result in the form of the GridCell matrix | | + | |
| - | | {{wiki:PublicMethod.gif|Public Method}}[[#GetAllFeatures(IEnumerable<String>)|GetAllFeatures]] | IEnumerable<String> | [[ThinkGeo.MapSuite.PortableCore.FeatureSource|FeatureSource]] | This method returns all of the InternalFeatures in the FeatureSource. | | + | |
| - | | {{wiki:PublicMethod.gif|Public Method}}[[#GetAllFeatures(IEnumerable<String>, Int32, Int32)|GetAllFeatures]] | IEnumerable<String>, Int32, Int32 | [[ThinkGeo.MapSuite.PortableCore.FeatureSource|FeatureSource]] | | | + | |
| - | | {{wiki:PublicMethod.gif|Public Method}}[[#GetAllFeatures(ReturningColumnsType, Int32, Int32)|GetAllFeatures]] | [[ThinkGeo.MapSuite.PortableCore.ReturningColumnsType|ReturningColumnsType]], Int32, Int32 | [[ThinkGeo.MapSuite.PortableCore.FeatureSource|FeatureSource]] | | | + | |
| - | | {{wiki:PublicMethod.gif|Public Method}}[[#GetAllFeatures(ReturningColumnsType, Int32)|GetAllFeatures]] | [[ThinkGeo.MapSuite.PortableCore.ReturningColumnsType|ReturningColumnsType]], Int32 | [[ThinkGeo.MapSuite.PortableCore.FeatureSource|FeatureSource]] | | | + | |
| - | | {{wiki:PublicMethod.gif|Public Method}}[[#GetAllFeatures(ReturningColumnsType)|GetAllFeatures]] | [[ThinkGeo.MapSuite.PortableCore.ReturningColumnsType|ReturningColumnsType]] | [[ThinkGeo.MapSuite.PortableCore.FeatureSource|FeatureSource]] | This method returns all of the InternalFeatures in the FeatureSource. | | + | |
| - | | {{wiki:PublicMethod.gif|Public Method}}[[#GetBoundingBox()|GetBoundingBox]] | | [[ThinkGeo.MapSuite.PortableCore.FeatureSource|FeatureSource]] | This method returns the bounding box which encompasses all of the features in the FeatureSource. | | + | |
| - | | {{wiki:PublicMethod.gif|Public Method}}[[#GetBoundingBoxById(String)|GetBoundingBoxById]] | String | [[ThinkGeo.MapSuite.PortableCore.FeatureSource|FeatureSource]] | This method returns a bounding box based on the InternalFeatures Id specified. | | + | |
| - | | {{wiki:PublicMethod.gif|Public Method}}[[#GetBoundingBoxByIds(IEnumerable<String>)|GetBoundingBoxByIds]] | IEnumerable<String> | [[ThinkGeo.MapSuite.PortableCore.FeatureSource|FeatureSource]] | This method returns a collection of bounding boxes based on the Feature Ids specified. | | + | |
| - | | {{wiki:PublicMethod.gif|Public Method}}[[#GetBoundingBoxesByIds(IEnumerable<String>)|GetBoundingBoxesByIds]] | IEnumerable<String> | [[ThinkGeo.MapSuite.PortableCore.FeatureSource|FeatureSource]] | This method returns a collection of bounding boxes based on the Feature Ids specified. | | + | |
| - | | {{wiki:PublicMethod.gif|Public Method}}[[#GetColumns()|GetColumns]] | | [[ThinkGeo.MapSuite.PortableCore.FeatureSource|FeatureSource]] | This method returns the columns available for the FeatureSource and caches them. | | + | |
| - | | {{wiki:PublicMethod.gif|Public Method}}[[#GetCount()|GetCount]] | | [[ThinkGeo.MapSuite.PortableCore.FeatureSource|FeatureSource]] | This method returns the count of the number of records in this FeatureSource. | | + | |
| - | | {{wiki:PublicMethod.gif|Public Method}}[[#GetDistinctColumnValues(String)|GetDistinctColumnValues]] | String | [[ThinkGeo.MapSuite.PortableCore.FeatureSource|FeatureSource]] | | | + | |
| - | | {{wiki:PublicMethod.gif|Public Method}}[[#GetFeatureById(String, IEnumerable<String>)|GetFeatureById]] | String, IEnumerable<String> | [[ThinkGeo.MapSuite.PortableCore.FeatureSource|FeatureSource]] | This method returns a Feature by providing its Id in the FeatureSource. | | + | |
| - | | {{wiki:PublicMethod.gif|Public Method}}[[#GetFeatureById(String, ReturningColumnsType)|GetFeatureById]] | String, [[ThinkGeo.MapSuite.PortableCore.ReturningColumnsType|ReturningColumnsType]] | [[ThinkGeo.MapSuite.PortableCore.FeatureSource|FeatureSource]] | This method returns a Feature by providing its Id in the FeatureSource. | | + | |
| - | | {{wiki:PublicMethod.gif|Public Method}}[[#GetFeaturesByColumnValue(String, String, IEnumerable<String>)|GetFeaturesByColumnValue]] | String, String, IEnumerable<String> | [[ThinkGeo.MapSuite.PortableCore.FeatureSource|FeatureSource]] | Get all of the features by passing a columnName and a specified columValue. | | + | |
| - | | {{wiki:PublicMethod.gif|Public Method}}[[#GetFeaturesByColumnValue(String, String)|GetFeaturesByColumnValue]] | String, String | [[ThinkGeo.MapSuite.PortableCore.FeatureSource|FeatureSource]] | Get all of the features by passing a columnName and a specified columValue. | | + | |
| - | | {{wiki:PublicMethod.gif|Public Method}}[[#GetFeaturesByColumnValue(String, String, ReturningColumnsType)|GetFeaturesByColumnValue]] | String, String, [[ThinkGeo.MapSuite.PortableCore.ReturningColumnsType|ReturningColumnsType]] | [[ThinkGeo.MapSuite.PortableCore.FeatureSource|FeatureSource]] | Get all of the features by passing a columnName and a specified columValue. | | + | |
| - | | {{wiki:PublicMethod.gif|Public Method}}[[#GetFeaturesByIds(IEnumerable<String>, IEnumerable<String>)|GetFeaturesByIds]] | IEnumerable<String>, IEnumerable<String> | [[ThinkGeo.MapSuite.PortableCore.FeatureSource|FeatureSource]] | This method returns a collection of InternalFeatures by providing a group of Ids. | | + | |
| - | | {{wiki:PublicMethod.gif|Public Method}}[[#GetFeaturesByIds(IEnumerable<String>, ReturningColumnsType)|GetFeaturesByIds]] | IEnumerable<String>, [[ThinkGeo.MapSuite.PortableCore.ReturningColumnsType|ReturningColumnsType]] | [[ThinkGeo.MapSuite.PortableCore.FeatureSource|FeatureSource]] | This method returns a collection of InternalFeatures by providing a group of Ids. | | + | |
| - | | {{wiki:PublicMethod.gif|Public Method}}[[#GetFeaturesForDrawing(RectangleShape, Double, Double, IEnumerable<String>)|GetFeaturesForDrawing]] | [[ThinkGeo.MapSuite.PortableCore.RectangleShape|RectangleShape]], Double, Double, IEnumerable<String> | [[ThinkGeo.MapSuite.PortableCore.FeatureSource|FeatureSource]] | This method returns the InternalFeatures that will be used for drawing. | | + | |
| - | | {{wiki:PublicMethod.gif|Public Method}}[[#GetFeaturesForDrawing(RectangleShape, Double, Double, ReturningColumnsType)|GetFeaturesForDrawing]] | [[ThinkGeo.MapSuite.PortableCore.RectangleShape|RectangleShape]], Double, Double, [[ThinkGeo.MapSuite.PortableCore.ReturningColumnsType|ReturningColumnsType]] | [[ThinkGeo.MapSuite.PortableCore.FeatureSource|FeatureSource]] | This method returns the InternalFeatures that will be used for drawing. | | + | |
| - | | {{wiki:PublicMethod.gif|Public Method}}[[#GetFeaturesInsideBoundingBox(RectangleShape, IEnumerable<String>)|GetFeaturesInsideBoundingBox]] | [[ThinkGeo.MapSuite.PortableCore.RectangleShape|RectangleShape]], IEnumerable<String> | [[ThinkGeo.MapSuite.PortableCore.FeatureSource|FeatureSource]] | This method returns all of the InternalFeatures of this FeatureSource inside of the specified bounding box. | | + | |
| - | | {{wiki:PublicMethod.gif|Public Method}}[[#GetFeaturesInsideBoundingBox(RectangleShape, ReturningColumnsType)|GetFeaturesInsideBoundingBox]] | [[ThinkGeo.MapSuite.PortableCore.RectangleShape|RectangleShape]], [[ThinkGeo.MapSuite.PortableCore.ReturningColumnsType|ReturningColumnsType]] | [[ThinkGeo.MapSuite.PortableCore.FeatureSource|FeatureSource]] | This method returns all of the InternalFeatures of this FeatureSource inside of the specified bounding box. | | + | |
| - | | {{wiki:PublicMethod.gif|Public Method}}[[#GetFeaturesNearestTo(Feature, GeographyUnit, Int32, IEnumerable<String>)|GetFeaturesNearestTo]] | [[ThinkGeo.MapSuite.PortableCore.Feature|Feature]], [[ThinkGeo.MapSuite.PortableCore.GeographyUnit|GeographyUnit]], Int32, IEnumerable<String> | [[ThinkGeo.MapSuite.PortableCore.FeatureSource|FeatureSource]] | This method returns a user defined number of InternalFeatures that are closest to the TargetShape. | | + | |
| - | | {{wiki:PublicMethod.gif|Public Method}}[[#GetFeaturesNearestTo(BaseShape, GeographyUnit, Int32, IEnumerable<String>)|GetFeaturesNearestTo]] | [[ThinkGeo.MapSuite.PortableCore.BaseShape|BaseShape]], [[ThinkGeo.MapSuite.PortableCore.GeographyUnit|GeographyUnit]], Int32, IEnumerable<String> | [[ThinkGeo.MapSuite.PortableCore.FeatureSource|FeatureSource]] | This method returns a user defined number of InternalFeatures that are closest to the TargetShape. | | + | |
| - | | {{wiki:PublicMethod.gif|Public Method}}[[#GetFeaturesNearestTo(Feature, GeographyUnit, Int32, ReturningColumnsType)|GetFeaturesNearestTo]] | [[ThinkGeo.MapSuite.PortableCore.Feature|Feature]], [[ThinkGeo.MapSuite.PortableCore.GeographyUnit|GeographyUnit]], Int32, [[ThinkGeo.MapSuite.PortableCore.ReturningColumnsType|ReturningColumnsType]] | [[ThinkGeo.MapSuite.PortableCore.FeatureSource|FeatureSource]] | This method returns a user defined number of InternalFeatures that are closest to the TargetShape. | | + | |
| - | | {{wiki:PublicMethod.gif|Public Method}}[[#GetFeaturesNearestTo(BaseShape, GeographyUnit, Int32, IEnumerable<String>, Double, DistanceUnit)|GetFeaturesNearestTo]] | [[ThinkGeo.MapSuite.PortableCore.BaseShape|BaseShape]], [[ThinkGeo.MapSuite.PortableCore.GeographyUnit|GeographyUnit]], Int32, IEnumerable<String>, Double, [[ThinkGeo.MapSuite.PortableCore.DistanceUnit|DistanceUnit]] | [[ThinkGeo.MapSuite.PortableCore.FeatureSource|FeatureSource]] | This method returns a user defined number of InternalFeatures that are closest to the TargetShape. | | + | |
| - | | {{wiki:PublicMethod.gif|Public Method}}[[#GetFeaturesNearestTo(Feature, GeographyUnit, Int32, IEnumerable<String>, Double, DistanceUnit)|GetFeaturesNearestTo]] | [[ThinkGeo.MapSuite.PortableCore.Feature|Feature]], [[ThinkGeo.MapSuite.PortableCore.GeographyUnit|GeographyUnit]], Int32, IEnumerable<String>, Double, [[ThinkGeo.MapSuite.PortableCore.DistanceUnit|DistanceUnit]] | [[ThinkGeo.MapSuite.PortableCore.FeatureSource|FeatureSource]] | This method returns a user defined number of InternalFeatures that are closest to the TargetShape. | | + | |
| - | | {{wiki:PublicMethod.gif|Public Method}}[[#GetFeaturesNearestTo(BaseShape, GeographyUnit, Int32, ReturningColumnsType)|GetFeaturesNearestTo]] | [[ThinkGeo.MapSuite.PortableCore.BaseShape|BaseShape]], [[ThinkGeo.MapSuite.PortableCore.GeographyUnit|GeographyUnit]], Int32, [[ThinkGeo.MapSuite.PortableCore.ReturningColumnsType|ReturningColumnsType]] | [[ThinkGeo.MapSuite.PortableCore.FeatureSource|FeatureSource]] | This method returns a user defined number of InternalFeatures that are closest to the TargetShape. | | + | |
| - | | {{wiki:PublicMethod.gif|Public Method}}[[#GetFeaturesOutsideBoundingBox(RectangleShape, ReturningColumnsType)|GetFeaturesOutsideBoundingBox]] | [[ThinkGeo.MapSuite.PortableCore.RectangleShape|RectangleShape]], [[ThinkGeo.MapSuite.PortableCore.ReturningColumnsType|ReturningColumnsType]] | [[ThinkGeo.MapSuite.PortableCore.FeatureSource|FeatureSource]] | This method returns all of the InternalFeatures of this FeatureSource outside of the specified bounding box. | | + | |
| - | | {{wiki:PublicMethod.gif|Public Method}}[[#GetFeaturesOutsideBoundingBox(RectangleShape, IEnumerable<String>)|GetFeaturesOutsideBoundingBox]] | [[ThinkGeo.MapSuite.PortableCore.RectangleShape|RectangleShape]], IEnumerable<String> | [[ThinkGeo.MapSuite.PortableCore.FeatureSource|FeatureSource]] | This method returns all of the InternalFeatures of this FeatureSource outside of the specified bounding box. | | + | |
| - | | {{wiki:PublicMethod.gif|Public Method}}[[#GetFeaturesWithinDistanceOf(BaseShape, GeographyUnit, DistanceUnit, Double, IEnumerable<String>)|GetFeaturesWithinDistanceOf]] | [[ThinkGeo.MapSuite.PortableCore.BaseShape|BaseShape]], [[ThinkGeo.MapSuite.PortableCore.GeographyUnit|GeographyUnit]], [[ThinkGeo.MapSuite.PortableCore.DistanceUnit|DistanceUnit]], Double, IEnumerable<String> | [[ThinkGeo.MapSuite.PortableCore.FeatureSource|FeatureSource]] | This method returns a collection of InternalFeatures that are within a certain distance of the TargetShape. | | + | |
| - | | {{wiki:PublicMethod.gif|Public Method}}[[#GetFeaturesWithinDistanceOf(Feature, GeographyUnit, DistanceUnit, Double, ReturningColumnsType)|GetFeaturesWithinDistanceOf]] | [[ThinkGeo.MapSuite.PortableCore.Feature|Feature]], [[ThinkGeo.MapSuite.PortableCore.GeographyUnit|GeographyUnit]], [[ThinkGeo.MapSuite.PortableCore.DistanceUnit|DistanceUnit]], Double, [[ThinkGeo.MapSuite.PortableCore.ReturningColumnsType|ReturningColumnsType]] | [[ThinkGeo.MapSuite.PortableCore.FeatureSource|FeatureSource]] | This method returns a collection of InternalFeatures that are within a certain distance of the TargetShape. | | + | |
| - | | {{wiki:PublicMethod.gif|Public Method}}[[#GetFeaturesWithinDistanceOf(Feature, GeographyUnit, DistanceUnit, Double, IEnumerable<String>)|GetFeaturesWithinDistanceOf]] | [[ThinkGeo.MapSuite.PortableCore.Feature|Feature]], [[ThinkGeo.MapSuite.PortableCore.GeographyUnit|GeographyUnit]], [[ThinkGeo.MapSuite.PortableCore.DistanceUnit|DistanceUnit]], Double, IEnumerable<String> | [[ThinkGeo.MapSuite.PortableCore.FeatureSource|FeatureSource]] | This method returns a collection of InternalFeatures that are within a certain distance of the TargetShape. | | + | |
| - | | {{wiki:PublicMethod.gif|Public Method}}[[#GetFeaturesWithinDistanceOf(BaseShape, GeographyUnit, DistanceUnit, Double, ReturningColumnsType)|GetFeaturesWithinDistanceOf]] | [[ThinkGeo.MapSuite.PortableCore.BaseShape|BaseShape]], [[ThinkGeo.MapSuite.PortableCore.GeographyUnit|GeographyUnit]], [[ThinkGeo.MapSuite.PortableCore.DistanceUnit|DistanceUnit]], Double, [[ThinkGeo.MapSuite.PortableCore.ReturningColumnsType|ReturningColumnsType]] | [[ThinkGeo.MapSuite.PortableCore.FeatureSource|FeatureSource]] | This method returns a collection of InternalFeatures that are within a certain distance of the TargetShape. | | + | |
| - | | {{wiki:PublicMethod.gif|Public Method}}[[#GetFirstFeaturesWellKnownType()|GetFirstFeaturesWellKnownType]] | | [[ThinkGeo.MapSuite.PortableCore.FeatureSource|FeatureSource]] | This method returns the well known type that represents the first feature from FeatureSource. | | + | |
| - | | {{wiki:PublicMethod.gif|Public Method}}[[#GetHashCode()|GetHashCode]] | | Object | | | + | |
| - | | {{wiki:PublicMethod.gif|Public Method}}[[#GetType()|GetType]] | | Object | | | + | |
| - | | {{wiki:PublicMethod.gif|Public Method}}[[#Open()|Open]] | | [[ThinkGeo.MapSuite.PortableCore.FeatureSource|FeatureSource]] | This method opens the FeatureSource so that it is initialized and ready to use. | | + | |
| - | | {{wiki:PublicMethod.gif|Public Method}}[[#RefreshColumns()|RefreshColumns]] | | [[ThinkGeo.MapSuite.PortableCore.FeatureSource|FeatureSource]] | This method refresh the columns available for the FeatureSource and caches them. | | + | |
| - | | {{wiki:PublicMethod.gif|Public Method}}{{wiki:Static.gif|Static Member}}[[[#ReplaceNoDataValue(GridCell[,|]], Double)|ReplaceNoDataValue]] | [[ThinkGeo.MapSuite.PortableCore.GridCell[|GridCell[]], ], Double | | | | + | |
| - | | {{wiki:PublicMethod.gif|Public Method}}{{wiki:Static.gif|Static Member}}[[[#ReplaceNoDataValue(GridCell[,|]], Double, GridInterpolationModel)|ReplaceNoDataValue]] | [[ThinkGeo.MapSuite.PortableCore.GridCell[|GridCell[]], ], Double, [[ThinkGeo.MapSuite.PortableCore.GridInterpolationModel|GridInterpolationModel]] | | | | + | |
| - | | {{wiki:PublicMethod.gif|Public Method}}[[#RollbackTransaction()|RollbackTransaction]] | | [[ThinkGeo.MapSuite.PortableCore.FeatureSource|FeatureSource]] | This method will cancel an existing transaction. It will free up the internal memory cache of any InternalFeatures added, updated or deleted. | | + | |
| - | | {{wiki:PublicMethod.gif|Public Method}}[[#SpatialQuery(BaseShape, QueryType, IEnumerable<String>)|SpatialQuery]] | [[ThinkGeo.MapSuite.PortableCore.BaseShape|BaseShape]], [[ThinkGeo.MapSuite.PortableCore.QueryType|QueryType]], IEnumerable<String> | [[ThinkGeo.MapSuite.PortableCore.FeatureSource|FeatureSource]] | This method returns all of the InternalFeatures based on the target Feature and the spatial query type specified. | | + | |
| - | | {{wiki:PublicMethod.gif|Public Method}}[[#SpatialQuery(BaseShape, QueryType, ReturningColumnsType)|SpatialQuery]] | [[ThinkGeo.MapSuite.PortableCore.BaseShape|BaseShape]], [[ThinkGeo.MapSuite.PortableCore.QueryType|QueryType]], [[ThinkGeo.MapSuite.PortableCore.ReturningColumnsType|ReturningColumnsType]] | [[ThinkGeo.MapSuite.PortableCore.FeatureSource|FeatureSource]] | This method returns all of the InternalFeatures based on the target Feature and the spatial query type specified. | | + | |
| - | | {{wiki:PublicMethod.gif|Public Method}}[[#SpatialQuery(Feature, QueryType, ReturningColumnsType)|SpatialQuery]] | [[ThinkGeo.MapSuite.PortableCore.Feature|Feature]], [[ThinkGeo.MapSuite.PortableCore.QueryType|QueryType]], [[ThinkGeo.MapSuite.PortableCore.ReturningColumnsType|ReturningColumnsType]] | [[ThinkGeo.MapSuite.PortableCore.FeatureSource|FeatureSource]] | This method returns all of the InternalFeatures based on the target Feature and the spatial query type specified. | | + | |
| - | | {{wiki:PublicMethod.gif|Public Method}}[[#SpatialQuery(Feature, QueryType, IEnumerable<String>)|SpatialQuery]] | [[ThinkGeo.MapSuite.PortableCore.Feature|Feature]], [[ThinkGeo.MapSuite.PortableCore.QueryType|QueryType]], IEnumerable<String> | [[ThinkGeo.MapSuite.PortableCore.FeatureSource|FeatureSource]] | This method returns all of the InternalFeatures based on the target Feature and the spatial query type specified. | | + | |
| - | | {{wiki:PublicMethod.gif|Public Method}}[[#ToString()|ToString]] | | Object | | | + | |
| - | | {{wiki:PublicMethod.gif|Public Method}}[[#UpdateColumn(String, FeatureSourceColumn)|UpdateColumn]] | String, [[ThinkGeo.MapSuite.PortableCore.FeatureSourceColumn|FeatureSourceColumn]] | [[ThinkGeo.MapSuite.PortableCore.FeatureSource|FeatureSource]] | | | + | |
| - | | {{wiki:PublicMethod.gif|Public Method}}[[#UpdateFeature(Feature)|UpdateFeature]] | [[ThinkGeo.MapSuite.PortableCore.Feature|Feature]] | [[ThinkGeo.MapSuite.PortableCore.FeatureSource|FeatureSource]] | This method updates a Feature in an existing transaction. | | + | |
| - | | {{wiki:PublicMethod.gif|Public Method}}[[#UpdateFeature(BaseShape, IDictionary<String, String>)|UpdateFeature]] | [[ThinkGeo.MapSuite.PortableCore.BaseShape|BaseShape]], IDictionary<String, String> | [[ThinkGeo.MapSuite.PortableCore.FeatureSource|FeatureSource]] | This method updates a Feature (composed of the passed-in BaseShape) in an existing transaction. | | + | |
| - | | {{wiki:PublicMethod.gif|Public Method}}[[#UpdateFeature(BaseShape)|UpdateFeature]] | [[ThinkGeo.MapSuite.PortableCore.BaseShape|BaseShape]] | [[ThinkGeo.MapSuite.PortableCore.FeatureSource|FeatureSource]] | This method updates a Feature (composed of the passed-in BaseShape) in an existing transaction. | | + | |
| - | ==== Protected Methods ==== | + | * //This method generates the cell matrix based on NumberOfColumns and NumberOfRows of current grid.// |
| - | ^ Name ^ Parameters ^ DeclaringType ^ Summary ^ | + | == Remarks == |
| - | | {{wiki:ProtectedMethod.gif|Protected Method}}[[#CanGetBoundingBoxQuicklyCore()|CanGetBoundingBoxQuicklyCore]] | | [[ThinkGeo.MapSuite.PortableCore.FeatureSource|FeatureSource]](overriden) | | | + | * //N/A// |
| - | | {{wiki:ProtectedMethod.gif|Protected Method}}[[#CanGetCountQuicklyCore()|CanGetCountQuicklyCore]] | | [[ThinkGeo.MapSuite.PortableCore.FeatureSource|FeatureSource]] | | | + | |
| - | | {{wiki:ProtectedMethod.gif|Protected Method}}[[#CloneDeepCore()|CloneDeepCore]] | | [[ThinkGeo.MapSuite.PortableCore.FeatureSource|FeatureSource]] | Create a copy of a FeatureSource using the deep clone process. The default implementation uses serialization. | | + | |
| - | | {{wiki:ProtectedMethod.gif|Protected Method}}[[#CloseCore()|CloseCore]] | | [[ThinkGeo.MapSuite.PortableCore.FeatureSource|FeatureSource]](overriden) | This method closes the FeatureSource and releases any resources it was using. | | + | |
| - | | {{wiki:ProtectedMethod.gif|Protected Method}}[[#CommitTransactionCore(TransactionBuffer)|CommitTransactionCore]] | [[ThinkGeo.MapSuite.PortableCore.TransactionBuffer|TransactionBuffer]] | [[ThinkGeo.MapSuite.PortableCore.FeatureSource|FeatureSource]](overriden) | This method will commit the existing transaction to its underlying source of data. | | + | |
| - | | {{wiki:ProtectedMethod.gif|Protected Method}}[[#ConvertToExternalProjection(RectangleShape)|ConvertToExternalProjection]] | [[ThinkGeo.MapSuite.PortableCore.RectangleShape|RectangleShape]] | [[ThinkGeo.MapSuite.PortableCore.FeatureSource|FeatureSource]] | This method projects items based on the Projection of the FeatureSource. | | + | |
| - | | {{wiki:ProtectedMethod.gif|Protected Method}}[[#ConvertToExternalProjection(IEnumerable<Feature>)|ConvertToExternalProjection]] | IEnumerable<[[ThinkGeo.MapSuite.PortableCore.Feature|Feature]]> | [[ThinkGeo.MapSuite.PortableCore.FeatureSource|FeatureSource]] | This method projects items based on the Projection of the FeatureSource. | | + | |
| - | | {{wiki:ProtectedMethod.gif|Protected Method}}[[#ConvertToExternalProjection(IEnumerable<RectangleShape>)|ConvertToExternalProjection]] | IEnumerable<[[ThinkGeo.MapSuite.PortableCore.RectangleShape|RectangleShape]]> | [[ThinkGeo.MapSuite.PortableCore.FeatureSource|FeatureSource]] | This method projects items based on the Projection of the FeatureSource. | | + | |
| - | | {{wiki:ProtectedMethod.gif|Protected Method}}[[#ConvertToExternalProjection(Feature)|ConvertToExternalProjection]] | [[ThinkGeo.MapSuite.PortableCore.Feature|Feature]] | [[ThinkGeo.MapSuite.PortableCore.FeatureSource|FeatureSource]] | This method projects items based on the Projection of the FeatureSource. | | + | |
| - | | {{wiki:ProtectedMethod.gif|Protected Method}}[[#ConvertToInternalProjection(IEnumerable<Feature>)|ConvertToInternalProjection]] | IEnumerable<[[ThinkGeo.MapSuite.PortableCore.Feature|Feature]]> | [[ThinkGeo.MapSuite.PortableCore.FeatureSource|FeatureSource]] | This method de-projects items based on the Projection of the FeatureSource. | | + | |
| - | | {{wiki:ProtectedMethod.gif|Protected Method}}[[#ConvertToInternalProjection(Feature)|ConvertToInternalProjection]] | [[ThinkGeo.MapSuite.PortableCore.Feature|Feature]] | [[ThinkGeo.MapSuite.PortableCore.FeatureSource|FeatureSource]] | This method de-projects items based on the Projection of the FeatureSource. | | + | |
| - | | {{wiki:ProtectedMethod.gif|Protected Method}}[[#ConvertToInternalProjection(BaseShape)|ConvertToInternalProjection]] | [[ThinkGeo.MapSuite.PortableCore.BaseShape|BaseShape]] | [[ThinkGeo.MapSuite.PortableCore.FeatureSource|FeatureSource]] | This method de-projects items based on the Projection of the FeatureSource. | | + | |
| - | | {{wiki:ProtectedMethod.gif|Protected Method}}[[#ConvertToInternalProjection(RectangleShape)|ConvertToInternalProjection]] | [[ThinkGeo.MapSuite.PortableCore.RectangleShape|RectangleShape]] | [[ThinkGeo.MapSuite.PortableCore.FeatureSource|FeatureSource]] | This method de-projects items based on the Projection of the FeatureSource. | | + | |
| - | | {{wiki:ProtectedMethod.gif|Protected Method}}[[#ConvertToInternalProjection(IEnumerable<RectangleShape>)|ConvertToInternalProjection]] | IEnumerable<[[ThinkGeo.MapSuite.PortableCore.RectangleShape|RectangleShape]]> | [[ThinkGeo.MapSuite.PortableCore.FeatureSource|FeatureSource]] | This method de-projects items based on the Projection of the FeatureSource. | | + | |
| - | | {{wiki:ProtectedMethod.gif|Protected Method}}[[#ExecuteNonQueryCore(String)|ExecuteNonQueryCore]] | String | [[ThinkGeo.MapSuite.PortableCore.FeatureSource|FeatureSource]] | Executes a SQL statement against a connection object. | | + | |
| - | | {{wiki:ProtectedMethod.gif|Protected Method}}[[#ExecuteQueryCore(String)|ExecuteQueryCore]] | String | [[ThinkGeo.MapSuite.PortableCore.FeatureSource|FeatureSource]] | Executes the query and returns the result returned by the query. | | + | |
| - | | {{wiki:ProtectedMethod.gif|Protected Method}}[[#ExecuteScalarCore(String)|ExecuteScalarCore]] | String | [[ThinkGeo.MapSuite.PortableCore.FeatureSource|FeatureSource]] | 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. | | + | |
| - | | {{wiki:ProtectedMethod.gif|Protected Method}}[[#Finalize()|Finalize]] | | Object | | | + | |
| - | | {{wiki:ProtectedMethod.gif|Protected Method}}[[#GetAllFeaturesCore(IEnumerable<String>, Int32, Int32)|GetAllFeaturesCore]] | IEnumerable<String>, Int32, Int32 | [[ThinkGeo.MapSuite.PortableCore.FeatureSource|FeatureSource]] | | | + | |
| - | | {{wiki:ProtectedMethod.gif|Protected Method}}[[#GetAllFeaturesCore(IEnumerable<String>)|GetAllFeaturesCore]] | IEnumerable<String> | [[ThinkGeo.MapSuite.PortableCore.FeatureSource|FeatureSource]](overriden) | This method returns all of the InternalFeatures in the FeatureSource. | | + | |
| - | | {{wiki:ProtectedMethod.gif|Protected Method}}[[#GetBoundingBoxByIdCore(String)|GetBoundingBoxByIdCore]] | String | [[ThinkGeo.MapSuite.PortableCore.FeatureSource|FeatureSource]] | | | + | |
| - | | {{wiki:ProtectedMethod.gif|Protected Method}}[[#GetBoundingBoxCore()|GetBoundingBoxCore]] | | [[ThinkGeo.MapSuite.PortableCore.FeatureSource|FeatureSource]](overriden) | This method returns the bounding box which encompasses all of the features in the FeatureSource. | | + | |
| - | | {{wiki:ProtectedMethod.gif|Protected Method}}[[#GetColumnNamesInsideFeatureSource(IEnumerable<String>)|GetColumnNamesInsideFeatureSource]] | IEnumerable<String> | [[ThinkGeo.MapSuite.PortableCore.FeatureSource|FeatureSource]] | This method returns the field names that are in the FeatureSource from a list of provided field names. | | + | |
| - | | {{wiki:ProtectedMethod.gif|Protected Method}}[[#GetColumnNamesOutsideFeatureSource(IEnumerable<String>)|GetColumnNamesOutsideFeatureSource]] | IEnumerable<String> | [[ThinkGeo.MapSuite.PortableCore.FeatureSource|FeatureSource]] | This method returns the field names that are not in the FeatureSource from a list of provided field names. | | + | |
| - | | {{wiki:ProtectedMethod.gif|Protected Method}}[[#GetColumnsCore()|GetColumnsCore]] | | [[ThinkGeo.MapSuite.PortableCore.FeatureSource|FeatureSource]](overriden) | This method returns the columns available for the FeatureSource. | | + | |
| - | | {{wiki:ProtectedMethod.gif|Protected Method}}[[#GetCountCore()|GetCountCore]] | | [[ThinkGeo.MapSuite.PortableCore.FeatureSource|FeatureSource]](overriden) | This method returns the count of the number of records in this FeatureSource. | | + | |
| - | | {{wiki:ProtectedMethod.gif|Protected Method}}[[#GetDistinctColumnValuesCore(String)|GetDistinctColumnValuesCore]] | String | [[ThinkGeo.MapSuite.PortableCore.FeatureSource|FeatureSource]] | | | + | |
| - | | {{wiki:ProtectedMethod.gif|Protected Method}}[[#GetFeaturesByColumnValueCore(String, String, IEnumerable<String>)|GetFeaturesByColumnValueCore]] | String, String, IEnumerable<String> | [[ThinkGeo.MapSuite.PortableCore.FeatureSource|FeatureSource]] | Get all of the features by passing a columnName and a specified columValue. | | + | |
| - | | {{wiki:ProtectedMethod.gif|Protected Method}}[[#GetFeaturesByIdsCore(IEnumerable<String>, IEnumerable<String>)|GetFeaturesByIdsCore]] | IEnumerable<String>, IEnumerable<String> | [[ThinkGeo.MapSuite.PortableCore.FeatureSource|FeatureSource]] | This method returns a collection of InternalFeatures by providing a group of Ids. | | + | |
| - | | {{wiki:ProtectedMethod.gif|Protected Method}}[[#GetFeaturesForDrawingCore(RectangleShape, Double, Double, IEnumerable<String>)|GetFeaturesForDrawingCore]] | [[ThinkGeo.MapSuite.PortableCore.RectangleShape|RectangleShape]], Double, Double, IEnumerable<String> | [[ThinkGeo.MapSuite.PortableCore.FeatureSource|FeatureSource]] | This method returns the InternalFeatures that will be used for drawing. | | + | |
| - | | {{wiki:ProtectedMethod.gif|Protected Method}}[[#GetFeaturesInsideBoundingBoxCore(RectangleShape, IEnumerable<String>)|GetFeaturesInsideBoundingBoxCore]] | [[ThinkGeo.MapSuite.PortableCore.RectangleShape|RectangleShape]], IEnumerable<String> | [[ThinkGeo.MapSuite.PortableCore.FeatureSource|FeatureSource]](overriden) | This method returns all of the InternalFeatures of this FeatureSource inside of the specified bounding box. | | + | |
| - | | {{wiki:ProtectedMethod.gif|Protected Method}}[[#GetFeaturesNearestToCore(BaseShape, GeographyUnit, Int32, IEnumerable<String>)|GetFeaturesNearestToCore]] | [[ThinkGeo.MapSuite.PortableCore.BaseShape|BaseShape]], [[ThinkGeo.MapSuite.PortableCore.GeographyUnit|GeographyUnit]], Int32, IEnumerable<String> | [[ThinkGeo.MapSuite.PortableCore.FeatureSource|FeatureSource]] | This method returns a user defined number of InternalFeatures that are closest to the TargetShape. | | + | |
| - | | {{wiki:ProtectedMethod.gif|Protected Method}}[[#GetFeaturesOutsideBoundingBoxCore(RectangleShape, IEnumerable<String>)|GetFeaturesOutsideBoundingBoxCore]] | [[ThinkGeo.MapSuite.PortableCore.RectangleShape|RectangleShape]], IEnumerable<String> | [[ThinkGeo.MapSuite.PortableCore.FeatureSource|FeatureSource]] | This method returns all of the InternalFeatures of this FeatureSource outside of the specified bounding box. | | + | |
| - | | {{wiki:ProtectedMethod.gif|Protected Method}}[[#GetFeaturesWithinDistanceOfCore(BaseShape, GeographyUnit, DistanceUnit, Double, IEnumerable<String>)|GetFeaturesWithinDistanceOfCore]] | [[ThinkGeo.MapSuite.PortableCore.BaseShape|BaseShape]], [[ThinkGeo.MapSuite.PortableCore.GeographyUnit|GeographyUnit]], [[ThinkGeo.MapSuite.PortableCore.DistanceUnit|DistanceUnit]], Double, IEnumerable<String> | [[ThinkGeo.MapSuite.PortableCore.FeatureSource|FeatureSource]] | This method returns a collection of InternalFeatures that are within a certain distance of the TargetShape. | | + | |
| - | | {{wiki:ProtectedMethod.gif|Protected Method}}[[#GetFirstFeaturesWellKnownTypeCore()|GetFirstFeaturesWellKnownTypeCore]] | | [[ThinkGeo.MapSuite.PortableCore.FeatureSource|FeatureSource]] | This method returns the well known type that represents the first feature from FeatureSource. | | + | |
| - | | {{wiki:ProtectedMethod.gif|Protected Method}}[[#GetReturningColumnNames(ReturningColumnsType)|GetReturningColumnNames]] | [[ThinkGeo.MapSuite.PortableCore.ReturningColumnsType|ReturningColumnsType]] | [[ThinkGeo.MapSuite.PortableCore.FeatureSource|FeatureSource]] | Get returning columnNames according to the returningColumnType. | | + | |
| - | | {{wiki:ProtectedMethod.gif|Protected Method}}[[#MemberwiseClone()|MemberwiseClone]] | | Object | | | + | |
| - | | {{wiki:ProtectedMethod.gif|Protected Method}}[[#OnClosedFeatureSource(ClosedFeatureSourceEventArgs)|OnClosedFeatureSource]] | [[ThinkGeo.MapSuite.PortableCore.ClosedFeatureSourceEventArgs|ClosedFeatureSourceEventArgs]] | [[ThinkGeo.MapSuite.PortableCore.FeatureSource|FeatureSource]] | This method allows you to raise the ClosedFeatureSource event from a derived class. | | + | |
| - | | {{wiki:ProtectedMethod.gif|Protected Method}}[[#OnClosingFeatureSource(ClosingFeatureSourceEventArgs)|OnClosingFeatureSource]] | [[ThinkGeo.MapSuite.PortableCore.ClosingFeatureSourceEventArgs|ClosingFeatureSourceEventArgs]] | [[ThinkGeo.MapSuite.PortableCore.FeatureSource|FeatureSource]] | This method allows you to raise the ClosingFeatureSource event from a derived class. | | + | |
| - | | {{wiki:ProtectedMethod.gif|Protected Method}}[[#OnCommittedTransaction(CommittedTransactionEventArgs)|OnCommittedTransaction]] | [[ThinkGeo.MapSuite.PortableCore.CommittedTransactionEventArgs|CommittedTransactionEventArgs]] | [[ThinkGeo.MapSuite.PortableCore.FeatureSource|FeatureSource]] | This method allows you to raise the CommittedTransaction event from a derived class. | | + | |
| - | | {{wiki:ProtectedMethod.gif|Protected Method}}[[#OnCommittingTransaction(CommittingTransactionEventArgs)|OnCommittingTransaction]] | [[ThinkGeo.MapSuite.PortableCore.CommittingTransactionEventArgs|CommittingTransactionEventArgs]] | [[ThinkGeo.MapSuite.PortableCore.FeatureSource|FeatureSource]] | This method allows you to raise the CommittingTransaction event from a derived class. | | + | |
| - | | {{wiki:ProtectedMethod.gif|Protected Method}}[[#OnCustomColumnFetch(CustomColumnFetchEventArgs)|OnCustomColumnFetch]] | [[ThinkGeo.MapSuite.PortableCore.CustomColumnFetchEventArgs|CustomColumnFetchEventArgs]] | [[ThinkGeo.MapSuite.PortableCore.FeatureSource|FeatureSource]] | This method allows you to raise the CustomColumnFetch event from a derived class. | | + | |
| - | | {{wiki:ProtectedMethod.gif|Protected Method}}[[#OnDrawingProgressChanged(DrawingProgressChangedEventArgs)|OnDrawingProgressChanged]] | [[ThinkGeo.MapSuite.PortableCore.DrawingProgressChangedEventArgs|DrawingProgressChangedEventArgs]] | [[ThinkGeo.MapSuite.PortableCore.FeatureSource|FeatureSource]] | | | + | |
| - | | {{wiki:ProtectedMethod.gif|Protected Method}}[[#OnOpenedFeatureSource(OpenedFeatureSourceEventArgs)|OnOpenedFeatureSource]] | [[ThinkGeo.MapSuite.PortableCore.OpenedFeatureSourceEventArgs|OpenedFeatureSourceEventArgs]] | [[ThinkGeo.MapSuite.PortableCore.FeatureSource|FeatureSource]] | This method allows you to raise the OpenedFeatureSource event from a derived class. | | + | |
| - | | {{wiki:ProtectedMethod.gif|Protected Method}}[[#OnOpeningFeatureSource(OpeningFeatureSourceEventArgs)|OnOpeningFeatureSource]] | [[ThinkGeo.MapSuite.PortableCore.OpeningFeatureSourceEventArgs|OpeningFeatureSourceEventArgs]] | [[ThinkGeo.MapSuite.PortableCore.FeatureSource|FeatureSource]] | This method allows you to raise the OpeningFeatureSource event from a derived class. | | + | |
| - | | {{wiki:ProtectedMethod.gif|Protected Method}}[[#OnStreamLoading(StreamLoadingEventArgs)|OnStreamLoading]] | [[ThinkGeo.MapSuite.PortableCore.StreamLoadingEventArgs|StreamLoadingEventArgs]] | | | | + | |
| - | | {{wiki:ProtectedMethod.gif|Protected Method}}[[#OpenCore()|OpenCore]] | | [[ThinkGeo.MapSuite.PortableCore.FeatureSource|FeatureSource]](overriden) | This method opens the FeatureSource so that it is initialized and ready to use. | | + | |
| - | | {{wiki:ProtectedMethod.gif|Protected Method}}[[#SpatialQueryCore(BaseShape, QueryType, IEnumerable<String>)|SpatialQueryCore]] | [[ThinkGeo.MapSuite.PortableCore.BaseShape|BaseShape]], [[ThinkGeo.MapSuite.PortableCore.QueryType|QueryType]], IEnumerable<String> | [[ThinkGeo.MapSuite.PortableCore.FeatureSource|FeatureSource]] | This method returns all of the InternalFeatures based on the target Feature and the spatial query type specified. | | + | |
| - | ==== Public Properties ==== | + | == Return Value == |
| - | ^ Name ^ Return ^ DeclaringType ^ Summary ^ | + | * Type:[[ThinkGeo.MapSuite.Core.GridCell[,]|GridCell[,]]] |
| - | | {{wiki:PublicProperty.gif|Public Property}}[[#CanExecuteSqlQuery|CanExecuteSqlQuery]] | Boolean | [[ThinkGeo.MapSuite.PortableCore.FeatureSource|FeatureSource]] | This property specifies whether the FeatureSource can excute a SQL query or not. If it is false, then it will throw exception when these APIs are calleds: ExecuteScalar, ExecuteNonQuery, ExecuteQuery | | + | * Description:This method returns a cell matrix of current grid. |
| - | | {{wiki:PublicProperty.gif|Public Property}}[[#CanModifyColumnStructure|CanModifyColumnStructure]] | Boolean | [[ThinkGeo.MapSuite.PortableCore.FeatureSource|FeatureSource]] | | | + | |
| - | | {{wiki:PublicProperty.gif|Public Property}}[[#CellSize|CellSize]] | Double | | Gets the cell size of the grid. | | + | |
| - | | {{wiki:PublicProperty.gif|Public Property}}[[#DataValueColumnName|DataValueColumnName]] | String | | | | + | |
| - | | {{wiki:PublicProperty.gif|Public Property}}[[#FeatureIdsToExclude|FeatureIdsToExclude]] | Collection<String> | [[ThinkGeo.MapSuite.PortableCore.FeatureSource|FeatureSource]] | A collection of strings representing record id of features not to get in the Layer. | | + | |
| - | | {{wiki:PublicProperty.gif|Public Property}}[[#GeoCache|GeoCache]] | [[ThinkGeo.MapSuite.PortableCore.FeatureCache|FeatureCache]] | [[ThinkGeo.MapSuite.PortableCore.FeatureSource|FeatureSource]] | The cache system. | | + | |
| - | | {{wiki:PublicProperty.gif|Public Property}}[[#Id|Id]] | String | [[ThinkGeo.MapSuite.PortableCore.FeatureSource|FeatureSource]] | | | + | |
| - | | {{wiki:PublicProperty.gif|Public Property}}[[#IsEditable|IsEditable]] | Boolean | [[ThinkGeo.MapSuite.PortableCore.FeatureSource|FeatureSource]](overriden) | This property returns if the FeatureSource allows edits or is read only. | | + | |
| - | | {{wiki:PublicProperty.gif|Public Property}}[[#IsInTransaction|IsInTransaction]] | Boolean | [[ThinkGeo.MapSuite.PortableCore.FeatureSource|FeatureSource]] | This property returns true if the FeatureSource is in a transaction and false if it is not. | | + | |
| - | | {{wiki:PublicProperty.gif|Public Property}}[[#IsOpen|IsOpen]] | Boolean | [[ThinkGeo.MapSuite.PortableCore.FeatureSource|FeatureSource]] | This property returns true if the FeatureSource is open and false if it is not. | | + | |
| - | | {{wiki:PublicProperty.gif|Public Property}}[[#IsTransactionLive|IsTransactionLive]] | Boolean | [[ThinkGeo.MapSuite.PortableCore.FeatureSource|FeatureSource]] | This property returns true if the features currently modified in a transaction are expected to reflect their state when calling other methods on the FeatureSource, such as spatial queries. | | + | |
| - | | {{wiki:PublicProperty.gif|Public Property}}[[#LowerLeftPoint|LowerLeftPoint]] | [[ThinkGeo.MapSuite.PortableCore.PointShape|PointShape]] | | Gets LowerLeft PointShape of the grid. | | + | |
| - | | {{wiki:PublicProperty.gif|Public Property}}[[#MaxRecordsToDraw|MaxRecordsToDraw]] | Int32 | [[ThinkGeo.MapSuite.PortableCore.FeatureSource|FeatureSource]] | | | + | |
| - | | {{wiki:PublicProperty.gif|Public Property}}[[#NoDataValue|NoDataValue]] | Double | | Gets the NoDataValue in the grid. | | + | |
| - | | {{wiki:PublicProperty.gif|Public Property}}[[#NumberOfColumns|NumberOfColumns]] | Int32 | | Gets column number of the grid. | | + | |
| - | | {{wiki:PublicProperty.gif|Public Property}}[[#NumberOfRows|NumberOfRows]] | Int32 | | Gets row number of the grid. | | + | |
| - | | {{wiki:PublicProperty.gif|Public Property}}[[#PathFilename|PathFilename]] | String | | This property gets and sets the path and file of the grid file you want to use. | | + | |
| - | | {{wiki:PublicProperty.gif|Public Property}}[[#Projection|Projection]] | [[ThinkGeo.MapSuite.PortableCore.Projection|Projection]] | [[ThinkGeo.MapSuite.PortableCore.FeatureSource|FeatureSource]] | This property holds the projection object that is used within the FeatureSource to ensure that features inside of the FeatureSource are projected. | | + | |
| - | | {{wiki:PublicProperty.gif|Public Property}}[[#TransactionBuffer|TransactionBuffer]] | [[ThinkGeo.MapSuite.PortableCore.TransactionBuffer|TransactionBuffer]] | [[ThinkGeo.MapSuite.PortableCore.FeatureSource|FeatureSource]] | The TransactionBuffer used in the Transaction System. | | + | |
| - | ==== Protected Properties ==== | + | == Parameters == |
| - | ^ Name ^ Return ^ DeclaringType ^ Summary ^ | + | <div newline></div> |
| - | | {{wiki:ProtectedProperty.gif|Protected Property}}[[#CanExecuteSqlQueryCore|CanExecuteSqlQueryCore]] | Boolean | [[ThinkGeo.MapSuite.PortableCore.FeatureSource|FeatureSource]] | This property specifies whether the FeatureSource can excute a SQL query or not. If it is false, then it will throw exception when these APIs are calleds: ExecuteScalar, ExecuteNonQuery, ExecuteQuery | | + | ** {{wiki:PublicMethod.gif|}} GetBoundingBoxByIds(IEnumerable<String>) ** |
| - | | {{wiki:ProtectedProperty.gif|Protected Property}}[[#CanModifyColumnStructureCore|CanModifyColumnStructureCore]] | Boolean | [[ThinkGeo.MapSuite.PortableCore.FeatureSource|FeatureSource]] | | | + | |
| - | | {{wiki:ProtectedProperty.gif|Protected Property}}[[#FeatureSourceColumns|FeatureSourceColumns]] | Collection<[[ThinkGeo.MapSuite.PortableCore.FeatureSourceColumn|FeatureSourceColumn]]> | [[ThinkGeo.MapSuite.PortableCore.FeatureSource|FeatureSource]] | This property gets the columns of the feature source. | | + | |
| - | | {{wiki:ProtectedProperty.gif|Protected Property}}[[#IsOpenCore|IsOpenCore]] | Boolean | [[ThinkGeo.MapSuite.PortableCore.FeatureSource|FeatureSource]] | This property returns true if the FeatureSource is open and false if it is not. | | + | |
| - | ==== Public Events ==== | + | * //N/A// |
| - | ^ Name ^ Event Arguments ^ DeclaringType ^ Summary ^ | + | == Remarks == |
| - | | {{wiki:PublicEvent.gif|Public Event}}[[#ClosedFeatureSource|ClosedFeatureSource]] | [[ThinkGeo.MapSuite.PortableCore.ClosedFeatureSourceEventArgs|ClosedFeatureSourceEventArgs]] | [[ThinkGeo.MapSuite.PortableCore.FeatureSource|FeatureSource]] | This event is called after the closing of the FeatureSource. | | + | * //N/A// |
| - | | {{wiki:PublicEvent.gif|Public Event}}[[#ClosingFeatureSource|ClosingFeatureSource]] | [[ThinkGeo.MapSuite.PortableCore.ClosingFeatureSourceEventArgs|ClosingFeatureSourceEventArgs]] | [[ThinkGeo.MapSuite.PortableCore.FeatureSource|FeatureSource]] | This event is called before the closing of the FeatureSource. | | + | |
| - | | {{wiki:PublicEvent.gif|Public Event}}[[#CommittedTransaction|CommittedTransaction]] | [[ThinkGeo.MapSuite.PortableCore.CommittedTransactionEventArgs|CommittedTransactionEventArgs]] | [[ThinkGeo.MapSuite.PortableCore.FeatureSource|FeatureSource]] | This event is raised after the CommitTransaction and the CommitTransactionCore are called and allows you access to the TransactionBuffer and the TransactionResults object before CommitTransaction method is returned. | | + | |
| - | | {{wiki:PublicEvent.gif|Public Event}}[[#CommittingTransaction|CommittingTransaction]] | [[ThinkGeo.MapSuite.PortableCore.CommittingTransactionEventArgs|CommittingTransactionEventArgs]] | [[ThinkGeo.MapSuite.PortableCore.FeatureSource|FeatureSource]] | This event is raised after the CommitTransaction method is called, but before the CommitTransactionCore is called. This allows you access to the TransactionBuffer before the transaction is committed. It also allows you to cancel the pending commit of the transaction. | | + | |
| - | | {{wiki:PublicEvent.gif|Public Event}}[[#CustomColumnFetch|CustomColumnFetch]] | [[ThinkGeo.MapSuite.PortableCore.CustomColumnFetchEventArgs|CustomColumnFetchEventArgs]] | [[ThinkGeo.MapSuite.PortableCore.FeatureSource|FeatureSource]] | This event is raised when fields are requested in a feature source method that do not exist in the feature source. It allows you to supplement the data from any outside source you have. | | + | |
| - | | {{wiki:PublicEvent.gif|Public Event}}[[#DrawingProgressChanged|DrawingProgressChanged]] | [[ThinkGeo.MapSuite.PortableCore.DrawingProgressChangedEventArgs|DrawingProgressChangedEventArgs]] | [[ThinkGeo.MapSuite.PortableCore.FeatureSource|FeatureSource]] | | | + | |
| - | | {{wiki:PublicEvent.gif|Public Event}}[[#GeneratingGrid|GeneratingGrid]] | [[ThinkGeo.MapSuite.PortableCore.GeneratingGridFeatureSourceEventArgs|GeneratingGridFeatureSourceEventArgs]] | | | | + | |
| - | | {{wiki:PublicEvent.gif|Public Event}}[[#OpenedFeatureSource|OpenedFeatureSource]] | [[ThinkGeo.MapSuite.PortableCore.OpenedFeatureSourceEventArgs|OpenedFeatureSourceEventArgs]] | [[ThinkGeo.MapSuite.PortableCore.FeatureSource|FeatureSource]] | This event is called after the opening of the FeatureSource. | | + | |
| - | | {{wiki:PublicEvent.gif|Public Event}}[[#OpeningFeatureSource|OpeningFeatureSource]] | [[ThinkGeo.MapSuite.PortableCore.OpeningFeatureSourceEventArgs|OpeningFeatureSourceEventArgs]] | [[ThinkGeo.MapSuite.PortableCore.FeatureSource|FeatureSource]] | This event is called before the opening of the FeatureSource. | | + | |
| - | | {{wiki:PublicEvent.gif|Public Event}}[[#StreamLoading|StreamLoading]] | [[ThinkGeo.MapSuite.PortableCore.StreamLoadingEventArgs|StreamLoadingEventArgs]] | | | | + | |
| - | ===== Public Constructors ===== | + | == Return Value == |
| - | ==== GridFeatureSource() ==== | + | * Type:[[ThinkGeo.MapSuite.Core.RectangleShape|RectangleShape]] |
| - | This is the constructor the for the class. If you use this constructor then you need to set the required properties manually. | + | * Description:N/A |
| - | === Overloads === | + | |
| - | This is the default constructor. | + | |
| - | === Parameters === | + | |
| - | ^ Name ^ Type ^ Description ^ | + | |
| - | [[#Public Constructors|Go Back]] | + | == Parameters == |
| - | ==== GridFeatureSource(String) ==== | + | * //ids// |
| - | This is the class constructor. | + | * Type:IEnumerable<String> |
| - | === Overloads === | + | * Description:N/A |
| - | This constructor allows you to pass in a path and file name. | + | |
| - | === Parameters === | + | |
| - | ^ Name ^ Type ^ Description ^ | + | |
| - | | gridPathFilename | String<!-- System.String --> | This parameter represents the path and file name to the grid file. | | + | |
| - | [[#Public Constructors|Go Back]] | + | <div newline></div> |
| - | ===== Protected Constructors ===== | + | ** {{wiki:PublicMethod.gif|}} GetBoundingBoxesByIds(IEnumerable<String>) ** |
| - | ===== Public Methods ===== | + | |
| - | ==== AddColumn(FeatureSourceColumn) ==== | + | |
| - | === Return Value === | + | |
| - | ^ Return Type ^ Description ^ | + | |
| - | | Void<!-- System.Void --> | | | + | |
| - | === Parameters === | + | * //N/A// |
| - | ^ Name ^ Type ^ Description ^ | + | == Remarks == |
| - | | featureSourceColumn | [[ThinkGeo.MapSuite.PortableCore.FeatureSourceColumn|FeatureSourceColumn]]<!-- ThinkGeo.MapSuite.PortableCore.FeatureSourceColumn --> | | | + | * //N/A// |
| - | <!-- ThinkGeo.MapSuite.PortableCore.FeatureSource --> | + | == Return Value == |
| - | [[#Public Methods|Go Back]] | + | * Type:Collection<[[ThinkGeo.MapSuite.Core.RectangleShape|RectangleShape]]> |
| - | ==== AddFeature(BaseShape) ==== | + | * Description:N/A |
| - | This method adds a new Feature (composed of the passed-in BaseShape) to an existing transaction. | + | |
| - | === Remarks === | + | |
| - | This method adds a new Feature (composed of the passed-in BaseShape) to an existing transaction. You will need to ensure that you have started a transaction by calling BeginTransaction. | + | |
| - | The Transaction System | + | == Parameters == |
| + | * //ids// | ||
| + | * Type:IEnumerable<String> | ||
| + | * Description:N/A | ||
| - | The 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 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 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. | + | <div newline></div> |
| + | ** {{wiki:PublicMethod.gif|}} GetFirstFeaturesWellKnownType() ** | ||
| - | In the case where the IsLiveTransaction is set to true, then things function slightly differently. The live transaction concept means that all of the modifications you perform during a transaction are live from the standpoint of the querying methods on the object. | + | * //N/A// |
| + | == Remarks == | ||
| + | * //N/A// | ||
| - | As 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, 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 would be considered live, though not committed. | + | == Return Value == |
| + | * Type:[[ThinkGeo.MapSuite.Core.WellKnownType|WellKnownType]] | ||
| + | * Description:N/A | ||
| - | In the case where you modify records -- such as expanding the size of a polygon -- those changes are reflected as well. 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 instead would return the larger records. In this case, the larger records are returned. You can set this property to be false, as well; in which case, all of the spatially related methods would ignore anything that is currently in the transaction buffer waiting to be committed. In such a case, only after committing the transaction would the FeatureSource reflect the changes. | + | == Parameters == |
| - | === Return Value === | + | <div newline></div> |
| - | ^ Return Type ^ Description ^ | + | ** {{wiki:PublicMethod.gif|}} CanGetBoundingBoxQuickly() ** |
| - | | String<!-- System.String --> | This string is the ID that will uniquely identify this Feature while it is in a transaction. | | + | |
| - | === Parameters === | + | * //N/A// |
| - | ^ Name ^ Type ^ Description ^ | + | == Remarks == |
| - | | shape | [[ThinkGeo.MapSuite.PortableCore.BaseShape|BaseShape]]<!-- ThinkGeo.MapSuite.PortableCore.BaseShape --> | This parameter represents the BaseShape that will be used to make the new Feature that will be added to the transaction. | | + | * //N/A// |
| - | <!-- ThinkGeo.MapSuite.PortableCore.FeatureSource --> | + | == Return Value == |
| - | [[#Public Methods|Go Back]] | + | * Type:Boolean |
| - | ==== AddFeature(Feature) ==== | + | * Description:N/A |
| - | This method adds a new Feature to an existing transaction. | + | |
| - | === Remarks === | + | |
| - | This method adds a new Feature to an existing transaction. You will need to ensure that you have started a transaction by calling BeginTransaction. | + | |
| - | The Transaction System | + | == Parameters == |
| + | <div newline></div> | ||
| + | ** {{wiki:PublicMethod.gif|}} CanGetCountQuickly() ** | ||
| - | The 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 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 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. | + | * //N/A// |
| + | == Remarks == | ||
| + | * //N/A// | ||
| - | In the case where the IsLiveTransaction is set to true, then things function slightly differently. The live transaction concept means that all of the modifications you perform during a transaction are live from the standpoint of the querying methods on the object. | + | == Return Value == |
| + | * Type:Boolean | ||
| + | * Description:N/A | ||
| - | As 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, 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 would be considered live, though not committed. | + | == Parameters == |
| + | <div newline></div> | ||
| + | ** {{wiki:PublicMethod.gif|}} GetDistinctColumnValues(String) ** | ||
| - | In the case where you modify records -- such as expanding the size of a polygon -- those changes are reflected as well. 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 instead would return the larger records. In this case, the larger records are returned. You can set this property to be false, as well; in which case, all of the spatially related methods would ignore anything that is currently in the transaction buffer waiting to be committed. In such a case, only after committing the transaction would the FeatureSource reflect the changes. | + | * //N/A// |
| - | === Return Value === | + | == Remarks == |
| - | ^ Return Type ^ Description ^ | + | * //N/A// |
| - | | String<!-- System.String --> | This string is the ID that will uniquely identify this Feature while it is in a transaction. | | + | |
| - | === Parameters === | + | == Return Value == |
| - | ^ Name ^ Type ^ Description ^ | + | * Type:Collection<[[ThinkGeo.MapSuite.Core.DistinctColumnValue|DistinctColumnValue]]> |
| - | | feature | [[ThinkGeo.MapSuite.PortableCore.Feature|Feature]]<!-- ThinkGeo.MapSuite.PortableCore.Feature --> | This parameter represents the new Feature that will be added to the transaction. | | + | * Description:N/A |
| - | <!-- ThinkGeo.MapSuite.PortableCore.FeatureSource --> | + | == Parameters == |
| - | [[#Public Methods|Go Back]] | + | * //columnName// |
| - | ==== AddFeature(BaseShape, IDictionary<String, String>) ==== | + | * Type:String |
| - | This method adds a new Feature composes of the passed in BaseShape to an existing transaction. | + | * Description:N/A |
| - | === Remarks === | + | |
| - | This method adds a new Feature (composed of the passed-in BaseShape) to an existing transaction. You will need to ensure that you have started a transaction by calling the BeginTransaction. | + | |
| - | The Transaction System | + | <div newline></div> |
| + | ** {{wiki:PublicMethod.gif|}} GetAllFeatures(ReturningColumnsType,Int32) ** | ||
| - | The 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 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 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. | + | * //N/A// |
| + | == Remarks == | ||
| + | * //N/A// | ||
| - | In the case where the IsLiveTransaction is set to true, then things function slightly differently. The live transaction concept means that all of the modifications you perform during a transaction are live from the standpoint of the querying methods on the object. | + | == Return Value == |
| + | * Type:Collection<[[ThinkGeo.MapSuite.Core.Feature|Feature]]> | ||
| + | * Description:N/A | ||
| - | As 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, 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 would be considered live, though not committed. | + | == Parameters == |
| + | * //returningColumnTypes// | ||
| + | * Type:[[ThinkGeo.MapSuite.Core.ReturningColumnsType|ReturningColumnsType]] | ||
| + | * Description:N/A | ||
| - | In the case where you modify records -- such as expanding the size of a polygon -- those changes are reflected as well. 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 instead would return the larger records. In this case, the larger records are returned. You can set this property to be false, as well; in which case, all of the spatially related methods would ignore anything that is currently in the transaction buffer waiting to be committed. In such a case, only after committing the transaction would the FeatureSource reflect the changes. | + | * //startIndex// |
| - | === Return Value === | + | * Type:Int32 |
| - | ^ Return Type ^ Description ^ | + | * Description:N/A |
| - | | String<!-- System.String --> | This string is the ID that will uniquely identify this Feature while it is in a transaction. | | + | |
| - | === Parameters === | + | <div newline></div> |
| - | ^ Name ^ Type ^ Description ^ | + | ** {{wiki:PublicMethod.gif|}} GetAllFeatures(ReturningColumnsType,Int32,Int32) ** |
| - | | shape | [[ThinkGeo.MapSuite.PortableCore.BaseShape|BaseShape]]<!-- ThinkGeo.MapSuite.PortableCore.BaseShape --> | This parameter represents the BaseShape that will be used to make new Feature that will be added to the transaction. | | + | |
| - | | columnValues | IDictionary<String,String><!-- System.Collections.Generic.IDictionary{System.String,System.String} --> | This parameter represents the columnValues for the new features taht will be added to the transaction. | | + | |
| - | <!-- ThinkGeo.MapSuite.PortableCore.FeatureSource --> | + | * //N/A// |
| - | [[#Public Methods|Go Back]] | + | == Remarks == |
| - | ==== BeginTransaction() ==== | + | * //N/A// |
| - | This method starts a new transaction if the FeasuteSource allows editing | + | |
| - | === Remarks === | + | |
| - | This method is used to start a transaction, assuming that the FeatureSource allows editing. There are some additional prerequisites to beginning a transaction, such as ensuring that a transaction is not already in progress. You must also be sure that the FeatureSource has been opened. | + | |
| - | The Transaction System | + | == Return Value == |
| + | * Type:Collection<[[ThinkGeo.MapSuite.Core.Feature|Feature]]> | ||
| + | * Description:N/A | ||
| - | The 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 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 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. | + | == Parameters == |
| + | * //returningColumnTypes// | ||
| + | * Type:[[ThinkGeo.MapSuite.Core.ReturningColumnsType|ReturningColumnsType]] | ||
| + | * Description:N/A | ||
| - | In the case where the IsLiveTransaction is set to true, then things function slightly differently. The live transaction concept means that all of the modifications you perform during a transaction are live from the standpoint of the querying methods on the object. | + | * //startIndex// |
| + | * Type:Int32 | ||
| + | * Description:N/A | ||
| - | As 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, 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 would be considered live, though not committed. | + | * //takeCount// |
| + | * Type:Int32 | ||
| + | * Description:N/A | ||
| - | In the case where you modify records -- such as expanding the size of a polygon -- those changes are reflected as well. 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 instead would return the larger records. In this case, the larger records are returned. You can set this property to be false, as well; in which case, all of the spatially related methods would ignore anything that is currently in the transaction buffer waiting to be committed. In such a case, only after committing the transaction would the FeatureSource reflect the changes. | + | <div newline></div> |
| - | === Return Value === | + | ** {{wiki:PublicMethod.gif|}} GetAllFeatures(IEnumerable<String>,Int32,Int32) ** |
| - | ^ Return Type ^ Description ^ | + | |
| - | | Void<!-- System.Void --> | | | + | |
| - | === Parameters === | + | * //N/A// |
| - | ^ Name ^ Type ^ Description ^ | + | == Remarks == |
| + | * //N/A// | ||
| - | <!-- ThinkGeo.MapSuite.PortableCore.FeatureSource --> | + | == Return Value == |
| - | [[#Public Methods|Go Back]] | + | * Type:Collection<[[ThinkGeo.MapSuite.Core.Feature|Feature]]> |
| - | ==== CanGetBoundingBoxQuickly() ==== | + | * Description:N/A |
| - | === Return Value === | + | |
| - | ^ Return Type ^ Description ^ | + | |
| - | | Boolean<!-- System.Boolean --> | | | + | |
| - | === Parameters === | + | == Parameters == |
| - | ^ Name ^ Type ^ Description ^ | + | * //returningColumnNames// |
| + | * Type:IEnumerable<String> | ||
| + | * Description:N/A | ||
| - | <!-- ThinkGeo.MapSuite.PortableCore.FeatureSource --> | + | * //startIndex// |
| - | [[#Public Methods|Go Back]] | + | * Type:Int32 |
| - | ==== CanGetCountQuickly() ==== | + | * Description:N/A |
| - | === Return Value === | + | |
| - | ^ Return Type ^ Description ^ | + | |
| - | | Boolean<!-- System.Boolean --> | | | + | |
| - | === Parameters === | + | * //takeCount// |
| - | ^ Name ^ Type ^ Description ^ | + | * Type:Int32 |
| + | * Description:N/A | ||
| - | <!-- ThinkGeo.MapSuite.PortableCore.FeatureSource --> | + | <div newline></div> |
| - | [[#Public Methods|Go Back]] | + | ** {{wiki:PublicMethod.gif|}} Close() ** |
| - | ==== CloneDeep() ==== | + | |
| - | Create a copy of a FeatureSource using the deep clone process. | + | |
| - | === Remarks === | + | |
| - | The difference between deep clone and shallow clone is as follows: In shallow cloning, only the object is copied; the objects within it are not. By contrast, deep cloning copies the cloned object as well as all the objects within. | + | |
| - | === Return Value === | + | |
| - | ^ Return Type ^ Description ^ | + | |
| - | | [[ThinkGeo.MapSuite.PortableCore.FeatureSource|FeatureSource]]<!-- ThinkGeo.MapSuite.PortableCore.FeatureSource --> | A cloned FeatureSource. | | + | |
| - | === Parameters === | + | * //N/A// |
| - | ^ Name ^ Type ^ Description ^ | + | == Remarks == |
| + | * //N/A// | ||
| - | <!-- ThinkGeo.MapSuite.PortableCore.FeatureSource --> | + | == Return Value == |
| - | [[#Public Methods|Go Back]] | + | * Type:Void |
| - | ==== Close() ==== | + | * Description:N/A |
| - | This method closes the FeatureSource and releases any resources it was using. | + | |
| - | === Remarks === | + | |
| - | This method is the concrete wrapper for the abstract method CloseCore. 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. | + | |
| - | If you override the Core version of this method, it is recommended that you take the following things into account: This method may be called multiple times, so we suggest you write the method 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. | + | == Parameters == |
| + | <div newline></div> | ||
| + | ** {{wiki:PublicMethod.gif|}} BeginTransaction() ** | ||
| - | As this is a concrete public method that wraps a Core method, we reserve the right to add events and other logic to pre- or post-process data returned by the Core version of the method. In this way, we leave our framework open on our end, but also allow you the developer to extend our logic to suit your needs. If you have questions about this, please contact our support team as we would be happy to work with you on extending our framework. | + | * //N/A// |
| - | === Return Value === | + | == Remarks == |
| - | ^ Return Type ^ Description ^ | + | * //N/A// |
| - | | Void<!-- System.Void --> | | | + | |
| - | === Parameters === | + | == Return Value == |
| - | ^ Name ^ Type ^ Description ^ | + | * Type:Void |
| + | * Description:N/A | ||
| - | <!-- ThinkGeo.MapSuite.PortableCore.FeatureSource --> | + | == Parameters == |
| - | [[#Public Methods|Go Back]] | + | <div newline></div> |
| - | ==== CommitTransaction() ==== | + | ** {{wiki:PublicMethod.gif|}} AddFeature(Feature) ** |
| - | This method will commit the existing transaction to its underlying source of data. | + | |
| - | === Remarks === | + | |
| - | This method is the concrete wrapper for the virtual method CommitTransactionCore. As this is the concrete version, the real work is done in the Core version of the method. It will commit the existing transaction to its underlying source of data. It will then pass back the results of the commit, including any error(s) received. Lastly, it will free up the internal memory cache of any InternalFeatures added, updated or deleted. You will need to ensure that you have started a transaction by calling BeginTransaction. | + | |
| - | The Transaction System | + | * //N/A// |
| + | == Remarks == | ||
| + | * //N/A// | ||
| - | The 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 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 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. | + | == Return Value == |
| + | * Type:String | ||
| + | * Description:N/A | ||
| - | In the case where the IsLiveTransaction is set to true, then things function slightly differently. The live transaction concept means that all of the modifications you perform during a transaction are live from the standpoint of the querying methods on the object. | + | == Parameters == |
| + | * //feature// | ||
| + | * Type:[[ThinkGeo.MapSuite.Core.Feature|Feature]] | ||
| + | * Description:N/A | ||
| - | As 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, 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 would be considered live, though not committed. | + | <div newline></div> |
| + | ** {{wiki:PublicMethod.gif|}} AddFeature(BaseShape) ** | ||
| - | In the case where you modify records -- such as expanding the size of a polygon -- those changes are reflected as well. 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 instead would return the larger records. In this case, the larger records are returned. You can set this property to be false, as well; in which case, all of the spatially related methods would ignore anything that is currently in the transaction buffer waiting to be committed. In such a case, only after committing the transaction would the FeatureSource reflect the changes. | + | * //N/A// |
| + | == Remarks == | ||
| + | * //N/A// | ||
| - | As this is a concrete public method that wraps a Core method, we reserve the right to add events and other logic to pre- or post-process data returned by the Core version of the method. In this way, we leave our framework open on our end, but also allow you the developer to extend our logic to suit your needs. If you have questions about this, please contact our support team as we would be happy to work with you on extending our framework. | + | == Return Value == |
| - | === Return Value === | + | * Type:String |
| - | ^ Return Type ^ Description ^ | + | * Description:N/A |
| - | | [[ThinkGeo.MapSuite.PortableCore.TransactionResult|TransactionResult]]<!-- ThinkGeo.MapSuite.PortableCore.TransactionResult --> | The returned 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 errors that were encountered during the committing of the transaction. | | + | |
| - | === Parameters === | + | == Parameters == |
| - | ^ Name ^ Type ^ Description ^ | + | * //shape// |
| + | * Type:[[ThinkGeo.MapSuite.Core.BaseShape|BaseShape]] | ||
| + | * Description:N/A | ||
| - | <!-- ThinkGeo.MapSuite.PortableCore.FeatureSource --> | + | <div newline></div> |
| - | [[#Public Methods|Go Back]] | + | ** {{wiki:PublicMethod.gif|}} AddFeature(BaseShape,IDictionary<String,String>) ** |
| - | ==== DeleteColumn(String) ==== | + | |
| - | === Return Value === | + | |
| - | ^ Return Type ^ Description ^ | + | |
| - | | Void<!-- System.Void --> | | | + | |
| - | === Parameters === | + | * //N/A// |
| - | ^ Name ^ Type ^ Description ^ | + | == Remarks == |
| - | | columnName | String<!-- System.String --> | | | + | * //N/A// |
| - | <!-- ThinkGeo.MapSuite.PortableCore.FeatureSource --> | + | == Return Value == |
| - | [[#Public Methods|Go Back]] | + | * Type:String |
| - | ==== DeleteFeature(String) ==== | + | * Description:N/A |
| - | This method deletes a Feature from an existing transaction. | + | |
| - | === Remarks === | + | |
| - | This method deletes a Feature from an existing transaction. You will need to ensure that you have started a transaction by calling the BeginTransaction. | + | |
| - | The Transaction System | + | == Parameters == |
| + | * //shape// | ||
| + | * Type:[[ThinkGeo.MapSuite.Core.BaseShape|BaseShape]] | ||
| + | * Description:N/A | ||
| - | The 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 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 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. | + | * //columnValues// |
| + | * Type:IDictionary<String,String> | ||
| + | * Description:N/A | ||
| - | In the case where the IsLiveTransaction is set to true, then things function slightly differently. The live transaction concept means that all of the modifications you perform during a transaction are live from the standpoint of the querying methods on the object. | + | <div newline></div> |
| + | ** {{wiki:PublicMethod.gif|}} DeleteFeature(String) ** | ||
| - | As 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, 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 would be considered live, though not committed. | + | * //N/A// |
| + | == Remarks == | ||
| + | * //N/A// | ||
| - | In the case where you modify records -- such as expanding the size of a polygon -- those changes are reflected as well. 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 instead would return the larger records. In this case, the larger records are returned. You can set this property to be false, as well; in which case, all of the spatially related methods would ignore anything that is currently in the transaction buffer waiting to be committed. In such a case, only after committing the transaction would the FeatureSource reflect the changes. | + | == Return Value == |
| - | === Return Value === | + | * Type:Void |
| - | ^ Return Type ^ Description ^ | + | * Description:N/A |
| - | | Void<!-- System.Void --> | | | + | |
| - | === Parameters === | + | == Parameters == |
| - | ^ Name ^ Type ^ Description ^ | + | * //id// |
| - | | id | String<!-- System.String --> | This string is the Id of the feature in the FeatureSource you wish to delete. | | + | * Type:String |
| + | * Description:N/A | ||
| - | <!-- ThinkGeo.MapSuite.PortableCore.FeatureSource --> | + | <div newline></div> |
| - | [[#Public Methods|Go Back]] | + | ** {{wiki:PublicMethod.gif|}} UpdateFeature(Feature) ** |
| - | ==== Equals(Object) ==== | + | |
| - | === Return Value === | + | |
| - | ^ Return Type ^ Description ^ | + | |
| - | | Boolean<!-- System.Boolean --> | | | + | |
| - | === Parameters === | + | * //N/A// |
| - | ^ Name ^ Type ^ Description ^ | + | == Remarks == |
| - | | obj | Object<!-- System.Object --> | | | + | * //N/A// |
| - | <!-- System.Object --> | + | == Return Value == |
| - | [[#Public Methods|Go Back]] | + | * Type:Void |
| - | ==== ExecuteNonQuery(String) ==== | + | * Description:N/A |
| - | Executes a SQL statement against a connection object. | + | |
| - | === Remarks === | + | |
| - | You can use ExecuteNonQuery to perform catalog operations (for example, querying the structure of a database or creating database objects such as tables), or to change the data in a database by executing UPDATE, INSERT, or DELETE statements. Although ExecuteNonQuery does not return any rows, any output parameters or return values mapped to parameters are populated with data. For UPDATE, INSERT, and DELETE statements, the return value is the number of rows affected by the command. | + | |
| - | === Return Value === | + | |
| - | ^ Return Type ^ Description ^ | + | |
| - | | Int32<!-- System.Int32 --> | The number of rows affected. | | + | |
| - | === Parameters === | + | == Parameters == |
| - | ^ Name ^ Type ^ Description ^ | + | * //feature// |
| - | | sqlStatement | String<!-- System.String --> | The sqlStatement to be excuted. | | + | * Type:[[ThinkGeo.MapSuite.Core.Feature|Feature]] |
| + | * Description:N/A | ||
| - | <!-- ThinkGeo.MapSuite.PortableCore.FeatureSource --> | + | <div newline></div> |
| - | [[#Public Methods|Go Back]] | + | ** {{wiki:PublicMethod.gif|}} UpdateFeature(BaseShape) ** |
| - | ==== ExecuteQuery(String) ==== | + | |
| - | Executes the query and returns the result returned by the query. | + | |
| - | === Remarks === | + | |
| - | Use the ExcuteScalar method to retrieve a single value from the database. This requires less code than using the ExcuteQuery method and then performing the operations necessary to generate the single value using the data. | + | |
| - | === Return Value === | + | |
| - | ^ Return Type ^ Description ^ | + | |
| - | | [[ThinkGeo.MapSuite.Portable.GeoDataTable|GeoDataTable]]<!-- ThinkGeo.MapSuite.Portable.GeoDataTable --> | The result set in the format of dataTable. | | + | |
| - | === Parameters === | + | * //N/A// |
| - | ^ Name ^ Type ^ Description ^ | + | == Remarks == |
| - | | sqlStatement | String<!-- System.String --> | The sqlStatement to be excuted. | | + | * //N/A// |
| - | <!-- ThinkGeo.MapSuite.PortableCore.FeatureSource --> | + | == Return Value == |
| - | [[#Public Methods|Go Back]] | + | * Type:Void |
| - | ==== ExecuteScalar(String) ==== | + | * Description:N/A |
| - | 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 requires less code than using the ExcuteQuery method and then performing the operations necessary to generate the single value using the data. | + | |
| - | === Return Value === | + | |
| - | ^ Return Type ^ Description ^ | + | |
| - | | Object<!-- System.Object --> | The first column of the first row in the result set. | | + | |
| - | === Parameters === | + | == Parameters == |
| - | ^ Name ^ Type ^ Description ^ | + | * //shape// |
| - | | sqlStatement | String<!-- System.String --> | The sqlStatement to be excuted. | | + | * Type:[[ThinkGeo.MapSuite.Core.BaseShape|BaseShape]] |
| + | * Description:N/A | ||
| - | <!-- ThinkGeo.MapSuite.PortableCore.FeatureSource --> | + | <div newline></div> |
| - | [[#Public Methods|Go Back]] | + | ** {{wiki:PublicMethod.gif|}} UpdateFeature(BaseShape,IDictionary<String,String>) ** |
| - | ==== GenerateGrid(GridDefinition, GridInterpolationModel, Stream) ==== | + | |
| - | <!-- static --> | + | |
| - | This method calculates all the cells in the grid and write the value of them into the grid file associates with the stream. | + | |
| - | === Return Value === | + | |
| - | ^ Return Type ^ Description ^ | + | |
| - | | Void<!-- System.Void --> | | | + | |
| - | === Parameters === | + | * //N/A// |
| - | ^ Name ^ Type ^ Description ^ | + | == Remarks == |
| - | | gridDefinition | [[ThinkGeo.MapSuite.PortableCore.GridDefinition|GridDefinition]]<!-- ThinkGeo.MapSuite.PortableCore.GridDefinition --> | This parameter contains the parameters used to describe the grid. | | + | * //N/A// |
| - | | gridInterpolationModel | [[ThinkGeo.MapSuite.PortableCore.GridInterpolationModel|GridInterpolationModel]]<!-- ThinkGeo.MapSuite.PortableCore.GridInterpolationModel --> | This parameter represents the interpolation model for calculating cell value of the grid | | + | |
| - | | outputStream | Stream<!-- System.IO.Stream --> | This parameter represents the stream associates with the output file. | | + | |
| - | <!-- ThinkGeo.MapSuite.PortableCore.GridFeatureSource --> | + | == Return Value == |
| - | [[#Public Methods|Go Back]] | + | * Type:Void |
| - | ==== GenerateGridMatrix() ==== | + | * Description:N/A |
| - | This method generates the cell matrix based on NumberOfColumns and NumberOfRows of current grid. | + | |
| - | === Return Value === | + | |
| - | ^ Return Type ^ Description ^ | + | |
| - | | [[ThinkGeo.MapSuite.PortableCore.GridCell[|GridCell[]],]<!-- ThinkGeo.MapSuite.PortableCore.GridCell[[,]] --> | This method returns a cell matrix of current grid. | | + | |
| - | === Parameters === | + | == Parameters == |
| - | ^ Name ^ Type ^ Description ^ | + | * //shape// |
| + | * Type:[[ThinkGeo.MapSuite.Core.BaseShape|BaseShape]] | ||
| + | * Description:N/A | ||
| - | <!-- ThinkGeo.MapSuite.PortableCore.GridFeatureSource --> | + | * //columnValues// |
| - | [[#Public Methods|Go Back]] | + | * Type:IDictionary<String,String> |
| - | ==== GenerateGridMatrix(GridDefinition, GridInterpolationModel) ==== | + | * Description:N/A |
| - | <!-- static --> | + | |
| - | This method calculates all the cells in the grid and returns the result in the form of the GridCell matrix | + | |
| - | === Return Value === | + | |
| - | ^ Return Type ^ Description ^ | + | |
| - | | [[ThinkGeo.MapSuite.PortableCore.GridCell[|GridCell[]],]<!-- ThinkGeo.MapSuite.PortableCore.GridCell[[,]] --> | This method returns the GridCell matrix which is calculated based on the input parameters. | | + | |
| - | === Parameters === | + | <div newline></div> |
| - | ^ Name ^ Type ^ Description ^ | + | ** {{wiki:PublicMethod.gif|}} RollbackTransaction() ** |
| - | | gridDefinition | [[ThinkGeo.MapSuite.PortableCore.GridDefinition|GridDefinition]]<!-- ThinkGeo.MapSuite.PortableCore.GridDefinition --> | This parameter contains the properties used to describe the grid. | | + | |
| - | | gridInterpolationModel | [[ThinkGeo.MapSuite.PortableCore.GridInterpolationModel|GridInterpolationModel]]<!-- ThinkGeo.MapSuite.PortableCore.GridInterpolationModel --> | This parameter represents the interpolation model for calculating cell value of the grid | | + | |
| - | <!-- ThinkGeo.MapSuite.PortableCore.GridFeatureSource --> | + | * //N/A// |
| - | [[#Public Methods|Go Back]] | + | == Remarks == |
| - | ==== GetAllFeatures(IEnumerable<String>) ==== | + | * //N/A// |
| - | This method returns all of the InternalFeatures in the FeatureSource. | + | |
| - | === Remarks === | + | |
| - | This method returns all of the InternalFeatures in the FeatureSource. It will return whatever is returned by the GetAllFeaturesCore method, along with any of the additions or subtractions made if you are in a transaction and that transaction is configured to be live. | + | |
| - | The main purpose of this method is to be the anchor of all of our default virtual implementations within this class. We as the framework developers wanted 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, let's say 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 of the records, then we can brute-force the answer. In this way, if you inherited from this class and only implemented this one method, we can provide default implementations for virtually every other API. | + | == Return Value == |
| + | * Type:Void | ||
| + | * Description:N/A | ||
| - | While this is nice for you the developer if you decide to create your own FeatureSource, it comes with a price: namely, it is very inefficient. In the example 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 faster. For example, in Oracle Spatial there is a specific SQL statement to perform this operation very quickly. The same holds true with other specific FeatureSource examples. | + | == Parameters == |
| + | <div newline></div> | ||
| + | ** {{wiki:PublicMethod.gif|}} CommitTransaction() ** | ||
| - | 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. This will ensure that nearly every other API will operate efficiently. Please see the specific API to determine what method it uses. | + | * //N/A// |
| + | == Remarks == | ||
| + | * //N/A// | ||
| - | As this is a concrete public method that wraps a Core method, we reserve the right to add events and other logic to pre- or post-process data returned by the Core version of the method. In this way, we leave our framework open on our end, but also allow you the developer to extend our logic to suit your needs. If you have questions about this, please contact our support team as we would be happy to work with you on extending our framework. | + | == Return Value == |
| - | === Return Value === | + | * Type:[[ThinkGeo.MapSuite.Core.TransactionResult|TransactionResult]] |
| - | ^ Return Type ^ Description ^ | + | * Description:N/A |
| - | | Collection<[[ThinkGeo.MapSuite.PortableCore.Feature|Feature]]><!-- System.Collections.ObjectModel.Collection{ThinkGeo.MapSuite.PortableCore.Feature} --> | The returned decimalDegreesValue is a collection of all of the InternalFeatures in the FeatureSource. | | + | |
| - | === Parameters === | + | == Parameters == |
| - | ^ Name ^ Type ^ Description ^ | + | <div newline></div> |
| - | | returningColumnNames | IEnumerable<String><!-- System.Collections.Generic.IEnumerable{System.String} --> | This parameter allows you to select the field names of the column data you wish to return with each Feature. | | + | ** {{wiki:PublicMethod.gif|}} AddColumn(FeatureSourceColumn) ** |
| - | <!-- ThinkGeo.MapSuite.PortableCore.FeatureSource --> | + | * //N/A// |
| - | [[#Public Methods|Go Back]] | + | == Remarks == |
| - | ==== GetAllFeatures(IEnumerable<String>, Int32, Int32) ==== | + | * //N/A// |
| - | === Return Value === | + | |
| - | ^ Return Type ^ Description ^ | + | |
| - | | Collection<[[ThinkGeo.MapSuite.PortableCore.Feature|Feature]]><!-- System.Collections.ObjectModel.Collection{ThinkGeo.MapSuite.PortableCore.Feature} --> | | | + | |
| - | === Parameters === | + | == Return Value == |
| - | ^ Name ^ Type ^ Description ^ | + | * Type:Void |
| - | | returningColumnNames | IEnumerable<String><!-- System.Collections.Generic.IEnumerable{System.String} --> | | | + | * Description:N/A |
| - | | startIndex | Int32<!-- System.Int32 --> | | | + | |
| - | | takeCount | Int32<!-- System.Int32 --> | | | + | |
| - | <!-- ThinkGeo.MapSuite.PortableCore.FeatureSource --> | + | == Parameters == |
| - | [[#Public Methods|Go Back]] | + | * //featureSourceColumn// |
| - | ==== GetAllFeatures(ReturningColumnsType, Int32, Int32) ==== | + | * Type:[[ThinkGeo.MapSuite.Core.FeatureSourceColumn|FeatureSourceColumn]] |
| - | === Return Value === | + | * Description:N/A |
| - | ^ Return Type ^ Description ^ | + | |
| - | | Collection<[[ThinkGeo.MapSuite.PortableCore.Feature|Feature]]><!-- System.Collections.ObjectModel.Collection{ThinkGeo.MapSuite.PortableCore.Feature} --> | | | + | |
| - | === Parameters === | + | <div newline></div> |
| - | ^ Name ^ Type ^ Description ^ | + | ** {{wiki:PublicMethod.gif|}} DeleteColumn(String) ** |
| - | | returningColumnTypes | [[ThinkGeo.MapSuite.PortableCore.ReturningColumnsType|ReturningColumnsType]]<!-- ThinkGeo.MapSuite.PortableCore.ReturningColumnsType --> | | | + | |
| - | | startIndex | Int32<!-- System.Int32 --> | | | + | |
| - | | takeCount | Int32<!-- System.Int32 --> | | | + | |
| - | <!-- ThinkGeo.MapSuite.PortableCore.FeatureSource --> | + | * //N/A// |
| - | [[#Public Methods|Go Back]] | + | == Remarks == |
| - | ==== GetAllFeatures(ReturningColumnsType, Int32) ==== | + | * //N/A// |
| - | === Return Value === | + | |
| - | ^ Return Type ^ Description ^ | + | |
| - | | Collection<[[ThinkGeo.MapSuite.PortableCore.Feature|Feature]]><!-- System.Collections.ObjectModel.Collection{ThinkGeo.MapSuite.PortableCore.Feature} --> | | | + | |
| - | === Parameters === | + | == Return Value == |
| - | ^ Name ^ Type ^ Description ^ | + | * Type:Void |
| - | | returningColumnTypes | [[ThinkGeo.MapSuite.PortableCore.ReturningColumnsType|ReturningColumnsType]]<!-- ThinkGeo.MapSuite.PortableCore.ReturningColumnsType --> | | | + | * Description:N/A |
| - | | startIndex | Int32<!-- System.Int32 --> | | | + | |
| - | <!-- ThinkGeo.MapSuite.PortableCore.FeatureSource --> | + | == Parameters == |
| - | [[#Public Methods|Go Back]] | + | * //columnName// |
| - | ==== GetAllFeatures(ReturningColumnsType) ==== | + | * Type:String |
| - | This method returns all of the InternalFeatures in the FeatureSource. | + | * Description:N/A |
| - | === Remarks === | + | |
| - | This method returns all of the InternalFeatures in the FeatureSource. It will return whatever is returned by the GetAllFeaturesCore method, along with any of the additions or subtractions made if you are in a transaction and that transaction is configured to be live. | + | |
| - | The main purpose of this method is to be the anchor of all of our default virtual implementations within this class. We as the framework developers wanted 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, let's say 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 of the records, then we can brute-force the answer. In this way, if you inherited from this class and only implemented this one method, we can provide default implementations for virtually every other API. | + | <div newline></div> |
| + | ** {{wiki:PublicMethod.gif|}} UpdateColumn(String,FeatureSourceColumn) ** | ||
| - | While this is nice for you the developer if you decide to create your own FeatureSource, it comes with a price: namely, it is very inefficient. In the example 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 faster. For example, in Oracle Spatial there is a specific SQL statement to perform this operation very quickly. The same holds true with other specific FeatureSource examples. | + | * //N/A// |
| + | == Remarks == | ||
| + | * //N/A// | ||
| - | 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. This will ensure that nearly every other API will operate efficiently. Please see the specific API to determine what method it uses. | + | == Return Value == |
| + | * Type:Void | ||
| + | * Description:N/A | ||
| - | As this is a concrete public method that wraps a Core method, we reserve the right to add events and other logic to pre- or post-process data returned by the Core version of the method. In this way, we leave our framework open on our end, but also allow you the developer to extend our logic to suit your needs. If you have questions about this, please contact our support team as we would be happy to work with you on extending our framework. | + | == Parameters == |
| - | === Return Value === | + | * //columnName// |
| - | ^ Return Type ^ Description ^ | + | * Type:String |
| - | | Collection<[[ThinkGeo.MapSuite.PortableCore.Feature|Feature]]><!-- System.Collections.ObjectModel.Collection{ThinkGeo.MapSuite.PortableCore.Feature} --> | The returned decimalDegreesValue is a collection of all of the InternalFeatures in the FeatureSource. | | + | * Description:N/A |
| - | === Parameters === | + | * //newFeatureSourceColumn// |
| - | ^ Name ^ Type ^ Description ^ | + | * Type:[[ThinkGeo.MapSuite.Core.FeatureSourceColumn|FeatureSourceColumn]] |
| - | | returningColumnNamesType | [[ThinkGeo.MapSuite.PortableCore.ReturningColumnsType|ReturningColumnsType]]<!-- ThinkGeo.MapSuite.PortableCore.ReturningColumnsType --> | This parameter allows you to select a type from the ReturningColumnsType that you wish to return with each Feature. | | + | * Description:N/A |
| - | <!-- ThinkGeo.MapSuite.PortableCore.FeatureSource --> | + | <div newline></div> |
| - | [[#Public Methods|Go Back]] | + | ** {{wiki:PublicMethod.gif|}} GetAllFeatures(IEnumerable<String>) ** |
| - | ==== GetBoundingBox() ==== | + | |
| - | This method returns the bounding box which encompasses all of the features in the FeatureSource. | + | |
| - | === Remarks === | + | |
| - | This method is the concrete wrapper for the virtual method GetBoundingBoxCore. It will return whatever is returned by the GetBoundingBoxCore method, along with any additions or subtractions made if you are in a transaction and that transaction is configured to be live. To determine what the default implementation of the abstract GetBoundingBoxCore method is, please see the documentation for it. | + | |
| - | 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. | + | * //N/A// |
| + | == Remarks == | ||
| + | * //N/A// | ||
| - | As this is a concrete public method that wraps a Core method, we reserve the right to add events and other logic to pre- or post-process data returned by the Core version of the method. In this way, we leave our framework open on our end, but also allow you the developer to extend our logic to suit your needs. If you have questions about this, please contact our support team as we would be happy to work with you on extending our framework. | + | == Return Value == |
| - | === Return Value === | + | * Type:Collection<[[ThinkGeo.MapSuite.Core.Feature|Feature]]> |
| - | ^ Return Type ^ Description ^ | + | * Description:N/A |
| - | | [[ThinkGeo.MapSuite.PortableCore.RectangleShape|RectangleShape]]<!-- ThinkGeo.MapSuite.PortableCore.RectangleShape --> | This method returns the bounding box which encompasses all of the features in the FeatureSource. | | + | |
| - | === Parameters === | + | == Parameters == |
| - | ^ Name ^ Type ^ Description ^ | + | * //returningColumnNames// |
| + | * Type:IEnumerable<String> | ||
| + | * Description:N/A | ||
| - | <!-- ThinkGeo.MapSuite.PortableCore.FeatureSource --> | + | <div newline></div> |
| - | [[#Public Methods|Go Back]] | + | ** {{wiki:PublicMethod.gif|}} GetAllFeatures(ReturningColumnsType) ** |
| - | ==== GetBoundingBoxById(String) ==== | + | |
| - | This method returns a bounding box based on the InternalFeatures Id specified. | + | |
| - | === Remarks === | + | |
| - | This method returns a bounding box by providing an Id. The internal implementation calls the GetFeaturesByIdsCore and only passes one Id in the collection. That method in turn calls the GetAllFeaturesCore. Because of this, if you want a more efficient version of this method, then we highly suggest you override the GetFeaturesByIdsCore method and provide a fast way to find a group of InternalFeatures by their Id. | + | |
| - | === Return Value === | + | |
| - | ^ Return Type ^ Description ^ | + | |
| - | | [[ThinkGeo.MapSuite.PortableCore.RectangleShape|RectangleShape]]<!-- ThinkGeo.MapSuite.PortableCore.RectangleShape --> | This method returns a bounding box based on the InternalFeatures Id specified. | | + | |
| - | === Parameters === | + | * //N/A// |
| - | ^ Name ^ Type ^ Description ^ | + | == Remarks == |
| - | | id | String<!-- System.String --> | This parameter represents the Id for the InternalFeatures whose bounding box you want. | | + | * //N/A// |
| - | <!-- ThinkGeo.MapSuite.PortableCore.FeatureSource --> | + | == Return Value == |
| - | [[#Public Methods|Go Back]] | + | * Type:Collection<[[ThinkGeo.MapSuite.Core.Feature|Feature]]> |
| - | ==== GetBoundingBoxByIds(IEnumerable<String>) ==== | + | * Description:N/A |
| - | This method returns a collection of bounding boxes based on the Feature Ids specified. | + | |
| - | === Remarks === | + | |
| - | This method returns a bounding boxes by providing a goupd of Ids. The internal implementation calls the GetFeaturesByIdsCore. That method in turn calls the GetAllFeaturesCore. Because of this, if you want a more efficient version of this method, then we highly suggest you override the GetFeaturesByIdsCore method and provide a fast way to find a group of InternalFeatures by their Id. | + | |
| - | === Return Value === | + | |
| - | ^ Return Type ^ Description ^ | + | |
| - | | [[ThinkGeo.MapSuite.PortableCore.RectangleShape|RectangleShape]]<!-- ThinkGeo.MapSuite.PortableCore.RectangleShape --> | This method returns a collection of bounding boxes based on the Feature Ids specified. | | + | |
| - | === Parameters === | + | == Parameters == |
| - | ^ Name ^ Type ^ Description ^ | + | * //returningColumnNamesType// |
| - | | ids | IEnumerable<String><!-- System.Collections.Generic.IEnumerable{System.String} --> | This parameter represents the group of Ids for the InternalFeatures whose bounding boxes you want. | | + | * Type:[[ThinkGeo.MapSuite.Core.ReturningColumnsType|ReturningColumnsType]] |
| + | * Description:N/A | ||
| - | <!-- ThinkGeo.MapSuite.PortableCore.FeatureSource --> | + | <div newline></div> |
| - | [[#Public Methods|Go Back]] | + | ** {{wiki:PublicMethod.gif|}} GetFeaturesOutsideBoundingBox(RectangleShape,IEnumerable<String>) ** |
| - | ==== GetBoundingBoxesByIds(IEnumerable<String>) ==== | + | |
| - | This method returns a collection of bounding boxes based on the Feature Ids specified. | + | |
| - | === Remarks === | + | |
| - | This method returns a bounding boxes by providing a goupd of Ids. The internal implementation calls the GetFeaturesByIdsCore. That method in turn calls the GetAllFeaturesCore. Because of this, if you want a more efficient version of this method, then we highly suggest you override the GetFeaturesByIdsCore method and provide a fast way to find a group of InternalFeatures by their Id. | + | |
| - | === Return Value === | + | |
| - | ^ Return Type ^ Description ^ | + | |
| - | | Collection<[[ThinkGeo.MapSuite.PortableCore.RectangleShape|RectangleShape]]><!-- System.Collections.ObjectModel.Collection{ThinkGeo.MapSuite.PortableCore.RectangleShape} --> | This method returns a collection of bounding boxes based on the Feature Ids specified. | | + | |
| - | === Parameters === | + | * //N/A// |
| - | ^ Name ^ Type ^ Description ^ | + | == Remarks == |
| - | | ids | IEnumerable<String><!-- System.Collections.Generic.IEnumerable{System.String} --> | This parameter represents the group of Ids for the InternalFeatures whose bounding boxes you want. | | + | * //N/A// |
| - | <!-- ThinkGeo.MapSuite.PortableCore.FeatureSource --> | + | == Return Value == |
| - | [[#Public Methods|Go Back]] | + | * Type:Collection<[[ThinkGeo.MapSuite.Core.Feature|Feature]]> |
| - | ==== GetColumns() ==== | + | * Description:N/A |
| - | This method returns the columns available for the FeatureSource and caches them. | + | |
| - | === Remarks === | + | |
| - | As this is the concrete method wrapping the GetColumnsCore, it is important to note that this method will cache the results to GetColumnsCore. What this means is that the first time this method is called it will call GetCollumnsCore, which is protected, and cache the results. The next time this method is called it will not call GetColumnsCore again. This was done to increase speed, as this is a critical method that is used very often in the internal code of the class. | + | |
| - | As this is a concrete public method that wraps a Core method, we reserve the right to add events and other logic to pre- or post-process data returned by the Core version of the method. In this way, we leave our framework open on our end, but also allow you the developer to extend our logic to suit your needs. If you have questions about this, please contact our support team as we would be happy to work with you on extending our framework. | + | == Parameters == |
| - | === Return Value === | + | * //boundingBox// |
| - | ^ Return Type ^ Description ^ | + | * Type:[[ThinkGeo.MapSuite.Core.RectangleShape|RectangleShape]] |
| - | | Collection<[[ThinkGeo.MapSuite.PortableCore.FeatureSourceColumn|FeatureSourceColumn]]><!-- System.Collections.ObjectModel.Collection{ThinkGeo.MapSuite.PortableCore.FeatureSourceColumn} --> | This method returns the columns available for the FeatureSource. | | + | * Description:N/A |
| - | === Parameters === | + | * //returningColumnNames// |
| - | ^ Name ^ Type ^ Description ^ | + | * Type:IEnumerable<String> |
| + | * Description:N/A | ||
| - | <!-- ThinkGeo.MapSuite.PortableCore.FeatureSource --> | + | <div newline></div> |
| - | [[#Public Methods|Go Back]] | + | ** {{wiki:PublicMethod.gif|}} GetFeaturesOutsideBoundingBox(RectangleShape,ReturningColumnsType) ** |
| - | ==== GetCount() ==== | + | |
| - | This method returns the count of the number of records in this FeatureSource. | + | |
| - | === Remarks === | + | |
| - | This method is the concrete wrapper for the virtual method GetCountCore. It will return whatever is returned by the GetCountCore method, along with any additions or subtractions made if you are in a transaction and that transaction is configured to be live. To determine what the default implementation of the abstract GetCountCore method is, please see the documentation for it. | + | |
| - | 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. | + | * //N/A// |
| + | == Remarks == | ||
| + | * //N/A// | ||
| - | As this is a concrete public method that wraps a Core method, we reserve the right to add events and other logic to pre- or post-process data returned by the Core version of the method. In this way, we leave our framework open on our end, but also allow you the developer to extend our logic to suit your needs. If you have questions about this, please contact our support team as we would be happy to work with you on extending our framework. | + | == Return Value == |
| - | === Return Value === | + | * Type:Collection<[[ThinkGeo.MapSuite.Core.Feature|Feature]]> |
| - | ^ Return Type ^ Description ^ | + | * Description:N/A |
| - | | Int32<!-- System.Int32 --> | This method returns the count of the number of records in this FeatureSource. | | + | |
| - | === Parameters === | + | == Parameters == |
| - | ^ Name ^ Type ^ Description ^ | + | * //boundingBox// |
| + | * Type:[[ThinkGeo.MapSuite.Core.RectangleShape|RectangleShape]] | ||
| + | * Description:N/A | ||
| - | <!-- ThinkGeo.MapSuite.PortableCore.FeatureSource --> | + | * //returningColumnNamesType// |
| - | [[#Public Methods|Go Back]] | + | * Type:[[ThinkGeo.MapSuite.Core.ReturningColumnsType|ReturningColumnsType]] |
| - | ==== GetDistinctColumnValues(String) ==== | + | * Description:N/A |
| - | === Return Value === | + | |
| - | ^ Return Type ^ Description ^ | + | |
| - | | Collection<[[ThinkGeo.MapSuite.PortableCore.DistinctColumnValue|DistinctColumnValue]]><!-- System.Collections.ObjectModel.Collection{ThinkGeo.MapSuite.PortableCore.DistinctColumnValue} --> | | | + | |
| - | === Parameters === | + | <div newline></div> |
| - | ^ Name ^ Type ^ Description ^ | + | ** {{wiki:PublicMethod.gif|}} GetFeaturesInsideBoundingBox(RectangleShape,IEnumerable<String>) ** |
| - | | columnName | String<!-- System.String --> | | | + | |
| - | <!-- ThinkGeo.MapSuite.PortableCore.FeatureSource --> | + | * //N/A// |
| - | [[#Public Methods|Go Back]] | + | == Remarks == |
| - | ==== GetFeatureById(String, IEnumerable<String>) ==== | + | * //N/A// |
| - | This method returns a Feature by providing its Id in the FeatureSource. | + | |
| - | === Remarks === | + | |
| - | This method returns a collection of InternalFeatures by providing a group of Ids. The internal implementation calls the GetFeaturesByIdsCore and only passes one Id in the collection. That method in turn calls the GetAllFeaturesCore. Because of this, if you want a more efficient version of this method, we highly suggest you override the GetFeaturesByIdsCore method and provide a fast way to find a group of InternalFeatures by their Id. | + | |
| - | === Return Value === | + | |
| - | ^ Return Type ^ Description ^ | + | |
| - | | [[ThinkGeo.MapSuite.PortableCore.Feature|Feature]]<!-- ThinkGeo.MapSuite.PortableCore.Feature --> | This method returns a Feature by providing its Id in the FeatureSource. | | + | |
| - | === Parameters === | + | == Return Value == |
| - | ^ Name ^ Type ^ Description ^ | + | * Type:Collection<[[ThinkGeo.MapSuite.Core.Feature|Feature]]> |
| - | | id | String<!-- System.String --> | This parameter is the Id which uniquely identifies it in the FeatureSource. | | + | * Description:N/A |
| - | | returningColumnNames | IEnumerable<String><!-- System.Collections.Generic.IEnumerable{System.String} --> | This parameter allows you to select the field names of the column data you wish to return with each Feature. | | + | |
| - | <!-- ThinkGeo.MapSuite.PortableCore.FeatureSource --> | + | == Parameters == |
| - | [[#Public Methods|Go Back]] | + | * //boundingBox// |
| - | ==== GetFeatureById(String, ReturningColumnsType) ==== | + | * Type:[[ThinkGeo.MapSuite.Core.RectangleShape|RectangleShape]] |
| - | This method returns a Feature by providing its Id in the FeatureSource. | + | * Description:N/A |
| - | === Remarks === | + | |
| - | This method returns a collection of InternalFeatures by providing a group of Ids. The internal implementation calls the GetFeaturesByIdsCore and only passes one Id in the collection. That method in turn calls the GetAllFeaturesCore. Because of this, if you want a more efficient version of this method, then we highly suggest you override the GetFeaturesByIdsCore method and provide a fast way to find a group of InternalFeatures by their Id. | + | |
| - | === Return Value === | + | |
| - | ^ Return Type ^ Description ^ | + | |
| - | | [[ThinkGeo.MapSuite.PortableCore.Feature|Feature]]<!-- ThinkGeo.MapSuite.PortableCore.Feature --> | This method returns a Feature by providing its Id in the FeatureSource. | | + | |
| - | === Parameters === | + | * //returningColumnNames// |
| - | ^ Name ^ Type ^ Description ^ | + | * Type:IEnumerable<String> |
| - | | id | String<!-- System.String --> | This parameter is the Id which uniquely identifies it in the FeatureSource. | | + | * Description:N/A |
| - | | returningColumnNamesType | [[ThinkGeo.MapSuite.PortableCore.ReturningColumnsType|ReturningColumnsType]]<!-- ThinkGeo.MapSuite.PortableCore.ReturningColumnsType --> | This parameter allows you to select a type from the ReturningColumnsType that you wish to return with each Feature. | | + | |
| - | <!-- ThinkGeo.MapSuite.PortableCore.FeatureSource --> | + | <div newline></div> |
| - | [[#Public Methods|Go Back]] | + | ** {{wiki:PublicMethod.gif|}} GetFeaturesInsideBoundingBox(RectangleShape,ReturningColumnsType) ** |
| - | ==== GetFeaturesByColumnValue(String, String, IEnumerable<String>) ==== | + | |
| - | Get all of the features by passing a columnName and a specified columValue. | + | |
| - | === Return Value === | + | |
| - | ^ Return Type ^ Description ^ | + | |
| - | | Collection<[[ThinkGeo.MapSuite.PortableCore.Feature|Feature]]><!-- System.Collections.ObjectModel.Collection{ThinkGeo.MapSuite.PortableCore.Feature} --> | The returnning features matches the columnValue. | | + | |
| - | === Parameters === | + | * //N/A// |
| - | ^ Name ^ Type ^ Description ^ | + | == Remarks == |
| - | | columnName | String<!-- System.String --> | The specified columnName to match the columnValue. | | + | * //N/A// |
| - | | columnValue | String<!-- System.String --> | The specified columnValue to match those returning features. | | + | |
| - | | returningColumnNames | IEnumerable<String><!-- System.Collections.Generic.IEnumerable{System.String} --> | This parameter allows you to select the field names of the column data you wish to return with each Feature. | | + | |
| - | <!-- ThinkGeo.MapSuite.PortableCore.FeatureSource --> | + | == Return Value == |
| - | [[#Public Methods|Go Back]] | + | * Type:Collection<[[ThinkGeo.MapSuite.Core.Feature|Feature]]> |
| - | ==== GetFeaturesByColumnValue(String, String) ==== | + | * Description:N/A |
| - | Get all of the features by passing a columnName and a specified columValue. | + | |
| - | === Return Value === | + | |
| - | ^ Return Type ^ Description ^ | + | |
| - | | Collection<[[ThinkGeo.MapSuite.PortableCore.Feature|Feature]]><!-- System.Collections.ObjectModel.Collection{ThinkGeo.MapSuite.PortableCore.Feature} --> | The returnning features matches the columnValue. | | + | |
| - | === Parameters === | + | == Parameters == |
| - | ^ Name ^ Type ^ Description ^ | + | * //boundingBox// |
| - | | columnName | String<!-- System.String --> | The specified columnName to match the columnValue. | | + | * Type:[[ThinkGeo.MapSuite.Core.RectangleShape|RectangleShape]] |
| - | | columnValue | String<!-- System.String --> | The specified columnValue to match those returning features. | | + | * Description:N/A |
| - | <!-- ThinkGeo.MapSuite.PortableCore.FeatureSource --> | + | * //returningColumnNamesType// |
| - | [[#Public Methods|Go Back]] | + | * Type:[[ThinkGeo.MapSuite.Core.ReturningColumnsType|ReturningColumnsType]] |
| - | ==== GetFeaturesByColumnValue(String, String, ReturningColumnsType) ==== | + | * Description:N/A |
| - | Get all of the features by passing a columnName and a specified columValue. | + | |
| - | === Return Value === | + | |
| - | ^ Return Type ^ Description ^ | + | |
| - | | Collection<[[ThinkGeo.MapSuite.PortableCore.Feature|Feature]]><!-- System.Collections.ObjectModel.Collection{ThinkGeo.MapSuite.PortableCore.Feature} --> | The returnning features matches the columnValue. | | + | |
| - | === Parameters === | + | <div newline></div> |
| - | ^ Name ^ Type ^ Description ^ | + | ** {{wiki:PublicMethod.gif|}} GetFeaturesForDrawing(RectangleShape,Double,Double,IEnumerable<String>) ** |
| - | | columnName | String<!-- System.String --> | The specified columnName to match the columnValue. | | + | |
| - | | columnValue | String<!-- System.String --> | The specified columnValue to match those returning features. | | + | |
| - | | returningColumnType | [[ThinkGeo.MapSuite.PortableCore.ReturningColumnsType|ReturningColumnsType]]<!-- ThinkGeo.MapSuite.PortableCore.ReturningColumnsType --> | This parameter allows you to select a type from the ReturningColumnsType that you wish to return with each Feature. | | + | |
| - | <!-- ThinkGeo.MapSuite.PortableCore.FeatureSource --> | + | * //N/A// |
| - | [[#Public Methods|Go Back]] | + | == Remarks == |
| - | ==== GetFeaturesByIds(IEnumerable<String>, IEnumerable<String>) ==== | + | * //N/A// |
| - | 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 GetFeaturesByIdsCore. That method in turn calls the GetAllFeaturesCore. Because of this, if you want a more efficient version of this method, then we highly suggest you override the GetFeaturesByIdsCore method and provide a fast way to find a group of InternalFeatures by their Id. | + | |
| - | As this is a concrete public method that wraps a Core method, we reserve the right to add events and other logic to pre- or post-process data returned by the Core version of the method. In this way, we leave our framework open on our end, but also allow you the developer to extend our logic to suit your needs. If you have questions about this, please contact our support team as we would be happy to work with you on extending our framework. | + | == Return Value == |
| - | === Return Value === | + | * Type:Collection<[[ThinkGeo.MapSuite.Core.Feature|Feature]]> |
| - | ^ Return Type ^ Description ^ | + | * Description:N/A |
| - | | Collection<[[ThinkGeo.MapSuite.PortableCore.Feature|Feature]]><!-- System.Collections.ObjectModel.Collection{ThinkGeo.MapSuite.PortableCore.Feature} --> | This method returns a collection of InternalFeatures by providing a group of Ids. | | + | |
| - | === Parameters === | + | == Parameters == |
| - | ^ Name ^ Type ^ Description ^ | + | * //boundingBox// |
| - | | ids | IEnumerable<String><!-- System.Collections.Generic.IEnumerable{System.String} --> | This parameter represents the group of Ids which uniquely identifies the InternalFeatures in the FeatureSource. | | + | * Type:[[ThinkGeo.MapSuite.Core.RectangleShape|RectangleShape]] |
| - | | returningColumnNames | IEnumerable<String><!-- System.Collections.Generic.IEnumerable{System.String} --> | This parameter allows you to select the field names of the column data you wish to return with each Feature. | | + | * Description:N/A |
| - | <!-- ThinkGeo.MapSuite.PortableCore.FeatureSource --> | + | * //screenWidth// |
| - | [[#Public Methods|Go Back]] | + | * Type:Double |
| - | ==== GetFeaturesByIds(IEnumerable<String>, ReturningColumnsType) ==== | + | * Description:N/A |
| - | 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 GetFeaturesByIdsCore. That method in turn calls the GetAllFeaturesCore. Because of this, if you want a more efficient version of this method, then we highly suggest you override the GetFeaturesByIdsCore method and provide a fast way to find a group of InternalFeatures by their Id. | + | |
| - | As this is a concrete public method that wraps a Core method, we reserve the right to add events and other logic to pre- or post-process data returned by the Core version of the method. In this way, we leave our framework open on our end, but also allow you the developer to extend our logic to suit your needs. If you have questions about this, please contact our support team as we would be happy to work with you on extending our framework. | + | * //screenHeight// |
| - | === Return Value === | + | * Type:Double |
| - | ^ Return Type ^ Description ^ | + | * Description:N/A |
| - | | Collection<[[ThinkGeo.MapSuite.PortableCore.Feature|Feature]]><!-- System.Collections.ObjectModel.Collection{ThinkGeo.MapSuite.PortableCore.Feature} --> | This method returns a collection of InternalFeatures by providing a group of Ids. | | + | |
| - | === Parameters === | + | * //returningColumnNames// |
| - | ^ Name ^ Type ^ Description ^ | + | * Type:IEnumerable<String> |
| - | | ids | IEnumerable<String><!-- System.Collections.Generic.IEnumerable{System.String} --> | This parameter represents the group of Ids which uniquely identifies the InternalFeatures in the FeatureSource. | | + | * Description:N/A |
| - | | returningColumnNamesType | [[ThinkGeo.MapSuite.PortableCore.ReturningColumnsType|ReturningColumnsType]]<!-- ThinkGeo.MapSuite.PortableCore.ReturningColumnsType --> | This parameter allows you to select a type from the ReturningColumnsType that you wish to return with each Feature. | | + | |
| - | <!-- ThinkGeo.MapSuite.PortableCore.FeatureSource --> | + | <div newline></div> |
| - | [[#Public Methods|Go Back]] | + | ** {{wiki:PublicMethod.gif|}} GetFeaturesForDrawing(RectangleShape,Double,Double,ReturningColumnsType) ** |
| - | ==== GetFeaturesForDrawing(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 that are inside 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 GetFeaturesForDrawing uses the GetFeaturesInsodeBoundingBoxCore with some optimizations based on the screen width and height. For example, we can determine if 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 of it instead. | + | * //N/A// |
| + | == Remarks == | ||
| + | * //N/A// | ||
| - | As this is a concrete public method that wraps a Core method, we reserve the right to add events and other logic to pre- or post-process data returned by the Core version of the method. In this way, we leave our framework open on our end, but also allow you the developer to extend our logic to suit your needs. If you have questions about this, please contact our support team as we would be happy to work with you on extending our framework. | + | == Return Value == |
| - | === Return Value === | + | * Type:Collection<[[ThinkGeo.MapSuite.Core.Feature|Feature]]> |
| - | ^ Return Type ^ Description ^ | + | * Description:N/A |
| - | | Collection<[[ThinkGeo.MapSuite.PortableCore.Feature|Feature]]><!-- System.Collections.ObjectModel.Collection{ThinkGeo.MapSuite.PortableCore.Feature} --> | This method returns the InternalFeatures that will be used for drawing. | | + | |
| - | === Parameters === | + | == Parameters == |
| - | ^ Name ^ Type ^ Description ^ | + | * //boundingBox// |
| - | | boundingBox | [[ThinkGeo.MapSuite.PortableCore.RectangleShape|RectangleShape]]<!-- ThinkGeo.MapSuite.PortableCore.RectangleShape --> | This parameter is the bounding box of the InternalFeatures you want to draw. | | + | * Type:[[ThinkGeo.MapSuite.Core.RectangleShape|RectangleShape]] |
| - | | screenWidth | Double<!-- System.Double --> | This parameter is the width of the canvas, in screen pixels, that you will draw on. | | + | * Description:N/A |
| - | | screenHeight | Double<!-- System.Double --> | This parameter is the height of the canvas, in screen pixels, that you will draw on. | | + | |
| - | | returningColumnNames | IEnumerable<String><!-- System.Collections.Generic.IEnumerable{System.String} --> | This parameter allows you to select the field names of the column data you wish to return with each Feature. | | + | |
| - | <!-- ThinkGeo.MapSuite.PortableCore.FeatureSource --> | + | * //screenWidth// |
| - | [[#Public Methods|Go Back]] | + | * Type:Double |
| - | ==== GetFeaturesForDrawing(RectangleShape, Double, Double, ReturningColumnsType) ==== | + | * Description:N/A |
| - | This method returns the InternalFeatures that will be used for drawing. | + | |
| - | === Remarks === | + | |
| - | This method returns all of the InternalFeatures of this FeatureSource that are inside 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 GetFeaturesForDrawing uses the GetFeaturesInsodeBoundingBoxCore with some optimizations based on the screen width and height. For example, we can determine if 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 of it instead. | + | * //screenHeight// |
| + | * Type:Double | ||
| + | * Description:N/A | ||
| - | As this is a concrete public method that wraps a Core method, we reserve the right to add events and other logic to pre- or post-process data returned by the Core version of the method. In this way, we leave our framework open on our end, but also allow you the developer to extend our logic to suit your needs. If you have questions about this, please contact our support team as we would be happy to work with you on extending our framework. | + | * //returningColumnNamesType// |
| - | === Return Value === | + | * Type:[[ThinkGeo.MapSuite.Core.ReturningColumnsType|ReturningColumnsType]] |
| - | ^ Return Type ^ Description ^ | + | * Description:N/A |
| - | | Collection<[[ThinkGeo.MapSuite.PortableCore.Feature|Feature]]><!-- System.Collections.ObjectModel.Collection{ThinkGeo.MapSuite.PortableCore.Feature} --> | This method returns the InternalFeatures that will be used for drawing. | | + | |
| - | === Parameters === | + | <div newline></div> |
| - | ^ Name ^ Type ^ Description ^ | + | ** {{wiki:PublicMethod.gif|}} SpatialQuery(BaseShape,QueryType,IEnumerable<String>) ** |
| - | | boundingBox | [[ThinkGeo.MapSuite.PortableCore.RectangleShape|RectangleShape]]<!-- ThinkGeo.MapSuite.PortableCore.RectangleShape --> | This parameter is the bounding box of the InternalFeatures that you want to draw. | | + | |
| - | | screenWidth | Double<!-- System.Double --> | This parameter is the width of the canvas, in screen pixels, that you will draw on. | | + | |
| - | | screenHeight | Double<!-- System.Double --> | This parameter is the height of the canvas, in screen pixels, that you will draw on. | | + | |
| - | | returningColumnNamesType | [[ThinkGeo.MapSuite.PortableCore.ReturningColumnsType|ReturningColumnsType]]<!-- ThinkGeo.MapSuite.PortableCore.ReturningColumnsType --> | This parameter allows you to select a type from the ReturningColumnsType you wish to return with each Feature. | | + | |
| - | <!-- ThinkGeo.MapSuite.PortableCore.FeatureSource --> | + | * //N/A// |
| - | [[#Public Methods|Go Back]] | + | == Remarks == |
| - | ==== GetFeaturesInsideBoundingBox(RectangleShape, IEnumerable<String>) ==== | + | * //N/A// |
| - | 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 in a transaction and that transaction is live, this method will also take that into consideration. | + | |
| - | 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 recommend that you use any spatial indexes you have at your disposal to make this method as fast as possible. | + | == Return Value == |
| + | * Type:Collection<[[ThinkGeo.MapSuite.Core.Feature|Feature]]> | ||
| + | * Description:N/A | ||
| - | As this is a concrete public method that wraps a Core method, we reserve the right to add events and other logic to pre- or post-process data returned by the Core version of the method. In this way, we leave our framework open on our end, but also allow you the developer to extend our logic to suit your needs. If you have questions about this, please contact our support team as we would be happy to work with you on extending our framework. | + | == Parameters == |
| - | === Return Value === | + | * //targetShape// |
| - | ^ Return Type ^ Description ^ | + | * Type:[[ThinkGeo.MapSuite.Core.BaseShape|BaseShape]] |
| - | | Collection<[[ThinkGeo.MapSuite.PortableCore.Feature|Feature]]><!-- System.Collections.ObjectModel.Collection{ThinkGeo.MapSuite.PortableCore.Feature} --> | The returned decimalDegreesValue is a collection of all of the InternalFeatures that are inside of the bounding box. | | + | * Description:N/A |
| - | === Parameters === | + | * //queryType// |
| - | ^ Name ^ Type ^ Description ^ | + | * Type:[[ThinkGeo.MapSuite.Core.QueryType|QueryType]] |
| - | | boundingBox | [[ThinkGeo.MapSuite.PortableCore.RectangleShape|RectangleShape]]<!-- ThinkGeo.MapSuite.PortableCore.RectangleShape --> | This parameter represents the bounding box that you wish to find InternalFeatures inside of. | | + | * Description:N/A |
| - | | returningColumnNames | IEnumerable<String><!-- System.Collections.Generic.IEnumerable{System.String} --> | This parameter allows you to select the field names of the column data you wish to return with each Feature. | | + | |
| - | <!-- ThinkGeo.MapSuite.PortableCore.FeatureSource --> | + | * //returningColumnNames// |
| - | [[#Public Methods|Go Back]] | + | * Type:IEnumerable<String> |
| - | ==== GetFeaturesInsideBoundingBox(RectangleShape, ReturningColumnsType) ==== | + | * Description:N/A |
| - | 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 in a transaction and that transaction is live, this method will also take that into consideration. | + | |
| - | 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. | + | <div newline></div> |
| + | ** {{wiki:PublicMethod.gif|}} SpatialQuery(BaseShape,QueryType,ReturningColumnsType) ** | ||
| - | As this is a concrete public method that wraps a Core method, we reserve the right to add events and other logic to pre- or post-process data returned by the Core version of the method. In this way, we leave our framework open on our end, but also allow you the developer to extend our logic to suit your needs. If you have questions about this, please contact our support team as we would be happy to work with you on extending our framework. | + | * //N/A// |
| - | === Return Value === | + | == Remarks == |
| - | ^ Return Type ^ Description ^ | + | * //N/A// |
| - | | Collection<[[ThinkGeo.MapSuite.PortableCore.Feature|Feature]]><!-- System.Collections.ObjectModel.Collection{ThinkGeo.MapSuite.PortableCore.Feature} --> | The returned decimalDegreesValue is a collection of all of the InternalFeatures that are inside of the bounding box. | | + | |
| - | === Parameters === | + | == Return Value == |
| - | ^ Name ^ Type ^ Description ^ | + | * Type:Collection<[[ThinkGeo.MapSuite.Core.Feature|Feature]]> |
| - | | boundingBox | [[ThinkGeo.MapSuite.PortableCore.RectangleShape|RectangleShape]]<!-- ThinkGeo.MapSuite.PortableCore.RectangleShape --> | This parameter represents the bounding box that you wish to find InternalFeatures inside of. | | + | * Description:N/A |
| - | | returningColumnNamesType | [[ThinkGeo.MapSuite.PortableCore.ReturningColumnsType|ReturningColumnsType]]<!-- ThinkGeo.MapSuite.PortableCore.ReturningColumnsType --> | This parameter allows you to select a type from the ReturningColumnsType that you wish to return with each Feature. | | + | |
| - | <!-- ThinkGeo.MapSuite.PortableCore.FeatureSource --> | + | == Parameters == |
| - | [[#Public Methods|Go Back]] | + | * //targetShape// |
| - | ==== GetFeaturesNearestTo(Feature, GeographyUnit, Int32, IEnumerable<String>) ==== | + | * Type:[[ThinkGeo.MapSuite.Core.BaseShape|BaseShape]] |
| - | This method returns a user defined number of InternalFeatures that are closest to the TargetShape. | + | * Description:N/A |
| - | === Remarks === | + | |
| - | This method returns a user defined number of InternalFeatures that are closest to the TargetShape. It is important to note that the TargetShape and the FeatureSource must use the same unit, such as feet or meters. If they do not, then the results will not be predictable or correct. If there is a current transaction and it is marked as live, then the results will include any transaction Feature that applies. | + | |
| - | The implementation we provided creates a small bounding box around the TargetShape and then queries the features inside of it. If we reach the number of items to find, then we measure the returned InternalFeatures to find the nearest. If we do not find enough records, we scale up the bounding box and try again. As you can see, this is not the most efficient method. If your underlying data provider exposes a more efficient way, we recommend you override the Core version of this method and implement it. | + | * //queryType// |
| + | * Type:[[ThinkGeo.MapSuite.Core.QueryType|QueryType]] | ||
| + | * Description:N/A | ||
| - | The default implementation of GetFeaturesNearestCore uses the GetFeaturesInsideBoundingBoxCore method for speed. We strongly recommend that you provide your own implementation for this method that will be more efficient. When you override GetFeaturesInsideBoundingBoxCore method, we recommend that you use any spatial indexes you have at your disposal to make this method as fast as possible. | + | * //returningColumnNamesType// |
| + | * Type:[[ThinkGeo.MapSuite.Core.ReturningColumnsType|ReturningColumnsType]] | ||
| + | * Description:N/A | ||
| - | As this is a concrete public method that wraps a Core method, we reserve the right to add events and other logic to pre- or post-process data returned by the Core version of the method. In this way, we leave our framework open on our end, but also allow you the developer to extend our logic to suit your needs. If you have questions about this, please contact our support team as we would be happy to work with you on extending our framework. | + | <div newline></div> |
| - | === Return Value === | + | ** {{wiki:PublicMethod.gif|}} SpatialQuery(Feature,QueryType,IEnumerable<String>) ** |
| - | ^ Return Type ^ Description ^ | + | |
| - | | Collection<[[ThinkGeo.MapSuite.PortableCore.Feature|Feature]]><!-- System.Collections.ObjectModel.Collection{ThinkGeo.MapSuite.PortableCore.Feature} --> | This method returns a user defined number of InternalFeatures that are closest to the TargetShape. | | + | |
| - | === Parameters === | + | * //N/A// |
| - | ^ Name ^ Type ^ Description ^ | + | == Remarks == |
| - | | targetFeature | [[ThinkGeo.MapSuite.PortableCore.Feature|Feature]]<!-- ThinkGeo.MapSuite.PortableCore.Feature --> | This parameter is the feature you want to find InternalFeatures close to. | | + | * //N/A// |
| - | | unitOfData | [[ThinkGeo.MapSuite.PortableCore.GeographyUnit|GeographyUnit]]<!-- ThinkGeo.MapSuite.PortableCore.GeographyUnit --> | This parameter is the unit of measurement that the TargetShape and the FeatureSource are in, such as feet, meters, etc. | | + | |
| - | | maxItemsToFind | Int32<!-- System.Int32 --> | This parameter defines how many close InternalFeatures to find around the TargetShape. | | + | |
| - | | returningColumnNames | IEnumerable<String><!-- System.Collections.Generic.IEnumerable{System.String} --> | This parameter allows you to select the field names of the column data you wish to return with each Feature. | | + | |
| - | <!-- ThinkGeo.MapSuite.PortableCore.FeatureSource --> | + | == Return Value == |
| - | [[#Public Methods|Go Back]] | + | * Type:Collection<[[ThinkGeo.MapSuite.Core.Feature|Feature]]> |
| - | ==== GetFeaturesNearestTo(BaseShape, GeographyUnit, Int32, IEnumerable<String>) ==== | + | * Description:N/A |
| - | This method returns a user defined number of InternalFeatures that are closest to the TargetShape. | + | |
| - | === Remarks === | + | |
| - | This method returns a user defined number of InternalFeatures that are closest to the TargetShape. It is important to note that the TargetShape and the FeatureSource must use the same unit, such as feet or meters. If they do not, then the results will not be predictable or correct. If there is a current transaction and it is marked as live, then the results will include any transaction Feature that applies. | + | |
| - | The implementation we provided creates a small bounding box around the TargetShape and then queries the features inside of it. If we reach the number of items to find, then we measure the returned InternalFeatures to find the nearest. If we do not find enough records, we scale up the bounding box and try again. As you can see, this is not the most efficient method. If your underlying data provider exposes a more efficient way, we recommend you override the Core version of this method and implement it. | + | == Parameters == |
| + | * //feature// | ||
| + | * Type:[[ThinkGeo.MapSuite.Core.Feature|Feature]] | ||
| + | * Description:N/A | ||
| - | The default implementation of GetFeaturesNearestCore uses the GetFeaturesInsideBoundingBoxCore method for speed. We strongly recommend that you provide your own implementation for this method that will be more efficient. When you override GetFeaturesInsideBoundingBoxCore method, we recommend that you use any spatial indexes you have at your disposal to make this method as fast as possible. | + | * //queryType// |
| + | * Type:[[ThinkGeo.MapSuite.Core.QueryType|QueryType]] | ||
| + | * Description:N/A | ||
| - | As this is a concrete public method that wraps a Core method, we reserve the right to add events and other logic to pre- or post-process data returned by the Core version of the method. In this way, we leave our framework open on our end, but also allow you the developer to extend our logic to suit your needs. If you have questions about this, please contact our support team as we would be happy to work with you on extending our framework. | + | * //returningColumnNames// |
| - | === Return Value === | + | * Type:IEnumerable<String> |
| - | ^ Return Type ^ Description ^ | + | * Description:N/A |
| - | | Collection<[[ThinkGeo.MapSuite.PortableCore.Feature|Feature]]><!-- System.Collections.ObjectModel.Collection{ThinkGeo.MapSuite.PortableCore.Feature} --> | This method returns a user defined number of InternalFeatures that are closest to the TargetShape. | | + | |
| - | === Parameters === | + | <div newline></div> |
| - | ^ Name ^ Type ^ Description ^ | + | ** {{wiki:PublicMethod.gif|}} SpatialQuery(Feature,QueryType,ReturningColumnsType) ** |
| - | | targetShape | [[ThinkGeo.MapSuite.PortableCore.BaseShape|BaseShape]]<!-- ThinkGeo.MapSuite.PortableCore.BaseShape --> | This parameter is the shape you want to find InternalFeatures close to. | | + | |
| - | | unitOfFeatureSource | [[ThinkGeo.MapSuite.PortableCore.GeographyUnit|GeographyUnit]]<!-- ThinkGeo.MapSuite.PortableCore.GeographyUnit --> | This parameter is the unit of measurement that the TargetShape and the FeatureSource are in, such as feet, meters, etc. | | + | |
| - | | maxItemsToFind | Int32<!-- System.Int32 --> | This parameter defines how many close InternalFeatures to find around the TargetShape. | | + | |
| - | | returningColumnNames | IEnumerable<String><!-- System.Collections.Generic.IEnumerable{System.String} --> | This parameter allows you to select the field names of the column data you wish to return with each Feature. | | + | |
| - | <!-- ThinkGeo.MapSuite.PortableCore.FeatureSource --> | + | * //N/A// |
| - | [[#Public Methods|Go Back]] | + | == Remarks == |
| - | ==== GetFeaturesNearestTo(Feature, GeographyUnit, Int32, ReturningColumnsType) ==== | + | * //N/A// |
| - | This method returns a user defined number of InternalFeatures that are closest to the TargetShape. | + | |
| - | === Remarks === | + | |
| - | This method returns a user defined number of InternalFeatures that are closest to the TargetShape. It is important to note that the TargetShape and the FeatureSource must use the same unit, such as feet or meters. If they do not, then the results will not be predictable or correct. If there is a current transaction and it is marked as live, then the results will include any transaction Feature that applies. | + | |
| - | The implementation we provided creates a small bounding box around the TargetShape and then queries the features inside of it. If we reach the number of items to find, then we measure the returned InternalFeatures to find the nearest. If we do not find enough records, we scale up the bounding box and try again. As you can see, this is not the most efficient method. If your underlying data provider exposes a more efficient way, we recommend you override the Core version of this method and implement it. | + | == Return Value == |
| + | * Type:Collection<[[ThinkGeo.MapSuite.Core.Feature|Feature]]> | ||
| + | * Description:N/A | ||
| - | The default implementation of GetFeaturesNearestCore uses the GetFeaturesInsideBoundingBoxCore method for speed. We strongly recommend that you provide your own implementation for this method that will be more efficient. When you override GetFeaturesInsideBoundingBoxCore method, we recommend that you use any spatial indexes you have at your disposal to make this method as fast as possible. | + | == Parameters == |
| + | * //feature// | ||
| + | * Type:[[ThinkGeo.MapSuite.Core.Feature|Feature]] | ||
| + | * Description:N/A | ||
| - | As this is a concrete public method that wraps a Core method, we reserve the right to add events and other logic to pre- or post-process data returned by the Core version of the method. In this way, we leave our framework open on our end, but also allow you the developer to extend our logic to suit your needs. If you have questions about this, please contact our support team as we would be happy to work with you on extending our framework. | + | * //queryType// |
| - | === Return Value === | + | * Type:[[ThinkGeo.MapSuite.Core.QueryType|QueryType]] |
| - | ^ Return Type ^ Description ^ | + | * Description:N/A |
| - | | Collection<[[ThinkGeo.MapSuite.PortableCore.Feature|Feature]]><!-- System.Collections.ObjectModel.Collection{ThinkGeo.MapSuite.PortableCore.Feature} --> | This method returns a user defined number of InternalFeatures that are closest to the TargetShape. | | + | |
| - | === Parameters === | + | * //returningColumnNamesType// |
| - | ^ Name ^ Type ^ Description ^ | + | * Type:[[ThinkGeo.MapSuite.Core.ReturningColumnsType|ReturningColumnsType]] |
| - | | targetFeature | [[ThinkGeo.MapSuite.PortableCore.Feature|Feature]]<!-- ThinkGeo.MapSuite.PortableCore.Feature --> | This parameter is the target feature you want to find InternalFeatures close to. | | + | * Description:N/A |
| - | | unitOfData | [[ThinkGeo.MapSuite.PortableCore.GeographyUnit|GeographyUnit]]<!-- ThinkGeo.MapSuite.PortableCore.GeographyUnit --> | This parameter is the unit of measurement that the TargetShape and the FeatureSource are in, such as feet, meters, etc. | | + | |
| - | | maxItemsToFind | Int32<!-- System.Int32 --> | This parameter defines how many close InternalFeatures to find around the TargetShape. | | + | |
| - | | returningColumnNamesType | [[ThinkGeo.MapSuite.PortableCore.ReturningColumnsType|ReturningColumnsType]]<!-- ThinkGeo.MapSuite.PortableCore.ReturningColumnsType --> | This parameter allows you to select a type from the ReturningColumnsType that you wish to return with each Feature. | | + | |
| - | <!-- ThinkGeo.MapSuite.PortableCore.FeatureSource --> | + | <div newline></div> |
| - | [[#Public Methods|Go Back]] | + | ** {{wiki:PublicMethod.gif|}} GetFeaturesNearestTo(BaseShape,GeographyUnit,Int32,IEnumerable<String>) ** |
| - | ==== GetFeaturesNearestTo(BaseShape, GeographyUnit, Int32, IEnumerable<String>, Double, DistanceUnit) ==== | + | |
| - | This method returns a user defined number of InternalFeatures that are closest to the TargetShape. | + | |
| - | === Remarks === | + | |
| - | This method returns a user defined number of InternalFeatures that are closest to the TargetShape. It is important to note that the TargetShape and the FeatureSource must use the same unit, such as feet or meters. If they do not, then the results will not be predictable or correct. If there is a current transaction and it is marked as live, then the results will include any transaction Feature that applies. | + | |
| - | The implementation we provided creates a small bounding box around the TargetShape and then queries the features inside of it. If we reach the number of items to find, then we measure the returned InternalFeatures to find the nearest. If we do not find enough records, we scale up the bounding box and try again. As you can see, this is not the most efficient method. If your underlying data provider exposes a more efficient way, we recommend you override the Core version of this method and implement it. | + | * //N/A// |
| + | == Remarks == | ||
| + | * //N/A// | ||
| - | The default implementation of GetFeaturesNearestCore uses the GetFeaturesInsideBoundingBoxCore method for speed. We strongly recommend that you provide your own implementation for this method that will be more efficient. When you override GetFeaturesInsideBoundingBoxCore method, we recommend that you use any spatial indexes you have at your disposal to make this method as fast as possible. | + | == Return Value == |
| + | * Type:Collection<[[ThinkGeo.MapSuite.Core.Feature|Feature]]> | ||
| + | * Description:N/A | ||
| - | As this is a concrete public method that wraps a Core method, we reserve the right to add events and other logic to pre- or post-process data returned by the Core version of the method. In this way, we leave our framework open on our end, but also allow you the developer to extend our logic to suit your needs. If you have questions about this, please contact our support team as we would be happy to work with you on extending our framework. | + | == Parameters == |
| - | === Return Value === | + | * //targetShape// |
| - | ^ Return Type ^ Description ^ | + | * Type:[[ThinkGeo.MapSuite.Core.BaseShape|BaseShape]] |
| - | | Collection<[[ThinkGeo.MapSuite.PortableCore.Feature|Feature]]><!-- System.Collections.ObjectModel.Collection{ThinkGeo.MapSuite.PortableCore.Feature} --> | This method returns a user defined number of InternalFeatures that are closest to the TargetShape. | | + | * Description:N/A |
| - | === Parameters === | + | * //unitOfFeatureSource// |
| - | ^ Name ^ Type ^ Description ^ | + | * Type:[[ThinkGeo.MapSuite.Core.GeographyUnit|GeographyUnit]] |
| - | | targetShape | [[ThinkGeo.MapSuite.PortableCore.BaseShape|BaseShape]]<!-- ThinkGeo.MapSuite.PortableCore.BaseShape --> | This parameter is the shape you want to find InternalFeatures close to. | | + | * Description:N/A |
| - | | unitOfData | [[ThinkGeo.MapSuite.PortableCore.GeographyUnit|GeographyUnit]]<!-- ThinkGeo.MapSuite.PortableCore.GeographyUnit --> | This parameter is the unit of measurement that the TargetShape and the FeatureSource are in, such as feet, meters, etc. | | + | |
| - | | maxItemsToFind | Int32<!-- System.Int32 --> | This parameter defines how many close InternalFeatures to find around the TargetShape. | | + | |
| - | | returningColumnNames | IEnumerable<String><!-- System.Collections.Generic.IEnumerable{System.String} --> | This parameter allows you to select the field names of the column data you wish to return with each Feature. | | + | |
| - | | searchRadius | Double<!-- System.Double --> | Limit the maximize distance proximately to search closest records. | | + | |
| - | | unitOfSearchRadius | [[ThinkGeo.MapSuite.PortableCore.DistanceUnit|DistanceUnit]]<!-- ThinkGeo.MapSuite.PortableCore.DistanceUnit --> | The unit of searchRadius parameter. | | + | |
| - | <!-- ThinkGeo.MapSuite.PortableCore.FeatureSource --> | + | * //maxItemsToFind// |
| - | [[#Public Methods|Go Back]] | + | * Type:Int32 |
| - | ==== GetFeaturesNearestTo(Feature, GeographyUnit, Int32, IEnumerable<String>, Double, DistanceUnit) ==== | + | * Description:N/A |
| - | This method returns a user defined number of InternalFeatures that are closest to the TargetShape. | + | |
| - | === Remarks === | + | |
| - | This method returns a user defined number of InternalFeatures that are closest to the TargetShape. It is important to note that the TargetShape and the FeatureSource must use the same unit, such as feet or meters. If they do not, then the results will not be predictable or correct. If there is a current transaction and it is marked as live, then the results will include any transaction Feature that applies. | + | |
| - | The implementation we provided creates a small bounding box around the TargetShape and then queries the features inside of it. If we reach the number of items to find, then we measure the returned InternalFeatures to find the nearest. If we do not find enough records, we scale up the bounding box and try again. As you can see, this is not the most efficient method. If your underlying data provider exposes a more efficient way, we recommend you override the Core version of this method and implement it. | + | * //returningColumnNames// |
| + | * Type:IEnumerable<String> | ||
| + | * Description:N/A | ||
| - | The default implementation of GetFeaturesNearestCore uses the GetFeaturesInsideBoundingBoxCore method for speed. We strongly recommend that you provide your own implementation for this method that will be more efficient. When you override GetFeaturesInsideBoundingBoxCore method, we recommend that you use any spatial indexes you have at your disposal to make this method as fast as possible. | + | <div newline></div> |
| + | ** {{wiki:PublicMethod.gif|}} GetFeaturesNearestTo(BaseShape,GeographyUnit,Int32,ReturningColumnsType) ** | ||
| - | As this is a concrete public method that wraps a Core method, we reserve the right to add events and other logic to pre- or post-process data returned by the Core version of the method. In this way, we leave our framework open on our end, but also allow you the developer to extend our logic to suit your needs. If you have questions about this, please contact our support team as we would be happy to work with you on extending our framework. | + | * //N/A// |
| - | === Return Value === | + | == Remarks == |
| - | ^ Return Type ^ Description ^ | + | * //N/A// |
| - | | Collection<[[ThinkGeo.MapSuite.PortableCore.Feature|Feature]]><!-- System.Collections.ObjectModel.Collection{ThinkGeo.MapSuite.PortableCore.Feature} --> | This method returns a user defined number of InternalFeatures that are closest to the TargetShape. | | + | |
| - | === Parameters === | + | == Return Value == |
| - | ^ Name ^ Type ^ Description ^ | + | * Type:Collection<[[ThinkGeo.MapSuite.Core.Feature|Feature]]> |
| - | | targetFeature | [[ThinkGeo.MapSuite.PortableCore.Feature|Feature]]<!-- ThinkGeo.MapSuite.PortableCore.Feature --> | This parameter is feature you want to find InternalFeatures close to. | | + | * Description:N/A |
| - | | unitOfData | [[ThinkGeo.MapSuite.PortableCore.GeographyUnit|GeographyUnit]]<!-- ThinkGeo.MapSuite.PortableCore.GeographyUnit --> | This parameter is the unit of measurement that the TargetShape and the FeatureSource are in, such as feet, meters, etc. | | + | |
| - | | maxItemsToFind | Int32<!-- System.Int32 --> | This parameter defines how many close InternalFeatures to find around the TargetShape. | | + | |
| - | | returningColumnNames | IEnumerable<String><!-- System.Collections.Generic.IEnumerable{System.String} --> | This parameter allows you to select the field names of the column data you wish to return with each Feature. | | + | |
| - | | searchRadius | Double<!-- System.Double --> | Limit the maximize distance proximately to search closest records. | | + | |
| - | | unitOfSearchRadius | [[ThinkGeo.MapSuite.PortableCore.DistanceUnit|DistanceUnit]]<!-- ThinkGeo.MapSuite.PortableCore.DistanceUnit --> | The unit of distanceLimits parameter. | | + | |
| - | <!-- ThinkGeo.MapSuite.PortableCore.FeatureSource --> | + | == Parameters == |
| - | [[#Public Methods|Go Back]] | + | * //targetShape// |
| - | ==== GetFeaturesNearestTo(BaseShape, GeographyUnit, Int32, ReturningColumnsType) ==== | + | * Type:[[ThinkGeo.MapSuite.Core.BaseShape|BaseShape]] |
| - | This method returns a user defined number of InternalFeatures that are closest to the TargetShape. | + | * Description:N/A |
| - | === Remarks === | + | |
| - | This method returns a user defined number of InternalFeatures that are closest to the TargetShape. It is important to note that the TargetShape and the FeatureSource must use the same unit, such as feet or meters. If they do not, then the results will not be predictable or correct. If there is a current transaction and it is marked as live, then the results will include any transaction Feature that applies. | + | |
| - | The implementation we provided creates a small bounding box around the TargetShape and then queries the features inside of it. If we reach the number of items to find, then we measure the returned InternalFeatures to find the nearest. If we do not find enough records, we scale up the bounding box and try again. As you can see, this is not the most efficient method. If your underlying data provider exposes a more efficient way, we recommend you override the Core version of this method and implement it. | + | * //unitOfData// |
| + | * Type:[[ThinkGeo.MapSuite.Core.GeographyUnit|GeographyUnit]] | ||
| + | * Description:N/A | ||
| - | The default implementation of GetFeaturesNearestCore uses the GetFeaturesInsideBoundingBoxCore method for speed. We strongly recommend that you provide your own implementation for this method that will be more efficient. When you override GetFeaturesInsideBoundingBoxCore method, we recommend that you use any spatial indexes you have at your disposal to make this method as fast as possible. | + | * //maxItemsToFind// |
| + | * Type:Int32 | ||
| + | * Description:N/A | ||
| - | As this is a concrete public method that wraps a Core method, we reserve the right to add events and other logic to pre- or post-process data returned by the Core version of the method. In this way, we leave our framework open on our end, but also allow you the developer to extend our logic to suit your needs. If you have questions about this, please contact our support team as we would be happy to work with you on extending our framework. | + | * //returningColumnNamesType// |
| - | === Return Value === | + | * Type:[[ThinkGeo.MapSuite.Core.ReturningColumnsType|ReturningColumnsType]] |
| - | ^ Return Type ^ Description ^ | + | * Description:N/A |
| - | | Collection<[[ThinkGeo.MapSuite.PortableCore.Feature|Feature]]><!-- System.Collections.ObjectModel.Collection{ThinkGeo.MapSuite.PortableCore.Feature} --> | This method returns a user defined number of InternalFeatures that are closest to the TargetShape. | | + | |
| - | === Parameters === | + | <div newline></div> |
| - | ^ Name ^ Type ^ Description ^ | + | ** {{wiki:PublicMethod.gif|}} GetFeaturesNearestTo(Feature,GeographyUnit,Int32,IEnumerable<String>) ** |
| - | | targetShape | [[ThinkGeo.MapSuite.PortableCore.BaseShape|BaseShape]]<!-- ThinkGeo.MapSuite.PortableCore.BaseShape --> | This parameter is the shape you want to find InternalFeatures close to. | | + | |
| - | | unitOfData | [[ThinkGeo.MapSuite.PortableCore.GeographyUnit|GeographyUnit]]<!-- ThinkGeo.MapSuite.PortableCore.GeographyUnit --> | This parameter is the unit of measurement that the TargetShape and the FeatureSource are in, such as feet, meters, etc. | | + | |
| - | | maxItemsToFind | Int32<!-- System.Int32 --> | This parameter defines how many close InternalFeatures to find around the TargetShape. | | + | |
| - | | returningColumnNamesType | [[ThinkGeo.MapSuite.PortableCore.ReturningColumnsType|ReturningColumnsType]]<!-- ThinkGeo.MapSuite.PortableCore.ReturningColumnsType --> | This parameter allows you to select a type from the ReturningColumnsType that you wish to return with each Feature. | | + | |
| - | <!-- ThinkGeo.MapSuite.PortableCore.FeatureSource --> | + | * //N/A// |
| - | [[#Public Methods|Go Back]] | + | == Remarks == |
| - | ==== GetFeaturesOutsideBoundingBox(RectangleShape, ReturningColumnsType) ==== | + | * //N/A// |
| - | 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:Collection<[[ThinkGeo.MapSuite.Core.Feature|Feature]]> | ||
| + | * Description:N/A | ||
| - | As this is a concrete public method that wraps a Core method, we reserve the right to add events and other logic to pre- or post-process data returned by the Core version of the method. In this way, we leave our framework open on our end, but also allow you the developer to extend our logic to suit your needs. If you have questions about this, please contact our support team as we would be happy to work with you on extending our framework. | + | == Parameters == |
| - | === Return Value === | + | * //targetFeature// |
| - | ^ Return Type ^ Description ^ | + | * Type:[[ThinkGeo.MapSuite.Core.Feature|Feature]] |
| - | | Collection<[[ThinkGeo.MapSuite.PortableCore.Feature|Feature]]><!-- System.Collections.ObjectModel.Collection{ThinkGeo.MapSuite.PortableCore.Feature} --> | This method returns all of the InternalFeatures of this FeatureSource outside of the specified bounding box. | | + | * Description:N/A |
| - | === Parameters === | + | * //unitOfData// |
| - | ^ Name ^ Type ^ Description ^ | + | * Type:[[ThinkGeo.MapSuite.Core.GeographyUnit|GeographyUnit]] |
| - | | boundingBox | [[ThinkGeo.MapSuite.PortableCore.RectangleShape|RectangleShape]]<!-- ThinkGeo.MapSuite.PortableCore.RectangleShape --> | This parameter represents the bounding box that you wish to find InternalFeatures outside of. | | + | * Description:N/A |
| - | | returningColumnNamesType | [[ThinkGeo.MapSuite.PortableCore.ReturningColumnsType|ReturningColumnsType]]<!-- ThinkGeo.MapSuite.PortableCore.ReturningColumnsType --> | This parameter allows you to select a type from the ReturningColumnsType that you wish to return with each Feature. | | + | |
| - | <!-- ThinkGeo.MapSuite.PortableCore.FeatureSource --> | + | * //maxItemsToFind// |
| - | [[#Public Methods|Go Back]] | + | * Type:Int32 |
| - | ==== GetFeaturesOutsideBoundingBox(RectangleShape, IEnumerable<String>) ==== | + | * Description:N/A |
| - | 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. | + | * //returningColumnNames// |
| + | * Type:IEnumerable<String> | ||
| + | * Description:N/A | ||
| - | As this is a concrete public method that wraps a Core method, we reserve the right to add events and other logic to pre- or post-process data returned by the Core version of the method. In this way, we leave our framework open on our end, but also allow you the developer to extend our logic to suit your needs. If you have questions about this, please contact our support team as we would be happy to work with you on extending our framework. | + | <div newline></div> |
| - | === Return Value === | + | ** {{wiki:PublicMethod.gif|}} GetFeaturesNearestTo(Feature,GeographyUnit,Int32,ReturningColumnsType) ** |
| - | ^ Return Type ^ Description ^ | + | |
| - | | Collection<[[ThinkGeo.MapSuite.PortableCore.Feature|Feature]]><!-- System.Collections.ObjectModel.Collection{ThinkGeo.MapSuite.PortableCore.Feature} --> | This method returns all of the InternalFeatures of this FeatureSource outside of the specified bounding box. | | + | |
| - | === Parameters === | + | * //N/A// |
| - | ^ Name ^ Type ^ Description ^ | + | == Remarks == |
| - | | boundingBox | [[ThinkGeo.MapSuite.PortableCore.RectangleShape|RectangleShape]]<!-- ThinkGeo.MapSuite.PortableCore.RectangleShape --> | This parameter represents the bounding box that you wish to find InternalFeatures outside of. | | + | * //N/A// |
| - | | returningColumnNames | IEnumerable<String><!-- System.Collections.Generic.IEnumerable{System.String} --> | This parameter allows you to select the field names of the column data you wish to return with each Feature. | | + | |
| - | <!-- ThinkGeo.MapSuite.PortableCore.FeatureSource --> | + | == Return Value == |
| - | [[#Public Methods|Go Back]] | + | * Type:Collection<[[ThinkGeo.MapSuite.Core.Feature|Feature]]> |
| - | ==== GetFeaturesWithinDistanceOf(BaseShape, GeographyUnit, DistanceUnit, Double, IEnumerable<String>) ==== | + | * Description:N/A |
| - | This method returns a collection of InternalFeatures that are within a certain distance of the TargetShape. | + | |
| - | === Remarks === | + | |
| - | This method returns a collection of InternalFeatures that are within a certain distance of the TargetShape. It is important to note that the TargetShape and the FeatureSource must use the same unit, such as feet or meters. If they do not, then the results will not be predictable or correct. If there is a current transaction and it is marked as live, then the results will include any transaction Feature that applies. | + | |
| - | The implementation we provided creates a bounding box around the TargetShape using the distance supplied and then queries the features inside of it. This may not be the most efficient method for this operation. If your underlying data provider exposes a more efficient way, we recommend you override the Core version of this method and implement it. | + | == Parameters == |
| + | * //targetFeature// | ||
| + | * Type:[[ThinkGeo.MapSuite.Core.Feature|Feature]] | ||
| + | * Description:N/A | ||
| - | The default implementation of GetFeaturesWithinDistanceOfCore uses the GetFeaturesInsideBoundingBoxCore method for speed. We strongly recommend that you provide your own implementation for this method that will be more efficient. When you override GetFeaturesInsideBoundingBoxCore method, we recommend that you use any spatial indexes you have at your disposal to make this method as fast as possible. | + | * //unitOfData// |
| + | * Type:[[ThinkGeo.MapSuite.Core.GeographyUnit|GeographyUnit]] | ||
| + | * Description:N/A | ||
| - | As this is a concrete public method that wraps a Core method, we reserve the right to add events and other logic to pre- or post-process data returned by the Core version of the method. In this way, we leave our framework open on our end, but also allow you the developer to extend our logic to suit your needs. If you have questions about this, please contact our support team as we would be happy to work with you on extending our framework. | + | * //maxItemsToFind// |
| - | === Return Value === | + | * Type:Int32 |
| - | ^ Return Type ^ Description ^ | + | * Description:N/A |
| - | | Collection<[[ThinkGeo.MapSuite.PortableCore.Feature|Feature]]><!-- System.Collections.ObjectModel.Collection{ThinkGeo.MapSuite.PortableCore.Feature} --> | This method returns a collection of InternalFeatures that are within a certain distance of the TargetShape. | | + | |
| - | === Parameters === | + | * //returningColumnNamesType// |
| - | ^ Name ^ Type ^ Description ^ | + | * Type:[[ThinkGeo.MapSuite.Core.ReturningColumnsType|ReturningColumnsType]] |
| - | | targetShape | [[ThinkGeo.MapSuite.PortableCore.BaseShape|BaseShape]]<!-- ThinkGeo.MapSuite.PortableCore.BaseShape --> | The shape you wish to find InternalFeatures within a distance of. | | + | * Description:N/A |
| - | | unitOfData | [[ThinkGeo.MapSuite.PortableCore.GeographyUnit|GeographyUnit]]<!-- ThinkGeo.MapSuite.PortableCore.GeographyUnit --> | This parameter is the unit of data that the FeatureSource and TargetShape are in. | | + | |
| - | | distanceUnit | [[ThinkGeo.MapSuite.PortableCore.DistanceUnit|DistanceUnit]]<!-- ThinkGeo.MapSuite.PortableCore.DistanceUnit --> | This parameter specifies the measurement unit for the distance parameter, such as feet, miles, kilometers, etc. | | + | |
| - | | distance | Double<!-- System.Double --> | This parameter specifies the distance in which to find InternalFeatures around the TargetShape. | | + | |
| - | | returningColumnNames | IEnumerable<String><!-- System.Collections.Generic.IEnumerable{System.String} --> | This parameter allows you to select the field names of the column data you wish to return with each Feature. | | + | |
| - | <!-- ThinkGeo.MapSuite.PortableCore.FeatureSource --> | + | <div newline></div> |
| - | [[#Public Methods|Go Back]] | + | ** {{wiki:PublicMethod.gif|}} GetFeaturesNearestTo(BaseShape,GeographyUnit,Int32,IEnumerable<String>,Double,DistanceUnit) ** |
| - | ==== GetFeaturesWithinDistanceOf(Feature, GeographyUnit, DistanceUnit, Double, ReturningColumnsType) ==== | + | |
| - | This method returns a collection of InternalFeatures that are within a certain distance of the TargetShape. | + | |
| - | === Remarks === | + | |
| - | This method returns a collection of InternalFeatures that are within a certain distance of the TargetShape. It is important to note that the TargetShape and the FeatureSource must use the same unit, such as feet or meters. If they do not, then the results will not be predictable or correct. If there is a current transaction and it is marked as live, then the results will include any transaction Feature that applies. | + | |
| - | The implementation we provided creates a bounding box around the TargetShape using the distance supplied and then queries the features inside of it. This may not be the most efficient method for this operation. If your underlying data provider exposes a more efficient way, we recommend you override the Core version of this method and implement it. | + | * //N/A// |
| + | == Remarks == | ||
| + | * //N/A// | ||
| - | The default implementation of GetFeaturesWithinDistanceOfCore uses the GetFeaturesInsideBoundingBoxCore method for speed. We strongly recommend that you provide your own implementation for this method that will be more efficient. When you override GetFeaturesInsideBoundingBoxCore method, we recommend that you use any spatial indexes you have at your disposal to make this method as fast as possible. | + | == Return Value == |
| - | === Return Value === | + | * Type:Collection<[[ThinkGeo.MapSuite.Core.Feature|Feature]]> |
| - | ^ Return Type ^ Description ^ | + | * Description:N/A |
| - | | Collection<[[ThinkGeo.MapSuite.PortableCore.Feature|Feature]]><!-- System.Collections.ObjectModel.Collection{ThinkGeo.MapSuite.PortableCore.Feature} --> | This method returns a collection of InternalFeatures that are within a certain distance of the TargetShape. | | + | |
| - | === Parameters === | + | == Parameters == |
| - | ^ Name ^ Type ^ Description ^ | + | * //targetShape// |
| - | | targetFeature | [[ThinkGeo.MapSuite.PortableCore.Feature|Feature]]<!-- ThinkGeo.MapSuite.PortableCore.Feature --> | The feature you wish to find InternalFeatures within a distance of. | | + | * Type:[[ThinkGeo.MapSuite.Core.BaseShape|BaseShape]] |
| - | | unitOfData | [[ThinkGeo.MapSuite.PortableCore.GeographyUnit|GeographyUnit]]<!-- ThinkGeo.MapSuite.PortableCore.GeographyUnit --> | This parameter is the unit of data that the FeatureSource and TargetShape are in. | | + | * Description:N/A |
| - | | distanceUnit | [[ThinkGeo.MapSuite.PortableCore.DistanceUnit|DistanceUnit]]<!-- ThinkGeo.MapSuite.PortableCore.DistanceUnit --> | This parameter specifies the measurement unit for the distance parameter, such as feet, miles, kilometers, etc. | | + | |
| - | | distance | Double<!-- System.Double --> | This parameter specifies the distance in which to find InternalFeatures around the TargetShape. | | + | |
| - | | returningColumnNamesType | [[ThinkGeo.MapSuite.PortableCore.ReturningColumnsType|ReturningColumnsType]]<!-- ThinkGeo.MapSuite.PortableCore.ReturningColumnsType --> | This parameter allows you to select a type from the ReturningColumnsType that you wish to return with each Feature. | | + | |
| - | <!-- ThinkGeo.MapSuite.PortableCore.FeatureSource --> | + | * //unitOfData// |
| - | [[#Public Methods|Go Back]] | + | * Type:[[ThinkGeo.MapSuite.Core.GeographyUnit|GeographyUnit]] |
| - | ==== GetFeaturesWithinDistanceOf(Feature, GeographyUnit, DistanceUnit, Double, IEnumerable<String>) ==== | + | * Description:N/A |
| - | This method returns a collection of InternalFeatures that are within a certain distance of the TargetShape. | + | |
| - | === Remarks === | + | |
| - | This method returns a collection of InternalFeatures that are within a certain distance of the TargetShape. It is important to note that the TargetShape and the FeatureSource must use the same unit, such as feet or meters. If they do not, then the results will not be predictable or correct. If there is a current transaction and it is marked as live, then the results will include any transaction Feature that applies. | + | |
| - | The implementation we provided creates a bounding box around the TargetShape using the distance supplied and then queries the features inside of it. This may not be the most efficient method for this operation. If your underlying data provider exposes a more efficient way, we recommend you override the Core version of this method and implement it. | + | * //maxItemsToFind// |
| + | * Type:Int32 | ||
| + | * Description:N/A | ||
| - | The default implementation of GetFeaturesWithinDistanceOfCore uses the GetFeaturesInsideBoundingBoxCore method for speed. We strongly recommend that you provide your own implementation for this method that will be more efficient. When you override GetFeaturesInsideBoundingBoxCore method, we recommend that you use any spatial indexes you have at your disposal to make this method as fast as possible. | + | * //returningColumnNames// |
| - | === Return Value === | + | * Type:IEnumerable<String> |
| - | ^ Return Type ^ Description ^ | + | * Description:N/A |
| - | | Collection<[[ThinkGeo.MapSuite.PortableCore.Feature|Feature]]><!-- System.Collections.ObjectModel.Collection{ThinkGeo.MapSuite.PortableCore.Feature} --> | This method returns a collection of InternalFeatures that are within a certain distance of the TargetShape. | | + | |
| - | === Parameters === | + | * //searchRadius// |
| - | ^ Name ^ Type ^ Description ^ | + | * Type:Double |
| - | | targetFeature | [[ThinkGeo.MapSuite.PortableCore.Feature|Feature]]<!-- ThinkGeo.MapSuite.PortableCore.Feature --> | The feature you wish to find InternalFeatures within a distance of. | | + | * Description:N/A |
| - | | unitOfData | [[ThinkGeo.MapSuite.PortableCore.GeographyUnit|GeographyUnit]]<!-- ThinkGeo.MapSuite.PortableCore.GeographyUnit --> | This parameter is the unit of data that the FeatureSource and TargetShape are in. | | + | |
| - | | distanceUnit | [[ThinkGeo.MapSuite.PortableCore.DistanceUnit|DistanceUnit]]<!-- ThinkGeo.MapSuite.PortableCore.DistanceUnit --> | This parameter specifies the measurement unit for the distance parameter, such as feet, miles, kilometers, etc. | | + | |
| - | | distance | Double<!-- System.Double --> | This parameter specifies the distance in which to find InternalFeatures around the TargetShape. | | + | |
| - | | returningColumnNames | IEnumerable<String><!-- System.Collections.Generic.IEnumerable{System.String} --> | This parameter allows you to select the field names of the column data you wish to return with each Feature. | | + | |
| - | <!-- ThinkGeo.MapSuite.PortableCore.FeatureSource --> | + | * //unitOfSearchRadius// |
| - | [[#Public Methods|Go Back]] | + | * Type:[[ThinkGeo.MapSuite.Core.DistanceUnit|DistanceUnit]] |
| - | ==== GetFeaturesWithinDistanceOf(BaseShape, GeographyUnit, DistanceUnit, Double, ReturningColumnsType) ==== | + | * Description:N/A |
| - | This method returns a collection of InternalFeatures that are within a certain distance of the TargetShape. | + | |
| - | === Remarks === | + | |
| - | This method returns a collection of InternalFeatures that are within a certain distance of the TargetShape. It is important to note that the TargetShape and the FeatureSource must use the same unit, such as feet or meters. If they do not, then the results will not be predictable or correct. If there is a current transaction and it is marked as live, then the results will include any transaction Feature that applies. | + | |
| - | The implementation we provided creates a bounding box around the TargetShape using the distance supplied and then queries the features inside of it. This may not be the most efficient method for this operation. If your underlying data provider exposes a more efficient way, we recommend you override the Core version of this method and implement it. | + | <div newline></div> |
| + | ** {{wiki:PublicMethod.gif|}} GetFeaturesNearestTo(Feature,GeographyUnit,Int32,IEnumerable<String>,Double,DistanceUnit) ** | ||
| - | The default implementation of GetFeaturesWithinDistanceOfCore uses the GetFeaturesInsideBoundingBoxCore method for speed. We strongly recommend that you provide your own implementation for this method that will be more efficient. When you override GetFeaturesInsideBoundingBoxCore method, we recommend that you use any spatial indexes you have at your disposal to make this method as fast as possible. | + | * //N/A// |
| - | === Return Value === | + | == Remarks == |
| - | ^ Return Type ^ Description ^ | + | * //N/A// |
| - | | Collection<[[ThinkGeo.MapSuite.PortableCore.Feature|Feature]]><!-- System.Collections.ObjectModel.Collection{ThinkGeo.MapSuite.PortableCore.Feature} --> | This method returns a collection of InternalFeatures that are within a certain distance of the TargetShape. | | + | |
| - | === Parameters === | + | == Return Value == |
| - | ^ Name ^ Type ^ Description ^ | + | * Type:Collection<[[ThinkGeo.MapSuite.Core.Feature|Feature]]> |
| - | | targetShape | [[ThinkGeo.MapSuite.PortableCore.BaseShape|BaseShape]]<!-- ThinkGeo.MapSuite.PortableCore.BaseShape --> | The shape you wish to find InternalFeatures within a distance of. | | + | * Description:N/A |
| - | | unitOfData | [[ThinkGeo.MapSuite.PortableCore.GeographyUnit|GeographyUnit]]<!-- ThinkGeo.MapSuite.PortableCore.GeographyUnit --> | This parameter is the unit of data that the FeatureSource and TargetShape are in. | | + | |
| - | | distanceUnit | [[ThinkGeo.MapSuite.PortableCore.DistanceUnit|DistanceUnit]]<!-- ThinkGeo.MapSuite.PortableCore.DistanceUnit --> | This parameter specifies the measurement unit for the distance parameter, such as feet, miles, kilometers, etc. | | + | |
| - | | distance | Double<!-- System.Double --> | This parameter specifies the distance in which to find InternalFeatures around the TargetShape. | | + | |
| - | | returningColumnNamesType | [[ThinkGeo.MapSuite.PortableCore.ReturningColumnsType|ReturningColumnsType]]<!-- ThinkGeo.MapSuite.PortableCore.ReturningColumnsType --> | This parameter allows you to select a type from the ReturningColumnsType that you wish to return with each Feature. | | + | |
| - | <!-- ThinkGeo.MapSuite.PortableCore.FeatureSource --> | + | == Parameters == |
| - | [[#Public Methods|Go Back]] | + | * //targetFeature// |
| - | ==== GetFirstFeaturesWellKnownType() ==== | + | * Type:[[ThinkGeo.MapSuite.Core.Feature|Feature]] |
| - | This method returns the well known type that represents the first feature from FeatureSource. | + | * Description:N/A |
| - | === Remarks === | + | |
| - | This method is the concrete wrapper for the virtual method GetFirstFeaturesWellKnownTypeCore. It will return whatever is returned by the GetFirstFeaturesWellKnownTypeCore method, along with any additions or subtractions made if you are in a transaction and that transaction is configured to be live. To determine what the default implementation of the abstract GetCountCore method is, please see the documentation for it. | + | |
| - | The default implementation of GetFirstFeaturesWellKnownTypeCore uses the GetAllFeaturesCore method to get WellKnownType of the first feature from all features. We strongly recommend that you provide your own implementation for this method that will be more efficient. | + | * //unitOfData// |
| + | * Type:[[ThinkGeo.MapSuite.Core.GeographyUnit|GeographyUnit]] | ||
| + | * Description:N/A | ||
| - | As this is a concrete public method that wraps a Core method, we reserve the right to add events and other logic to pre- or post-process data returned by the Core version of the method. In this way, we leave our framework open on our end, but also allow you the developer to extend our logic to suit your needs. If you have questions about this, please contact our support team as we would be happy to work with you on extending our framework. | + | * //maxItemsToFind// |
| - | === Return Value === | + | * Type:Int32 |
| - | ^ Return Type ^ Description ^ | + | * Description:N/A |
| - | | [[ThinkGeo.MapSuite.PortableCore.WellKnownType|WellKnownType]]<!-- ThinkGeo.MapSuite.PortableCore.WellKnownType --> | This method returns the well known type that represents the first feature from FeatureSource. | | + | |
| - | === Parameters === | + | * //returningColumnNames// |
| - | ^ Name ^ Type ^ Description ^ | + | * Type:IEnumerable<String> |
| + | * Description:N/A | ||
| - | <!-- ThinkGeo.MapSuite.PortableCore.FeatureSource --> | + | * //searchRadius// |
| - | [[#Public Methods|Go Back]] | + | * Type:Double |
| - | ==== GetHashCode() ==== | + | * Description:N/A |
| - | === Return Value === | + | |
| - | ^ Return Type ^ Description ^ | + | |
| - | | Int32<!-- System.Int32 --> | | | + | |
| - | === Parameters === | + | * //unitOfSearchRadius// |
| - | ^ Name ^ Type ^ Description ^ | + | * Type:[[ThinkGeo.MapSuite.Core.DistanceUnit|DistanceUnit]] |
| + | * Description:N/A | ||
| - | <!-- System.Object --> | + | <div newline></div> |
| - | [[#Public Methods|Go Back]] | + | ** {{wiki:PublicMethod.gif|}} GetFeaturesWithinDistanceOf(BaseShape,GeographyUnit,DistanceUnit,Double,IEnumerable<String>) ** |
| - | ==== GetType() ==== | + | |
| - | === Return Value === | + | |
| - | ^ Return Type ^ Description ^ | + | |
| - | | Type<!-- System.Type --> | | | + | |
| - | === Parameters === | + | * //N/A// |
| - | ^ Name ^ Type ^ Description ^ | + | == Remarks == |
| + | * //N/A// | ||
| - | <!-- System.Object --> | + | == Return Value == |
| - | [[#Public Methods|Go Back]] | + | * Type:Collection<[[ThinkGeo.MapSuite.Core.Feature|Feature]]> |
| - | ==== Open() ==== | + | * Description:N/A |
| - | This method opens the FeatureSource so that it is initialized and ready to use. | + | |
| - | === Remarks === | + | |
| - | This method is the concrete wrapper for the abstract method OpenCore. The Open method plays 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 the abstract method, consider opening files for file-based sources, 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. | + | == Parameters == |
| + | * //targetShape// | ||
| + | * Type:[[ThinkGeo.MapSuite.Core.BaseShape|BaseShape]] | ||
| + | * Description:N/A | ||
| - | As this is a concrete public method that wraps a Core method, we reserve the right to add events and other logic to pre- or post-process data returned by the Core version of the method. In this way, we leave our framework open on our end, but also allow you the developer to extend our logic to suit your needs. If you have questions about this, please contact our support team as we would be happy to work with you on extending our framework. | + | * //unitOfData// |
| - | === Return Value === | + | * Type:[[ThinkGeo.MapSuite.Core.GeographyUnit|GeographyUnit]] |
| - | ^ Return Type ^ Description ^ | + | * Description:N/A |
| - | | Void<!-- System.Void --> | | | + | |
| - | === Parameters === | + | * //distanceUnit// |
| - | ^ Name ^ Type ^ Description ^ | + | * Type:[[ThinkGeo.MapSuite.Core.DistanceUnit|DistanceUnit]] |
| + | * Description:N/A | ||
| - | <!-- ThinkGeo.MapSuite.PortableCore.FeatureSource --> | + | * //distance// |
| - | [[#Public Methods|Go Back]] | + | * Type:Double |
| - | ==== RefreshColumns() ==== | + | * Description:N/A |
| - | This method refresh the columns available for the FeatureSource and caches them. | + | |
| - | === Return Value === | + | |
| - | ^ Return Type ^ Description ^ | + | |
| - | | Void<!-- System.Void --> | This method refresh the columns available for the FeatureSource. | | + | |
| - | === Parameters === | + | * //returningColumnNames// |
| - | ^ Name ^ Type ^ Description ^ | + | * Type:IEnumerable<String> |
| + | * Description:N/A | ||
| - | <!-- ThinkGeo.MapSuite.PortableCore.FeatureSource --> | + | <div newline></div> |
| - | [[#Public Methods|Go Back]] | + | ** {{wiki:PublicMethod.gif|}} GetFeaturesWithinDistanceOf(BaseShape,GeographyUnit,DistanceUnit,Double,ReturningColumnsType) ** |
| - | ==== ReplaceNoDataValue(GridCell[[,|]], Double) ==== | + | |
| - | <!-- static --> | + | |
| - | === Return Value === | + | |
| - | ^ Return Type ^ Description ^ | + | |
| - | | [[ThinkGeo.MapSuite.PortableCore.GridCell[|GridCell[]],]<!-- ThinkGeo.MapSuite.PortableCore.GridCell[[,]] --> | | | + | |
| - | === Parameters === | + | * //N/A// |
| - | ^ Name ^ Type ^ Description ^ | + | == Remarks == |
| - | | gridMatrix | [[ThinkGeo.MapSuite.PortableCore.GridCell[|GridCell[]],]<!-- ThinkGeo.MapSuite.PortableCore.GridCell[[,]] --> | | | + | * //N/A// |
| - | | noDataValue | Double<!-- System.Double --> | | | + | |
| - | <!-- ThinkGeo.MapSuite.PortableCore.GridFeatureSource --> | + | == Return Value == |
| - | [[#Public Methods|Go Back]] | + | * Type:Collection<[[ThinkGeo.MapSuite.Core.Feature|Feature]]> |
| - | ==== ReplaceNoDataValue(GridCell[[,|]], Double, GridInterpolationModel) ==== | + | * Description:N/A |
| - | <!-- static --> | + | |
| - | === Return Value === | + | |
| - | ^ Return Type ^ Description ^ | + | |
| - | | [[ThinkGeo.MapSuite.PortableCore.GridCell[|GridCell[]],]<!-- ThinkGeo.MapSuite.PortableCore.GridCell[[,]] --> | | | + | |
| - | === Parameters === | + | == Parameters == |
| - | ^ Name ^ Type ^ Description ^ | + | * //targetShape// |
| - | | gridMatrix | [[ThinkGeo.MapSuite.PortableCore.GridCell[|GridCell[]],]<!-- ThinkGeo.MapSuite.PortableCore.GridCell[[,]] --> | | | + | * Type:[[ThinkGeo.MapSuite.Core.BaseShape|BaseShape]] |
| - | | noDataValue | Double<!-- System.Double --> | | | + | * Description:N/A |
| - | | gridInterpolationModel | [[ThinkGeo.MapSuite.PortableCore.GridInterpolationModel|GridInterpolationModel]]<!-- ThinkGeo.MapSuite.PortableCore.GridInterpolationModel --> | | | + | |
| - | <!-- ThinkGeo.MapSuite.PortableCore.GridFeatureSource --> | + | * //unitOfData// |
| - | [[#Public Methods|Go Back]] | + | * Type:[[ThinkGeo.MapSuite.Core.GeographyUnit|GeographyUnit]] |
| - | ==== RollbackTransaction() ==== | + | * Description:N/A |
| - | This method will cancel an existing transaction. It will free up the internal memory cache of any InternalFeatures added, updated or deleted. | + | |
| - | === Remarks === | + | |
| - | This method will cancel an existing transaction. It will free up the internal memory cache of any InternalFeatures added, updated or deleted. You will need to ensure that you have started a transaction by calling BeginTransaction. | + | |
| - | The Transaction System | + | * //distanceUnit// |
| + | * Type:[[ThinkGeo.MapSuite.Core.DistanceUnit|DistanceUnit]] | ||
| + | * Description:N/A | ||
| - | The 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 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 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. | + | * //distance// |
| + | * Type:Double | ||
| + | * Description:N/A | ||
| - | In the case where the IsLiveTransaction is set to true, then things function slightly differently. The live transaction concept means that all of the modifications you perform during a transaction are live from the standpoint of the querying methods on the object. | + | * //returningColumnNamesType// |
| + | * Type:[[ThinkGeo.MapSuite.Core.ReturningColumnsType|ReturningColumnsType]] | ||
| + | * Description:N/A | ||
| - | As 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, 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 would be considered live, though not committed. | + | <div newline></div> |
| + | ** {{wiki:PublicMethod.gif|}} GetFeaturesWithinDistanceOf(Feature,GeographyUnit,DistanceUnit,Double,IEnumerable<String>) ** | ||
| - | In the case where you modify records -- such as expanding the size of a polygon -- those changes are reflected as well. 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 instead would return the larger records. In this case, the larger records are returned. You can set this property to be false, as well; in which case, all of the spatially related methods would ignore anything that is currently in the transaction buffer waiting to be committed. In such a case, only after committing the transaction would the FeatureSource reflect the changes. | + | * //N/A// |
| - | === Return Value === | + | == Remarks == |
| - | ^ Return Type ^ Description ^ | + | * //N/A// |
| - | | Void<!-- System.Void --> | | | + | |
| - | === Parameters === | + | == Return Value == |
| - | ^ Name ^ Type ^ Description ^ | + | * Type:Collection<[[ThinkGeo.MapSuite.Core.Feature|Feature]]> |
| + | * Description:N/A | ||
| - | <!-- ThinkGeo.MapSuite.PortableCore.FeatureSource --> | + | == Parameters == |
| - | [[#Public Methods|Go Back]] | + | * //targetFeature// |
| - | ==== SpatialQuery(BaseShape, QueryType, IEnumerable<String>) ==== | + | * Type:[[ThinkGeo.MapSuite.Core.Feature|Feature]] |
| - | This method returns all of the InternalFeatures based on the target Feature and the spatial query type specified. | + | * Description:N/A |
| - | === Remarks === | + | |
| - | This method returns all of the InternalFeatures based on the target Feature and the spatial query type specified below. If there is a current transaction and it is marked as live, then the results will include any transaction Feature that applies. | + | |
| - | <strong>Spatial Query Types:</strong> | + | * //unitOfData// |
| + | * Type:[[ThinkGeo.MapSuite.Core.GeographyUnit|GeographyUnit]] | ||
| + | * Description:N/A | ||
| - | <strong>Disjoint</strong> - This method returns InternalFeatures where the specific Feature and the targetShape have no points in common. | + | * //distanceUnit// |
| + | * Type:[[ThinkGeo.MapSuite.Core.DistanceUnit|DistanceUnit]] | ||
| + | * Description:N/A | ||
| - | <strong>Intersects</strong> - This method returns InternalFeatures where the specific Feature and the targetShape have at least one point in common. | + | * //distance// |
| + | * Type:Double | ||
| + | * Description:N/A | ||
| - | <strong>Touches</strong> - This method returns InternalFeatures where the specific Feature and the targetShape have at least one boundary point in common, but no interior points. | + | * //returningColumnNames// |
| + | * Type:IEnumerable<String> | ||
| + | * Description:N/A | ||
| - | <strong>Crosses</strong> - This method returns InternalFeatures where the specific Feature and the targetShape share some but not all interior points. | + | <div newline></div> |
| + | ** {{wiki:PublicMethod.gif|}} GetFeaturesWithinDistanceOf(Feature,GeographyUnit,DistanceUnit,Double,ReturningColumnsType) ** | ||
| - | <strong>Within</strong> - This method returns InternalFeatures where the specific Feature lies within the interior of the targetShape. | + | * //N/A// |
| + | == Remarks == | ||
| + | * //N/A// | ||
| - | <strong>Contains</strong> - This method returns InternalFeatures where the specific Feature lies within the interior of the current shape. | + | == Return Value == |
| + | * Type:Collection<[[ThinkGeo.MapSuite.Core.Feature|Feature]]> | ||
| + | * Description:N/A | ||
| - | <strong>Overlaps</strong> - This method returns InternalFeatures where the specific Feature and the targetShape share some but not all points in common. | + | == Parameters == |
| + | * //targetFeature// | ||
| + | * Type:[[ThinkGeo.MapSuite.Core.Feature|Feature]] | ||
| + | * Description:N/A | ||
| - | <strong>TopologicalEqual</strong> - This method returns InternalFeatures where the specific Feature and the target Shape are topologically equal. | + | * //unitOfData// |
| + | * Type:[[ThinkGeo.MapSuite.Core.GeographyUnit|GeographyUnit]] | ||
| + | * Description:N/A | ||
| - | The default implementation of SpatialQueryCore uses the GetFeaturesInsideBoundingBoxCore method to pre-filter the spatial query. We strongly recommend that you provide your own implementation for this method that will be more efficient. When you override this method, we recommend that you use any spatial indexes you have at your disposal to make this method as fast as possible. | + | * //distanceUnit// |
| + | * Type:[[ThinkGeo.MapSuite.Core.DistanceUnit|DistanceUnit]] | ||
| + | * Description:N/A | ||
| - | As this is a concrete public method that wraps a Core method, we reserve the right to add events and other logic to pre- or post-process data returned by the Core version of the method. In this way, we leave our framework open on our end, but also allow you the developer to extend our logic to suit your needs. If you have questions about this, please contact our support team as we would be happy to work with you on extending our framework. | + | * //distance// |
| - | === Return Value === | + | * Type:Double |
| - | ^ Return Type ^ Description ^ | + | * Description:N/A |
| - | | Collection<[[ThinkGeo.MapSuite.PortableCore.Feature|Feature]]><!-- System.Collections.ObjectModel.Collection{ThinkGeo.MapSuite.PortableCore.Feature} --> | The returned decimalDegreesValue is a collection of InternalFeatures that match the spatial query you executed based on the TargetShape. | | + | |
| - | === Parameters === | + | * //returningColumnNamesType// |
| - | ^ Name ^ Type ^ Description ^ | + | * Type:[[ThinkGeo.MapSuite.Core.ReturningColumnsType|ReturningColumnsType]] |
| - | | targetShape | [[ThinkGeo.MapSuite.PortableCore.BaseShape|BaseShape]]<!-- ThinkGeo.MapSuite.PortableCore.BaseShape --> | This parameter specifies the target shape used in the spatial query. | | + | * Description:N/A |
| - | | queryType | [[ThinkGeo.MapSuite.PortableCore.QueryType|QueryType]]<!-- ThinkGeo.MapSuite.PortableCore.QueryType --> | This parameter specifies what kind of spatial query you wish to perform. | | + | |
| - | | returningColumnNames | IEnumerable<String><!-- System.Collections.Generic.IEnumerable{System.String} --> | This parameter allows you to select the field names of the column data you wish to return with each Feature. | | + | |
| - | <!-- ThinkGeo.MapSuite.PortableCore.FeatureSource --> | + | <div newline></div> |
| - | [[#Public Methods|Go Back]] | + | ** {{wiki:PublicMethod.gif|}} GetFeatureById(String,IEnumerable<String>) ** |
| - | ==== SpatialQuery(BaseShape, QueryType, ReturningColumnsType) ==== | + | |
| - | This method returns all of the InternalFeatures based on the target Feature and the spatial query type specified. | + | |
| - | === Remarks === | + | |
| - | This method returns all of the InternalFeatures based on the target Feature and the spatial query type specified below. If there is a current transaction and it is marked as live, then the results will include any transaction Feature that applies. | + | |
| - | <strong>Spatial Query Types:</strong> | + | * //N/A// |
| + | == Remarks == | ||
| + | * //N/A// | ||
| - | <strong>Disjoint</strong> - This method returns InternalFeatures where the specific Feature and the targetShape have no points in common. | + | == Return Value == |
| + | * Type:[[ThinkGeo.MapSuite.Core.Feature|Feature]] | ||
| + | * Description:N/A | ||
| - | <strong>Intersects</strong> - This method returns InternalFeatures where the specific Feature and the targetShape have at least one point in common. | + | == Parameters == |
| + | * //id// | ||
| + | * Type:String | ||
| + | * Description:N/A | ||
| - | <strong>Touches</strong> - This method returns InternalFeatures where the specific Feature and the targetShape have at least one boundary point in common, but no interior points. | + | * //returningColumnNames// |
| + | * Type:IEnumerable<String> | ||
| + | * Description:N/A | ||
| - | <strong>Crosses</strong> - This method returns InternalFeatures where the specific Feature and the targetShape share some but not all interior points. | + | <div newline></div> |
| + | ** {{wiki:PublicMethod.gif|}} GetFeatureById(String,ReturningColumnsType) ** | ||
| - | <strong>Within</strong> - This method returns InternalFeatures where the specific Feature lies within the interior of the targetShape. | + | * //N/A// |
| + | == Remarks == | ||
| + | * //N/A// | ||
| - | <strong>Contains</strong> - This method returns InternalFeatures where the specific Feature lies within the interior of the current shape. | + | == Return Value == |
| + | * Type:[[ThinkGeo.MapSuite.Core.Feature|Feature]] | ||
| + | * Description:N/A | ||
| - | <strong>Overlaps</strong> - This method returns InternalFeatures where the specific Feature and the targetShape share some but not all points in common. | + | == Parameters == |
| + | * //id// | ||
| + | * Type:String | ||
| + | * Description:N/A | ||
| - | <strong>TopologicalEqual</strong> - This method returns InternalFeatures where the specific Feature and the target Shape are topologically equal. | + | * //returningColumnNamesType// |
| + | * Type:[[ThinkGeo.MapSuite.Core.ReturningColumnsType|ReturningColumnsType]] | ||
| + | * Description:N/A | ||
| - | The default implementation of SpatialQueryCore uses the GetFeaturesInsideBoundingBoxCore method to pre-filter the spatial query. We strongly recommend that you provide your own implementation for this method that will be more efficient. When you override this method, we recommend that you use any spatial indexes you have at your disposal to make this method as fast as possible. | + | <div newline></div> |
| + | ** {{wiki:PublicMethod.gif|}} GetFeaturesByIds(IEnumerable<String>,IEnumerable<String>) ** | ||
| - | As this is a concrete public method that wraps a Core method, we reserve the right to add events and other logic to pre- or post-process data returned by the Core version of the method. In this way, we leave our framework open on our end, but also allow you the developer to extend our logic to suit your needs. If you have questions about this, please contact our support team as we would be happy to work with you on extending our framework. | + | * //N/A// |
| - | === Return Value === | + | == Remarks == |
| - | ^ Return Type ^ Description ^ | + | * //N/A// |
| - | | Collection<[[ThinkGeo.MapSuite.PortableCore.Feature|Feature]]><!-- System.Collections.ObjectModel.Collection{ThinkGeo.MapSuite.PortableCore.Feature} --> | The return decimalDegreesValue is a collection of InternalFeatures that match the spatial query you executed based on the TargetShape. | | + | |
| - | === Parameters === | + | == Return Value == |
| - | ^ Name ^ Type ^ Description ^ | + | * Type:Collection<[[ThinkGeo.MapSuite.Core.Feature|Feature]]> |
| - | | targetShape | [[ThinkGeo.MapSuite.PortableCore.BaseShape|BaseShape]]<!-- ThinkGeo.MapSuite.PortableCore.BaseShape --> | This parameter specifies the target shape used in the spatial query. | | + | * Description:N/A |
| - | | queryType | [[ThinkGeo.MapSuite.PortableCore.QueryType|QueryType]]<!-- ThinkGeo.MapSuite.PortableCore.QueryType --> | This parameter specifies what kind of spatial query you wish to perform. | | + | |
| - | | returningColumnNamesType | [[ThinkGeo.MapSuite.PortableCore.ReturningColumnsType|ReturningColumnsType]]<!-- ThinkGeo.MapSuite.PortableCore.ReturningColumnsType --> | This parameter allows you to select a type from the ReturningColumnsType that you wish to return with each Feature. | | + | |
| - | <!-- ThinkGeo.MapSuite.PortableCore.FeatureSource --> | + | == Parameters == |
| - | [[#Public Methods|Go Back]] | + | * //ids// |
| - | ==== SpatialQuery(Feature, QueryType, ReturningColumnsType) ==== | + | * Type:IEnumerable<String> |
| - | This method returns all of the InternalFeatures based on the target Feature and the spatial query type specified. | + | * Description:N/A |
| - | === Remarks === | + | |
| - | This method returns all of the InternalFeatures based on the target Feature and the spatial query type specified below. If there is a current transaction and it is marked as live, then the results will include any transaction Feature that applies. | + | |
| - | <strong>Spatial Query Types:</strong> | + | * //returningColumnNames// |
| + | * Type:IEnumerable<String> | ||
| + | * Description:N/A | ||
| - | <strong>Disjoint</strong> - This method returns InternalFeatures where the specific Feature and the targetShape have no points in common. | + | <div newline></div> |
| + | ** {{wiki:PublicMethod.gif|}} GetFeaturesByIds(IEnumerable<String>,ReturningColumnsType) ** | ||
| - | <strong>Intersects</strong> - This method returns InternalFeatures where the specific Feature and the targetShape have at least one point in common. | + | * //N/A// |
| + | == Remarks == | ||
| + | * //N/A// | ||
| - | <strong>Touches</strong> - This method returns InternalFeatures where the specific Feature and the targetShape have at least one boundary point in common, but no interior points. | + | == Return Value == |
| + | * Type:Collection<[[ThinkGeo.MapSuite.Core.Feature|Feature]]> | ||
| + | * Description:N/A | ||
| - | <strong>Crosses</strong> - This method returns InternalFeatures where the specific Feature and the targetShape share some but not all interior points. | + | == Parameters == |
| + | * //ids// | ||
| + | * Type:IEnumerable<String> | ||
| + | * Description:N/A | ||
| - | <strong>Within</strong> - This method returns InternalFeatures where the specific Feature lies within the interior of the targetShape. | + | * //returningColumnNamesType// |
| + | * Type:[[ThinkGeo.MapSuite.Core.ReturningColumnsType|ReturningColumnsType]] | ||
| + | * Description:N/A | ||
| - | <strong>Contains</strong> - This method returns InternalFeatures where the specific Feature lies within the interior of the current shape. | + | <div newline></div> |
| + | ** {{wiki:PublicMethod.gif|}} GetBoundingBoxById(String) ** | ||
| - | <strong>Overlaps</strong> - This method returns InternalFeatures where the specific Feature and the targetShape share some but not all points in common. | + | * //N/A// |
| + | == Remarks == | ||
| + | * //N/A// | ||
| - | <strong>TopologicalEqual</strong> - This method returns InternalFeatures where the specific Feature and the target Shape are topologically equal. | + | == Return Value == |
| + | * Type:[[ThinkGeo.MapSuite.Core.RectangleShape|RectangleShape]] | ||
| + | * Description:N/A | ||
| - | The default implementation of SpatialQueryCore uses the GetFeaturesInsideBoundingBoxCore method to pre-filter the spatial query. We strongly recommend that you provide your own implementation for this method that will be more efficient. When you override this method, we recommend that you use any spatial indexes you have at your disposal to make this method as fast as possible. | + | == Parameters == |
| + | * //id// | ||
| + | * Type:String | ||
| + | * Description:N/A | ||
| - | As this is a concrete public method that wraps a Core method, we reserve the right to add events and other logic to pre- or post-process data returned by the Core version of the method. In this way, we leave our framework open on our end, but also allow you the developer to extend our logic to suit your needs. If you have questions about this, please contact our support team as we would be happy to work with you on extending our framework. | + | <div newline></div> |
| - | === Return Value === | + | ** {{wiki:PublicMethod.gif|}} ExecuteNonQuery(String) ** |
| - | ^ Return Type ^ Description ^ | + | |
| - | | Collection<[[ThinkGeo.MapSuite.PortableCore.Feature|Feature]]><!-- System.Collections.ObjectModel.Collection{ThinkGeo.MapSuite.PortableCore.Feature} --> | The returned decimalDegreesValue is a collection of InternalFeatures that match the spatial query you executed based on the TargetShape. | | + | |
| - | === Parameters === | + | * //N/A// |
| - | ^ Name ^ Type ^ Description ^ | + | == Remarks == |
| - | | feature | [[ThinkGeo.MapSuite.PortableCore.Feature|Feature]]<!-- ThinkGeo.MapSuite.PortableCore.Feature --> | This parameter specifies the target feature used in the spatial query. | | + | * //N/A// |
| - | | queryType | [[ThinkGeo.MapSuite.PortableCore.QueryType|QueryType]]<!-- ThinkGeo.MapSuite.PortableCore.QueryType --> | This parameter specifies what kind of spatial query you wish to perform. | | + | |
| - | | returningColumnNamesType | [[ThinkGeo.MapSuite.PortableCore.ReturningColumnsType|ReturningColumnsType]]<!-- ThinkGeo.MapSuite.PortableCore.ReturningColumnsType --> | This parameter allows you to select a type from the ReturningColumnsType that you wish to return with each Feature. | | + | |
| - | <!-- ThinkGeo.MapSuite.PortableCore.FeatureSource --> | + | == Return Value == |
| - | [[#Public Methods|Go Back]] | + | * Type:Int32 |
| - | ==== SpatialQuery(Feature, QueryType, IEnumerable<String>) ==== | + | * Description:N/A |
| - | This method returns all of the InternalFeatures based on the target Feature and the spatial query type specified. | + | |
| - | === Remarks === | + | |
| - | This method returns all of the InternalFeatures based on the target Feature and the spatial query type specified below. If there is a current transaction and it is marked as live, then the results will include any transaction Feature that applies. | + | |
| - | <strong>Spatial Query Types:</strong> | + | == Parameters == |
| + | * //sqlStatement// | ||
| + | * Type:String | ||
| + | * Description:N/A | ||
| - | <strong>Disjoint</strong> - This method returns InternalFeatures where the specific Feature and the targetShape have no points in common. | + | <div newline></div> |
| + | ** {{wiki:PublicMethod.gif|}} GetFeaturesByColumnValue(String,String,ReturningColumnsType) ** | ||
| - | <strong>Intersects</strong> - This method returns InternalFeatures where the specific Feature and the targetShape have at least one point in common. | + | * //N/A// |
| + | == Remarks == | ||
| + | * //N/A// | ||
| - | <strong>Touches</strong> - This method returns InternalFeatures where the specific Feature and the targetShape have at least one boundary point in common, but no interior points. | + | == Return Value == |
| + | * Type:Collection<[[ThinkGeo.MapSuite.Core.Feature|Feature]]> | ||
| + | * Description:N/A | ||
| - | <strong>Crosses</strong> - This method returns InternalFeatures where the specific Feature and the targetShape share some but not all interior points. | + | == Parameters == |
| + | * //columnName// | ||
| + | * Type:String | ||
| + | * Description:N/A | ||
| - | <strong>Within</strong> - This method returns InternalFeatures where the specific Feature lies within the interior of the targetShape. | + | * //columnValue// |
| + | * Type:String | ||
| + | * Description:N/A | ||
| - | <strong>Contains</strong> - This method returns InternalFeatures where the specific Feature lies within the interior of the current shape. | + | * //returningColumnType// |
| + | * Type:[[ThinkGeo.MapSuite.Core.ReturningColumnsType|ReturningColumnsType]] | ||
| + | * Description:N/A | ||
| - | <strong>Overlaps</strong> - This method returns InternalFeatures where the specific Feature and the targetShape share some but not all points in common. | + | <div newline></div> |
| + | ** {{wiki:PublicMethod.gif|}} GetFeaturesByColumnValue(String,String,IEnumerable<String>) ** | ||
| - | <strong>TopologicalEqual</strong> - This method returns InternalFeatures where the specific Feature and the target Shape are topologically equal. | + | * //N/A// |
| + | == Remarks == | ||
| + | * //N/A// | ||
| - | The default implementation of SpatialQueryCore uses the GetFeaturesInsideBoundingBoxCore method to pre-filter the spatial query. We strongly recommend that you provide your own implementation for this method that will be more efficient. When you override this method, we recommend that you use any spatial indexes you have at your disposal to make this method as fast as possible. | + | == Return Value == |
| + | * Type:Collection<[[ThinkGeo.MapSuite.Core.Feature|Feature]]> | ||
| + | * Description:N/A | ||
| - | As this is a concrete public method that wraps a Core method, we reserve the right to add events and other logic to pre- or post-process data returned by the Core version of the method. In this way, we leave our framework open on our end, but also allow you the developer to extend our logic to suit your needs. If you have questions about this, please contact our support team as we would be happy to work with you on extending our framework. | + | == Parameters == |
| - | === Return Value === | + | * //columnName// |
| - | ^ Return Type ^ Description ^ | + | * Type:String |
| - | | Collection<[[ThinkGeo.MapSuite.PortableCore.Feature|Feature]]><!-- System.Collections.ObjectModel.Collection{ThinkGeo.MapSuite.PortableCore.Feature} --> | The returned decimalDegreesValue is a collection of InternalFeatures that match the spatial query you executed based on the TargetShape. | | + | * Description:N/A |
| - | === Parameters === | + | * //columnValue// |
| - | ^ Name ^ Type ^ Description ^ | + | * Type:String |
| - | | feature | [[ThinkGeo.MapSuite.PortableCore.Feature|Feature]]<!-- ThinkGeo.MapSuite.PortableCore.Feature --> | This parameter specifies the target feature used in the spatial query. | | + | * Description:N/A |
| - | | queryType | [[ThinkGeo.MapSuite.PortableCore.QueryType|QueryType]]<!-- ThinkGeo.MapSuite.PortableCore.QueryType --> | This parameter specifies what kind of spatial query you wish to perform. | | + | |
| - | | returningColumnNames | IEnumerable<String><!-- System.Collections.Generic.IEnumerable{System.String} --> | This parameter allows you to select the field names of the column data you wish to return with each Feature. | | + | |
| - | <!-- ThinkGeo.MapSuite.PortableCore.FeatureSource --> | + | * //returningColumnNames// |
| - | [[#Public Methods|Go Back]] | + | * Type:IEnumerable<String> |
| - | ==== ToString() ==== | + | * Description:N/A |
| - | === Return Value === | + | |
| - | ^ Return Type ^ Description ^ | + | |
| - | | String<!-- System.String --> | | | + | |
| - | === Parameters === | + | <div newline></div> |
| - | ^ Name ^ Type ^ Description ^ | + | ** {{wiki:PublicMethod.gif|}} GetFeaturesByColumnValue(String,String) ** |
| - | <!-- System.Object --> | + | * //N/A// |
| - | [[#Public Methods|Go Back]] | + | == Remarks == |
| - | ==== UpdateColumn(String, FeatureSourceColumn) ==== | + | * //N/A// |
| - | === Return Value === | + | |
| - | ^ Return Type ^ Description ^ | + | |
| - | | Void<!-- System.Void --> | | | + | |
| - | === Parameters === | + | == Return Value == |
| - | ^ Name ^ Type ^ Description ^ | + | * Type:Collection<[[ThinkGeo.MapSuite.Core.Feature|Feature]]> |
| - | | columnName | String<!-- System.String --> | | | + | * Description:N/A |
| - | | newFeatureSourceColumn | [[ThinkGeo.MapSuite.PortableCore.FeatureSourceColumn|FeatureSourceColumn]]<!-- ThinkGeo.MapSuite.PortableCore.FeatureSourceColumn --> | | | + | |
| - | <!-- ThinkGeo.MapSuite.PortableCore.FeatureSource --> | + | == Parameters == |
| - | [[#Public Methods|Go Back]] | + | * //columnName// |
| - | ==== UpdateFeature(Feature) ==== | + | * Type:String |
| - | This method updates a Feature in an existing transaction. | + | * Description:N/A |
| - | === Remarks === | + | |
| - | This method updates a Feature in an existing transaction. You will need to ensure that you have started a transaction by calling the BeginTransaction. | + | |
| - | The Transaction System | + | * //columnValue// |
| + | * Type:String | ||
| + | * Description:N/A | ||
| - | The 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 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 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. | + | <div newline></div> |
| + | ** {{wiki:PublicMethod.gif|}} ExecuteScalar(String) ** | ||
| - | In the case where the IsLiveTransaction is set to true, then things function slightly differently. The live transaction concept means that all of the modifications you perform during a transaction are live from the standpoint of the querying methods on the object. | + | * //N/A// |
| + | == Remarks == | ||
| + | * //N/A// | ||
| - | As 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, 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 would be considered live, though not committed. | + | == Return Value == |
| + | * Type:Object | ||
| + | * Description:N/A | ||
| - | In the case where you modify records -- such as expanding the size of a polygon -- those changes are reflected as well. 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 instead would return the larger records. In this case, the larger records are returned. You can set this property to be false, as well; in which case, all of the spatially related methods would ignore anything that is currently in the transaction buffer waiting to be committed. In such a case, only after committing the transaction would the FeatureSource reflect the changes. | + | == Parameters == |
| - | === Return Value === | + | * //sqlStatement// |
| - | ^ Return Type ^ Description ^ | + | * Type:String |
| - | | Void<!-- System.Void --> | | | + | * Description:N/A |
| - | === Parameters === | + | <div newline></div> |
| - | ^ Name ^ Type ^ Description ^ | + | ** {{wiki:PublicMethod.gif|}} ExecuteQuery(String) ** |
| - | | feature | [[ThinkGeo.MapSuite.PortableCore.Feature|Feature]]<!-- ThinkGeo.MapSuite.PortableCore.Feature --> | The Feature you wish to update in the transaction. | | + | |
| - | <!-- ThinkGeo.MapSuite.PortableCore.FeatureSource --> | + | * //N/A// |
| - | [[#Public Methods|Go Back]] | + | == Remarks == |
| - | ==== UpdateFeature(BaseShape, IDictionary<String, String>) ==== | + | * //N/A// |
| - | This method updates a Feature (composed of the passed-in BaseShape) in an existing transaction. | + | |
| - | === Remarks === | + | |
| - | This method updates a Feature (composed of the passed in BaseShape) in an existing transaction. You will need to ensure that you have started a transaction by calling BeginTransaction. | + | |
| - | The Transaction System | + | == Return Value == |
| + | * Type:[[ThinkGeo.MapSuite.Portable.GeoDataTable|GeoDataTable]] | ||
| + | * Description:N/A | ||
| - | The 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 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 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. | + | == Parameters == |
| + | * //sqlStatement// | ||
| + | * Type:String | ||
| + | * Description:N/A | ||
| - | In the case where the IsLiveTransaction is set to true, then things function slightly differently. The live transaction concept means that all of the modifications you perform during a transaction are live from the standpoint of the querying methods on the object. | + | <div newline></div> |
| + | ** {{wiki:PublicMethod.gif|}} GetColumns() ** | ||
| - | As 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, 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 would be considered live, though not committed. | + | * //N/A// |
| + | == Remarks == | ||
| + | * //N/A// | ||
| - | In the case where you modify records -- such as expanding the size of a polygon -- those changes are reflected as well. 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 instead would return the larger records. In this case, the larger records are returned. You can set this property to be false, as well; in which case, all of the spatially related methods would ignore anything that is currently in the transaction buffer waiting to be committed. In such a case, only after committing the transaction would the FeatureSource reflect the changes. | + | == Return Value == |
| - | === Return Value === | + | * Type:Collection<[[ThinkGeo.MapSuite.Core.FeatureSourceColumn|FeatureSourceColumn]]> |
| - | ^ Return Type ^ Description ^ | + | * Description:N/A |
| - | | Void<!-- System.Void --> | | | + | |
| - | === Parameters === | + | == Parameters == |
| - | ^ Name ^ Type ^ Description ^ | + | <div newline></div> |
| - | | shape | [[ThinkGeo.MapSuite.PortableCore.BaseShape|BaseShape]]<!-- ThinkGeo.MapSuite.PortableCore.BaseShape --> | The shape that will be used to make the new Feature that you wish to update in the transaction. | | + | ** {{wiki:PublicMethod.gif|}} RefreshColumns() ** |
| - | | columnValues | IDictionary<String,String><!-- System.Collections.Generic.IDictionary{System.String,System.String} --> | This parameter represents the columnValues for the new features that will be added to the transaction. | | + | |
| - | <!-- ThinkGeo.MapSuite.PortableCore.FeatureSource --> | + | * //N/A// |
| - | [[#Public Methods|Go Back]] | + | == Remarks == |
| - | ==== UpdateFeature(BaseShape) ==== | + | * //N/A// |
| - | This method updates a Feature (composed of the passed-in BaseShape) in an existing transaction. | + | |
| - | === Remarks === | + | |
| - | This method updates a Feature (composed of the passed-in BaseShape) in an existing transaction. You will need to ensure that you have started a transaction by calling BeginTransaction. | + | |
| - | The Transaction System | + | == Return Value == |
| + | * Type:Void | ||
| + | * Description:N/A | ||
| - | The 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 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 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. | + | == Parameters == |
| + | <div newline></div> | ||
| + | ** {{wiki:PublicMethod.gif|}} GetCount() ** | ||
| - | In the case where the IsLiveTransaction is set to true, then things function slightly differently. The live transaction concept means that all of the modifications you perform during a transaction are live from the standpoint of the querying methods on the object. | + | * //N/A// |
| + | == Remarks == | ||
| + | * //N/A// | ||
| - | As 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, 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 would be considered live, though not committed. | + | == Return Value == |
| + | * Type:Int32 | ||
| + | * Description:N/A | ||
| - | In the case where you modify records -- such as expanding the size of a polygon -- those changes are reflected as well. 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 instead would return the larger records. In this case, the larger records are returned. You can set this property to be false, as well; in which case, all of the spatially related methods would ignore anything that is currently in the transaction buffer waiting to be committed. In such a case, only after committing the transaction would the FeatureSource reflect the changes. | + | == Parameters == |
| - | === Return Value === | + | <div newline></div> |
| - | ^ Return Type ^ Description ^ | + | ** {{wiki:PublicMethod.gif|}} GetBoundingBox() ** |
| - | | Void<!-- System.Void --> | | | + | |
| - | === Parameters === | + | * //N/A// |
| - | ^ Name ^ Type ^ Description ^ | + | == Remarks == |
| - | | shape | [[ThinkGeo.MapSuite.PortableCore.BaseShape|BaseShape]]<!-- ThinkGeo.MapSuite.PortableCore.BaseShape --> | The shape that will be used to make the new Feature that you wish to update in the transaction. | | + | * //N/A// |
| - | <!-- ThinkGeo.MapSuite.PortableCore.FeatureSource --> | + | == Return Value == |
| - | [[#Public Methods|Go Back]] | + | * Type:[[ThinkGeo.MapSuite.Core.RectangleShape|RectangleShape]] |
| - | ===== Protected Methods ===== | + | * Description:N/A |
| - | ==== CanGetBoundingBoxQuicklyCore() ==== | + | |
| - | === Return Value === | + | |
| - | ^ Return Type ^ Description ^ | + | |
| - | | Boolean<!-- System.Boolean --> | | | + | |
| - | === Parameters === | + | == Parameters == |
| - | ^ Name ^ Type ^ Description ^ | + | <div newline></div> |
| + | ** {{wiki:PublicMethod.gif|}} CloneDeep() ** | ||
| - | <!-- ThinkGeo.MapSuite.PortableCore.FeatureSource(overriden) --> | + | * //N/A// |
| - | [[#Protected Methods|Go Back]] | + | == Remarks == |
| - | ==== CanGetCountQuicklyCore() ==== | + | * //N/A// |
| - | === Return Value === | + | |
| - | ^ Return Type ^ Description ^ | + | |
| - | | Boolean<!-- System.Boolean --> | | | + | |
| - | === Parameters === | + | == Return Value == |
| - | ^ Name ^ Type ^ Description ^ | + | * Type:[[ThinkGeo.MapSuite.Core.FeatureSource|FeatureSource]] |
| + | * Description:N/A | ||
| - | <!-- ThinkGeo.MapSuite.PortableCore.FeatureSource --> | + | == Parameters == |
| - | [[#Protected Methods|Go Back]] | + | <div newline></div> |
| - | ==== CloneDeepCore() ==== | + | ** {{wiki:PublicMethod.gif|}} Open() ** |
| - | Create a copy of a FeatureSource using the deep clone process. The default implementation uses serialization. | + | |
| - | === Remarks === | + | |
| - | The difference between deep clone and shallow clone is as follows: In shallow cloning, only the object is copied; the objects within it are not. By contrast, deep cloning copies the cloned object as well as all the objects within. | + | |
| - | === Return Value === | + | |
| - | ^ Return Type ^ Description ^ | + | |
| - | | [[ThinkGeo.MapSuite.PortableCore.FeatureSource|FeatureSource]]<!-- ThinkGeo.MapSuite.PortableCore.FeatureSource --> | A cloned FeatureSource. | | + | |
| - | === Parameters === | + | * //N/A// |
| - | ^ Name ^ Type ^ Description ^ | + | == Remarks == |
| + | * //N/A// | ||
| - | <!-- ThinkGeo.MapSuite.PortableCore.FeatureSource --> | + | == Return Value == |
| - | [[#Protected Methods|Go Back]] | + | * Type:Void |
| - | ==== CloseCore() ==== | + | * Description:N/A |
| - | This method closes the FeatureSource and releases any resources it was using. | + | |
| - | === 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. | + | == Parameters == |
| - | === Return Value === | + | <div newline></div> |
| - | ^ Return Type ^ Description ^ | + | ** {{wiki:PublicMethod.gif|}} ToString() ** |
| - | | Void<!-- System.Void --> | | | + | |
| - | === Parameters === | + | * //N/A// |
| - | ^ Name ^ Type ^ Description ^ | + | == Remarks == |
| + | * //N/A// | ||
| - | <!-- ThinkGeo.MapSuite.PortableCore.FeatureSource(overriden) --> | + | == Return Value == |
| - | [[#Protected Methods|Go Back]] | + | * Type:String |
| - | ==== CommitTransactionCore(TransactionBuffer) ==== | + | * Description:N/A |
| - | 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 System | + | == Parameters == |
| + | <div newline></div> | ||
| + | ** {{wiki:PublicMethod.gif|}} Equals(Object) ** | ||
| - | The 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. | + | * //N/A// |
| + | == Remarks == | ||
| + | * //N/A// | ||
| - | 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. | + | == Return Value == |
| + | * Type:Boolean | ||
| + | * Description:N/A | ||
| - | 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. | + | == Parameters == |
| + | * //obj// | ||
| + | * Type:Object | ||
| + | * Description:N/A | ||
| - | 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. | + | <div newline></div> |
| - | === Return Value === | + | ** {{wiki:PublicMethod.gif|}} GetHashCode() ** |
| - | ^ Return Type ^ Description ^ | + | |
| - | | [[ThinkGeo.MapSuite.PortableCore.TransactionResult|TransactionResult]]<!-- ThinkGeo.MapSuite.PortableCore.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 === | + | * //N/A// |
| - | ^ Name ^ Type ^ Description ^ | + | == Remarks == |
| - | | transactions | [[ThinkGeo.MapSuite.PortableCore.TransactionBuffer|TransactionBuffer]]<!-- ThinkGeo.MapSuite.PortableCore.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. | | + | * //N/A// |
| - | <!-- ThinkGeo.MapSuite.PortableCore.FeatureSource(overriden) --> | + | == Return Value == |
| - | [[#Protected Methods|Go Back]] | + | * Type:Int32 |
| - | ==== ConvertToExternalProjection(RectangleShape) ==== | + | * Description:N/A |
| - | This method projects items based on the Projection of the FeatureSource. | + | |
| - | === Remarks === | + | |
| - | This is a protected method that is intended to help developers who want to implement or extend one of our FeatureSources. It is important to note that projection, as a general rule, happens inside the non-Core methods and we usually take care of it. However, as a developer, if you wish to add a new public method, then you will need to handle the projection yourself. | + | |
| - | With these projection methods it is very easy to handle the projection and de-projection. Remember that when adding your own public methods you always de-project incoming shapes and alway project outgoing shapes. Also remember that the Core methods do not consider projection, and they assume the data being passed into them and out of them is the same unit as the underlying data. | + | == Parameters == |
| + | <div newline></div> | ||
| + | ** {{wiki:PublicMethod.gif|}} GetType() ** | ||
| - | Example of a New Public Method: | + | * //N/A// |
| + | == Remarks == | ||
| + | * //N/A// | ||
| - | public Feature ProcessFeature(Feature incomingFeature) | + | == Return Value == |
| - | { | + | * Type:Type |
| + | * Description:N/A | ||
| - | <nowiki>//</nowiki>Be sure that you use the FromProjection on the incomingFeatureParameter as the first thing you do in this method. | + | == Parameters == |
| + | <div newline></div> | ||
| + | ** {{wiki:PublicMethod.gif|}}{{wiki:Static.gif|}} GenerateGridMatrix(GridDefinition,GridInterpolationModel) ** | ||
| - | <nowiki>//</nowiki> Call a Core Method or do your own processing | + | * //This method calculates all the cells in the grid and returns the result in the form of the GridCell matrix// |
| + | == Remarks == | ||
| + | * //N/A// | ||
| - | <nowiki>//</nowiki>Be sure that you call the ToProjection on the return result of the method before you pass it out. | + | == Return Value == |
| + | * Type:[[ThinkGeo.MapSuite.Core.GridCell[,]|GridCell[,]]] | ||
| + | * Description:This method returns the GridCell matrix which is calculated based on the input parameters. | ||
| - | } | + | == Parameters == |
| - | === Return Value === | + | * //gridDefinition// |
| - | ^ Return Type ^ Description ^ | + | * Type:[[ThinkGeo.MapSuite.Core.GridDefinition|GridDefinition]] |
| - | | [[ThinkGeo.MapSuite.PortableCore.RectangleShape|RectangleShape]]<!-- ThinkGeo.MapSuite.PortableCore.RectangleShape --> | This method projects a RectangleShape based on the Projection of the FeatureSource. | | + | * Description:This parameter contains the properties used to describe the grid. |
| - | === Parameters === | + | * //gridInterpolationModel// |
| - | ^ Name ^ Type ^ Description ^ | + | * Type:[[ThinkGeo.MapSuite.Core.GridInterpolationModel|GridInterpolationModel]] |
| - | | rectangle | [[ThinkGeo.MapSuite.PortableCore.RectangleShape|RectangleShape]]<!-- ThinkGeo.MapSuite.PortableCore.RectangleShape --> | This parameter represents the rectangle you wish to project. | | + | * Description:This parameter represents the interpolation model for calculating cell value of the grid |
| - | <!-- ThinkGeo.MapSuite.PortableCore.FeatureSource --> | + | <div newline></div> |
| - | [[#Protected Methods|Go Back]] | + | ** {{wiki:PublicMethod.gif|}}{{wiki:Static.gif|}} ReplaceNoDataValue(GridCell[,],Double) ** |
| - | ==== ConvertToExternalProjection(IEnumerable<Feature>) ==== | + | |
| - | This method projects items based on the Projection of the FeatureSource. | + | |
| - | === Remarks === | + | |
| - | This is a protected method that is intended to help developers who want to implement or extend one of our FeatureSources. It is important to note that projection, as a general rule, happens inside the non-Core methods and we usually take care of it. However, as a developer, if you wish to add a new public method, then you will need to handle the projection yourself. | + | |
| - | With these projection methods it is very easy to handle the projection and de-projection. Remember that when adding your own public methods you always de-project incoming shapes and alway project outgoing shapes. Also remember that the Core methods do not consider projection, and they assume the data being passed into them and out of them is the same unit as the underlying data. | + | * //N/A// |
| + | == Remarks == | ||
| + | * //N/A// | ||
| - | Example of a New Public Method: | + | == Return Value == |
| + | * Type:[[ThinkGeo.MapSuite.Core.GridCell[,]|GridCell[,]]] | ||
| + | * Description:N/A | ||
| - | public Feature ProcessFeature(Feature incomingFeature) | + | == Parameters == |
| - | { | + | * //gridMatrix// |
| + | * Type:[[ThinkGeo.MapSuite.Core.GridCell[,]|GridCell[,]]] | ||
| + | * Description:N/A | ||
| - | <nowiki>//</nowiki>Be sure that you use the FromProjection on the incomingFeatureParameter as the first thing you do in this method. | + | * //noDataValue// |
| + | * Type:Double | ||
| + | * Description:N/A | ||
| - | <nowiki>//</nowiki> Call a Core Method or do your own processing | + | <div newline></div> |
| + | ** {{wiki:PublicMethod.gif|}}{{wiki:Static.gif|}} ReplaceNoDataValue(GridCell[,],Double,GridInterpolationModel) ** | ||
| - | <nowiki>//</nowiki>Be sure that you call the ToProjection on the return result of the method before you pass it out. | + | * //N/A// |
| + | == Remarks == | ||
| + | * //N/A// | ||
| - | } | + | == Return Value == |
| - | === Return Value === | + | * Type:[[ThinkGeo.MapSuite.Core.GridCell[,]|GridCell[,]]] |
| - | ^ Return Type ^ Description ^ | + | * Description:N/A |
| - | | Collection<[[ThinkGeo.MapSuite.PortableCore.Feature|Feature]]><!-- System.Collections.ObjectModel.Collection{ThinkGeo.MapSuite.PortableCore.Feature} --> | This method projects a Feature based on the Projection of the FeatureSource. | | + | |
| - | === Parameters === | + | == Parameters == |
| - | ^ Name ^ Type ^ Description ^ | + | * //gridMatrix// |
| - | | features | IEnumerable<[[ThinkGeo.MapSuite.PortableCore.Feature|Feature]]><!-- System.Collections.Generic.IEnumerable{ThinkGeo.MapSuite.PortableCore.Feature} --> | This parameter represents a group of Features that you wish to project. | | + | * Type:[[ThinkGeo.MapSuite.Core.GridCell[,]|GridCell[,]]] |
| + | * Description:N/A | ||
| - | <!-- ThinkGeo.MapSuite.PortableCore.FeatureSource --> | + | * //noDataValue// |
| - | [[#Protected Methods|Go Back]] | + | * Type:Double |
| - | ==== ConvertToExternalProjection(IEnumerable<RectangleShape>) ==== | + | * Description:N/A |
| - | This method projects items based on the Projection of the FeatureSource. | + | |
| - | === Remarks === | + | |
| - | This is a protected method that is intended to help developers who want to implement or extend one of our FeatureSources. It is important to note that projection, as a general rule, happens inside the non-Core methods and we usually take care of it. However, as a developer, if you wish to add a new public method, then you will need to handle the projection yourself. | + | |
| - | With these projection methods it is very easy to handle the projection and de-projection. Remember that when adding your own public methods you always de-project incoming shapes and alway project outgoing shapes. Also remember that the Core methods do not consider projection, and they assume the data being passed into them and out of them is the same unit as the underlying data. | + | * //gridInterpolationModel// |
| + | * Type:[[ThinkGeo.MapSuite.Core.GridInterpolationModel|GridInterpolationModel]] | ||
| + | * Description:N/A | ||
| - | Example of a New Public Method: | + | <div newline></div> |
| + | ** {{wiki:PublicMethod.gif|}}{{wiki:Static.gif|}} GenerateGrid(GridDefinition,GridInterpolationModel,Stream) ** | ||
| - | public Feature ProcessFeature(Feature incomingFeature) | + | * //This method calculates all the cells in the grid and write the value of them into the grid file associates with the stream.// |
| - | { | + | == Remarks == |
| + | * //N/A// | ||
| - | <nowiki>//</nowiki>Be sure that you use the FromProjection on the incomingFeatureParameter as the first thing you do in this method. | + | == Return Value == |
| + | * Type:Void | ||
| + | * Description:N/A | ||
| - | <nowiki>//</nowiki> Call a Core Method or do your own processing | + | == Parameters == |
| + | * //gridDefinition// | ||
| + | * Type:[[ThinkGeo.MapSuite.Core.GridDefinition|GridDefinition]] | ||
| + | * Description:This parameter contains the parameters used to describe the grid. | ||
| - | <nowiki>//</nowiki>Be sure that you call the ToProjection on the return result of the method before you pass it out. | + | * //gridInterpolationModel// |
| + | * Type:[[ThinkGeo.MapSuite.Core.GridInterpolationModel|GridInterpolationModel]] | ||
| + | * Description:This parameter represents the interpolation model for calculating cell value of the grid | ||
| - | } | + | * //outputStream// |
| - | === Return Value === | + | * Type:Stream |
| - | ^ Return Type ^ Description ^ | + | * Description:This parameter represents the stream associates with the output file. |
| - | | Collection<[[ThinkGeo.MapSuite.PortableCore.RectangleShape|RectangleShape]]><!-- System.Collections.ObjectModel.Collection{ThinkGeo.MapSuite.PortableCore.RectangleShape} --> | This method projects a Feature based on the Projection of the FeatureSource. | | + | |
| - | === Parameters === | + | <div newline></div> |
| - | ^ Name ^ Type ^ Description ^ | + | ==== Protected Methods ==== |
| - | | rectangles | IEnumerable<[[ThinkGeo.MapSuite.PortableCore.RectangleShape|RectangleShape]]><!-- System.Collections.Generic.IEnumerable{ThinkGeo.MapSuite.PortableCore.RectangleShape} --> | This parameter represents a group of RectangleShapes that you wish to project. | | + | ** {{wiki:ProtectedMethod.gif|}} OpenCore() ** |
| - | <!-- ThinkGeo.MapSuite.PortableCore.FeatureSource --> | + | * //This method opens the FeatureSource so that it is initialized and ready to use.// |
| - | [[#Protected Methods|Go Back]] | + | == Remarks == |
| - | ==== ConvertToExternalProjection(Feature) ==== | + | * //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 virtual 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.// |
| - | This method projects items based on the Projection of the FeatureSource. | + | |
| - | === Remarks === | + | |
| - | This is a protected method that is intended to help developers who want to implement or extend one of our FeatureSources. It is important to note that projection, as a general rule, happens inside the non-Core methods and we usually take care of it. However, as a developer, if you wish to add a new public method, then you will need to handle the projection yourself. | + | |
| - | With these projection methods it is very easy to handle the projection and de-projection. Remember that when adding your own public methods you always de-project incoming shapes and alway project outgoing shapes. Also remember that the Core methods do not consider projection, and they assume the data being passed into them and out of them is the same unit as the underlying data. | + | == Return Value == |
| + | * Type:Void | ||
| + | * Description:None | ||
| - | Example of a New Public Method: | + | == Parameters == |
| + | <div newline></div> | ||
| + | ** {{wiki:ProtectedMethod.gif|}} CanGetBoundingBoxQuicklyCore() ** | ||
| - | public Feature ProcessFeature(Feature incomingFeature) | + | * //N/A// |
| - | { | + | == Remarks == |
| + | * //N/A// | ||
| - | <nowiki>//</nowiki>Be sure that you use the FromProjection on the incomingFeatureParameter as the first thing you do in this method. | + | == Return Value == |
| + | * Type:Boolean | ||
| + | * Description:N/A | ||
| - | <nowiki>//</nowiki> Call a Core Method or do your own processing | + | == Parameters == |
| + | <div newline></div> | ||
| + | ** {{wiki:ProtectedMethod.gif|}} OnStreamLoading(StreamLoadingEventArgs) ** | ||
| - | <nowiki>//</nowiki>Be sure that you call the ToProjection on the return result of the method before you pass it out. | + | * //N/A// |
| + | == Remarks == | ||
| + | * //N/A// | ||
| - | } | + | == Return Value == |
| - | === Return Value === | + | * Type:Void |
| - | ^ Return Type ^ Description ^ | + | * Description:N/A |
| - | | [[ThinkGeo.MapSuite.PortableCore.Feature|Feature]]<!-- ThinkGeo.MapSuite.PortableCore.Feature --> | This method projects a Feature based on the Projection of the FeatureSource. | | + | |
| - | === Parameters === | + | == Parameters == |
| - | ^ Name ^ Type ^ Description ^ | + | * //e// |
| - | | feature | [[ThinkGeo.MapSuite.PortableCore.Feature|Feature]]<!-- ThinkGeo.MapSuite.PortableCore.Feature --> | This parameter represents the Feature you wish to project. | | + | * Type:[[ThinkGeo.MapSuite.Core.StreamLoadingEventArgs|StreamLoadingEventArgs]] |
| + | * Description:N/A | ||
| - | <!-- ThinkGeo.MapSuite.PortableCore.FeatureSource --> | + | <div newline></div> |
| - | [[#Protected Methods|Go Back]] | + | ** {{wiki:ProtectedMethod.gif|}} CloseCore() ** |
| - | ==== ConvertToInternalProjection(IEnumerable<Feature>) ==== | + | |
| - | This method de-projects items based on the Projection of the FeatureSource. | + | |
| - | === Remarks === | + | |
| - | This is a protected method that is intended to help developers who want to implement or extend one of our FeatureSources. It is important to note that projection, as a general rule, happens inside the non-Core methods and we usually take care of it. However, as a developer, if you wish to add a new public method, then you will need to handle the projection yourself. | + | |
| - | With these projection methods it is very easy to handle the projection and de-projection. Remember that when adding your own public methods you always de-project incoming shapes and alway project outgoing shapes. Also remember that the Core methods do not consider projection, and they assume the data being passed into them and out of them is the same unit as the underlying data. | + | * //This method closes the FeatureSource and releases any resources it was using.// |
| + | == 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.// | ||
| - | Example of a New Public Method: | + | == Return Value == |
| + | * Type:Void | ||
| + | * Description:None | ||
| - | public Feature ProcessFeature(Feature incomingFeature) | + | == Parameters == |
| - | { | + | <div newline></div> |
| + | ** {{wiki:ProtectedMethod.gif|}} GetColumnsCore() ** | ||
| - | <nowiki>//</nowiki>Be sure that you use the FromProjection on the incomingFeatureParameter as the first thing you do in this method. | + | * //This method returns the columns available for the FeatureSource.// |
| + | == Remarks == | ||
| + | * //As this is the virtual 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.// | ||
| - | <nowiki>//</nowiki> Call a Core Method or do your own processing | + | == Return Value == |
| + | * Type:Collection<[[ThinkGeo.MapSuite.Core.FeatureSourceColumn|FeatureSourceColumn]]> | ||
| + | * Description:This method returns the columns available for the FeatureSource. | ||
| - | <nowiki>//</nowiki>Be sure that you call the ToProjection on the return result of the method before you pass it out. | + | == Parameters == |
| + | <div newline></div> | ||
| + | ** {{wiki:ProtectedMethod.gif|}} CommitTransactionCore(TransactionBuffer) ** | ||
| - | } | + | * //This method will commit the existing transaction to its underlying source of data.// |
| - | === Return Value === | + | == Remarks == |
| - | ^ Return Type ^ Description ^ | + | * //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.// |
| - | | Collection<[[ThinkGeo.MapSuite.PortableCore.Feature|Feature]]><!-- System.Collections.ObjectModel.Collection{ThinkGeo.MapSuite.PortableCore.Feature} --> | This method de-projects a Feature based on the Projection of the FeatureSource. | | + | |
| - | === Parameters === | + | == Return Value == |
| - | ^ Name ^ Type ^ Description ^ | + | * Type:[[ThinkGeo.MapSuite.Core.TransactionResult|TransactionResult]] |
| - | | features | IEnumerable<[[ThinkGeo.MapSuite.PortableCore.Feature|Feature]]><!-- System.Collections.Generic.IEnumerable{ThinkGeo.MapSuite.PortableCore.Feature} --> | This parameter represents the group of Features that you wish to de-project. | | + | * 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. |
| - | <!-- ThinkGeo.MapSuite.PortableCore.FeatureSource --> | + | == Parameters == |
| - | [[#Protected Methods|Go Back]] | + | * //transactions// |
| - | ==== ConvertToInternalProjection(Feature) ==== | + | * Type:[[ThinkGeo.MapSuite.Core.TransactionBuffer|TransactionBuffer]] |
| - | This method de-projects items based on the Projection of the FeatureSource. | + | * 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. |
| - | === Remarks === | + | |
| - | This is a protected method that is intended to help developers who want to implement or extend one of our FeatureSources. It is important to note that projection, as a general rule, happens inside the non-Core methods and we usually take care of it. However, as a developer, if you wish to add a new public method, then you will need to handle the projection yourself. | + | |
| - | With these projection methods it is very easy to handle the projection and de-projection. Remember that when adding your own public methods you always de-project incoming shapes and alway project outgoing shapes. Also remember that the Core methods do not consider projection, and they assume the data being passed into them and out of them is the same unit as the underlying data. | + | <div newline></div> |
| + | ** {{wiki:ProtectedMethod.gif|}} GetAllFeaturesCore(IEnumerable<String>) ** | ||
| - | Example of a New Public Method: | + | * //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.// | ||
| - | public Feature ProcessFeature(Feature incomingFeature) | + | == Return Value == |
| - | { | + | * Type:Collection<[[ThinkGeo.MapSuite.Core.Feature|Feature]]> |
| + | * Description:The return decimalDegreesValue is a collection of all of the InternalFeatures in the FeatureSource. | ||
| - | <nowiki>//</nowiki>Be sure that you use the FromProjection on the incomingFeatureParameter as the first thing you do in this method. | + | == 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. | ||
| - | <nowiki>//</nowiki> Call a Core Method or do your own processing | + | <div newline></div> |
| + | ** {{wiki:ProtectedMethod.gif|}} GetBoundingBoxCore() ** | ||
| - | <nowiki>//</nowiki>Be sure that you call the ToProjection on the return result of the method before you pass it out. | + | * //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 == |
| - | === Return Value === | + | * Type:[[ThinkGeo.MapSuite.Core.RectangleShape|RectangleShape]] |
| - | ^ Return Type ^ Description ^ | + | * Description:This method returns the bounding box which encompasses all of the features in the FeatureSource. |
| - | | [[ThinkGeo.MapSuite.PortableCore.Feature|Feature]]<!-- ThinkGeo.MapSuite.PortableCore.Feature --> | This method de-projects a Feature based on the Projection of the FeatureSource. | | + | |
| - | === Parameters === | + | == Parameters == |
| - | ^ Name ^ Type ^ Description ^ | + | <div newline></div> |
| - | | feature | [[ThinkGeo.MapSuite.PortableCore.Feature|Feature]]<!-- ThinkGeo.MapSuite.PortableCore.Feature --> | This parameter represents the Feature you wish to de-project. | | + | ** {{wiki:ProtectedMethod.gif|}} GetCountCore() ** |
| - | <!-- ThinkGeo.MapSuite.PortableCore.FeatureSource --> | + | * //This method returns the count of the number of records in this FeatureSource.// |
| - | [[#Protected Methods|Go Back]] | + | == Remarks == |
| - | ==== ConvertToInternalProjection(BaseShape) ==== | + | * //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.// |
| - | This method de-projects items based on the Projection of the FeatureSource. | + | |
| - | === Remarks === | + | |
| - | This is a protected method that is intended to help developers who want to implement or extend one of our FeatureSources. It is important to note that projection, as a general rule, happens inside the non-Core methods and we usually take care of it. However, as a developer, if you wish to add a new public method, then you will need to handle the projection yourself. | + | |
| - | With these projection methods it is very easy to handle the projection and de-projection. Remember that when adding your own public methods you always de-project incoming shapes and alway project outgoing shapes. Also remember that the Core methods do not consider projection, and they assume the data being passed into them and out of them is the same unit as the underlying data. | + | == Return Value == |
| + | * Type:Int32 | ||
| + | * Description:This method returns the count of the number of records in this FeatureSource. | ||
| - | Example of a New Public Method: | + | == Parameters == |
| + | <div newline></div> | ||
| + | ** {{wiki:ProtectedMethod.gif|}} GetFeaturesInsideBoundingBoxCore(RectangleShape,IEnumerable<String>) ** | ||
| - | public Feature ProcessFeature(Feature incomingFeature) | + | * //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.// | ||
| - | <nowiki>//</nowiki>Be sure that you use the FromProjection on the incomingFeatureParameter as the first thing you do in this method. | + | == Return Value == |
| + | * Type:Collection<[[ThinkGeo.MapSuite.Core.Feature|Feature]]> | ||
| + | * Description:The return decimalDegreesValue is a collection of all of the InternalFeatures that are inside of the bounding box. | ||
| - | <nowiki>//</nowiki> Call a Core Method or do your own processing | + | == Parameters == |
| + | * //boundingBox// | ||
| + | * Type:[[ThinkGeo.MapSuite.Core.RectangleShape|RectangleShape]] | ||
| + | * Description:This parameter represents the bounding box you with to find InternalFeatures inside of. | ||
| - | <nowiki>//</nowiki>Be sure that you call the ToProjection on the return result of the method before you pass it out. | + | * //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. | ||
| - | } | + | <div newline></div> |
| - | === Return Value === | + | ** {{wiki:ProtectedMethod.gif|}} GetBoundingBoxByIdCore(String) ** |
| - | ^ Return Type ^ Description ^ | + | |
| - | | [[ThinkGeo.MapSuite.PortableCore.BaseShape|BaseShape]]<!-- ThinkGeo.MapSuite.PortableCore.BaseShape --> | This method de-projects a BaseShape based on the Projection of the FeatureSource. | | + | |
| - | === Parameters === | + | * //N/A// |
| - | ^ Name ^ Type ^ Description ^ | + | == Remarks == |
| - | | baseShape | [[ThinkGeo.MapSuite.PortableCore.BaseShape|BaseShape]]<!-- ThinkGeo.MapSuite.PortableCore.BaseShape --> | This parameter represents the BaseShape you wish to de-project. | | + | * //N/A// |
| - | <!-- ThinkGeo.MapSuite.PortableCore.FeatureSource --> | + | == Return Value == |
| - | [[#Protected Methods|Go Back]] | + | * Type:[[ThinkGeo.MapSuite.Core.RectangleShape|RectangleShape]] |
| - | ==== ConvertToInternalProjection(RectangleShape) ==== | + | * Description:N/A |
| - | This method de-projects items based on the Projection of the FeatureSource. | + | |
| - | === Remarks === | + | |
| - | This is a protected method that is intended to help developers who want to implement or extend one of our FeatureSources. It is important to note that projection, as a general rule, happens inside the non-Core methods and we usually take care of it. However, as a developer, if you wish to add a new public method, then you will need to handle the projection yourself. | + | |
| - | With these projection methods it is very easy to handle the projection and de-projection. Remember that when adding your own public methods you always de-project incoming shapes and alway project outgoing shapes. Also remember that the Core methods do not consider projection, and they assume the data being passed into them and out of them is the same unit as the underlying data. | + | == Parameters == |
| + | * //id// | ||
| + | * Type:String | ||
| + | * Description:N/A | ||
| - | Example of a New Public Method: | + | <div newline></div> |
| + | ** {{wiki:ProtectedMethod.gif|}} GetFirstFeaturesWellKnownTypeCore() ** | ||
| - | public Feature ProcessFeature(Feature incomingFeature) | + | * //N/A// |
| - | { | + | == Remarks == |
| + | * //N/A// | ||
| - | <nowiki>//</nowiki>Be sure that you use the FromProjection on the incomingFeatureParameter as the first thing you do in this method. | + | == Return Value == |
| + | * Type:[[ThinkGeo.MapSuite.Core.WellKnownType|WellKnownType]] | ||
| + | * Description:N/A | ||
| - | <nowiki>//</nowiki> Call a Core Method or do your own processing | + | == Parameters == |
| + | <div newline></div> | ||
| + | ** {{wiki:ProtectedMethod.gif|}} GetFeaturesByIdsCore(IEnumerable<String>,IEnumerable<String>) ** | ||
| - | <nowiki>//</nowiki>Be sure that you call the ToProjection on the return result of the method before you pass it out. | + | * //N/A// |
| + | == Remarks == | ||
| + | * //N/A// | ||
| - | } | + | == Return Value == |
| - | === Return Value === | + | * Type:Collection<[[ThinkGeo.MapSuite.Core.Feature|Feature]]> |
| - | ^ Return Type ^ Description ^ | + | * Description:N/A |
| - | | [[ThinkGeo.MapSuite.PortableCore.RectangleShape|RectangleShape]]<!-- ThinkGeo.MapSuite.PortableCore.RectangleShape --> | This method de-projects a RectangleShape based on the Projection of the FeatureSource. | | + | |
| - | === Parameters === | + | == Parameters == |
| - | ^ Name ^ Type ^ Description ^ | + | * //ids// |
| - | | rectangle | [[ThinkGeo.MapSuite.PortableCore.RectangleShape|RectangleShape]]<!-- ThinkGeo.MapSuite.PortableCore.RectangleShape --> | This parameter represents the rectangle you wish to de-project. | | + | * Type:IEnumerable<String> |
| + | * Description:N/A | ||
| - | <!-- ThinkGeo.MapSuite.PortableCore.FeatureSource --> | + | * //returningColumnNames// |
| - | [[#Protected Methods|Go Back]] | + | * Type:IEnumerable<String> |
| - | ==== ConvertToInternalProjection(IEnumerable<RectangleShape>) ==== | + | * Description:N/A |
| - | This method de-projects items based on the Projection of the FeatureSource. | + | |
| - | === Remarks === | + | |
| - | This is a protected method that is intended to help developers who want to implement or extend one of our FeatureSources. It is important to note that projection, as a general rule, happens inside the non-Core methods and we usually take care of it. However, as a developer, if you wish to add a new public method, then you will need to handle the projection yourself. | + | |
| - | With these projection methods it is very easy to handle the projection and de-projection. Remember that when adding your own public methods you always de-project incoming shapes and alway project outgoing shapes. Also remember that the Core methods do not consider projection, and they assume the data being passed into them and out of them is the same unit as the underlying data. | + | <div newline></div> |
| + | ** {{wiki:ProtectedMethod.gif|}} ConvertToExternalProjection(IEnumerable<RectangleShape>) ** | ||
| - | Example of a New Public Method: | + | * //N/A// |
| + | == Remarks == | ||
| + | * //N/A// | ||
| - | public Feature ProcessFeature(Feature incomingFeature) | + | == Return Value == |
| - | { | + | * Type:Collection<[[ThinkGeo.MapSuite.Core.RectangleShape|RectangleShape]]> |
| + | * Description:N/A | ||
| - | <nowiki>//</nowiki>Be sure that you use the FromProjection on the incomingFeatureParameter as the first thing you do in this method. | + | == Parameters == |
| + | * //rectangles// | ||
| + | * Type:IEnumerable<[[ThinkGeo.MapSuite.Core.RectangleShape|RectangleShape]]> | ||
| + | * Description:N/A | ||
| - | <nowiki>//</nowiki> Call a Core Method or do your own processing | + | <div newline></div> |
| + | ** {{wiki:ProtectedMethod.gif|}} ConvertToInternalProjection(IEnumerable<RectangleShape>) ** | ||
| - | <nowiki>//</nowiki>Be sure that you call the ToProjection on the return result of the method before you pass it out. | + | * //N/A// |
| + | == Remarks == | ||
| + | * //N/A// | ||
| - | } | + | == Return Value == |
| - | === Return Value === | + | * Type:Collection<[[ThinkGeo.MapSuite.Core.RectangleShape|RectangleShape]]> |
| - | ^ Return Type ^ Description ^ | + | * Description:N/A |
| - | | Collection<[[ThinkGeo.MapSuite.PortableCore.RectangleShape|RectangleShape]]><!-- System.Collections.ObjectModel.Collection{ThinkGeo.MapSuite.PortableCore.RectangleShape} --> | This method de-projects a BaseShape based on the Projection of the FeatureSource. | | + | |
| - | === Parameters === | + | == Parameters == |
| - | ^ Name ^ Type ^ Description ^ | + | * //rectangles// |
| - | | rectangles | IEnumerable<[[ThinkGeo.MapSuite.PortableCore.RectangleShape|RectangleShape]]><!-- System.Collections.Generic.IEnumerable{ThinkGeo.MapSuite.PortableCore.RectangleShape} --> | This parameter represents a group of RectangleShapes that you wish to de-project. | | + | * Type:IEnumerable<[[ThinkGeo.MapSuite.Core.RectangleShape|RectangleShape]]> |
| + | * Description:N/A | ||
| - | <!-- ThinkGeo.MapSuite.PortableCore.FeatureSource --> | + | <div newline></div> |
| - | [[#Protected Methods|Go Back]] | + | ** {{wiki:ProtectedMethod.gif|}} ConvertToExternalProjection(RectangleShape) ** |
| - | ==== ExecuteNonQueryCore(String) ==== | + | |
| - | Executes a SQL statement against a connection object. | + | |
| - | === Remarks === | + | |
| - | You can use ExecuteNonQuery to perform catalog operations (for example, querying the structure of a database or creating database objects such as tables), or to change the data in a database by executing UPDATE, INSERT, or DELETE statements. Although ExecuteNonQuery does not return any rows, any output parameters or return values mapped to parameters are populated with data. For UPDATE, INSERT, and DELETE statements, the return value is the number of rows affected by the command. | + | |
| - | === Return Value === | + | |
| - | ^ Return Type ^ Description ^ | + | |
| - | | Int32<!-- System.Int32 --> | The number of rows affected. | | + | |
| - | === Parameters === | + | * //N/A// |
| - | ^ Name ^ Type ^ Description ^ | + | == Remarks == |
| - | | sqlStatement | String<!-- System.String --> | The sqlStatement to be excuted. | | + | * //N/A// |
| - | <!-- ThinkGeo.MapSuite.PortableCore.FeatureSource --> | + | == Return Value == |
| - | [[#Protected Methods|Go Back]] | + | * Type:[[ThinkGeo.MapSuite.Core.RectangleShape|RectangleShape]] |
| - | ==== ExecuteQueryCore(String) ==== | + | * Description:N/A |
| - | Executes the query and returns the result returned by the query. | + | |
| - | === Remarks === | + | |
| - | Use the ExcuteScalar method to retrieve a single value from the database. This requires less code than using the ExcuteQuery method and then performing the operations necessary to generate the single value using the data. | + | |
| - | === Return Value === | + | |
| - | ^ Return Type ^ Description ^ | + | |
| - | | [[ThinkGeo.MapSuite.Portable.GeoDataTable|GeoDataTable]]<!-- ThinkGeo.MapSuite.Portable.GeoDataTable --> | The result set in the format of dataTable. | | + | |
| - | === Parameters === | + | == Parameters == |
| - | ^ Name ^ Type ^ Description ^ | + | * //rectangle// |
| - | | sqlStatement | String<!-- System.String --> | The sqlStatement to be excuted. | | + | * Type:[[ThinkGeo.MapSuite.Core.RectangleShape|RectangleShape]] |
| + | * Description:N/A | ||
| - | <!-- ThinkGeo.MapSuite.PortableCore.FeatureSource --> | + | <div newline></div> |
| - | [[#Protected Methods|Go Back]] | + | ** {{wiki:ProtectedMethod.gif|}} ConvertToInternalProjection(RectangleShape) ** |
| - | ==== 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 requires less code than using the ExcuteQuery method and then performing the operations necessary to generate the single value using the data. | + | |
| - | === Return Value === | + | |
| - | ^ Return Type ^ Description ^ | + | |
| - | | Object<!-- System.Object --> | The first column of the first row in the result set. | | + | |
| - | === Parameters === | + | * //N/A// |
| - | ^ Name ^ Type ^ Description ^ | + | == Remarks == |
| - | | sqlStatement | String<!-- System.String --> | The sqlStatement to be excuted. | | + | * //N/A// |
| - | <!-- ThinkGeo.MapSuite.PortableCore.FeatureSource --> | + | == Return Value == |
| - | [[#Protected Methods|Go Back]] | + | * Type:[[ThinkGeo.MapSuite.Core.RectangleShape|RectangleShape]] |
| - | ==== Finalize() ==== | + | * Description:N/A |
| - | === Return Value === | + | |
| - | ^ Return Type ^ Description ^ | + | |
| - | | Void<!-- System.Void --> | | | + | |
| - | === Parameters === | + | == Parameters == |
| - | ^ Name ^ Type ^ Description ^ | + | * //rectangle// |
| + | * Type:[[ThinkGeo.MapSuite.Core.RectangleShape|RectangleShape]] | ||
| + | * Description:N/A | ||
| - | <!-- System.Object --> | + | <div newline></div> |
| - | [[#Protected Methods|Go Back]] | + | ** {{wiki:ProtectedMethod.gif|}} ConvertToInternalProjectionCall(RectangleShape) ** |
| - | ==== GetAllFeaturesCore(IEnumerable<String>, Int32, Int32) ==== | + | |
| - | === Return Value === | + | |
| - | ^ Return Type ^ Description ^ | + | |
| - | | Collection<[[ThinkGeo.MapSuite.PortableCore.Feature|Feature]]><!-- System.Collections.ObjectModel.Collection{ThinkGeo.MapSuite.PortableCore.Feature} --> | | | + | |
| - | === Parameters === | + | * //N/A// |
| - | ^ Name ^ Type ^ Description ^ | + | == Remarks == |
| - | | returningColumnNames | IEnumerable<String><!-- System.Collections.Generic.IEnumerable{System.String} --> | | | + | * //N/A// |
| - | | startIndex | Int32<!-- System.Int32 --> | | | + | |
| - | | takeCount | Int32<!-- System.Int32 --> | | | + | |
| - | <!-- ThinkGeo.MapSuite.PortableCore.FeatureSource --> | + | == Return Value == |
| - | [[#Protected Methods|Go Back]] | + | * Type:[[ThinkGeo.MapSuite.Core.RectangleShape|RectangleShape]] |
| - | ==== GetAllFeaturesCore(IEnumerable<String>) ==== | + | * Description:N/A |
| - | 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. | + | == Parameters == |
| + | * //rectangle// | ||
| + | * Type:[[ThinkGeo.MapSuite.Core.RectangleShape|RectangleShape]] | ||
| + | * Description:N/A | ||
| - | 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. | + | <div newline></div> |
| + | ** {{wiki:ProtectedMethod.gif|}} ConvertToInternalProjection(BaseShape) ** | ||
| - | 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. | + | * //N/A// |
| - | === Return Value === | + | == Remarks == |
| - | ^ Return Type ^ Description ^ | + | * //N/A// |
| - | | Collection<[[ThinkGeo.MapSuite.PortableCore.Feature|Feature]]><!-- System.Collections.ObjectModel.Collection{ThinkGeo.MapSuite.PortableCore.Feature} --> | The return decimalDegreesValue is a collection of all of the InternalFeatures in the FeatureSource. | | + | |
| - | === Parameters === | + | == Return Value == |
| - | ^ Name ^ Type ^ Description ^ | + | * Type:[[ThinkGeo.MapSuite.Core.BaseShape|BaseShape]] |
| - | | returningColumnNames | IEnumerable<String><!-- System.Collections.Generic.IEnumerable{System.String} --> | This parameter allows you to select the field names of the column data you wish to return with each Feature. | | + | * Description:N/A |
| - | <!-- ThinkGeo.MapSuite.PortableCore.FeatureSource(overriden) --> | + | == Parameters == |
| - | [[#Protected Methods|Go Back]] | + | * //baseShape// |
| - | ==== GetBoundingBoxByIdCore(String) ==== | + | * Type:[[ThinkGeo.MapSuite.Core.BaseShape|BaseShape]] |
| - | === Return Value === | + | * Description:N/A |
| - | ^ Return Type ^ Description ^ | + | |
| - | | [[ThinkGeo.MapSuite.PortableCore.RectangleShape|RectangleShape]]<!-- ThinkGeo.MapSuite.PortableCore.RectangleShape --> | | | + | |
| - | === Parameters === | + | <div newline></div> |
| - | ^ Name ^ Type ^ Description ^ | + | ** {{wiki:ProtectedMethod.gif|}} ConvertToExternalProjection(IEnumerable<Feature>) ** |
| - | | id | String<!-- System.String --> | | | + | |
| - | <!-- ThinkGeo.MapSuite.PortableCore.FeatureSource --> | + | * //N/A// |
| - | [[#Protected Methods|Go Back]] | + | == Remarks == |
| - | ==== GetBoundingBoxCore() ==== | + | * //N/A// |
| - | 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 | + | == Return Value == |
| + | * Type:Collection<[[ThinkGeo.MapSuite.Core.Feature|Feature]]> | ||
| + | * Description:N/A | ||
| - | 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. | + | == Parameters == |
| - | === Return Value === | + | * //features// |
| - | ^ Return Type ^ Description ^ | + | * Type:IEnumerable<[[ThinkGeo.MapSuite.Core.Feature|Feature]]> |
| - | | [[ThinkGeo.MapSuite.PortableCore.RectangleShape|RectangleShape]]<!-- ThinkGeo.MapSuite.PortableCore.RectangleShape --> | This method returns the bounding box which encompasses all of the features in the FeatureSource. | | + | * Description:N/A |
| - | === Parameters === | + | <div newline></div> |
| - | ^ Name ^ Type ^ Description ^ | + | ** {{wiki:ProtectedMethod.gif|}} ConvertToInternalProjection(IEnumerable<Feature>) ** |
| - | <!-- ThinkGeo.MapSuite.PortableCore.FeatureSource(overriden) --> | + | * //N/A// |
| - | [[#Protected Methods|Go Back]] | + | == Remarks == |
| - | ==== GetColumnNamesInsideFeatureSource(IEnumerable<String>) ==== | + | * //N/A// |
| - | This method returns the field names that are in the FeatureSource from a list of provided field names. | + | |
| - | === Remarks === | + | |
| - | This is a protected method that is intended to help developers who want to implement or extend one of our FeatureSources. It is important to note that, as a general rule, returning column data of a Feature or a set of InternalFeatures happens inside the non-Core methods and we usually take care of it. However, as a developer, if you wish to add a new public method, then you will need to handle the projection yourself. | + | |
| - | Let's say, for example, that you want to add a new Find method called FindLargeFeatures. You pass in a group of columns to return. Most of the time, the requested columns will actually be in the FeatureSource, but sometimes they will not. The way we allow users to get data from outside of the Feature Source is by raising an event called CustomColumnFetch. This way, we allow people to provide data that is outside of the FeatureSource. Since you will be implementing your own public method, you will want to support this as all of our other public methods do. | + | == Return Value == |
| + | * Type:Collection<[[ThinkGeo.MapSuite.Core.Feature|Feature]]> | ||
| + | * Description:N/A | ||
| - | When you first enter the public method, you will want to separate out the fields that are in the FeatureSource from those that are not. You can call this method and the GetColumnNamesOutsideFeatureSource. If inside your public method you need to call any of our Core methods, then you need to make sure that you only pass in the list of column names that are in the FeatureSource. We assume that Core methods are simple and they do not handle this complexity. | + | == Parameters == |
| + | * //features// | ||
| + | * Type:IEnumerable<[[ThinkGeo.MapSuite.Core.Feature|Feature]]> | ||
| + | * Description:N/A | ||
| - | With the list of non-FeatureSource column names, you simply loop through each column name for each record and call the OnCustomColumnFetch method while passing in the proper parameters. This will allow you give the user a chance to provide the values for the Feature's fields that were not in the FeatureSource. After that, you combine your results and pass them back out as the return. | + | <div newline></div> |
| + | ** {{wiki:ProtectedMethod.gif|}} ConvertToExternalProjection(Feature) ** | ||
| - | public Collection<Feature> FindLargeFeatures(double AreaSize, IEnumerable <string> columnsToReturn) | + | * //N/A// |
| - | { | + | == Remarks == |
| + | * //N/A// | ||
| - | <nowiki>//</nowiki>Step 1: Separate the columns that are in the FeatureSource from those that are not. | + | == Return Value == |
| + | * Type:[[ThinkGeo.MapSuite.Core.Feature|Feature]] | ||
| + | * Description:N/A | ||
| - | <nowiki>//</nowiki> Step 2: Call any Core Methods and only pass in the columns that are in the FeatureSource | + | == Parameters == |
| + | * //feature// | ||
| + | * Type:[[ThinkGeo.MapSuite.Core.Feature|Feature]] | ||
| + | * Description:N/A | ||
| - | <nowiki>//</nowiki>Step3: For Each feature/column name combination, call the OnCustomFiedlFetch and allow your user to provide the custom data. | + | <div newline></div> |
| + | ** {{wiki:ProtectedMethod.gif|}} ConvertToInternalProjection(Feature) ** | ||
| - | <nowiki>//</nowiki> Step4: Integrate the custom data with the result of the Core method plus any processing you did. Then return the consolidated result. | + | * //N/A// |
| + | == Remarks == | ||
| + | * //N/A// | ||
| - | } | + | == Return Value == |
| - | === Return Value === | + | * Type:[[ThinkGeo.MapSuite.Core.Feature|Feature]] |
| - | ^ Return Type ^ Description ^ | + | * Description:N/A |
| - | | Collection<String><!-- System.Collections.ObjectModel.Collection{System.String} --> | This method returns the field names that are in the FeatureSource from a list of provided field names. | | + | |
| - | === Parameters === | + | == Parameters == |
| - | ^ Name ^ Type ^ Description ^ | + | * //feature// |
| - | | returningColumnNames | IEnumerable<String><!-- System.Collections.Generic.IEnumerable{System.String} --> | This parameter is a list of column names, where not every field name may be in the FeatureSource. | | + | * Type:[[ThinkGeo.MapSuite.Core.Feature|Feature]] |
| + | * Description:N/A | ||
| - | <!-- ThinkGeo.MapSuite.PortableCore.FeatureSource --> | + | <div newline></div> |
| - | [[#Protected Methods|Go Back]] | + | ** {{wiki:ProtectedMethod.gif|}} GetColumnNamesInsideFeatureSource(IEnumerable<String>) ** |
| - | ==== GetColumnNamesOutsideFeatureSource(IEnumerable<String>) ==== | + | |
| - | This method returns the field names that are not in the FeatureSource from a list of provided field names. | + | |
| - | === Remarks === | + | |
| - | This is a protected method that is intended to help developers who want to implement or extend one of our FeatureSources. It is important to note that, as a general rule, returning column data of a Feature or a set of InternalFeatures happens inside the non-Core methods and we usually take care of it. However, as a developer, if you wish to add a new public method, then you will need to handle the projection yourself. | + | |
| - | Let's say, for example, that you want to add a new Find method called FindLargeFeatures. You pass in a group of columns to return. Most of the time, the requested columns will actually be in the FeatureSource, but sometimes they will not. The way we allow users to get data from outside of the Feature Source is by raising an event called CustomColumnFetch. This way, we allow people to provide data that is outside of the FeatureSource. Since you will be implementing your own public method, you will want to support this as all of our other public methods do. | + | * //N/A// |
| + | == Remarks == | ||
| + | * //N/A// | ||
| - | When you first enter the public method, you will want to separate out the fields that are in the FeatureSource from those that are not. You can call this method and the GetColumnNamesOutsideFeatureSource. If inside your public method you need to call any of our Core methods, then you need to make sure that you only pass in the list of column names that are in the FeatureSource. We assume that Core methods are simple and they do not handle this complexity. | + | == Return Value == |
| + | * Type:Collection<String> | ||
| + | * Description:N/A | ||
| - | With the list of non-FeatureSource column names, you simply loop through each column name for each record and call the OnCustomColumnFetch method while passing in the proper parameters. This will allow you give the user a chance to provide the values for the Feature's fields that were not in the FeatureSource. After that, you combine your results and pass them back out as the return. | + | == Parameters == |
| + | * //returningColumnNames// | ||
| + | * Type:IEnumerable<String> | ||
| + | * Description:N/A | ||
| - | public Collection<Feature> FindLargeFeatures(double AreaSize, IEnumerable <string> columnsToReturn) | + | <div newline></div> |
| - | { | + | ** {{wiki:ProtectedMethod.gif|}} GetColumnNamesOutsideFeatureSource(IEnumerable<String>) ** |
| - | <nowiki>//</nowiki>Step 1: Separate the columns that are in the FeatureSource from those that are not. | + | * //N/A// |
| + | == Remarks == | ||
| + | * //N/A// | ||
| - | <nowiki>//</nowiki> Step 2: Call any Core Methods and only pass in the columns that are in the FeatureSource | + | == Return Value == |
| + | * Type:Collection<String> | ||
| + | * Description:N/A | ||
| - | <nowiki>//</nowiki>Step3: For Each feature/column name combination, call the OnCustomFiedlFetch and allow your user to provide the custom data. | + | == Parameters == |
| + | * //returningColumnNames// | ||
| + | * Type:IEnumerable<String> | ||
| + | * Description:N/A | ||
| - | <nowiki>//</nowiki> Step4: Integrate the custom data with the result of the Core method plus any processing you did. Then return the consolidated result. | + | <div newline></div> |
| + | ** {{wiki:ProtectedMethod.gif|}} GetReturningColumnNames(ReturningColumnsType) ** | ||
| - | } | + | * //N/A// |
| - | === Return Value === | + | == Remarks == |
| - | ^ Return Type ^ Description ^ | + | * //N/A// |
| - | | Collection<String><!-- System.Collections.ObjectModel.Collection{System.String} --> | This method returns the field names that are not in the FeatureSource from a list of provided field names. | | + | |
| - | === Parameters === | + | == Return Value == |
| - | ^ Name ^ Type ^ Description ^ | + | * Type:Collection<String> |
| - | | returningColumnNames | IEnumerable<String><!-- System.Collections.Generic.IEnumerable{System.String} --> | This parameter is a list of field names, where not every field name may be in the FeatureSource. | | + | * Description:N/A |
| - | <!-- ThinkGeo.MapSuite.PortableCore.FeatureSource --> | + | == Parameters == |
| - | [[#Protected Methods|Go Back]] | + | * //returningColumnNamesType// |
| - | ==== GetColumnsCore() ==== | + | * Type:[[ThinkGeo.MapSuite.Core.ReturningColumnsType|ReturningColumnsType]] |
| - | This method returns the columns available for the FeatureSource. | + | * Description:N/A |
| - | === Remarks === | + | |
| - | As this is the virtual 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 === | + | |
| - | ^ Return Type ^ Description ^ | + | |
| - | | Collection<[[ThinkGeo.MapSuite.PortableCore.FeatureSourceColumn|FeatureSourceColumn]]><!-- System.Collections.ObjectModel.Collection{ThinkGeo.MapSuite.PortableCore.FeatureSourceColumn} --> | This method returns the columns available for the FeatureSource. | | + | |
| - | === Parameters === | + | <div newline></div> |
| - | ^ Name ^ Type ^ Description ^ | + | ** {{wiki:ProtectedMethod.gif|}} RemoveEmptyAndExcludeFeatures(Collection<Feature>) ** |
| - | <!-- ThinkGeo.MapSuite.PortableCore.FeatureSource(overriden) --> | + | * //N/A// |
| - | [[#Protected Methods|Go Back]] | + | == Remarks == |
| - | ==== GetCountCore() ==== | + | * //N/A// |
| - | 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 | + | == Return Value == |
| + | * Type:Void | ||
| + | * Description:N/A | ||
| - | 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. | + | == Parameters == |
| - | === Return Value === | + | * //sourceFeatures// |
| - | ^ Return Type ^ Description ^ | + | * Type:Collection<[[ThinkGeo.MapSuite.Core.Feature|Feature]]> |
| - | | Int32<!-- System.Int32 --> | This method returns the count of the number of records in this FeatureSource. | | + | * Description:N/A |
| - | === Parameters === | + | <div newline></div> |
| - | ^ Name ^ Type ^ Description ^ | + | ** {{wiki:ProtectedMethod.gif|}} OnDrawingProgressChanged(DrawingProgressChangedEventArgs) ** |
| - | <!-- ThinkGeo.MapSuite.PortableCore.FeatureSource(overriden) --> | + | * //N/A// |
| - | [[#Protected Methods|Go Back]] | + | == Remarks == |
| - | ==== GetDistinctColumnValuesCore(String) ==== | + | * //N/A// |
| - | === Return Value === | + | |
| - | ^ Return Type ^ Description ^ | + | |
| - | | Collection<[[ThinkGeo.MapSuite.PortableCore.DistinctColumnValue|DistinctColumnValue]]><!-- System.Collections.ObjectModel.Collection{ThinkGeo.MapSuite.PortableCore.DistinctColumnValue} --> | | | + | |
| - | === Parameters === | + | == Return Value == |
| - | ^ Name ^ Type ^ Description ^ | + | * Type:Void |
| - | | columnName | String<!-- System.String --> | | | + | * Description:N/A |
| - | <!-- ThinkGeo.MapSuite.PortableCore.FeatureSource --> | + | == Parameters == |
| - | [[#Protected Methods|Go Back]] | + | * //e// |
| - | ==== GetFeaturesByColumnValueCore(String, String, IEnumerable<String>) ==== | + | * Type:[[ThinkGeo.MapSuite.Core.DrawingProgressChangedEventArgs|DrawingProgressChangedEventArgs]] |
| - | Get all of the features by passing a columnName and a specified columValue. | + | * Description:N/A |
| - | === Return Value === | + | |
| - | ^ Return Type ^ Description ^ | + | |
| - | | Collection<[[ThinkGeo.MapSuite.PortableCore.Feature|Feature]]><!-- System.Collections.ObjectModel.Collection{ThinkGeo.MapSuite.PortableCore.Feature} --> | The returnning features matches the columnValue. | | + | |
| - | === Parameters === | + | <div newline></div> |
| - | ^ Name ^ Type ^ Description ^ | + | ** {{wiki:ProtectedMethod.gif|}} GetColumnNamesOutsideFeatureSourceCall(IEnumerable<String>) ** |
| - | | columnName | String<!-- System.String --> | The specified columnName to match the columnValue. | | + | |
| - | | columnValue | String<!-- System.String --> | The specified columnValue to match those returning features. | | + | |
| - | | returningColumnNames | IEnumerable<String><!-- System.Collections.Generic.IEnumerable{System.String} --> | This parameter allows you to select the field names of the column data you wish to return with each Feature. | | + | |
| - | <!-- ThinkGeo.MapSuite.PortableCore.FeatureSource --> | + | * //N/A// |
| - | [[#Protected Methods|Go Back]] | + | == Remarks == |
| - | ==== GetFeaturesByIdsCore(IEnumerable<String>, IEnumerable<String>) ==== | + | * //N/A// |
| - | 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 a more efficient version of this method, then we highly suggest you override the GetFeaturesByIdsCore method and provide a fast way to find a group of InternalFeatures by their Id. | + | |
| - | === Return Value === | + | |
| - | ^ Return Type ^ Description ^ | + | |
| - | | Collection<[[ThinkGeo.MapSuite.PortableCore.Feature|Feature]]><!-- System.Collections.ObjectModel.Collection{ThinkGeo.MapSuite.PortableCore.Feature} --> | This method returns a collection of InternalFeatures by providing a group of Ids. | | + | |
| - | === Parameters === | + | == Return Value == |
| - | ^ Name ^ Type ^ Description ^ | + | * Type:Collection<String> |
| - | | ids | IEnumerable<String><!-- System.Collections.Generic.IEnumerable{System.String} --> | This parameter represents the group of Ids which uniquely identified the InternalFeatures in the FeatureSource. | | + | * Description:N/A |
| - | | returningColumnNames | IEnumerable<String><!-- System.Collections.Generic.IEnumerable{System.String} --> | This parameter allows you to select the field names of the column data you wish to return with each Feature. | | + | |
| - | <!-- ThinkGeo.MapSuite.PortableCore.FeatureSource --> | + | == Parameters == |
| - | [[#Protected Methods|Go Back]] | + | * //returningColumnNames// |
| - | ==== GetFeaturesForDrawingCore(RectangleShape, Double, Double, IEnumerable<String>) ==== | + | * Type:IEnumerable<String> |
| - | This method returns the InternalFeatures that will be used for drawing. | + | * Description:N/A |
| - | === 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 GetFeaturesForDrawingCore uses the GetFeaturesInsodeBoundingBoxCore with some optimizations based on the screen width and height. For example, we can determine if 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 of it instead. | + | <div newline></div> |
| - | === Return Value === | + | ** {{wiki:ProtectedMethod.gif|}} CanGetCountQuicklyCore() ** |
| - | ^ Return Type ^ Description ^ | + | |
| - | | Collection<[[ThinkGeo.MapSuite.PortableCore.Feature|Feature]]><!-- System.Collections.ObjectModel.Collection{ThinkGeo.MapSuite.PortableCore.Feature} --> | This method returns the InternalFeatures that will be used for drawing. | | + | |
| - | === Parameters === | + | * //N/A// |
| - | ^ Name ^ Type ^ Description ^ | + | == Remarks == |
| - | | boundingBox | [[ThinkGeo.MapSuite.PortableCore.RectangleShape|RectangleShape]]<!-- ThinkGeo.MapSuite.PortableCore.RectangleShape --> | This parameter is the bounding box of the InternalFeatures that you want to draw. | | + | * //N/A// |
| - | | screenWidth | Double<!-- System.Double --> | This parameter is the width of the canvas, in screen pixels, that you will draw on. | | + | |
| - | | screenHeight | Double<!-- System.Double --> | This parameter is the height of the canvas, in screen pixels, that you will draw on. | | + | |
| - | | returningColumnNames | IEnumerable<String><!-- System.Collections.Generic.IEnumerable{System.String} --> | This parameter allows you to select the field names of the column data you wish to return with each Feature. | | + | |
| - | <!-- ThinkGeo.MapSuite.PortableCore.FeatureSource --> | + | == Return Value == |
| - | [[#Protected Methods|Go Back]] | + | * Type:Boolean |
| - | ==== GetFeaturesInsideBoundingBoxCore(RectangleShape, IEnumerable<String>) ==== | + | * Description:N/A |
| - | 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. | + | == Parameters == |
| - | === Return Value === | + | <div newline></div> |
| - | ^ Return Type ^ Description ^ | + | ** {{wiki:ProtectedMethod.gif|}} GetDistinctColumnValuesCore(String) ** |
| - | | Collection<[[ThinkGeo.MapSuite.PortableCore.Feature|Feature]]><!-- System.Collections.ObjectModel.Collection{ThinkGeo.MapSuite.PortableCore.Feature} --> | The return decimalDegreesValue is a collection of all of the InternalFeatures that are inside of the bounding box. | | + | |
| - | === Parameters === | + | * //N/A// |
| - | ^ Name ^ Type ^ Description ^ | + | == Remarks == |
| - | | boundingBox | [[ThinkGeo.MapSuite.PortableCore.RectangleShape|RectangleShape]]<!-- ThinkGeo.MapSuite.PortableCore.RectangleShape --> | This parameter represents the bounding box you with to find InternalFeatures inside of. | | + | * //N/A// |
| - | | returningColumnNames | IEnumerable<String><!-- System.Collections.Generic.IEnumerable{System.String} --> | This parameter allows you to select the field names of the column data you wish to return with each Feature. | | + | |
| - | <!-- ThinkGeo.MapSuite.PortableCore.FeatureSource(overriden) --> | + | == Return Value == |
| - | [[#Protected Methods|Go Back]] | + | * Type:Collection<[[ThinkGeo.MapSuite.Core.DistinctColumnValue|DistinctColumnValue]]> |
| - | ==== GetFeaturesNearestToCore(BaseShape, GeographyUnit, Int32, IEnumerable<String>) ==== | + | * Description:N/A |
| - | This method returns a user defined number of InternalFeatures that are closest to the TargetShape. | + | |
| - | === Remarks === | + | |
| - | This method returns a user defined number of InternalFeatures that are closest to the TargetShape. It is important to note that the TargetShape and the FeatureSource must use the same unit, such as feet or meters. If they do not, then the results will not be predictable or correct. If there is a current transaction and it is marked as live, then the results will include any transaction Feature that applies. | + | |
| - | The implementation we provided creates a small bounding box around the TargetShape and then queries the features inside of it. If we reach the number of items to find, then we measure the returned InternalFeatures to find the nearest. If we do not find enough records, we scale up the bounding box and try again. As you can see, this is not the most efficient method. If your underlying data provider exposes a more efficient way, we recommend you override the Core version of this method and implement it. | + | == Parameters == |
| + | * //columnName// | ||
| + | * Type:String | ||
| + | * Description:N/A | ||
| - | The default implementation of GetFeaturesNearestCore uses the GetFeaturesInsideBoundingBoxCore method for speed. We strongly recommend that you provide your own implementation for this method that will be more efficient. When you override GetFeaturesInsideBoundingBoxCore method, we recommend that you use any spatial indexes you have at your disposal to make this method as fast as possible. | + | <div newline></div> |
| - | === Return Value === | + | ** {{wiki:ProtectedMethod.gif|}} GetAllFeaturesCore(IEnumerable<String>,Int32,Int32) ** |
| - | ^ Return Type ^ Description ^ | + | |
| - | | Collection<[[ThinkGeo.MapSuite.PortableCore.Feature|Feature]]><!-- System.Collections.ObjectModel.Collection{ThinkGeo.MapSuite.PortableCore.Feature} --> | This method returns a user defined number of InternalFeatures that are closest to the TargetShape. | | + | |
| - | === Parameters === | + | * //N/A// |
| - | ^ Name ^ Type ^ Description ^ | + | == Remarks == |
| - | | targetShape | [[ThinkGeo.MapSuite.PortableCore.BaseShape|BaseShape]]<!-- ThinkGeo.MapSuite.PortableCore.BaseShape --> | This parameter is the shape you want to find InternalFeatures close to. | | + | * //N/A// |
| - | | unitOfData | [[ThinkGeo.MapSuite.PortableCore.GeographyUnit|GeographyUnit]]<!-- ThinkGeo.MapSuite.PortableCore.GeographyUnit --> | This parameter is the unit of measurement that the TargetShape and the FeatureSource are in, such as feet, meters, etc. | | + | |
| - | | maxItemsToFind | Int32<!-- System.Int32 --> | This parameter defines how many close InternalFeatures to find around the TargetShape. | | + | |
| - | | returningColumnNames | IEnumerable<String><!-- System.Collections.Generic.IEnumerable{System.String} --> | This parameter allows you to select the field names of the column data you wish to return with each Feature. | | + | |
| - | <!-- ThinkGeo.MapSuite.PortableCore.FeatureSource --> | + | == Return Value == |
| - | [[#Protected Methods|Go Back]] | + | * Type:Collection<[[ThinkGeo.MapSuite.Core.Feature|Feature]]> |
| - | ==== GetFeaturesOutsideBoundingBoxCore(RectangleShape, IEnumerable<String>) ==== | + | * Description:N/A |
| - | 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. | + | == Parameters == |
| - | === Return Value === | + | * //returningColumnNames// |
| - | ^ Return Type ^ Description ^ | + | * Type:IEnumerable<String> |
| - | | Collection<[[ThinkGeo.MapSuite.PortableCore.Feature|Feature]]><!-- System.Collections.ObjectModel.Collection{ThinkGeo.MapSuite.PortableCore.Feature} --> | This method returns all of the InternalFeatures of this FeatureSource outside of the specified bounding box. | | + | * Description:N/A |
| - | === Parameters === | + | * //startIndex// |
| - | ^ Name ^ Type ^ Description ^ | + | * Type:Int32 |
| - | | boundingBox | [[ThinkGeo.MapSuite.PortableCore.RectangleShape|RectangleShape]]<!-- ThinkGeo.MapSuite.PortableCore.RectangleShape --> | This parameter represents the bounding box that you wish to find InternalFeatures outside of. | | + | * Description:N/A |
| - | | returningColumnNames | IEnumerable<String><!-- System.Collections.Generic.IEnumerable{System.String} --> | This parameter allows you to select the field names of the column data you wish to return with each Feature. | | + | |
| - | <!-- ThinkGeo.MapSuite.PortableCore.FeatureSource --> | + | * //takeCount// |
| - | [[#Protected Methods|Go Back]] | + | * Type:Int32 |
| - | ==== GetFeaturesWithinDistanceOfCore(BaseShape, GeographyUnit, DistanceUnit, Double, IEnumerable<String>) ==== | + | * Description:N/A |
| - | This method returns a collection of InternalFeatures that are within a certain distance of the TargetShape. | + | |
| - | === Remarks === | + | |
| - | This method returns a collection of InternalFeatures that are within a certain distance of the TargetShape. It is important to note that the TargetShape and the FeatureSource must use the same unit, such as feet or meters. If they do not, then the results will not be predictable or correct. If there is a current transaction and it is marked as live, then the results will include any transaction Feature that applies. | + | |
| - | The implementation we provided creates a bounding box around the TargetShape using the distance supplied and then queries the features inside of it. This may not be the most efficient method for this operation. If your underlying data provider exposes a more efficient way, we recommend you override the Core version of this method and implement it. | + | <div newline></div> |
| + | ** {{wiki:ProtectedMethod.gif|}} RaiseCustomColumnFetchEvent(Collection<Feature>,Collection<String>,Boolean) ** | ||
| - | The default implementation of GetFeaturesWithinDistanceOfCore uses the GetFeaturesInsideBoundingBoxCore method for speed. We strongly recommend that you provide your own implementation for this method that will be more efficient. When you override GetFeaturesInsideBoundingBoxCore method, we recommend that you use any spatial indexes you have at your disposal to make this method as fast as possible. | + | * //N/A// |
| - | === Return Value === | + | == Remarks == |
| - | ^ Return Type ^ Description ^ | + | * //N/A// |
| - | | Collection<[[ThinkGeo.MapSuite.PortableCore.Feature|Feature]]><!-- System.Collections.ObjectModel.Collection{ThinkGeo.MapSuite.PortableCore.Feature} --> | This method returns a collection of InternalFeatures that are within a certain distance of the TargetShape. | | + | |
| - | === Parameters === | + | == Return Value == |
| - | ^ Name ^ Type ^ Description ^ | + | * Type:Collection<[[ThinkGeo.MapSuite.Core.Feature|Feature]]> |
| - | | targetShape | [[ThinkGeo.MapSuite.PortableCore.BaseShape|BaseShape]]<!-- ThinkGeo.MapSuite.PortableCore.BaseShape --> | The shape you wish to find InternalFeatures within a distance of. | | + | * Description:N/A |
| - | | unitOfData | [[ThinkGeo.MapSuite.PortableCore.GeographyUnit|GeographyUnit]]<!-- ThinkGeo.MapSuite.PortableCore.GeographyUnit --> | This parameter is the unit of data that the FeatureSource and TargetShape are in. | | + | |
| - | | distanceUnit | [[ThinkGeo.MapSuite.PortableCore.DistanceUnit|DistanceUnit]]<!-- ThinkGeo.MapSuite.PortableCore.DistanceUnit --> | This parameter specifies the measurement unit for the distance parameter, such as feet, miles, kilometers, etc. | | + | |
| - | | distance | Double<!-- System.Double --> | This parameter specifies the distance in which to find InternalFeatures around the TargetShape. | | + | |
| - | | returningColumnNames | IEnumerable<String><!-- System.Collections.Generic.IEnumerable{System.String} --> | This parameter allows you to select the field names of the column data you wish to return with each Feature. | | + | |
| - | <!-- ThinkGeo.MapSuite.PortableCore.FeatureSource --> | + | == Parameters == |
| - | [[#Protected Methods|Go Back]] | + | * //sourceFeatures// |
| - | ==== GetFirstFeaturesWellKnownTypeCore() ==== | + | * Type:Collection<[[ThinkGeo.MapSuite.Core.Feature|Feature]]> |
| - | This method returns the well known type that represents the first feature from FeatureSource. | + | * Description:N/A |
| - | === Remarks === | + | |
| - | This protected virtual method is called from the concrete public method GetFirstFeaturesWellKnownType. It does not take into account any transaction activity, as this is the responsibility of the concrete public method GetFirstFeaturesWellKnownType. This way, as a developer, if you choose to override this method you do not have to consider transactions at all. | + | |
| - | The default implementation of GetCountCore uses the GetAllRFeaturesCore method to get WellKnownType of the first feature from all features. We strongly recommend that you provide your own implementation for this method that will be more efficient. | + | * //fieldNamesOutsideOfSource// |
| + | * Type:Collection<String> | ||
| + | * Description:N/A | ||
| - | If you do not override this method, it will get the count by calling the GetAllFeaturesCore method and get WellKnownType of the first feature from all features. 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 records without returning them. In these ways you can greatly improve the performance of this method. | + | * //forceRaiseEvent// |
| - | === Return Value === | + | * Type:Boolean |
| - | ^ Return Type ^ Description ^ | + | * Description:N/A |
| - | | [[ThinkGeo.MapSuite.PortableCore.WellKnownType|WellKnownType]]<!-- ThinkGeo.MapSuite.PortableCore.WellKnownType --> | This method returns the well known type that represents the first feature from FeatureSource. | | + | |
| - | === Parameters === | + | <div newline></div> |
| - | ^ Name ^ Type ^ Description ^ | + | ** {{wiki:ProtectedMethod.gif|}} GetFeaturesOutsideBoundingBoxCore(RectangleShape,IEnumerable<String>) ** |
| - | <!-- ThinkGeo.MapSuite.PortableCore.FeatureSource --> | + | * //N/A// |
| - | [[#Protected Methods|Go Back]] | + | == Remarks == |
| - | ==== GetReturningColumnNames(ReturningColumnsType) ==== | + | * //N/A// |
| - | Get returning columnNames according to the returningColumnType. | + | |
| - | === Remarks === | + | |
| - | The concreted FeatureSource can override this logic if needed. | + | |
| - | === Return Value === | + | |
| - | ^ Return Type ^ Description ^ | + | |
| - | | Collection<String><!-- System.Collections.ObjectModel.Collection{System.String} --> | The returning ColumnNames based on the given returningColumnNamesType. | | + | |
| - | === Parameters === | + | == Return Value == |
| - | ^ Name ^ Type ^ Description ^ | + | * Type:Collection<[[ThinkGeo.MapSuite.Core.Feature|Feature]]> |
| - | | returningColumnNamesType | [[ThinkGeo.MapSuite.PortableCore.ReturningColumnsType|ReturningColumnsType]]<!-- ThinkGeo.MapSuite.PortableCore.ReturningColumnsType --> | The passed in returningColumnType. | | + | * Description:N/A |
| - | <!-- ThinkGeo.MapSuite.PortableCore.FeatureSource --> | + | == Parameters == |
| - | [[#Protected Methods|Go Back]] | + | * //boundingBox// |
| - | ==== MemberwiseClone() ==== | + | * Type:[[ThinkGeo.MapSuite.Core.RectangleShape|RectangleShape]] |
| - | === Return Value === | + | * Description:N/A |
| - | ^ Return Type ^ Description ^ | + | |
| - | | Object<!-- System.Object --> | | | + | |
| - | === Parameters === | + | * //returningColumnNames// |
| - | ^ Name ^ Type ^ Description ^ | + | * Type:IEnumerable<String> |
| + | * Description:N/A | ||
| - | <!-- System.Object --> | + | <div newline></div> |
| - | [[#Protected Methods|Go Back]] | + | ** {{wiki:ProtectedMethod.gif|}} ConvertToExternalProjectionIfNecessary(Collection<Feature>) ** |
| - | ==== OnClosedFeatureSource(ClosedFeatureSourceEventArgs) ==== | + | |
| - | This method allows you to raise the ClosedFeatureSource event from a derived class. | + | |
| - | === Remarks === | + | |
| - | You can call this method from a derived class to enable it to raise the ClosedFeatureSource event. This may be useful if you plan to extend the FeatureSource and you need access to the event. | + | |
| - | Details on the event: | + | * //N/A// |
| + | == Remarks == | ||
| + | * //N/A// | ||
| - | This event is called after the closing of the FeatureSource. Technically, this event is called after the calling of the Close method on the FeatureSource and after the protected CloseCore method. | + | == Return Value == |
| + | * Type:Collection<[[ThinkGeo.MapSuite.Core.Feature|Feature]]> | ||
| + | * Description:N/A | ||
| - | It is typical that the FeatureSource may be opened and closed may times during the life cycle of your application. The type of control the MapEngine is embedded in will dictate how often this happens. For example, in the case of the Web Edition, each time a FeatureSource is in the Ajax or Post Back part of the page cycle, it will close the FeatureSource before returning back to the client. This is to conserve resources, as the web is a connection-less environment. In the case of the Desktop Edition, we can keep the FeaureSources open, knowing that we can maintain a persistent connection. | + | == Parameters == |
| - | === Return Value === | + | * //returnFeatures// |
| - | ^ Return Type ^ Description ^ | + | * Type:Collection<[[ThinkGeo.MapSuite.Core.Feature|Feature]]> |
| - | | Void<!-- System.Void --> | | | + | * Description:N/A |
| - | === Parameters === | + | <div newline></div> |
| - | ^ Name ^ Type ^ Description ^ | + | ** {{wiki:ProtectedMethod.gif|}} ProcessTransaction(RectangleShape,Collection<Feature>,Boolean) ** |
| - | | e | [[ThinkGeo.MapSuite.PortableCore.ClosedFeatureSourceEventArgs|ClosedFeatureSourceEventArgs]]<!-- ThinkGeo.MapSuite.PortableCore.ClosedFeatureSourceEventArgs --> | This parameter is the event arguments which define the parameters passed to the recipient of the event. | | + | |
| - | <!-- ThinkGeo.MapSuite.PortableCore.FeatureSource --> | + | * //N/A// |
| - | [[#Protected Methods|Go Back]] | + | == Remarks == |
| - | ==== OnClosingFeatureSource(ClosingFeatureSourceEventArgs) ==== | + | * //N/A// |
| - | This method allows you to raise the ClosingFeatureSource event from a derived class. | + | |
| - | === Remarks === | + | |
| - | You can call this method from a derived class to enable it to raise the ClosingFeatureSource event. This may be useful if you plan to extend the FeatureSource and you need access to the event. | + | |
| - | Details on the event: | + | == Return Value == |
| + | * Type:Void | ||
| + | * Description:N/A | ||
| - | This event is called before the closing of the FeatureSource. Technically, this event is called after the calling of the Close method on the FeatureSource, but before the protected CloseCore method. | + | == Parameters == |
| + | * //boundingBox// | ||
| + | * Type:[[ThinkGeo.MapSuite.Core.RectangleShape|RectangleShape]] | ||
| + | * Description:N/A | ||
| - | It is typical that the FeatureSource may be opened and closed may times during the life cycle of your application. The type of control the MapEngine is embedded in will dictate how often this happens. For example, in the case of the Web Edition, each time a FeatureSource is in the Ajax or Post Back part of the page cycle, it will close the FeatureSource before returning back to the client. This is to conserve resources, as the web is a connection-less environment. In the case of the Desktop Edition, we can keep the FeaureSources open, knowing that we can maintain a persistent connection. | + | * //returnFeatures// |
| - | === Return Value === | + | * Type:Collection<[[ThinkGeo.MapSuite.Core.Feature|Feature]]> |
| - | ^ Return Type ^ Description ^ | + | * Description:N/A |
| - | | Void<!-- System.Void --> | | | + | |
| - | === Parameters === | + | * //needUpdateProjection// |
| - | ^ Name ^ Type ^ Description ^ | + | * Type:Boolean |
| - | | e | [[ThinkGeo.MapSuite.PortableCore.ClosingFeatureSourceEventArgs|ClosingFeatureSourceEventArgs]]<!-- ThinkGeo.MapSuite.PortableCore.ClosingFeatureSourceEventArgs --> | This parameter is the event arguments which define the parameters passed to the recipient of the event. | | + | * Description:N/A |
| - | <!-- ThinkGeo.MapSuite.PortableCore.FeatureSource --> | + | <div newline></div> |
| - | [[#Protected Methods|Go Back]] | + | ** {{wiki:ProtectedMethod.gif|}} GetWrappingFeaturesLeft(RectangleShape,Double,Double,IEnumerable<String>,RectangleShape) ** |
| - | ==== OnCommittedTransaction(CommittedTransactionEventArgs) ==== | + | |
| - | This method allows you to raise the CommittedTransaction event from a derived class. | + | |
| - | === Remarks === | + | |
| - | You can call this method from a derived class to enable it to raise the CommittedTransaction event. This may be useful if you plan to extend the FeatureSource and you need access to the event. | + | |
| - | Details on the event: | + | * //N/A// |
| + | == Remarks == | ||
| + | * //N/A// | ||
| - | This event is raised after the CommitTransactionCore is called and allows you access to the TransactionBuffer and the TransactionResults object before CommitTransaction method is returned. | + | == Return Value == |
| + | * Type:Collection<[[ThinkGeo.MapSuite.Core.Feature|Feature]]> | ||
| + | * Description:N/A | ||
| - | With this event, you can analyze the results of the transaction and do any cleanup code necessary. In the event some of the records did not commit, you can handle these items here. The TransactionResults object is passed out of the CommitTransaction method so you could analyze it then; however, this is the only place where you have access to both the TransactionResults object and the TransactionBuffer object at the same time. These are useful together to try and determine what went wrong and possibly try and re-commit them. | + | == Parameters == |
| + | * //boundingBox// | ||
| + | * Type:[[ThinkGeo.MapSuite.Core.RectangleShape|RectangleShape]] | ||
| + | * Description:N/A | ||
| - | At the time of this event, you will technically be out of the current transaction. | + | * //screenWidth// |
| - | === Return Value === | + | * Type:Double |
| - | ^ Return Type ^ Description ^ | + | * Description:N/A |
| - | | Void<!-- System.Void --> | | | + | |
| - | === Parameters === | + | * //screenHeight// |
| - | ^ Name ^ Type ^ Description ^ | + | * Type:Double |
| - | | e | [[ThinkGeo.MapSuite.PortableCore.CommittedTransactionEventArgs|CommittedTransactionEventArgs]]<!-- ThinkGeo.MapSuite.PortableCore.CommittedTransactionEventArgs --> | This parameter is the event arguments which define the parameters passed to the recipient of the event. | | + | * Description:N/A |
| - | <!-- ThinkGeo.MapSuite.PortableCore.FeatureSource --> | + | * //returningColumnNames// |
| - | [[#Protected Methods|Go Back]] | + | * Type:IEnumerable<String> |
| - | ==== OnCommittingTransaction(CommittingTransactionEventArgs) ==== | + | * Description:N/A |
| - | This method allows you to raise the CommittingTransaction event from a derived class. | + | |
| - | === Remarks === | + | |
| - | You can call this method from a derived class to enable it to raise the CommittingTransaction event. This may be useful if you plan to extend the FeatureSource and you need access to the event. | + | |
| - | Details on the event: | + | * //wrappingExtent// |
| + | * Type:[[ThinkGeo.MapSuite.Core.RectangleShape|RectangleShape]] | ||
| + | * Description:N/A | ||
| - | This event is raised before the CommitTransactionCore is called and allows you access to the TransactionBuffer before the transaction is committed. It also allows you to cancel the pending transaction. The TransactionBuffer is the object that stores all of the pending transactions and is accessible through this event to allow you either add, remove or modify transactions. | + | <div newline></div> |
| + | ** {{wiki:ProtectedMethod.gif|}} GetWrappingFeaturesRight(RectangleShape,Double,Double,IEnumerable<String>,RectangleShape) ** | ||
| - | In the event that you cancel the CommitTransaction method, the transaction remains intact and you will still be editing. This makes it a nice place to possibly check for connectivity before the TransactionCore code is run, which is where the records are actually committed. Calling the RollBackTransaction method is the only way to permanently cancel a pending transaction without committing it. | + | * //N/A// |
| - | === Return Value === | + | == Remarks == |
| - | ^ Return Type ^ Description ^ | + | * //N/A// |
| - | | Void<!-- System.Void --> | | | + | |
| - | === Parameters === | + | == Return Value == |
| - | ^ Name ^ Type ^ Description ^ | + | * Type:Collection<[[ThinkGeo.MapSuite.Core.Feature|Feature]]> |
| - | | e | [[ThinkGeo.MapSuite.PortableCore.CommittingTransactionEventArgs|CommittingTransactionEventArgs]]<!-- ThinkGeo.MapSuite.PortableCore.CommittingTransactionEventArgs --> | This parameter is the event arguments which define the parameters passed to the recipient of the event. | | + | * Description:N/A |
| - | <!-- ThinkGeo.MapSuite.PortableCore.FeatureSource --> | + | == Parameters == |
| - | [[#Protected Methods|Go Back]] | + | * //boundingBox// |
| - | ==== OnCustomColumnFetch(CustomColumnFetchEventArgs) ==== | + | * Type:[[ThinkGeo.MapSuite.Core.RectangleShape|RectangleShape]] |
| - | This method allows you to raise the CustomColumnFetch event from a derived class. | + | * Description:N/A |
| - | === Remarks === | + | |
| - | You can call this method from a derived class to enable it to raise the CustomColumnFetch event. This may be useful if you plan to extend the FeatureSource and you need access to user-definable field data. | + | |
| - | Details on the event: | + | * //screenWidth// |
| + | * Type:Double | ||
| + | * Description:N/A | ||
| - | This event is raised when fields are requested in a feature source method that do not exist in the feature source. It allows you supplement the data from any outside source you may have. | + | * //screenHeight// |
| + | * Type:Double | ||
| + | * Description:N/A | ||
| - | It is used primarily when you have data relating to a particular feature or set of features that is not within source of the data. For example, you may have a shape file of the world whose .dbf component describes the area and population of each country. Additionally, in an outside SQL Server table, you may also have data about the countries, and it is this data that you wish to use for determining how you want to color each country. | + | * //returningColumnNames// |
| + | * Type:IEnumerable<String> | ||
| + | * Description:N/A | ||
| - | To integrate this SQL data, you simply create a file name that does not exist in the .dbf file. Whenever Map Suite is queried to return records that specifically require this field, the FeatureSource will raise this event and allow you the developer to supply the data. In this way, you can query the SQL table and store the data in some sort of collection, and then when the event is raised, simply supply that data. | + | * //wrappingExtent// |
| + | * Type:[[ThinkGeo.MapSuite.Core.RectangleShape|RectangleShape]] | ||
| + | * Description:N/A | ||
| - | As this is an event, it will raise for each feature and field combination requested. This means that the event can be raised quite often, and we suggest that you cache the data you wish to supply in memory. We recommend against sending out a new SQL query each time this event is raised. Image that you are supplementing two columns and your query returns 2,000 rows. This means that if you requested those fields, the event would be raised 4,000 times. | + | <div newline></div> |
| - | === Return Value === | + | ** {{wiki:ProtectedMethod.gif|}} GetFeaturesForDrawingCore(RectangleShape,Double,Double,IEnumerable<String>) ** |
| - | ^ Return Type ^ Description ^ | + | |
| - | | Void<!-- System.Void --> | | | + | |
| - | === Parameters === | + | * //N/A// |
| - | ^ Name ^ Type ^ Description ^ | + | == Remarks == |
| - | | e | [[ThinkGeo.MapSuite.PortableCore.CustomColumnFetchEventArgs|CustomColumnFetchEventArgs]]<!-- ThinkGeo.MapSuite.PortableCore.CustomColumnFetchEventArgs --> | This parameter is the event arguments which define the parameters passed to the recipient of the event. | | + | * //N/A// |
| - | <!-- ThinkGeo.MapSuite.PortableCore.FeatureSource --> | + | == Return Value == |
| - | [[#Protected Methods|Go Back]] | + | * Type:Collection<[[ThinkGeo.MapSuite.Core.Feature|Feature]]> |
| - | ==== OnDrawingProgressChanged(DrawingProgressChangedEventArgs) ==== | + | * Description:N/A |
| - | === Return Value === | + | |
| - | ^ Return Type ^ Description ^ | + | |
| - | | Void<!-- System.Void --> | | | + | |
| - | === Parameters === | + | == Parameters == |
| - | ^ Name ^ Type ^ Description ^ | + | * //boundingBox// |
| - | | e | [[ThinkGeo.MapSuite.PortableCore.DrawingProgressChangedEventArgs|DrawingProgressChangedEventArgs]]<!-- ThinkGeo.MapSuite.PortableCore.DrawingProgressChangedEventArgs --> | | | + | * Type:[[ThinkGeo.MapSuite.Core.RectangleShape|RectangleShape]] |
| + | * Description:N/A | ||
| - | <!-- ThinkGeo.MapSuite.PortableCore.FeatureSource --> | + | * //screenWidth// |
| - | [[#Protected Methods|Go Back]] | + | * Type:Double |
| - | ==== OnOpenedFeatureSource(OpenedFeatureSourceEventArgs) ==== | + | * Description:N/A |
| - | This method allows you to raise the OpenedFeatureSource event from a derived class. | + | |
| - | === Remarks === | + | |
| - | You can call this method from a derived class to enable it to raise the OpenedFeatureSource event. This may be useful if you plan to extend the FeatureSource and you need access to the event. | + | |
| - | Details on the event: | + | * //screenHeight// |
| + | * Type:Double | ||
| + | * Description:N/A | ||
| - | This event is called after the opening of the FeatureSource. Technically, this event is called after the calling of the Open method on the FeatureSource and after the protected OpenCore method is called. | + | * //returningColumnNames// |
| + | * Type:IEnumerable<String> | ||
| + | * Description:N/A | ||
| - | It is typical that the FeatureSource may be opened and closed may times during the life cycle of your application. The type of control the MapEngine is embedded in will dictate how often this happens. For example, in the case of the Web Edition, each time a FeatureSource is in the Ajax or Post Back part of the page cycle, it will close the FeatureSource before returning back to the client. This is to conserve resources, as the web is a connection-less environment. In the case of the Desktop Edition, we can keep the FeaureSources open, knowing that we can maintain a persistent connection. | + | <div newline></div> |
| - | === Return Value === | + | ** {{wiki:ProtectedMethod.gif|}} SpatialQueryCore(BaseShape,QueryType,IEnumerable<String>) ** |
| - | ^ Return Type ^ Description ^ | + | |
| - | | Void<!-- System.Void --> | | | + | |
| - | === Parameters === | + | * //N/A// |
| - | ^ Name ^ Type ^ Description ^ | + | == Remarks == |
| - | | e | [[ThinkGeo.MapSuite.PortableCore.OpenedFeatureSourceEventArgs|OpenedFeatureSourceEventArgs]]<!-- ThinkGeo.MapSuite.PortableCore.OpenedFeatureSourceEventArgs --> | This parameter is the event arguments which define the parameters passed to the recipient of the event. | | + | * //N/A// |
| - | <!-- ThinkGeo.MapSuite.PortableCore.FeatureSource --> | + | == Return Value == |
| - | [[#Protected Methods|Go Back]] | + | * Type:Collection<[[ThinkGeo.MapSuite.Core.Feature|Feature]]> |
| - | ==== OnOpeningFeatureSource(OpeningFeatureSourceEventArgs) ==== | + | * Description:N/A |
| - | This method allows you to raise the OpeningFeatureSource event from a derived class. | + | |
| - | === Remarks === | + | |
| - | You can call this method from a derived class to enable it to raise the OpeningFeatureSource event. This may be useful if you plan to extend the FeatureSource and you need access to the event. | + | |
| - | Details on the event: | + | == Parameters == |
| + | * //targetShape// | ||
| + | * Type:[[ThinkGeo.MapSuite.Core.BaseShape|BaseShape]] | ||
| + | * Description:N/A | ||
| - | This event is called before the opening of the FeatureSource. Technically, this event is called after the calling of the Open method on the FeatureSource, but before the protected OpenCore method. | + | * //queryType// |
| + | * Type:[[ThinkGeo.MapSuite.Core.QueryType|QueryType]] | ||
| + | * Description:N/A | ||
| - | It is typical that the FeatureSource may be opened and closed may times during the life cycle of your application. The type of control the MapEngine is embedded in will dictate how often this happens. For example, in the case of the Web Edition, each time a FeatureSource is in the Ajax or Post Back part of the page cycle, it will close the FeatureSource before returning back to the client. This is to conserve resources, as the web is a connection-less environment. In the case of the Desktop Edition, we can keep the FeaureSources open, knowing that we can maintain a persistent connection. | + | * //returningColumnNames// |
| - | === Return Value === | + | * Type:IEnumerable<String> |
| - | ^ Return Type ^ Description ^ | + | * Description:N/A |
| - | | Void<!-- System.Void --> | | | + | |
| - | === Parameters === | + | <div newline></div> |
| - | ^ Name ^ Type ^ Description ^ | + | ** {{wiki:ProtectedMethod.gif|}} GetFeaturesNearestToCore(BaseShape,GeographyUnit,Int32,IEnumerable<String>) ** |
| - | | e | [[ThinkGeo.MapSuite.PortableCore.OpeningFeatureSourceEventArgs|OpeningFeatureSourceEventArgs]]<!-- ThinkGeo.MapSuite.PortableCore.OpeningFeatureSourceEventArgs --> | This parameter is the event arguments which define the parameters passed to the recipient of the event. | | + | |
| - | <!-- ThinkGeo.MapSuite.PortableCore.FeatureSource --> | + | * //N/A// |
| - | [[#Protected Methods|Go Back]] | + | == Remarks == |
| - | ==== OnStreamLoading(StreamLoadingEventArgs) ==== | + | * //N/A// |
| - | === Return Value === | + | |
| - | ^ Return Type ^ Description ^ | + | |
| - | | Void<!-- System.Void --> | | | + | |
| - | === Parameters === | + | == Return Value == |
| - | ^ Name ^ Type ^ Description ^ | + | * Type:Collection<[[ThinkGeo.MapSuite.Core.Feature|Feature]]> |
| - | | e | [[ThinkGeo.MapSuite.PortableCore.StreamLoadingEventArgs|StreamLoadingEventArgs]]<!-- ThinkGeo.MapSuite.PortableCore.StreamLoadingEventArgs --> | | | + | * Description:N/A |
| - | <!-- ThinkGeo.MapSuite.PortableCore.GridFeatureSource --> | + | == Parameters == |
| - | [[#Protected Methods|Go Back]] | + | * //targetShape// |
| - | ==== OpenCore() ==== | + | * Type:[[ThinkGeo.MapSuite.Core.BaseShape|BaseShape]] |
| - | This method opens the FeatureSource so that it is initialized and ready to use. | + | * Description:N/A |
| - | === 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 virtual 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. | + | * //unitOfData// |
| - | === Return Value === | + | * Type:[[ThinkGeo.MapSuite.Core.GeographyUnit|GeographyUnit]] |
| - | ^ Return Type ^ Description ^ | + | * Description:N/A |
| - | | Void<!-- System.Void --> | | | + | |
| - | === Parameters === | + | * //maxItemsToFind// |
| - | ^ Name ^ Type ^ Description ^ | + | * Type:Int32 |
| + | * Description:N/A | ||
| - | <!-- ThinkGeo.MapSuite.PortableCore.FeatureSource(overriden) --> | + | * //returningColumnNames// |
| - | [[#Protected Methods|Go Back]] | + | * Type:IEnumerable<String> |
| - | ==== SpatialQueryCore(BaseShape, QueryType, IEnumerable<String>) ==== | + | * Description:N/A |
| - | This method returns all of the InternalFeatures based on the target Feature and the spatial query type specified. | + | |
| - | === Remarks === | + | |
| - | This method returns all of the InternalFeatures based on the target Feature and the spatial query type specified below. If you override this method, you do not need to consider transactions. It is suggested that if you are looking to speed up this method that you first override the GetFeaturesInsideBoundingBoxCore and then re-test this method, as it relies heavily on that method internally. See more information below. | + | |
| - | <strong>Spatial Query Types:</strong> | + | <div newline></div> |
| + | ** {{wiki:ProtectedMethod.gif|}} GetFeaturesWithinDistanceOfCore(BaseShape,GeographyUnit,DistanceUnit,Double,IEnumerable<String>) ** | ||
| - | <strong>Disjoint</strong> - This method returns InternalFeatures where the specific Feature and the targetShape have no points in common. | + | * //N/A// |
| + | == Remarks == | ||
| + | * //N/A// | ||
| - | <strong>Intersects</strong> - This method returns InternalFeatures where the specific Feature and the targetShape have at least one point in common. | + | == Return Value == |
| + | * Type:Collection<[[ThinkGeo.MapSuite.Core.Feature|Feature]]> | ||
| + | * Description:N/A | ||
| - | <strong>Touches</strong> - This method returns InternalFeatures where the specific Feature and the targetShape have at least one boundary point in common, but no interior points. | + | == Parameters == |
| + | * //targetShape// | ||
| + | * Type:[[ThinkGeo.MapSuite.Core.BaseShape|BaseShape]] | ||
| + | * Description:N/A | ||
| - | <strong>Crosses</strong> - This method returns InternalFeatures where the specific Feature and the targetShape share some but not all interior points. | + | * //unitOfData// |
| + | * Type:[[ThinkGeo.MapSuite.Core.GeographyUnit|GeographyUnit]] | ||
| + | * Description:N/A | ||
| - | <strong>Within</strong> - This method returns InternalFeatures where the specific Feature lies within the interior of the targetShape. | + | * //distanceUnit// |
| + | * Type:[[ThinkGeo.MapSuite.Core.DistanceUnit|DistanceUnit]] | ||
| + | * Description:N/A | ||
| - | <strong>Contains</strong> - This method returns InternalFeatures where the specific Feature lies within the interior of the current shape. | + | * //distance// |
| + | * Type:Double | ||
| + | * Description:N/A | ||
| - | <strong>Overlaps</strong> - This method returns InternalFeatures where the specific Feature and the targetShape share some but not all points in common. | + | * //returningColumnNames// |
| + | * Type:IEnumerable<String> | ||
| + | * Description:N/A | ||
| - | <strong>TopologicalEqual</strong> - This method returns InternalFeatures where the specific Feature and the target Shape are topologically equal. | + | <div newline></div> |
| + | ** {{wiki:ProtectedMethod.gif|}} OnCustomColumnFetch(CustomColumnFetchEventArgs) ** | ||
| - | The default implementation of SpatialQueryCore uses the GetFeaturesInsideBoundingBoxCore method to pre-filter the spatial query. We strongly recommend that you provide your own implementation for this method that will be more efficient. When you override this method, we recommend that you use any spatial indexes you have at your disposal to make this method as fast as possible. | + | * //N/A// |
| - | === Return Value === | + | == Remarks == |
| - | ^ Return Type ^ Description ^ | + | * //N/A// |
| - | | Collection<[[ThinkGeo.MapSuite.PortableCore.Feature|Feature]]><!-- System.Collections.ObjectModel.Collection{ThinkGeo.MapSuite.PortableCore.Feature} --> | The return decimalDegreesValue is a collection of InternalFeatures that match the spatial query you executed based on the TargetShape. | | + | |
| - | === Parameters === | + | == Return Value == |
| - | ^ Name ^ Type ^ Description ^ | + | * Type:Void |
| - | | targetShape | [[ThinkGeo.MapSuite.PortableCore.BaseShape|BaseShape]]<!-- ThinkGeo.MapSuite.PortableCore.BaseShape --> | This parameter specifies the target shape used in the spatial query. | | + | * Description:N/A |
| - | | queryType | [[ThinkGeo.MapSuite.PortableCore.QueryType|QueryType]]<!-- ThinkGeo.MapSuite.PortableCore.QueryType --> | This parameter specifies what kind of spatial query you wish to perform. | | + | |
| - | | returningColumnNames | IEnumerable<String><!-- System.Collections.Generic.IEnumerable{System.String} --> | This parameter allows you to select the field names of the column data you wish to return with each Feature. | | + | |
| - | <!-- ThinkGeo.MapSuite.PortableCore.FeatureSource --> | + | == Parameters == |
| - | [[#Protected Methods|Go Back]] | + | * //e// |
| - | ===== Public Properties ===== | + | * Type:[[ThinkGeo.MapSuite.Core.CustomColumnFetchEventArgs|CustomColumnFetchEventArgs]] |
| - | ==== CanExecuteSqlQuery ==== | + | * Description:N/A |
| - | This property specifies whether the FeatureSource can excute a SQL query or not. If it is false, then it will throw exception when these APIs are calleds: ExecuteScalar, ExecuteNonQuery, ExecuteQuery | + | |
| - | === Remarks === | + | |
| - | The default implementation is false. | + | |
| - | === Return Value === | + | |
| - | ^ Return Type ^ | + | |
| - | | Boolean<!-- System.Boolean --> | | + | |
| - | <!-- ThinkGeo.MapSuite.PortableCore.FeatureSource --> | + | <div newline></div> |
| - | [[#Public Properties|Go Back]] | + | ** {{wiki:ProtectedMethod.gif|}} OnCommittingTransaction(CommittingTransactionEventArgs) ** |
| - | ==== CanModifyColumnStructure ==== | + | |
| - | === Return Value === | + | |
| - | ^ Return Type ^ | + | |
| - | | Boolean<!-- System.Boolean --> | | + | |
| - | <!-- ThinkGeo.MapSuite.PortableCore.FeatureSource --> | + | * //N/A// |
| - | [[#Public Properties|Go Back]] | + | == Remarks == |
| - | ==== CellSize ==== | + | * //N/A// |
| - | Gets the cell size of the grid. | + | |
| - | === Return Value === | + | |
| - | ^ Return Type ^ | + | |
| - | | Double<!-- System.Double --> | | + | |
| - | <!-- ThinkGeo.MapSuite.PortableCore.GridFeatureSource --> | + | == Return Value == |
| - | [[#Public Properties|Go Back]] | + | * Type:Void |
| - | ==== DataValueColumnName ==== | + | * Description:N/A |
| - | === Return Value === | + | |
| - | ^ Return Type ^ | + | |
| - | | String<!-- System.String --> | | + | |
| - | <!-- ThinkGeo.MapSuite.PortableCore.GridFeatureSource --> | + | == Parameters == |
| - | [[#Public Properties|Go Back]] | + | * //e// |
| - | ==== FeatureIdsToExclude ==== | + | * Type:[[ThinkGeo.MapSuite.Core.CommittingTransactionEventArgs|CommittingTransactionEventArgs]] |
| - | A collection of strings representing record id of features not to get in the Layer. | + | * Description:N/A |
| - | === Remarks === | + | |
| - | This string collection is a handy place to specify what records not to get from the source. Suppose you have a shape file of roads and you want to hide the roads within a particular rectangle, simply execute GetFeaturesInsideBoundingBox() and add the id of the return features to the collection and forget about them. Since you can set this by Layer it makes is easy to determine what to and what not to. | + | |
| - | === Return Value === | + | |
| - | ^ Return Type ^ | + | |
| - | | Collection<String><!-- System.Collections.ObjectModel.Collection{System.String} --> | | + | |
| - | <!-- ThinkGeo.MapSuite.PortableCore.FeatureSource --> | + | <div newline></div> |
| - | [[#Public Properties|Go Back]] | + | ** {{wiki:ProtectedMethod.gif|}} OnCommittedTransaction(CommittedTransactionEventArgs) ** |
| - | ==== GeoCache ==== | + | |
| - | The cache system. | + | |
| - | === Remarks === | + | |
| - | You must set IsActive to true for the Cache system. The default is not active. | + | |
| - | === Return Value === | + | |
| - | ^ Return Type ^ | + | |
| - | | [[ThinkGeo.MapSuite.PortableCore.FeatureCache|FeatureCache]]<!-- ThinkGeo.MapSuite.PortableCore.FeatureCache --> | | + | |
| - | <!-- ThinkGeo.MapSuite.PortableCore.FeatureSource --> | + | * //N/A// |
| - | [[#Public Properties|Go Back]] | + | == Remarks == |
| - | ==== Id ==== | + | * //N/A// |
| - | === Return Value === | + | |
| - | ^ Return Type ^ | + | |
| - | | String<!-- System.String --> | | + | |
| - | <!-- ThinkGeo.MapSuite.PortableCore.FeatureSource --> | + | == Return Value == |
| - | [[#Public Properties|Go Back]] | + | * Type:Void |
| - | ==== IsEditable ==== | + | * Description:N/A |
| - | 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. | + | == Parameters == |
| - | === Return Value === | + | * //e// |
| - | ^ Return Type ^ | + | * Type:[[ThinkGeo.MapSuite.Core.CommittedTransactionEventArgs|CommittedTransactionEventArgs]] |
| - | | Boolean<!-- System.Boolean --> | | + | * Description:N/A |
| - | <!-- ThinkGeo.MapSuite.PortableCore.FeatureSource(overriden) --> | + | <div newline></div> |
| - | [[#Public Properties|Go Back]] | + | ** {{wiki:ProtectedMethod.gif|}} OnOpeningFeatureSource(OpeningFeatureSourceEventArgs) ** |
| - | ==== IsInTransaction ==== | + | |
| - | This property returns true if the FeatureSource is in a transaction and false if it is not. | + | |
| - | === Remarks === | + | |
| - | To enter a transaction, you must first call the BeginTransaction method of the FeatureSource. It is possible that some FeatureSources are read-only and do not allow edits. To end a transaction, you must either call CommitTransaction or RollbackTransaction. | + | |
| - | === Return Value === | + | |
| - | ^ Return Type ^ | + | |
| - | | Boolean<!-- System.Boolean --> | | + | |
| - | <!-- ThinkGeo.MapSuite.PortableCore.FeatureSource --> | + | * //N/A// |
| - | [[#Public Properties|Go Back]] | + | == Remarks == |
| - | ==== IsOpen ==== | + | * //N/A// |
| - | This property returns true if the FeatureSource is open and false if it is not. | + | |
| - | === Remarks === | + | |
| - | Various methods on the FeatureSource require that it be in an open state. If one of those methods is called when the state is not open, then the method will throw an exception. To enter the open state, you must call the FeatureSource's Open method. The method will raise an exception if the current FeatureSource is already open. | + | |
| - | === Return Value === | + | |
| - | ^ Return Type ^ | + | |
| - | | Boolean<!-- System.Boolean --> | | + | |
| - | <!-- ThinkGeo.MapSuite.PortableCore.FeatureSource --> | + | == Return Value == |
| - | [[#Public Properties|Go Back]] | + | * Type:Void |
| - | ==== IsTransactionLive ==== | + | * Description:N/A |
| - | This property returns true if the features currently modified in a transaction are expected to reflect their state when calling other methods on the FeatureSource, such as spatial queries. | + | |
| - | === Remarks === | + | |
| - | The live transaction concept means that all of the modifications you perform during a transaction are live from the standpoint of the querying methods on the object. | + | |
| - | As 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, 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 would be considered live, though not committed. | + | == Parameters == |
| + | * //e// | ||
| + | * Type:[[ThinkGeo.MapSuite.Core.OpeningFeatureSourceEventArgs|OpeningFeatureSourceEventArgs]] | ||
| + | * Description:N/A | ||
| - | In the case where you modify records -- such as expanding the size of a polygon -- those changes are reflected as well. 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 instead would return the larger records. In this case, the larger records are returned. You can set this property to be false, as well; in which case, all of the spatially related methods would ignore anything that is currently in the transaction buffer waiting to be committed. In such a case, only after committing the transaction would the FeatureSource reflect the changes. | + | <div newline></div> |
| - | === Return Value === | + | ** {{wiki:ProtectedMethod.gif|}} OnOpenedFeatureSource(OpenedFeatureSourceEventArgs) ** |
| - | ^ Return Type ^ | + | |
| - | | Boolean<!-- System.Boolean --> | | + | |
| - | <!-- ThinkGeo.MapSuite.PortableCore.FeatureSource --> | + | * //N/A// |
| - | [[#Public Properties|Go Back]] | + | == Remarks == |
| - | ==== LowerLeftPoint ==== | + | * //N/A// |
| - | Gets LowerLeft PointShape of the grid. | + | |
| - | === Return Value === | + | |
| - | ^ Return Type ^ | + | |
| - | | [[ThinkGeo.MapSuite.PortableCore.PointShape|PointShape]]<!-- ThinkGeo.MapSuite.PortableCore.PointShape --> | | + | |
| - | <!-- ThinkGeo.MapSuite.PortableCore.GridFeatureSource --> | + | == Return Value == |
| - | [[#Public Properties|Go Back]] | + | * Type:Void |
| - | ==== MaxRecordsToDraw ==== | + | * Description:N/A |
| - | === Return Value === | + | |
| - | ^ Return Type ^ | + | |
| - | | Int32<!-- System.Int32 --> | | + | |
| - | <!-- ThinkGeo.MapSuite.PortableCore.FeatureSource --> | + | == Parameters == |
| - | [[#Public Properties|Go Back]] | + | * //e// |
| - | ==== NoDataValue ==== | + | * Type:[[ThinkGeo.MapSuite.Core.OpenedFeatureSourceEventArgs|OpenedFeatureSourceEventArgs]] |
| - | Gets the NoDataValue in the grid. | + | * Description:N/A |
| - | === Return Value === | + | |
| - | ^ Return Type ^ | + | |
| - | | Double<!-- System.Double --> | | + | |
| - | <!-- ThinkGeo.MapSuite.PortableCore.GridFeatureSource --> | + | <div newline></div> |
| - | [[#Public Properties|Go Back]] | + | ** {{wiki:ProtectedMethod.gif|}} OnClosingFeatureSource(ClosingFeatureSourceEventArgs) ** |
| - | ==== NumberOfColumns ==== | + | |
| - | Gets column number of the grid. | + | |
| - | === Return Value === | + | |
| - | ^ Return Type ^ | + | |
| - | | Int32<!-- System.Int32 --> | | + | |
| - | <!-- ThinkGeo.MapSuite.PortableCore.GridFeatureSource --> | + | * //N/A// |
| - | [[#Public Properties|Go Back]] | + | == Remarks == |
| - | ==== NumberOfRows ==== | + | * //N/A// |
| - | Gets row number of the grid. | + | |
| - | === Return Value === | + | |
| - | ^ Return Type ^ | + | |
| - | | Int32<!-- System.Int32 --> | | + | |
| - | <!-- ThinkGeo.MapSuite.PortableCore.GridFeatureSource --> | + | == Return Value == |
| - | [[#Public Properties|Go Back]] | + | * Type:Void |
| - | ==== PathFilename ==== | + | * Description:N/A |
| - | This property gets and sets the path and file of the grid file you want to use. | + | |
| - | === Remarks === | + | |
| - | When you specify the path and file name it should be in the correct format. If the path and filename you provided we cannot find it then we will throw an exception. | + | |
| - | === Return Value === | + | |
| - | ^ Return Type ^ | + | |
| - | | String<!-- System.String --> | | + | |
| - | <!-- ThinkGeo.MapSuite.PortableCore.GridFeatureSource --> | + | == Parameters == |
| - | [[#Public Properties|Go Back]] | + | * //e// |
| - | ==== Projection ==== | + | * Type:[[ThinkGeo.MapSuite.Core.ClosingFeatureSourceEventArgs|ClosingFeatureSourceEventArgs]] |
| - | This property holds the projection object that is used within the FeatureSource to ensure that features inside of the FeatureSource are projected. | + | * Description:N/A |
| - | === Remarks === | + | |
| - | By default this property is null, meaning that the data being passed back from any methods on the FeatureSource will be in the coordinate system of the raw data. When you specify a projection object in the property, all incoming and outgoing method calls will subject the features to projection. | + | |
| - | For example, if the spatial database you are using has all of its data stored in decimal degrees, but you want to see the data in UTM, you would create a projection object that goes from decimal degrees to UTM and set that as the projection. With this one property set, we will ensure that it will seem to you the developer that all of the data in the FeatureSource is in UTM. That means every spatial query will return UTM projected shapes. You can even pass in UTM shapes for the parameters. Internally, we will ensure that the shapes are converted to and from the projection without any intervention on the developer's part. | + | <div newline></div> |
| + | ** {{wiki:ProtectedMethod.gif|}} OnClosedFeatureSource(ClosedFeatureSourceEventArgs) ** | ||
| - | In fact, even when you override virtual or abstract core methods in the FeatureSource, you will not need to know about projections at all. Simply work with the data in its native coordinate system. We will handle all of the projection at the high level method. | + | * //N/A// |
| - | === Return Value === | + | == Remarks == |
| - | ^ Return Type ^ | + | * //N/A// |
| - | | [[ThinkGeo.MapSuite.PortableCore.Projection|Projection]]<!-- ThinkGeo.MapSuite.PortableCore.Projection --> | | + | |
| - | <!-- ThinkGeo.MapSuite.PortableCore.FeatureSource --> | + | == Return Value == |
| - | [[#Public Properties|Go Back]] | + | * Type:Void |
| - | ==== TransactionBuffer ==== | + | * Description:N/A |
| - | The TransactionBuffer used in the Transaction System. | + | |
| - | === Remarks === | + | |
| - | The Transaction System | + | |
| - | The 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 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 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. | + | == Parameters == |
| + | * //e// | ||
| + | * Type:[[ThinkGeo.MapSuite.Core.ClosedFeatureSourceEventArgs|ClosedFeatureSourceEventArgs]] | ||
| + | * Description:N/A | ||
| - | In the case where the IsLiveTransaction is set to true, then things function slightly differently. The live transaction concept means that all of the modifications you perform during a transaction are live from the standpoint of the querying methods on the object. | + | <div newline></div> |
| + | ** {{wiki:ProtectedMethod.gif|}} ExecuteNonQueryCore(String) ** | ||
| - | As 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, 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 would be considered live, though not committed. | + | * //N/A// |
| + | == Remarks == | ||
| + | * //N/A// | ||
| - | In the case where you modify records -- such as expanding the size of a polygon -- those changes are reflected as well. 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 instead would return the larger records. In this case, the larger records are returned. You can set this property to be false, as well; in which case, all of the spatially related methods would ignore anything that is currently in the transaction buffer waiting to be committed. In such a case, only after committing the transaction would the FeatureSource reflect the changes. | + | == Return Value == |
| - | === Return Value === | + | * Type:Int32 |
| - | ^ Return Type ^ | + | * Description:N/A |
| - | | [[ThinkGeo.MapSuite.PortableCore.TransactionBuffer|TransactionBuffer]]<!-- ThinkGeo.MapSuite.PortableCore.TransactionBuffer --> | | + | |
| - | <!-- ThinkGeo.MapSuite.PortableCore.FeatureSource --> | + | == Parameters == |
| - | [[#Public Properties|Go Back]] | + | * //sqlStatement// |
| - | ===== Protected Properties ===== | + | * Type:String |
| - | ==== CanExecuteSqlQueryCore ==== | + | * Description:N/A |
| - | This property specifies whether the FeatureSource can excute a SQL query or not. If it is false, then it will throw exception when these APIs are calleds: ExecuteScalar, ExecuteNonQuery, ExecuteQuery | + | |
| - | === Remarks === | + | |
| - | The default implementation is false. | + | |
| - | === Return Value === | + | |
| - | ^ Return Type ^ | + | |
| - | | Boolean<!-- System.Boolean --> | | + | |
| - | <!-- ThinkGeo.MapSuite.PortableCore.FeatureSource --> | + | <div newline></div> |
| - | [[#Protected Properties|Go Back]] | + | ** {{wiki:ProtectedMethod.gif|}} GetFeaturesByColumnValueCore(String,String,IEnumerable<String>) ** |
| - | ==== CanModifyColumnStructureCore ==== | + | |
| - | === Return Value === | + | |
| - | ^ Return Type ^ | + | |
| - | | Boolean<!-- System.Boolean --> | | + | |
| - | <!-- ThinkGeo.MapSuite.PortableCore.FeatureSource --> | + | * //N/A// |
| - | [[#Protected Properties|Go Back]] | + | == Remarks == |
| - | ==== FeatureSourceColumns ==== | + | * //N/A// |
| - | This property gets the columns of the feature source. | + | |
| - | === Remarks === | + | |
| - | None. | + | |
| - | === Return Value === | + | |
| - | ^ Return Type ^ | + | |
| - | | Collection<[[ThinkGeo.MapSuite.PortableCore.FeatureSourceColumn|FeatureSourceColumn]]><!-- System.Collections.ObjectModel.Collection{ThinkGeo.MapSuite.PortableCore.FeatureSourceColumn} --> | | + | |
| - | <!-- ThinkGeo.MapSuite.PortableCore.FeatureSource --> | + | == Return Value == |
| - | [[#Protected Properties|Go Back]] | + | * Type:Collection<[[ThinkGeo.MapSuite.Core.Feature|Feature]]> |
| - | ==== IsOpenCore ==== | + | * Description:N/A |
| - | This property returns true if the FeatureSource is open and false if it is not. | + | |
| - | === Remarks === | + | |
| - | Various methods on the FeatureSource require that it be in an open state. If one of those methods is called when the state is not open, then the method will throw an exception. To enter the open state, you must call the FeatureSource's Open method. The method will raise an exception if the current FeatureSource is already open. | + | |
| - | === Return Value === | + | |
| - | ^ Return Type ^ | + | |
| - | | Boolean<!-- System.Boolean --> | | + | |
| - | <!-- ThinkGeo.MapSuite.PortableCore.FeatureSource --> | + | == Parameters == |
| - | [[#Protected Properties|Go Back]] | + | * //columnName// |
| - | ===== Public Events ===== | + | * Type:String |
| - | ==== ClosedFeatureSource ==== | + | * Description:N/A |
| - | This event is called after the closing of the FeatureSource. | + | |
| - | === Remarks === | + | |
| - | This event is called after the closing of the FeatureSource. Technically, this event is called after the calling of the Close method on the FeatureSource and after the protected CloseCore method. | + | |
| - | It is typical that the FeatureSource may be opened and closed may times during the life cycle of your application. The type of control the MapEngine is embedded in will dictate how often this happens. For example, in the case of the Web Edition, each time a FeatureSource is in the Ajax or Post Back part of the page cycle, it will close the FeatureSource before returning back to the client. This is to conserve resources, as the web is a connection-less environment. In the case of the Desktop Edition, we can keep the FeaureSources open, knowing that we can maintain a persistent connection. | + | * //columnValue// |
| - | === Event Arguments === | + | * Type:String |
| - | ^ Event Arguments ^ | + | * Description:N/A |
| - | | [[ThinkGeo.MapSuite.PortableCore.ClosedFeatureSourceEventArgs|ClosedFeatureSourceEventArgs]]<!-- ThinkGeo.MapSuite.PortableCore.ClosedFeatureSourceEventArgs --> | | + | |
| + | * //returningColumnNames// | ||
| + | * Type:IEnumerable<String> | ||
| + | * Description:N/A | ||
| + | |||
| + | <div newline></div> | ||
| + | ** {{wiki:ProtectedMethod.gif|}} ExecuteScalarCore(String) ** | ||
| + | |||
| + | * //N/A// | ||
| + | == Remarks == | ||
| + | * //N/A// | ||
| + | |||
| + | == Return Value == | ||
| + | * Type:Object | ||
| + | * Description:N/A | ||
| + | |||
| + | == Parameters == | ||
| + | * //sqlStatement// | ||
| + | * Type:String | ||
| + | * Description:N/A | ||
| + | |||
| + | <div newline></div> | ||
| + | ** {{wiki:ProtectedMethod.gif|}} ExecuteQueryCore(String) ** | ||
| + | |||
| + | * //N/A// | ||
| + | == Remarks == | ||
| + | * //N/A// | ||
| + | |||
| + | == Return Value == | ||
| + | * Type:[[ThinkGeo.MapSuite.Portable.GeoDataTable|GeoDataTable]] | ||
| + | * Description:N/A | ||
| + | |||
| + | == Parameters == | ||
| + | * //sqlStatement// | ||
| + | * Type:String | ||
| + | * Description:N/A | ||
| + | |||
| + | <div newline></div> | ||
| + | ** {{wiki:ProtectedMethod.gif|}} CloneDeepCore() ** | ||
| + | |||
| + | * //N/A// | ||
| + | == Remarks == | ||
| + | * //N/A// | ||
| + | |||
| + | == Return Value == | ||
| + | * Type:[[ThinkGeo.MapSuite.Core.FeatureSource|FeatureSource]] | ||
| + | * Description:N/A | ||
| + | |||
| + | == Parameters == | ||
| + | <div newline></div> | ||
| + | ** {{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|}} PathFilename ** | ||
| + | |||
| + | * //This property gets and sets the path and file of the grid file you want to use.// | ||
| + | == Remarks == | ||
| + | * //When you specify the path and file name it should be in the correct format. If the path and filename you provided we cannot find it then we will throw an exception.// | ||
| + | == Return Value == | ||
| + | * Type:String | ||
| + | |||
| + | ** {{wiki:PublicProperty.gif|}} CellSize ** | ||
| + | |||
| + | * //Gets the cell size of the grid.// | ||
| + | == Remarks == | ||
| + | * //N/A// | ||
| + | == Return Value == | ||
| + | * Type:Double | ||
| + | |||
| + | ** {{wiki:PublicProperty.gif|}} NumberOfColumns ** | ||
| + | |||
| + | * //Gets column number of the grid.// | ||
| + | == Remarks == | ||
| + | * //N/A// | ||
| + | == Return Value == | ||
| + | * Type:Int32 | ||
| + | |||
| + | ** {{wiki:PublicProperty.gif|}} NumberOfRows ** | ||
| + | |||
| + | * //Gets row number of the grid.// | ||
| + | == Remarks == | ||
| + | * //N/A// | ||
| + | == Return Value == | ||
| + | * Type:Int32 | ||
| + | |||
| + | ** {{wiki:PublicProperty.gif|}} LowerLeftPoint ** | ||
| + | |||
| + | * //Gets LowerLeft PointShape of the grid.// | ||
| + | == Remarks == | ||
| + | * //N/A// | ||
| + | == Return Value == | ||
| + | * Type:[[ThinkGeo.MapSuite.Core.PointShape|PointShape]] | ||
| + | |||
| + | ** {{wiki:PublicProperty.gif|}} NoDataValue ** | ||
| + | |||
| + | * //Gets the NoDataValue in the grid.// | ||
| + | == Remarks == | ||
| + | * //N/A// | ||
| + | == Return Value == | ||
| + | * Type:Double | ||
| + | |||
| + | ** {{wiki:PublicProperty.gif|}} 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 | ||
| + | |||
| + | ** {{wiki:PublicProperty.gif|}} DataValueColumnName ** | ||
| + | |||
| + | * //N/A// | ||
| + | == Remarks == | ||
| + | * //N/A// | ||
| + | == Return Value == | ||
| + | * Type:String | ||
| + | |||
| + | ** {{wiki:PublicProperty.gif|}} Id ** | ||
| + | |||
| + | * //N/A// | ||
| + | == Remarks == | ||
| + | * //N/A// | ||
| + | == Return Value == | ||
| + | * Type:String | ||
| + | |||
| + | ** {{wiki:PublicProperty.gif|}} CanExecuteSqlQuery ** | ||
| + | |||
| + | * //N/A// | ||
| + | == Remarks == | ||
| + | * //N/A// | ||
| + | == Return Value == | ||
| + | * Type:Boolean | ||
| + | |||
| + | ** {{wiki:PublicProperty.gif|}} IsOpen ** | ||
| + | |||
| + | * //N/A// | ||
| + | == Remarks == | ||
| + | * //N/A// | ||
| + | == Return Value == | ||
| + | * Type:Boolean | ||
| + | |||
| + | ** {{wiki:PublicProperty.gif|}} CanModifyColumnStructure ** | ||
| + | |||
| + | * //N/A// | ||
| + | == Remarks == | ||
| + | * //N/A// | ||
| + | == Return Value == | ||
| + | * Type:Boolean | ||
| + | |||
| + | ** {{wiki:PublicProperty.gif|}} IsInTransaction ** | ||
| + | |||
| + | * //N/A// | ||
| + | == Remarks == | ||
| + | * //N/A// | ||
| + | == Return Value == | ||
| + | * Type:Boolean | ||
| + | |||
| + | ** {{wiki:PublicProperty.gif|}} IsTransactionLive ** | ||
| + | |||
| + | * //N/A// | ||
| + | == Remarks == | ||
| + | * //N/A// | ||
| + | == Return Value == | ||
| + | * Type:Boolean | ||
| + | |||
| + | ** {{wiki:PublicProperty.gif|}} Projection ** | ||
| + | |||
| + | * //N/A// | ||
| + | == Remarks == | ||
| + | * //N/A// | ||
| + | == Return Value == | ||
| + | * Type:[[ThinkGeo.MapSuite.Core.Projection|Projection]] | ||
| + | |||
| + | ** {{wiki:PublicProperty.gif|}} GeoCache ** | ||
| + | |||
| + | * //N/A// | ||
| + | == Remarks == | ||
| + | * //N/A// | ||
| + | == Return Value == | ||
| + | * Type:[[ThinkGeo.MapSuite.Core.FeatureCache|FeatureCache]] | ||
| + | |||
| + | ** {{wiki:PublicProperty.gif|}} FeatureIdsToExclude ** | ||
| + | |||
| + | * //N/A// | ||
| + | == Remarks == | ||
| + | * //N/A// | ||
| + | == Return Value == | ||
| + | * Type:Collection<String> | ||
| + | |||
| + | ** {{wiki:PublicProperty.gif|}} TransactionBuffer ** | ||
| + | |||
| + | * //N/A// | ||
| + | == Remarks == | ||
| + | * //N/A// | ||
| + | == Return Value == | ||
| + | * Type:[[ThinkGeo.MapSuite.Core.TransactionBuffer|TransactionBuffer]] | ||
| + | |||
| + | ** {{wiki:PublicProperty.gif|}} MaxRecordsToDraw ** | ||
| + | |||
| + | * //N/A// | ||
| + | == Remarks == | ||
| + | * //N/A// | ||
| + | == Return Value == | ||
| + | * Type:Int32 | ||
| + | |||
| + | ==== Protected Properties ==== | ||
| + | ** {{wiki:ProtectedProperty.gif|}} CanExecuteSqlQueryCore ** | ||
| + | |||
| + | * //N/A// | ||
| + | == Remarks == | ||
| + | * //N/A// | ||
| + | == Return Value == | ||
| + | * Type:Boolean | ||
| + | |||
| + | ** {{wiki:ProtectedProperty.gif|}} IsOpenCore ** | ||
| + | |||
| + | * //N/A// | ||
| + | == Remarks == | ||
| + | * //N/A// | ||
| + | == Return Value == | ||
| + | * Type:Boolean | ||
| + | |||
| + | ** {{wiki:ProtectedProperty.gif|}} CanModifyColumnStructureCore ** | ||
| + | |||
| + | * //N/A// | ||
| + | == Remarks == | ||
| + | * //N/A// | ||
| + | == Return Value == | ||
| + | * Type:Boolean | ||
| + | |||
| + | ** {{wiki:ProtectedProperty.gif|}} FeatureSourceColumns ** | ||
| + | |||
| + | * //N/A// | ||
| + | == Remarks == | ||
| + | * //N/A// | ||
| + | == Return Value == | ||
| + | * Type:Collection<[[ThinkGeo.MapSuite.Core.FeatureSourceColumn|FeatureSourceColumn]]> | ||
| + | |||
| + | ==== Public Events ==== | ||
| + | ** {{wiki:PublicEvent.gif|}} GeneratingGrid ** | ||
| + | * //N/A// | ||
| + | == Remarks == | ||
| + | * //N/A// | ||
| - | <!-- ThinkGeo.MapSuite.PortableCore.FeatureSource --> | + | Event Arguments:[[ThinkGeo.MapSuite.Core.GeneratingGridFeatureSourceEventArgs|GeneratingGridFeatureSourceEventArgs]] |
| - | [[#Public Events|Go Back]] | + | |
| - | ==== ClosingFeatureSource ==== | + | |
| - | This event is called before the closing of the FeatureSource. | + | |
| - | === Remarks === | + | |
| - | This event is called before the closing of the FeatureSource. Technically, this event is called after the calling of the Close method on the FeatureSource, but before the protected CloseCore method. | + | |
| - | It is typical that the FeatureSource may be opened and closed may times during the life cycle of your application. The type of control the MapEngine is embedded in will dictate how often this happens. For example, in the case of the Web Edition, each time a FeatureSource is in the Ajax or Post Back part of the page cycle, it will close the FeatureSource before returning back to the client. This is to conserve resources, as the web is a connection-less environment. In the case of the Desktop Edition, we can keep the FeaureSources open, knowing that we can maintain a persistent connection. | + | ** {{wiki:PublicEvent.gif|}} StreamLoading ** |
| - | === Event Arguments === | + | * //N/A// |
| - | ^ Event Arguments ^ | + | == Remarks == |
| - | | [[ThinkGeo.MapSuite.PortableCore.ClosingFeatureSourceEventArgs|ClosingFeatureSourceEventArgs]]<!-- ThinkGeo.MapSuite.PortableCore.ClosingFeatureSourceEventArgs --> | | + | * //N/A// |
| - | <!-- ThinkGeo.MapSuite.PortableCore.FeatureSource --> | + | Event Arguments:[[ThinkGeo.MapSuite.Core.StreamLoadingEventArgs|StreamLoadingEventArgs]] |
| - | [[#Public Events|Go Back]] | + | |
| - | ==== CommittedTransaction ==== | + | |
| - | This event is raised after the CommitTransaction and the CommitTransactionCore are called and allows you access to the TransactionBuffer and the TransactionResults object before CommitTransaction method is returned. | + | |
| - | === Remarks === | + | |
| - | This event is raised after the CommitTransactionCore is called and allows you access to the TransactionBuffer and the TransactionResults object before CommitTransaction method is returned. | + | |
| - | With this event, you can analyze the results of the transaction and do any cleanup code necessary. In the event some of the records did not commit, you can handle those items here. The TransactionResults object is passed out of the CommitTransaction method so you could analyze it then; however, this is the only place where you have access to both the TransactionResults object and the TransactionBuffer object at the same time. These are useful together to try and determine what went wrong and possibly try and re-commit them. | + | ** {{wiki:PublicEvent.gif|}} DrawingProgressChanged ** |
| + | * //N/A// | ||
| + | == Remarks == | ||
| + | * //N/A// | ||
| - | At the time of this event you will technically be out of the current transaction. | + | Event Arguments:[[ThinkGeo.MapSuite.Core.DrawingProgressChangedEventArgs|DrawingProgressChangedEventArgs]] |
| - | === Event Arguments === | + | |
| - | ^ Event Arguments ^ | + | |
| - | | [[ThinkGeo.MapSuite.PortableCore.CommittedTransactionEventArgs|CommittedTransactionEventArgs]]<!-- ThinkGeo.MapSuite.PortableCore.CommittedTransactionEventArgs --> | | + | |
| - | <!-- ThinkGeo.MapSuite.PortableCore.FeatureSource --> | + | ** {{wiki:PublicEvent.gif|}} CustomColumnFetch ** |
| - | [[#Public Events|Go Back]] | + | * //N/A// |
| - | ==== CommittingTransaction ==== | + | == Remarks == |
| - | This event is raised after the CommitTransaction method is called, but before the CommitTransactionCore is called. This allows you access to the TransactionBuffer before the transaction is committed. It also allows you to cancel the pending commit of the transaction. | + | * //N/A// |
| - | === Remarks === | + | |
| - | This event is raised before the CommitTransactionCore is called and allows you access to the TransactionBuffer before the transaction is committed. It also allows you to cancel the pending transaction. The TransactionBuffer is the object that stores all of the pending transactions and is accessible through this event to allow you to either add, remove or modify transactions. | + | |
| - | In the event that you cancel the CommitTransaction method, the transaction remains intact and you will still be editing. This makes it a nice place to possibly check for connectivity before the TransactionCore code is run, which is where the records are actually committed. Calling the RollBackTransaction method is the only way to permanently cancel a pending transaction without committing it. | + | Event Arguments:[[ThinkGeo.MapSuite.Core.CustomColumnFetchEventArgs|CustomColumnFetchEventArgs]] |
| - | === Event Arguments === | + | |
| - | ^ Event Arguments ^ | + | |
| - | | [[ThinkGeo.MapSuite.PortableCore.CommittingTransactionEventArgs|CommittingTransactionEventArgs]]<!-- ThinkGeo.MapSuite.PortableCore.CommittingTransactionEventArgs --> | | + | |
| - | <!-- ThinkGeo.MapSuite.PortableCore.FeatureSource --> | + | ** {{wiki:PublicEvent.gif|}} CommittingTransaction ** |
| - | [[#Public Events|Go Back]] | + | * //N/A// |
| - | ==== CustomColumnFetch ==== | + | == Remarks == |
| - | This event is raised when fields are requested in a feature source method that do not exist in the feature source. It allows you to supplement the data from any outside source you have. | + | * //N/A// |
| - | === Remarks === | + | |
| - | This event is raised when fields are requested in a feature source method that do not exist in the feature source. It allows you to supplement the data from any outside source you have. | + | |
| - | It is used primarily when you have data relating to a particular feature or set of features that is not within source of the data. For example, you may have a shape file of the world whose .dbf component describes the area and population of each country. Additionally, in an outside SQL Server table, you may also have data about the countries, and it is this data that you wish to use for determining how you want to color each country. | + | Event Arguments:[[ThinkGeo.MapSuite.Core.CommittingTransactionEventArgs|CommittingTransactionEventArgs]] |
| - | To integrate this SQL data, you simply create a file name that does not exist in the .dbf file. Whenever Map Suite is queried to return records that specifically require this field, the FeatureSource will raise this event and allow you the developer to supply the data. In this way, you can query the SQL table and store the data in some sort of collection, and then when the event is raised, simply supply that data. | + | ** {{wiki:PublicEvent.gif|}} CommittedTransaction ** |
| + | * //N/A// | ||
| + | == Remarks == | ||
| + | * //N/A// | ||
| - | As this is an event, it will raise for each feature and field combination requested. This means that the event can be raised quite often, and we suggest that you cache the data you wish to supply in memory. We recommend against sending out a new SQL query each time this event is raised. Image that you are supplementing two columns and your query returns 2,000 rows. This means that if you requested those fields, the event would be raised 4,000 times. | + | Event Arguments:[[ThinkGeo.MapSuite.Core.CommittedTransactionEventArgs|CommittedTransactionEventArgs]] |
| - | === Event Arguments === | + | |
| - | ^ Event Arguments ^ | + | |
| - | | [[ThinkGeo.MapSuite.PortableCore.CustomColumnFetchEventArgs|CustomColumnFetchEventArgs]]<!-- ThinkGeo.MapSuite.PortableCore.CustomColumnFetchEventArgs --> | | + | |
| - | <!-- ThinkGeo.MapSuite.PortableCore.FeatureSource --> | + | ** {{wiki:PublicEvent.gif|}} OpeningFeatureSource ** |
| - | [[#Public Events|Go Back]] | + | * //N/A// |
| - | ==== DrawingProgressChanged ==== | + | == Remarks == |
| - | === Event Arguments === | + | * //N/A// |
| - | ^ Event Arguments ^ | + | |
| - | | [[ThinkGeo.MapSuite.PortableCore.DrawingProgressChangedEventArgs|DrawingProgressChangedEventArgs]]<!-- ThinkGeo.MapSuite.PortableCore.DrawingProgressChangedEventArgs --> | | + | |
| - | <!-- ThinkGeo.MapSuite.PortableCore.FeatureSource --> | + | Event Arguments:[[ThinkGeo.MapSuite.Core.OpeningFeatureSourceEventArgs|OpeningFeatureSourceEventArgs]] |
| - | [[#Public Events|Go Back]] | + | |
| - | ==== GeneratingGrid ==== | + | |
| - | === Event Arguments === | + | |
| - | ^ Event Arguments ^ | + | |
| - | | [[ThinkGeo.MapSuite.PortableCore.GeneratingGridFeatureSourceEventArgs|GeneratingGridFeatureSourceEventArgs]]<!-- ThinkGeo.MapSuite.PortableCore.GeneratingGridFeatureSourceEventArgs --> | | + | |
| - | <!-- ThinkGeo.MapSuite.PortableCore.GridFeatureSource --> | + | ** {{wiki:PublicEvent.gif|}} OpenedFeatureSource ** |
| - | [[#Public Events|Go Back]] | + | * //N/A// |
| - | ==== OpenedFeatureSource ==== | + | == Remarks == |
| - | This event is called after the opening of the FeatureSource. | + | * //N/A// |
| - | === Remarks === | + | |
| - | This event is called after the opening of the FeatureSource. Technically, this event is called after the calling of the Open method on the FeatureSource and after the protected OpenCore method is called. | + | |
| - | It is typical that the FeatureSource may be opened and closed may times during the life cycle of your application. The type of control the MapEngine is embedded in will dictate how often this happens. For example, in the case of the Web Edition, each time a FeatureSource is in the Ajax or Post Back part of the page cycle, it will close the FeatureSource before returning back to the client. This is to conserve resources, as the web is a connection-less environment. In the case of the Desktop Edition, we can keep the FeaureSources open, knowing that we can maintain a persistent connection. | + | Event Arguments:[[ThinkGeo.MapSuite.Core.OpenedFeatureSourceEventArgs|OpenedFeatureSourceEventArgs]] |
| - | === Event Arguments === | + | |
| - | ^ Event Arguments ^ | + | |
| - | | [[ThinkGeo.MapSuite.PortableCore.OpenedFeatureSourceEventArgs|OpenedFeatureSourceEventArgs]]<!-- ThinkGeo.MapSuite.PortableCore.OpenedFeatureSourceEventArgs --> | | + | |
| - | <!-- ThinkGeo.MapSuite.PortableCore.FeatureSource --> | + | ** {{wiki:PublicEvent.gif|}} ClosingFeatureSource ** |
| - | [[#Public Events|Go Back]] | + | * //N/A// |
| - | ==== OpeningFeatureSource ==== | + | == Remarks == |
| - | This event is called before the opening of the FeatureSource. | + | * //N/A// |
| - | === Remarks === | + | |
| - | This event is called before the opening of the FeatureSource. Technically, this event is called after the calling of the Open method on the FeatureSource, but before the protected OpenCore method. | + | |
| - | It is typical that the FeatureSource may be opened and closed may times during the life cycle of your application. The type of control the MapEngine is embedded in will dictate how often this happens. For example, in the case of the Web Edition, each time a FeatureSource is in the Ajax or Post Back part of the page cycle, it will close the FeatureSource before returning back to the client. This is to conserve resources, as the web is a connection-less environment. In the case of the Desktop Edition, we can keep the FeaureSources open, knowing that we can maintain a persistent connection. | + | Event Arguments:[[ThinkGeo.MapSuite.Core.ClosingFeatureSourceEventArgs|ClosingFeatureSourceEventArgs]] |
| - | === Event Arguments === | + | |
| - | ^ Event Arguments ^ | + | |
| - | | [[ThinkGeo.MapSuite.PortableCore.OpeningFeatureSourceEventArgs|OpeningFeatureSourceEventArgs]]<!-- ThinkGeo.MapSuite.PortableCore.OpeningFeatureSourceEventArgs --> | | + | |
| - | <!-- ThinkGeo.MapSuite.PortableCore.FeatureSource --> | + | ** {{wiki:PublicEvent.gif|}} ClosedFeatureSource ** |
| - | [[#Public Events|Go Back]] | + | * //N/A// |
| - | ==== StreamLoading ==== | + | == Remarks == |
| - | === Event Arguments === | + | * //N/A// |
| - | ^ Event Arguments ^ | + | |
| - | | [[ThinkGeo.MapSuite.PortableCore.StreamLoadingEventArgs|StreamLoadingEventArgs]]<!-- ThinkGeo.MapSuite.PortableCore.StreamLoadingEventArgs --> | | + | |
| - | <!-- ThinkGeo.MapSuite.PortableCore.GridFeatureSource --> | + | Event Arguments:[[ThinkGeo.MapSuite.Core.ClosedFeatureSourceEventArgs|ClosedFeatureSourceEventArgs]] |
| - | [[#Public Events|Go Back]] | + | |
| - | __NOTOC__ | ||
| - | [[Category:MapSuitePortableCore]] | ||
| - | [[Category:ThinkGeo.MapSuite.PortableCore]] | ||
| - | [[Category:UpdateDocumentation]] | ||
thinkgeo.mapsuite.portablecore.gridfeaturesource.1440040132.txt.gz · Last modified: 2015/09/23 01:36 (external edit)