thinkgeo.mapsuite.portablecore.querytools
Differences
This shows you the differences between two versions of the page.
| Next revision | Previous revision | ||
|
thinkgeo.mapsuite.portablecore.querytools [2015/08/20 03:08] 127.0.0.1 external edit |
thinkgeo.mapsuite.portablecore.querytools [2017/03/16 21:59] (current) |
||
|---|---|---|---|
| Line 1: | Line 1: | ||
| - | ====== ThinkGeo.MapSuite.PortableCore.QueryTools ====== | + | ====== ThinkGeo.MapSuite.Core.QueryTools ====== |
| + | {{section>upgrade_map_suite_to_10.0}} | ||
| - | |||
| - | <!-- Class --> | ||
| This is a helper class that allows you to execute various queries. | This is a helper class that allows you to execute various queries. | ||
| - | === Remarks === | ||
| - | This is a helper class that allows you to execute various queries. It wraps the query functionality of the FeatureSource and provides a simpler and more focused set of APIs. | ||
| ===== Inheritance Hierarchy ===== | ===== Inheritance Hierarchy ===== | ||
| - | *System.Object | + | *System.Object |
| - | **[[ThinkGeo.MapSuite.PortableCore.QueryTools]] | + | ***ThinkGeo.MapSuite.Core.QueryTools** |
| ===== Members Summary ===== | ===== Members Summary ===== | ||
| ==== Public Constructors ==== | ==== Public Constructors ==== | ||
| - | ^ Name ^ Parameters ^ DeclaringType ^ Summary ^ | + | ** {{wiki:PublicMethod.gif|}} QueryTools(FeatureSource) ** |
| - | | {{wiki:PublicMethod.gif|Public Method}}[[#QueryTools(FeatureSource)|QueryTools]] | [[ThinkGeo.MapSuite.PortableCore.FeatureSource|FeatureSource]] | | This is a constructor for the class. | | + | |
| + | * //This is a constructor for the class.// | ||
| + | == Remarks == | ||
| + | * //Each of the calls in this class thunk through to the FeatureSource passed in.// | ||
| + | == Parameters == | ||
| + | * //featureSource// | ||
| + | * Type:[[ThinkGeo.MapSuite.Core.FeatureSource|FeatureSource]] | ||
| + | * Description:This parameter is the FeatureSource that will provide the functionality for this class's methods. | ||
| + | |||
| + | <div newline></div> | ||
| ==== Protected Constructors ==== | ==== Protected Constructors ==== | ||
| - | ^ Name ^ Parameters ^ DeclaringType ^ Summary ^ | + | ** {{wiki:ProtectedMethod.gif|}} QueryTools() ** |
| - | | {{wiki:ProtectedMethod.gif|Protected Method}}[[#QueryTools()|QueryTools]] | | | This is a constructor for the class. | | + | |
| + | * //This is a constructor for the class.// | ||
| + | == Remarks == | ||
| + | * //This is the default constructor, though it is typically not intended to be used.// | ||
| + | == Parameters == | ||
| + | <div newline></div> | ||
| ==== Public Methods ==== | ==== Public Methods ==== | ||
| - | ^ Name ^ Parameters ^ DeclaringType ^ Summary ^ | + | ** {{wiki:PublicMethod.gif|}} ExecuteQuery(String) ** |
| - | | {{wiki:PublicMethod.gif|Public Method}}[[#Equals(Object)|Equals]] | Object | Object | | | + | |
| - | | {{wiki:PublicMethod.gif|Public Method}}[[#ExecuteNonQuery(String)|ExecuteNonQuery]] | String | | Executes a SQL statement against a connection object. | | + | |
| - | | {{wiki:PublicMethod.gif|Public Method}}[[#ExecuteQuery(String)|ExecuteQuery]] | String | | Executes the query and returns the result returned by the query. | | + | |
| - | | {{wiki:PublicMethod.gif|Public Method}}[[#ExecuteScalar(String)|ExecuteScalar]] | 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. | | + | |
| - | | {{wiki:PublicMethod.gif|Public Method}}[[#GetAllFeatures(IEnumerable<String>)|GetAllFeatures]] | IEnumerable<String> | | This method returns all of the InternalFeatures in the FeatureSource. | | + | |
| - | | {{wiki:PublicMethod.gif|Public Method}}[[#GetAllFeatures(ReturningColumnsType)|GetAllFeatures]] | [[ThinkGeo.MapSuite.PortableCore.ReturningColumnsType|ReturningColumnsType]] | | This method returns all of the InternalFeatures in the FeatureSource. | | + | |
| - | | {{wiki:PublicMethod.gif|Public Method}}[[#GetBoundingBoxById(String)|GetBoundingBoxById]] | String | | This method returns the bounding box for the Id specified. | | + | |
| - | | {{wiki:PublicMethod.gif|Public Method}}[[#GetBoundingBoxesByIds(IEnumerable<String>)|GetBoundingBoxesByIds]] | IEnumerable<String> | | This method returns a collection of bounding boxes based on the collection of Ids provided. | | + | |
| - | | {{wiki:PublicMethod.gif|Public Method}}[[#GetColumns()|GetColumns]] | | | This method returns the collection of columns for this FeatureSource. | | + | |
| - | | {{wiki:PublicMethod.gif|Public Method}}[[#GetCount()|GetCount]] | | | This method returns the count of all of the InternalFeatures in the FeatureSource. | | + | |
| - | | {{wiki:PublicMethod.gif|Public Method}}[[#GetFeatureById(String, ReturningColumnsType)|GetFeatureById]] | String, [[ThinkGeo.MapSuite.PortableCore.ReturningColumnsType|ReturningColumnsType]] | | This method returns an InternalFeature based on an Id provided. | | + | |
| - | | {{wiki:PublicMethod.gif|Public Method}}[[#GetFeatureById(String, IEnumerable<String>)|GetFeatureById]] | String, IEnumerable<String> | | This method returns an InternalFeature based on an Id provided. | | + | |
| - | | {{wiki:PublicMethod.gif|Public Method}}[[#GetFeaturesByColumnValue(String, String, ReturningColumnsType)|GetFeaturesByColumnValue]] | String, String, [[ThinkGeo.MapSuite.PortableCore.ReturningColumnsType|ReturningColumnsType]] | | Get all of the features by passing a columnName and a specified columValue. | | + | |
| - | | {{wiki:PublicMethod.gif|Public Method}}[[#GetFeaturesByColumnValue(String, String, IEnumerable<String>)|GetFeaturesByColumnValue]] | String, String, IEnumerable<String> | | Get all of the features by passing a columnName and a specified columValue. | | + | |
| - | | {{wiki:PublicMethod.gif|Public Method}}[[#GetFeaturesByColumnValue(String, String)|GetFeaturesByColumnValue]] | String, String | | Get all of the features by passing a columnName and a specified columValue. | | + | |
| - | | {{wiki:PublicMethod.gif|Public Method}}[[#GetFeaturesByIds(IEnumerable<String>, ReturningColumnsType)|GetFeaturesByIds]] | IEnumerable<String>, [[ThinkGeo.MapSuite.PortableCore.ReturningColumnsType|ReturningColumnsType]] | | This method returns a collection of InternalFeatures based on the collection of Ids provided. | | + | |
| - | | {{wiki:PublicMethod.gif|Public Method}}[[#GetFeaturesByIds(IEnumerable<String>, IEnumerable<String>)|GetFeaturesByIds]] | IEnumerable<String>, IEnumerable<String> | | This method returns a collection of InternalFeatures based on the collection of Ids provided. | | + | |
| - | | {{wiki:PublicMethod.gif|Public Method}}[[#GetFeaturesContaining(BaseShape, IEnumerable<String>)|GetFeaturesContaining]] | [[ThinkGeo.MapSuite.PortableCore.BaseShape|BaseShape]], IEnumerable<String> | | This method returns all of the InternalFeatures that contain the target shape. | | + | |
| - | | {{wiki:PublicMethod.gif|Public Method}}[[#GetFeaturesContaining(BaseShape, ReturningColumnsType)|GetFeaturesContaining]] | [[ThinkGeo.MapSuite.PortableCore.BaseShape|BaseShape]], [[ThinkGeo.MapSuite.PortableCore.ReturningColumnsType|ReturningColumnsType]] | | This method returns all of the InternalFeatures based on the target Feature and the spatial query type specified. | | + | |
| - | | {{wiki:PublicMethod.gif|Public Method}}[[#GetFeaturesContaining(Feature, IEnumerable<String>)|GetFeaturesContaining]] | [[ThinkGeo.MapSuite.PortableCore.Feature|Feature]], IEnumerable<String> | | This method returns all of the InternalFeatures based on the target Feature and the spatial query type specified. | | + | |
| - | | {{wiki:PublicMethod.gif|Public Method}}[[#GetFeaturesContaining(Feature, ReturningColumnsType)|GetFeaturesContaining]] | [[ThinkGeo.MapSuite.PortableCore.Feature|Feature]], [[ThinkGeo.MapSuite.PortableCore.ReturningColumnsType|ReturningColumnsType]] | | This method returns all of the InternalFeatures based on the target Feature and the spatial query type specified. | | + | |
| - | | {{wiki:PublicMethod.gif|Public Method}}[[#GetFeaturesCrossing(BaseShape, ReturningColumnsType)|GetFeaturesCrossing]] | [[ThinkGeo.MapSuite.PortableCore.BaseShape|BaseShape]], [[ThinkGeo.MapSuite.PortableCore.ReturningColumnsType|ReturningColumnsType]] | | This method returns all of the InternalFeatures that cross the target shape. | | + | |
| - | | {{wiki:PublicMethod.gif|Public Method}}[[#GetFeaturesCrossing(BaseShape, IEnumerable<String>)|GetFeaturesCrossing]] | [[ThinkGeo.MapSuite.PortableCore.BaseShape|BaseShape]], IEnumerable<String> | | This method returns all of the InternalFeatures that cross the target shape. | | + | |
| - | | {{wiki:PublicMethod.gif|Public Method}}[[#GetFeaturesCrossing(Feature, IEnumerable<String>)|GetFeaturesCrossing]] | [[ThinkGeo.MapSuite.PortableCore.Feature|Feature]], IEnumerable<String> | | This method returns all of the InternalFeatures that cross the target Feature. | | + | |
| - | | {{wiki:PublicMethod.gif|Public Method}}[[#GetFeaturesCrossing(Feature, ReturningColumnsType)|GetFeaturesCrossing]] | [[ThinkGeo.MapSuite.PortableCore.Feature|Feature]], [[ThinkGeo.MapSuite.PortableCore.ReturningColumnsType|ReturningColumnsType]] | | This method returns all of the InternalFeatures that cross the target Feature. | | + | |
| - | | {{wiki:PublicMethod.gif|Public Method}}[[#GetFeaturesDisjointed(Feature, IEnumerable<String>)|GetFeaturesDisjointed]] | [[ThinkGeo.MapSuite.PortableCore.Feature|Feature]], IEnumerable<String> | | This method returns all of the InternalFeatures that disjoint the target Feature. | | + | |
| - | | {{wiki:PublicMethod.gif|Public Method}}[[#GetFeaturesDisjointed(BaseShape, IEnumerable<String>)|GetFeaturesDisjointed]] | [[ThinkGeo.MapSuite.PortableCore.BaseShape|BaseShape]], IEnumerable<String> | | This method returns all of the InternalFeatures that disjoint the target Feature. | | + | |
| - | | {{wiki:PublicMethod.gif|Public Method}}[[#GetFeaturesDisjointed(Feature, ReturningColumnsType)|GetFeaturesDisjointed]] | [[ThinkGeo.MapSuite.PortableCore.Feature|Feature]], [[ThinkGeo.MapSuite.PortableCore.ReturningColumnsType|ReturningColumnsType]] | | This method returns all of the InternalFeatures that disjoint the target Feature. | | + | |
| - | | {{wiki:PublicMethod.gif|Public Method}}[[#GetFeaturesDisjointed(BaseShape, ReturningColumnsType)|GetFeaturesDisjointed]] | [[ThinkGeo.MapSuite.PortableCore.BaseShape|BaseShape]], [[ThinkGeo.MapSuite.PortableCore.ReturningColumnsType|ReturningColumnsType]] | | This method returns all of the InternalFeatures that disjoint the target Feature. | | + | |
| - | | {{wiki:PublicMethod.gif|Public Method}}[[#GetFeaturesInsideBoundingBox(RectangleShape, IEnumerable<String>)|GetFeaturesInsideBoundingBox]] | [[ThinkGeo.MapSuite.PortableCore.RectangleShape|RectangleShape]], IEnumerable<String> | | This method returns all of the InternalFeatures that are inside of the boundingBox. | | + | |
| - | | {{wiki:PublicMethod.gif|Public Method}}[[#GetFeaturesInsideBoundingBox(RectangleShape, ReturningColumnsType)|GetFeaturesInsideBoundingBox]] | [[ThinkGeo.MapSuite.PortableCore.RectangleShape|RectangleShape]], [[ThinkGeo.MapSuite.PortableCore.ReturningColumnsType|ReturningColumnsType]] | | This method returns all of the InternalFeatures that are inside of the boundingBox. | | + | |
| - | | {{wiki:PublicMethod.gif|Public Method}}[[#GetFeaturesIntersecting(Feature, IEnumerable<String>)|GetFeaturesIntersecting]] | [[ThinkGeo.MapSuite.PortableCore.Feature|Feature]], IEnumerable<String> | | This method returns all of the InternalFeatures that intersect the target Feature. | | + | |
| - | | {{wiki:PublicMethod.gif|Public Method}}[[#GetFeaturesIntersecting(BaseShape, IEnumerable<String>)|GetFeaturesIntersecting]] | [[ThinkGeo.MapSuite.PortableCore.BaseShape|BaseShape]], IEnumerable<String> | | This method returns all of the InternalFeatures that intersect the target Feature. | | + | |
| - | | {{wiki:PublicMethod.gif|Public Method}}[[#GetFeaturesIntersecting(BaseShape, ReturningColumnsType)|GetFeaturesIntersecting]] | [[ThinkGeo.MapSuite.PortableCore.BaseShape|BaseShape]], [[ThinkGeo.MapSuite.PortableCore.ReturningColumnsType|ReturningColumnsType]] | | This method returns all of the InternalFeatures that intersect the target Feature. | | + | |
| - | | {{wiki:PublicMethod.gif|Public Method}}[[#GetFeaturesIntersecting(Feature, ReturningColumnsType)|GetFeaturesIntersecting]] | [[ThinkGeo.MapSuite.PortableCore.Feature|Feature]], [[ThinkGeo.MapSuite.PortableCore.ReturningColumnsType|ReturningColumnsType]] | | This method returns all of the InternalFeatures that intersect the target Feature. | | + | |
| - | | {{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]] | | 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]] | | 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>)|GetFeaturesNearestTo]] | [[ThinkGeo.MapSuite.PortableCore.Feature|Feature]], [[ThinkGeo.MapSuite.PortableCore.GeographyUnit|GeographyUnit]], Int32, IEnumerable<String> | | This method returns a user defined number of InternalFeatures that are closest to the TargetFeature. | | + | |
| - | | {{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]] | | 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> | | 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]] | | This method returns a user defined number of InternalFeatures that are closest to the TargetFeature. | | + | |
| - | | {{wiki:PublicMethod.gif|Public Method}}[[#GetFeaturesOutsideBoundingBox(RectangleShape, ReturningColumnsType)|GetFeaturesOutsideBoundingBox]] | [[ThinkGeo.MapSuite.PortableCore.RectangleShape|RectangleShape]], [[ThinkGeo.MapSuite.PortableCore.ReturningColumnsType|ReturningColumnsType]] | | This method returns all of the InternalFeatures that are outside of the boundingBox. | | + | |
| - | | {{wiki:PublicMethod.gif|Public Method}}[[#GetFeaturesOutsideBoundingBox(RectangleShape, IEnumerable<String>)|GetFeaturesOutsideBoundingBox]] | [[ThinkGeo.MapSuite.PortableCore.RectangleShape|RectangleShape]], IEnumerable<String> | | This method returns all of the InternalFeatures that are outside of the boundingBox. | | + | |
| - | | {{wiki:PublicMethod.gif|Public Method}}[[#GetFeaturesOverlapping(Feature, ReturningColumnsType)|GetFeaturesOverlapping]] | [[ThinkGeo.MapSuite.PortableCore.Feature|Feature]], [[ThinkGeo.MapSuite.PortableCore.ReturningColumnsType|ReturningColumnsType]] | | This method returns all of the InternalFeatures that overlap the target Feature. | | + | |
| - | | {{wiki:PublicMethod.gif|Public Method}}[[#GetFeaturesOverlapping(Feature, IEnumerable<String>)|GetFeaturesOverlapping]] | [[ThinkGeo.MapSuite.PortableCore.Feature|Feature]], IEnumerable<String> | | This method returns all of the InternalFeatures that overlap the target Feature. | | + | |
| - | | {{wiki:PublicMethod.gif|Public Method}}[[#GetFeaturesOverlapping(BaseShape, ReturningColumnsType)|GetFeaturesOverlapping]] | [[ThinkGeo.MapSuite.PortableCore.BaseShape|BaseShape]], [[ThinkGeo.MapSuite.PortableCore.ReturningColumnsType|ReturningColumnsType]] | | This method returns all of the InternalFeatures that overlap the target Feature. | | + | |
| - | | {{wiki:PublicMethod.gif|Public Method}}[[#GetFeaturesOverlapping(BaseShape, IEnumerable<String>)|GetFeaturesOverlapping]] | [[ThinkGeo.MapSuite.PortableCore.BaseShape|BaseShape]], IEnumerable<String> | | This method returns all of the InternalFeatures that overlap the target Feature. | | + | |
| - | | {{wiki:PublicMethod.gif|Public Method}}[[#GetFeaturesTopologicalEqual(BaseShape, ReturningColumnsType)|GetFeaturesTopologicalEqual]] | [[ThinkGeo.MapSuite.PortableCore.BaseShape|BaseShape]], [[ThinkGeo.MapSuite.PortableCore.ReturningColumnsType|ReturningColumnsType]] | | This method returns all of the InternalFeatures that topologicalEqual the target Feature. | | + | |
| - | | {{wiki:PublicMethod.gif|Public Method}}[[#GetFeaturesTopologicalEqual(Feature, IEnumerable<String>)|GetFeaturesTopologicalEqual]] | [[ThinkGeo.MapSuite.PortableCore.Feature|Feature]], IEnumerable<String> | | This method returns all of the InternalFeatures that topologicalEqual the target Feature. | | + | |
| - | | {{wiki:PublicMethod.gif|Public Method}}[[#GetFeaturesTopologicalEqual(Feature, ReturningColumnsType)|GetFeaturesTopologicalEqual]] | [[ThinkGeo.MapSuite.PortableCore.Feature|Feature]], [[ThinkGeo.MapSuite.PortableCore.ReturningColumnsType|ReturningColumnsType]] | | This method returns all of the InternalFeatures that topologicalEqual the target Feature. | | + | |
| - | | {{wiki:PublicMethod.gif|Public Method}}[[#GetFeaturesTopologicalEqual(BaseShape, IEnumerable<String>)|GetFeaturesTopologicalEqual]] | [[ThinkGeo.MapSuite.PortableCore.BaseShape|BaseShape]], IEnumerable<String> | | This method returns all of the InternalFeatures that topologicalEqual the target Feature. | | + | |
| - | | {{wiki:PublicMethod.gif|Public Method}}[[#GetFeaturesTouching(Feature, IEnumerable<String>)|GetFeaturesTouching]] | [[ThinkGeo.MapSuite.PortableCore.Feature|Feature]], IEnumerable<String> | | This method returns all of the InternalFeatures that touch the target Feature. | | + | |
| - | | {{wiki:PublicMethod.gif|Public Method}}[[#GetFeaturesTouching(Feature, ReturningColumnsType)|GetFeaturesTouching]] | [[ThinkGeo.MapSuite.PortableCore.Feature|Feature]], [[ThinkGeo.MapSuite.PortableCore.ReturningColumnsType|ReturningColumnsType]] | | This method returns all of the InternalFeatures that touch the target Feature. | | + | |
| - | | {{wiki:PublicMethod.gif|Public Method}}[[#GetFeaturesTouching(BaseShape, ReturningColumnsType)|GetFeaturesTouching]] | [[ThinkGeo.MapSuite.PortableCore.BaseShape|BaseShape]], [[ThinkGeo.MapSuite.PortableCore.ReturningColumnsType|ReturningColumnsType]] | | This method returns all of the InternalFeatures that touch the target Feature. | | + | |
| - | | {{wiki:PublicMethod.gif|Public Method}}[[#GetFeaturesTouching(BaseShape, IEnumerable<String>)|GetFeaturesTouching]] | [[ThinkGeo.MapSuite.PortableCore.BaseShape|BaseShape]], IEnumerable<String> | | This method returns all of the InternalFeatures that touch the target Feature. | | + | |
| - | | {{wiki:PublicMethod.gif|Public Method}}[[#GetFeaturesWithin(Feature, IEnumerable<String>)|GetFeaturesWithin]] | [[ThinkGeo.MapSuite.PortableCore.Feature|Feature]], IEnumerable<String> | | This method returns all of the InternalFeatures that are within the target Feature. | | + | |
| - | | {{wiki:PublicMethod.gif|Public Method}}[[#GetFeaturesWithin(Feature, ReturningColumnsType)|GetFeaturesWithin]] | [[ThinkGeo.MapSuite.PortableCore.Feature|Feature]], [[ThinkGeo.MapSuite.PortableCore.ReturningColumnsType|ReturningColumnsType]] | | This method returns all of the InternalFeatures that are within the target Feature. | | + | |
| - | | {{wiki:PublicMethod.gif|Public Method}}[[#GetFeaturesWithin(BaseShape, ReturningColumnsType)|GetFeaturesWithin]] | [[ThinkGeo.MapSuite.PortableCore.BaseShape|BaseShape]], [[ThinkGeo.MapSuite.PortableCore.ReturningColumnsType|ReturningColumnsType]] | | This method returns all of the InternalFeatures that are within the target Feature. | | + | |
| - | | {{wiki:PublicMethod.gif|Public Method}}[[#GetFeaturesWithin(BaseShape, IEnumerable<String>)|GetFeaturesWithin]] | [[ThinkGeo.MapSuite.PortableCore.BaseShape|BaseShape]], IEnumerable<String> | | This method returns all of the InternalFeatures that are within the target Feature. | | + | |
| - | | {{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> | | This method returns a collection of InternalFeatures that are within a certain distance of the TargetFeature. | | + | |
| - | | {{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]] | | 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, IEnumerable<String>)|GetFeaturesWithinDistanceOf]] | [[ThinkGeo.MapSuite.PortableCore.BaseShape|BaseShape]], [[ThinkGeo.MapSuite.PortableCore.GeographyUnit|GeographyUnit]], [[ThinkGeo.MapSuite.PortableCore.DistanceUnit|DistanceUnit]], Double, IEnumerable<String> | | 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]] | | This method returns a collection of InternalFeatures that are within a certain distance of the TargetFeature. | | + | |
| - | | {{wiki:PublicMethod.gif|Public Method}}[[#GetHashCode()|GetHashCode]] | | Object | | | + | |
| - | | {{wiki:PublicMethod.gif|Public Method}}[[#GetType()|GetType]] | | Object | | | + | |
| - | | {{wiki:PublicMethod.gif|Public Method}}[[#ToString()|ToString]] | | Object | | | + | |
| - | ==== Protected Methods ==== | + | * //Executes the query and returns the result returned by the query.// |
| - | ^ Name ^ Parameters ^ DeclaringType ^ Summary ^ | + | == Remarks == |
| - | | {{wiki:ProtectedMethod.gif|Protected Method}}[[#Finalize()|Finalize]] | | Object | | | + | * //Use the ExcuteScalar method to retrieve a single value from the database. This requires less code than use the ExcuteQuery method and then performing the operations necessary to generate the single value using the data.// |
| - | | {{wiki:ProtectedMethod.gif|Protected Method}}[[#MemberwiseClone()|MemberwiseClone]] | | Object | | | + | |
| - | ==== Public Properties ==== | + | == Return Value == |
| - | ^ Name ^ Return ^ DeclaringType ^ Summary ^ | + | * Type:[[ThinkGeo.MapSuite.Portable.GeoDataTable|GeoDataTable]] |
| - | | {{wiki:PublicProperty.gif|Public Property}}[[#CanExecuteSqlQuery|CanExecuteSqlQuery]] | Boolean | | This property specifies whether FeatureSource can excute a SQL query or not. If it is false, then it will throw an exception when the following APIs are called: ExecuteScalar, ExecuteNonQuery, ExecuteQuery | | + | * Description:The result set in the format of dataTable. |
| - | ==== Protected Properties ==== | + | == Parameters == |
| - | ^ Name ^ Return ^ DeclaringType ^ Summary ^ | + | * //sqlStatement// |
| + | * Type:String | ||
| + | * Description:The SQL statement to be excuted. | ||
| - | ==== Public Events ==== | + | <div newline></div> |
| - | ^ Name ^ Event Arguments ^ DeclaringType ^ Summary ^ | + | ** {{wiki:PublicMethod.gif|}} GetFeaturesByColumnValue(String,String,ReturningColumnsType) ** |
| - | ===== Public Constructors ===== | + | * //Get all of the features by passing a columnName and a specified columValue.// |
| - | ==== QueryTools(FeatureSource) ==== | + | == Remarks == |
| - | This is a constructor for the class. | + | * //N/A// |
| - | === Overloads === | + | |
| - | This constructor allows you to provide a FeatureSouce that will provide the functionality for this class's methods. | + | |
| - | === Remarks === | + | |
| - | Each of the calls in this class thunk through to the FeatureSource passed in. | + | |
| - | === Parameters === | + | |
| - | ^ Name ^ Type ^ Description ^ | + | |
| - | | featureSource | [[ThinkGeo.MapSuite.PortableCore.FeatureSource|FeatureSource]]<!-- ThinkGeo.MapSuite.PortableCore.FeatureSource --> | This parameter is the FeatureSource that will provide the functionality for this class's methods. | | + | |
| - | [[#Public Constructors|Go Back]] | + | == Return Value == |
| - | ===== Protected Constructors ===== | + | * Type:Collection<[[ThinkGeo.MapSuite.Core.Feature|Feature]]> |
| - | ==== QueryTools() ==== | + | * Description:The returnning features matches the columnValue. |
| - | This is a constructor for the class. | + | |
| - | === Overloads === | + | |
| - | This is the default constructor, though it is typically not intended to be used. | + | |
| - | === Remarks === | + | |
| - | This is the default constructor, though it is typically not intended to be used. | + | |
| - | === Parameters === | + | |
| - | ^ Name ^ Type ^ Description ^ | + | |
| - | [[#Protected Constructors|Go Back]] | + | == Parameters == |
| - | ===== Public Methods ===== | + | * //columnName// |
| - | ==== Equals(Object) ==== | + | * Type:String |
| - | === Return Value === | + | * Description:The specified columnName to match the columnValue. |
| - | ^ Return Type ^ Description ^ | + | |
| - | | Boolean<!-- System.Boolean --> | | | + | |
| - | === Parameters === | + | * //columnValue// |
| - | ^ Name ^ Type ^ Description ^ | + | * Type:String |
| - | | obj | Object<!-- System.Object --> | | | + | * Description:The specified columnValue to match those returning features. |
| - | <!-- System.Object --> | + | * //returningColumnType// |
| - | [[#Public Methods|Go Back]] | + | * Type:[[ThinkGeo.MapSuite.Core.ReturningColumnsType|ReturningColumnsType]] |
| - | ==== ExecuteNonQuery(String) ==== | + | * Description:This parameter specifies the columns contained in the return features. |
| - | 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 === | + | <div newline></div> |
| - | ^ Name ^ Type ^ Description ^ | + | ** {{wiki:PublicMethod.gif|}} GetFeaturesByColumnValue(String,String,IEnumerable<String>) ** |
| - | | sqlStatement | String<!-- System.String --> | The sqlStatement to be excuted. | | + | |
| - | <!-- ThinkGeo.MapSuite.PortableCore.QueryTools --> | + | * //Get all of the features by passing a columnName and a specified columValue.// |
| - | [[#Public Methods|Go Back]] | + | == Remarks == |
| - | ==== ExecuteQuery(String) ==== | + | * //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 use 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 === | + | == Return Value == |
| - | ^ Name ^ Type ^ Description ^ | + | * Type:Collection<[[ThinkGeo.MapSuite.Core.Feature|Feature]]> |
| - | | sqlStatement | String<!-- System.String --> | The SQL statement to be excuted. | | + | * Description:The returnning features matches the columnValue. |
| - | <!-- ThinkGeo.MapSuite.PortableCore.QueryTools --> | + | == Parameters == |
| - | [[#Public Methods|Go Back]] | + | * //columnName// |
| - | ==== ExecuteScalar(String) ==== | + | * Type: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. | + | * Description:The specified columnName to match the columnValue. |
| - | === Remarks === | + | |
| - | Use the ExcuteScalar method to retrieve a single value from the database. This requires less code than use 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 === | + | * //columnValue// |
| - | ^ Name ^ Type ^ Description ^ | + | * Type:String |
| - | | sqlStatement | String<!-- System.String --> | The SQL statement to be excuted. | | + | * Description:The specified columnValue to match those returning features. |
| - | <!-- ThinkGeo.MapSuite.PortableCore.QueryTools --> | + | * //returningColumnNames// |
| - | [[#Public Methods|Go Back]] | + | * Type:IEnumerable<String> |
| - | ==== GetAllFeatures(IEnumerable<String>) ==== | + | * Description:This parameter specifies the columns contained in the return features. |
| - | 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. | + | <div newline></div> |
| + | ** {{wiki:PublicMethod.gif|}} GetFeaturesByColumnValue(String,String) ** | ||
| - | 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. | + | * //Get all of the features by passing a columnName and a specified columValue.// |
| + | == 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:Collection<[[ThinkGeo.MapSuite.Core.Feature|Feature]]> | ||
| + | * Description:The returnning features matches the columnValue. | ||
| - | 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 return value is a collection of all of the InternalFeatures in the FeatureSource. | | + | * Description:The specified columnName to match the columnValue. |
| - | === Parameters === | + | * //columnValue// |
| - | ^ Name ^ Type ^ Description ^ | + | * Type:String |
| - | | 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:The specified columnValue to match those returning features. |
| - | <!-- ThinkGeo.MapSuite.PortableCore.QueryTools --> | + | <div newline></div> |
| - | [[#Public Methods|Go Back]] | + | ** {{wiki:PublicMethod.gif|}} GetFeaturesContaining(BaseShape,IEnumerable<String>) ** |
| - | ==== GetAllFeatures(ReturningColumnsType) ==== | + | |
| - | 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. | + | * //This method returns all of the InternalFeatures that contain the target shape.// |
| + | == Remarks == | ||
| + | * //This method returns all of the InternalFeatures that contain the specified target shape. If there is a current transaction and it is marked as live, then the results will include any transaction Feature that applies.// | ||
| - | 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. | + | == Return Value == |
| + | * Type:Collection<[[ThinkGeo.MapSuite.Core.Feature|Feature]]> | ||
| + | * Description:The return value is a collection of InternalFeatures that contain the TargetShape you passed in. | ||
| - | 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. | + | == Parameters == |
| + | * //targetShape// | ||
| + | * Type:[[ThinkGeo.MapSuite.Core.BaseShape|BaseShape]] | ||
| + | * Description:This parameter specifies the target shape used in the spatial query. | ||
| - | 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:This parameter specifies the columns contained in the return features. |
| - | | Collection<[[ThinkGeo.MapSuite.PortableCore.Feature|Feature]]><!-- System.Collections.ObjectModel.Collection{ThinkGeo.MapSuite.PortableCore.Feature} --> | The return value is a collection of all of the InternalFeatures in the FeatureSource. | | + | |
| - | === Parameters === | + | <div newline></div> |
| - | ^ Name ^ Type ^ Description ^ | + | ** {{wiki:PublicMethod.gif|}} GetFeaturesContaining(BaseShape,ReturningColumnsType) ** |
| - | | returningColumnNamesType | [[ThinkGeo.MapSuite.PortableCore.ReturningColumnsType|ReturningColumnsType]]<!-- ThinkGeo.MapSuite.PortableCore.ReturningColumnsType --> | This parameter allows you to select the field names of the column data you wish to return with each Feature. | | + | |
| - | <!-- ThinkGeo.MapSuite.PortableCore.QueryTools --> | + | * //This method returns all of the InternalFeatures based on the target Feature and the spatial query type specified.// |
| - | [[#Public Methods|Go Back]] | + | == Remarks == |
| - | ==== GetBoundingBoxById(String) ==== | + | * //This method returns all of the InternalFeatures that contain the target shape. If there is a current transaction and it is marked as live, then the results will include any transaction Feature that applies.ReturningColumnsType:NoColumns - This method ensures that the returning features contain no column values.AllColumns - This method ensures that the returning features contain all column values.// |
| - | This method returns the bounding box for the Id specified. | + | |
| - | === Remarks === | + | |
| - | This method returns the bounding box for the Id specified. | + | |
| - | === Return Value === | + | |
| - | ^ Return Type ^ Description ^ | + | |
| - | | [[ThinkGeo.MapSuite.PortableCore.RectangleShape|RectangleShape]]<!-- ThinkGeo.MapSuite.PortableCore.RectangleShape --> | This method returns the bounding box for the Id specified. | | + | |
| - | === Parameters === | + | == Return Value == |
| - | ^ Name ^ Type ^ Description ^ | + | * Type:Collection<[[ThinkGeo.MapSuite.Core.Feature|Feature]]> |
| - | | id | String<!-- System.String --> | This parameter is the unique Id of the feature for which you want to find the bounding box. | | + | * Description:The return value is a collection of InternalFeatures that match the spatial query you executed based on the TargetShape. |
| - | <!-- ThinkGeo.MapSuite.PortableCore.QueryTools --> | + | == Parameters == |
| - | [[#Public Methods|Go Back]] | + | * //targetShape// |
| - | ==== GetBoundingBoxesByIds(IEnumerable<String>) ==== | + | * Type:[[ThinkGeo.MapSuite.Core.BaseShape|BaseShape]] |
| - | This method returns a collection of bounding boxes based on the collection of Ids provided. | + | * Description:This parameter specifies the target shape used in the spatial query. |
| - | === Remarks === | + | |
| - | This method returns a collection of bounding boxes based on the collection of Ids provided. | + | |
| - | === 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 collection of Ids provided. | | + | |
| - | === Parameters === | + | * //returningColumnNamesType// |
| - | ^ Name ^ Type ^ Description ^ | + | * Type:[[ThinkGeo.MapSuite.Core.ReturningColumnsType|ReturningColumnsType]] |
| - | | ids | IEnumerable<String><!-- System.Collections.Generic.IEnumerable{System.String} --> | This parameter is the collection of Ids you want to find. | | + | * Description:This parameter specifies the columns contained in the return features. |
| - | <!-- ThinkGeo.MapSuite.PortableCore.QueryTools --> | + | <div newline></div> |
| - | [[#Public Methods|Go Back]] | + | ** {{wiki:PublicMethod.gif|}} GetFeaturesContaining(Feature,IEnumerable<String>) ** |
| - | ==== GetColumns() ==== | + | |
| - | This method returns the collection of columns for this FeatureSource. | + | |
| - | === Remarks === | + | |
| - | This method returns the collection of columns for this FeatureSource. | + | |
| - | === Return Value === | + | |
| - | ^ Return Type ^ Description ^ | + | |
| - | | Collection<[[ThinkGeo.MapSuite.PortableCore.FeatureSourceColumn|FeatureSourceColumn]]><!-- System.Collections.ObjectModel.Collection{ThinkGeo.MapSuite.PortableCore.FeatureSourceColumn} --> | This method returns the collection of columns for this FeatureSource. | | + | |
| - | === Parameters === | + | * //This method returns all of the InternalFeatures based on the target Feature and the spatial query type specified.// |
| - | ^ Name ^ Type ^ Description ^ | + | == Remarks == |
| + | * //This method returns all of the InternalFeatures that contain the target shape. If there is a current transaction and it is marked as live, then the results will include any transaction Feature that applies.ReturningColumnsType:NoColumns - This method ensures that the returning features contain no column values.AllColumns - This method ensures that the returning features contain all column values.// | ||
| - | <!-- ThinkGeo.MapSuite.PortableCore.QueryTools --> | + | == Return Value == |
| - | [[#Public Methods|Go Back]] | + | * Type:Collection<[[ThinkGeo.MapSuite.Core.Feature|Feature]]> |
| - | ==== GetCount() ==== | + | * Description:The return value is a collection of InternalFeatures that match the spatial query you executed based on the TargetShape. |
| - | This method returns the count of all of the InternalFeatures in the FeatureSource. | + | |
| - | === Remarks === | + | |
| - | This method returns the count of all of the InternalFeatures in the FeatureSource. | + | |
| - | === Return Value === | + | |
| - | ^ Return Type ^ Description ^ | + | |
| - | | Int32<!-- System.Int32 --> | This method returns the count of all of the InternalFeatures in the FeatureSource. | | + | |
| - | === Parameters === | + | == Parameters == |
| - | ^ Name ^ Type ^ Description ^ | + | * //targetFeature// |
| + | * Type:[[ThinkGeo.MapSuite.Core.Feature|Feature]] | ||
| + | * Description:This parameter specifies the target feature used in the spatial query. | ||
| - | <!-- ThinkGeo.MapSuite.PortableCore.QueryTools --> | + | * //returningColumnNames// |
| - | [[#Public Methods|Go Back]] | + | * Type:IEnumerable<String> |
| - | ==== GetFeatureById(String, ReturningColumnsType) ==== | + | * Description:This parameter specifies the columns contained in the return features. |
| - | This method returns an InternalFeature based on an Id provided. | + | |
| - | === Remarks === | + | |
| - | This method returns an InternalFeature based on an Id provided. | + | |
| - | === Return Value === | + | |
| - | ^ Return Type ^ Description ^ | + | |
| - | | [[ThinkGeo.MapSuite.PortableCore.Feature|Feature]]<!-- ThinkGeo.MapSuite.PortableCore.Feature --> | This method returns an InternalFeature based on an Id provided. | | + | |
| - | === Parameters === | + | <div newline></div> |
| - | ^ Name ^ Type ^ Description ^ | + | ** {{wiki:PublicMethod.gif|}} GetFeaturesContaining(Feature,ReturningColumnsType) ** |
| - | | id | String<!-- System.String --> | This parameter is the unique Id for the feature you want to find. | | + | |
| - | | returningColumnNamesType | [[ThinkGeo.MapSuite.PortableCore.ReturningColumnsType|ReturningColumnsType]]<!-- ThinkGeo.MapSuite.PortableCore.ReturningColumnsType --> | This parameter is a list of column names you want returned with the Feature. | | + | |
| - | <!-- ThinkGeo.MapSuite.PortableCore.QueryTools --> | + | * //This method returns all of the InternalFeatures based on the target Feature and the spatial query type specified.// |
| - | [[#Public Methods|Go Back]] | + | == Remarks == |
| - | ==== GetFeatureById(String, IEnumerable<String>) ==== | + | * //This method returns all of the InternalFeatures that contain the target shape. If there is a current transaction and it is marked as live, then the results will include any transaction Feature that applies.ReturningColumnsType:NoColumns - This method ensures that the returning features contain no column values.AllColumns - This method ensures that the returning features contain all column values.// |
| - | This method returns an InternalFeature based on an Id provided. | + | |
| - | === Remarks === | + | |
| - | This method returns an InternalFeature based on an Id provided. | + | |
| - | === Return Value === | + | |
| - | ^ Return Type ^ Description ^ | + | |
| - | | [[ThinkGeo.MapSuite.PortableCore.Feature|Feature]]<!-- ThinkGeo.MapSuite.PortableCore.Feature --> | This method returns an InternalFeature based on an Id provided. | | + | |
| - | === Parameters === | + | == Return Value == |
| - | ^ Name ^ Type ^ Description ^ | + | * Type:Collection<[[ThinkGeo.MapSuite.Core.Feature|Feature]]> |
| - | | id | String<!-- System.String --> | This parameter is the unique Id for the feature you want to find. | | + | * Description:The return value is a collection of InternalFeatures that match the spatial query you executed based on the TargetFeature. |
| - | | returningColumnNames | IEnumerable<String><!-- System.Collections.Generic.IEnumerable{System.String} --> | This parameter is a list of column names you want returned with the Feature. | | + | |
| - | <!-- ThinkGeo.MapSuite.PortableCore.QueryTools --> | + | == Parameters == |
| - | [[#Public Methods|Go Back]] | + | * //targetFeature// |
| - | ==== GetFeaturesByColumnValue(String, String, ReturningColumnsType) ==== | + | * Type:[[ThinkGeo.MapSuite.Core.Feature|Feature]] |
| - | Get all of the features by passing a columnName and a specified columValue. | + | * Description:This parameter specifies the target feature used in the spatial query. |
| - | === 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 === | + | * //returningColumnNamesType// |
| - | ^ Name ^ Type ^ Description ^ | + | * Type:[[ThinkGeo.MapSuite.Core.ReturningColumnsType|ReturningColumnsType]] |
| - | | columnName | String<!-- System.String --> | The specified columnName to match the columnValue. | | + | * Description:This parameter specifies the columns contained in the return features. |
| - | | columnValue | String<!-- System.String --> | The specified columnValue to match those returning features. | | + | |
| - | | returningColumnType | [[ThinkGeo.MapSuite.PortableCore.ReturningColumnsType|ReturningColumnsType]]<!-- ThinkGeo.MapSuite.PortableCore.ReturningColumnsType --> | This parameter specifies the columns contained in the return features. | | + | |
| - | <!-- ThinkGeo.MapSuite.PortableCore.QueryTools --> | + | <div newline></div> |
| - | [[#Public Methods|Go Back]] | + | ** {{wiki:PublicMethod.gif|}} GetFeaturesCrossing(BaseShape,IEnumerable<String>) ** |
| - | ==== 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 === | + | * //This method returns all of the InternalFeatures that cross the target shape.// |
| - | ^ Name ^ Type ^ Description ^ | + | == Remarks == |
| - | | columnName | String<!-- System.String --> | The specified columnName to match the columnValue. | | + | * //This method returns all of the InternalFeatures that cross the target shape. If there is a current transaction and it is marked as live, then the results will include any transaction Feature that applies.Crossing - The Geometries share some but not all interior points, and the dimension of the intersection is less than that of at least one of the Geometries.// |
| - | | columnValue | String<!-- System.String --> | The specified columnValue to match those returning features. | | + | |
| - | | returningColumnNames | IEnumerable<String><!-- System.Collections.Generic.IEnumerable{System.String} --> | This parameter specifies the columns contained in the return features. | | + | |
| - | <!-- ThinkGeo.MapSuite.PortableCore.QueryTools --> | + | == Return Value == |
| - | [[#Public Methods|Go Back]] | + | * Type:Collection<[[ThinkGeo.MapSuite.Core.Feature|Feature]]> |
| - | ==== GetFeaturesByColumnValue(String, String) ==== | + | * Description:The return value is a collection of InternalFeatures that cross the TargetShape you passed in. |
| - | 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 ^ | + | * //targetShape// |
| - | | columnName | String<!-- System.String --> | The specified columnName to match the columnValue. | | + | * Type:[[ThinkGeo.MapSuite.Core.BaseShape|BaseShape]] |
| - | | columnValue | String<!-- System.String --> | The specified columnValue to match those returning features. | | + | * Description:This parameter specifies the target shape used in the spatial query. |
| - | <!-- ThinkGeo.MapSuite.PortableCore.QueryTools --> | + | * //returningColumnNames// |
| - | [[#Public Methods|Go Back]] | + | * Type:IEnumerable<String> |
| - | ==== GetFeaturesByIds(IEnumerable<String>, ReturningColumnsType) ==== | + | * Description:This parameter specifies the columns contained in the return features. |
| - | This method returns a collection of InternalFeatures based on the collection of Ids provided. | + | |
| - | === Remarks === | + | |
| - | This method returns a collection of InternalFeatures based on the collection of Ids provided. | + | |
| - | === 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 based on the collection of Ids provided. | | + | |
| - | === Parameters === | + | <div newline></div> |
| - | ^ Name ^ Type ^ Description ^ | + | ** {{wiki:PublicMethod.gif|}} GetFeaturesCrossing(BaseShape,ReturningColumnsType) ** |
| - | | ids | IEnumerable<String><!-- System.Collections.Generic.IEnumerable{System.String} --> | This parameter is the collection of Ids you want to find. | | + | |
| - | | returningColumnNamesType | [[ThinkGeo.MapSuite.PortableCore.ReturningColumnsType|ReturningColumnsType]]<!-- ThinkGeo.MapSuite.PortableCore.ReturningColumnsType --> | This parameter is a list of column names you want returned with the Features. | | + | |
| - | <!-- ThinkGeo.MapSuite.PortableCore.QueryTools --> | + | * //This method returns all of the InternalFeatures that cross the target shape.// |
| - | [[#Public Methods|Go Back]] | + | == Remarks == |
| - | ==== GetFeaturesByIds(IEnumerable<String>, IEnumerable<String>) ==== | + | * //This method returns all of the InternalFeatures that cross the target shape. If there is a current transaction and it is marked as live, then the results will include any transaction Feature that applies.ReturningColumnsType:NoColumns - This method ensures that the returning features contain no column values.AllColumns - This method ensures that the returning features contain all column values.// |
| - | This method returns a collection of InternalFeatures based on the collection of Ids provided. | + | |
| - | === Remarks === | + | |
| - | This method returns a collection of InternalFeatures based on the collection of Ids provided. | + | |
| - | === 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 based on the collection of Ids provided. | | + | |
| - | === Parameters === | + | == Return Value == |
| - | ^ Name ^ Type ^ Description ^ | + | * Type:Collection<[[ThinkGeo.MapSuite.Core.Feature|Feature]]> |
| - | | ids | IEnumerable<String><!-- System.Collections.Generic.IEnumerable{System.String} --> | This parameter is the collection of Ids you want to find. | | + | * Description:The return value is a collection of InternalFeatures that match the spatial query you executed based on the TargetShape. |
| - | | returningColumnNames | IEnumerable<String><!-- System.Collections.Generic.IEnumerable{System.String} --> | This parameter is a list of column names you want returned with the Features. | | + | |
| - | <!-- ThinkGeo.MapSuite.PortableCore.QueryTools --> | + | == Parameters == |
| - | [[#Public Methods|Go Back]] | + | * //targetShape// |
| - | ==== GetFeaturesContaining(BaseShape, IEnumerable<String>) ==== | + | * Type:[[ThinkGeo.MapSuite.Core.BaseShape|BaseShape]] |
| - | This method returns all of the InternalFeatures that contain the target shape. | + | * Description:This parameter specifies the target shape used in the spatial query. |
| - | === Overloads === | + | |
| - | This method returns all of the features that contain the target shape. | + | |
| - | === Remarks === | + | |
| - | This method returns all of the InternalFeatures that contain the specified target shape. If there is a current transaction and it is marked as live, then the results will include any transaction Feature that applies. | + | |
| - | === Return Value === | + | |
| - | ^ Return Type ^ Description ^ | + | |
| - | | Collection<[[ThinkGeo.MapSuite.PortableCore.Feature|Feature]]><!-- System.Collections.ObjectModel.Collection{ThinkGeo.MapSuite.PortableCore.Feature} --> | The return value is a collection of InternalFeatures that contain the TargetShape you passed in. | | + | |
| - | === 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:This parameter specifies the columns contained in the return features. |
| - | | returningColumnNames | IEnumerable<String><!-- System.Collections.Generic.IEnumerable{System.String} --> | This parameter specifies the columns contained in the return features. | | + | |
| - | <!-- ThinkGeo.MapSuite.PortableCore.QueryTools --> | + | <div newline></div> |
| - | [[#Public Methods|Go Back]] | + | ** {{wiki:PublicMethod.gif|}} GetFeaturesCrossing(Feature,IEnumerable<String>) ** |
| - | ==== GetFeaturesContaining(BaseShape, ReturningColumnsType) ==== | + | |
| - | This method returns all of the InternalFeatures based on the target Feature and the spatial query type specified. | + | |
| - | === Overloads === | + | |
| - | This method returns all of the features that contain the target shape. | + | |
| - | === Remarks === | + | |
| - | This method returns all of the InternalFeatures that contain the target shape. If there is a current transaction and it is marked as live, then the results will include any transaction Feature that applies. | + | |
| - | <strong>ReturningColumnsType:</strong> | + | * //This method returns all of the InternalFeatures that cross the target Feature.// |
| + | == Remarks == | ||
| + | * //This method returns all of the Internalfeatures that cross the target shape. If there is a current transaction and it is marked as live, then the results will include any transaction Feature that applies.ReturningColumnsType:NoColumns - This method ensures that the returning features contain no column values.AllColumns - This method ensures that the returning features contain all column values.// | ||
| - | <strong>NoColumns</strong> - This method ensures that the returning features contain no column values. | + | == Return Value == |
| + | * Type:Collection<[[ThinkGeo.MapSuite.Core.Feature|Feature]]> | ||
| + | * Description:The return value is a collection of InternalFeatures that match the spatial query you executed based on the TargetShape. | ||
| - | <strong>AllColumns</strong> - This method ensures that the returning features contain all column values. | + | == 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} --> | The return value is a collection of InternalFeatures that match the spatial query you executed based on the TargetShape. | | + | * Description:This parameter specifies the target feature used in the spatial query. |
| - | === Parameters === | + | * //returningColumnNames// |
| - | ^ Name ^ Type ^ Description ^ | + | * Type:IEnumerable<String> |
| - | | targetShape | [[ThinkGeo.MapSuite.PortableCore.BaseShape|BaseShape]]<!-- ThinkGeo.MapSuite.PortableCore.BaseShape --> | This parameter specifies the target shape used in the spatial query. | | + | * Description:This parameter specifies the columns contained in the return features. |
| - | | returningColumnNamesType | [[ThinkGeo.MapSuite.PortableCore.ReturningColumnsType|ReturningColumnsType]]<!-- ThinkGeo.MapSuite.PortableCore.ReturningColumnsType --> | This parameter specifies the columns contained in the return features. | | + | |
| - | <!-- ThinkGeo.MapSuite.PortableCore.QueryTools --> | + | <div newline></div> |
| - | [[#Public Methods|Go Back]] | + | ** {{wiki:PublicMethod.gif|}} GetFeaturesCrossing(Feature,ReturningColumnsType) ** |
| - | ==== GetFeaturesContaining(Feature, IEnumerable<String>) ==== | + | |
| - | This method returns all of the InternalFeatures based on the target Feature and the spatial query type specified. | + | |
| - | === Overloads === | + | |
| - | This method returns all of the features that contain the target shape. | + | |
| - | === Remarks === | + | |
| - | This method returns all of the InternalFeatures that contain the target shape. If there is a current transaction and it is marked as live, then the results will include any transaction Feature that applies. | + | |
| - | <strong>ReturningColumnsType:</strong> | + | * //This method returns all of the InternalFeatures that cross the target Feature.// |
| + | == Remarks == | ||
| + | * //This method returns all of the Internalfeatures that cross the target shape. If there is a current transaction and it is marked as live, then the results will include any transaction Feature that applies.ReturningColumnsType:NoColumns - This method ensures that the returning features contain no column values.AllColumns - This method ensures that the returning features contain all column values.// | ||
| - | <strong>NoColumns</strong> - This method ensures that the returning features contain no column values. | + | == Return Value == |
| + | * Type:Collection<[[ThinkGeo.MapSuite.Core.Feature|Feature]]> | ||
| + | * Description:The return value is a collection of InternalFeatures that match the spatial query you executed based on the TargetShape. | ||
| - | <strong>AllColumns</strong> - This method ensures that the returning features contain all column values. | + | == 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} --> | The return value is a collection of InternalFeatures that match the spatial query you executed based on the TargetShape. | | + | * Description:This parameter specifies the target feature used in the spatial query. |
| - | === Parameters === | + | * //returningColumnNamesType// |
| - | ^ Name ^ Type ^ Description ^ | + | * Type:[[ThinkGeo.MapSuite.Core.ReturningColumnsType|ReturningColumnsType]] |
| - | | targetFeature | [[ThinkGeo.MapSuite.PortableCore.Feature|Feature]]<!-- ThinkGeo.MapSuite.PortableCore.Feature --> | This parameter specifies the target feature used in the spatial query. | | + | * Description:This parameter specifies the columns contained in the return features. |
| - | | returningColumnNames | IEnumerable<String><!-- System.Collections.Generic.IEnumerable{System.String} --> | This parameter specifies the columns contained in the return features. | | + | |
| - | <!-- ThinkGeo.MapSuite.PortableCore.QueryTools --> | + | <div newline></div> |
| - | [[#Public Methods|Go Back]] | + | ** {{wiki:PublicMethod.gif|}} GetFeaturesDisjointed(BaseShape,IEnumerable<String>) ** |
| - | ==== GetFeaturesContaining(Feature, ReturningColumnsType) ==== | + | |
| - | This method returns all of the InternalFeatures based on the target Feature and the spatial query type specified. | + | |
| - | === Overloads === | + | |
| - | This method returns all of the features that contain the target feature. | + | |
| - | === Remarks === | + | |
| - | This method returns all of the InternalFeatures that contain the target shape. If there is a current transaction and it is marked as live, then the results will include any transaction Feature that applies. | + | |
| - | <strong>ReturningColumnsType:</strong> | + | * //This method returns all of the InternalFeatures that disjoint the target Feature.// |
| + | == Remarks == | ||
| + | * //This method returns all of the InternalFeatures that disjoint the target shape. If there is a current transaction and it is marked as live, then the results will include any transaction Feature that applies.Disjoint - The Geometries have no point in common.// | ||
| - | <strong>NoColumns</strong> - This method ensures that the returning features contain no column values. | + | == Return Value == |
| + | * Type:Collection<[[ThinkGeo.MapSuite.Core.Feature|Feature]]> | ||
| + | * Description:The return value is a collection of InternalFeatures that match the spatial query you executed based on the TargetShape. | ||
| - | <strong>AllColumns</strong> - This method ensures that the returning features contain all column values. | + | == 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 return value is a collection of InternalFeatures that match the spatial query you executed based on the TargetFeature. | | + | * Description:This parameter specifies the target shape used in the spatial query. |
| - | === Parameters === | + | * //returningColumnNames// |
| - | ^ Name ^ Type ^ Description ^ | + | * Type:IEnumerable<String> |
| - | | targetFeature | [[ThinkGeo.MapSuite.PortableCore.Feature|Feature]]<!-- ThinkGeo.MapSuite.PortableCore.Feature --> | This parameter specifies the target feature used in the spatial query. | | + | * Description:This parameter specifies the columns contained in the return features. |
| - | | returningColumnNamesType | [[ThinkGeo.MapSuite.PortableCore.ReturningColumnsType|ReturningColumnsType]]<!-- ThinkGeo.MapSuite.PortableCore.ReturningColumnsType --> | This parameter specifies the columns contained in the return features. | | + | |
| - | <!-- ThinkGeo.MapSuite.PortableCore.QueryTools --> | + | <div newline></div> |
| - | [[#Public Methods|Go Back]] | + | ** {{wiki:PublicMethod.gif|}} GetFeaturesDisjointed(BaseShape,ReturningColumnsType) ** |
| - | ==== GetFeaturesCrossing(BaseShape, ReturningColumnsType) ==== | + | |
| - | This method returns all of the InternalFeatures that cross the target shape. | + | |
| - | === Overloads === | + | |
| - | This method returns all of the features which crosses the target shape. | + | |
| - | === Remarks === | + | |
| - | This method returns all of the InternalFeatures that cross the target shape. If there is a current transaction and it is marked as live, then the results will include any transaction Feature that applies. | + | |
| - | <strong>ReturningColumnsType:</strong> | + | * //This method returns all of the InternalFeatures that disjoint the target Feature.// |
| + | == Remarks == | ||
| + | * //This method returns all of the InternalFeatures that disjoint the target shape. If there is a current transaction and it is marked as live, then the results will include any transaction Feature that applies.Disjoint - The Geometries have no point in common.ReturningColumnsType:NoColumns - This method ensures that the returning features contain no column values.AllColumns - This method ensures that the returning features contain all column values.// | ||
| - | <strong>NoColumns</strong> - This method ensures that the returning features contain no column values. | + | == Return Value == |
| + | * Type:Collection<[[ThinkGeo.MapSuite.Core.Feature|Feature]]> | ||
| + | * Description:The return value is a collection of InternalFeatures that match the spatial query you executed based on the TargetShape. | ||
| - | <strong>AllColumns</strong> - This method ensures that the returning features contain all column values. | + | == 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 return value is a collection of InternalFeatures that match the spatial query you executed based on the TargetShape. | | + | * Description:This parameter specifies the target shape used in the spatial query. |
| - | === 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:This parameter specifies the columns contained in the return features. |
| - | | returningColumnNamesType | [[ThinkGeo.MapSuite.PortableCore.ReturningColumnsType|ReturningColumnsType]]<!-- ThinkGeo.MapSuite.PortableCore.ReturningColumnsType --> | This parameter specifies the columns contained in the return features. | | + | |
| - | <!-- ThinkGeo.MapSuite.PortableCore.QueryTools --> | + | <div newline></div> |
| - | [[#Public Methods|Go Back]] | + | ** {{wiki:PublicMethod.gif|}} GetFeaturesDisjointed(Feature,IEnumerable<String>) ** |
| - | ==== GetFeaturesCrossing(BaseShape, IEnumerable<String>) ==== | + | |
| - | This method returns all of the InternalFeatures that cross the target shape. | + | |
| - | === Overloads === | + | |
| - | This method returns all of the features that cross the target shape. | + | |
| - | === Remarks === | + | |
| - | This method returns all of the InternalFeatures that cross the target shape. If there is a current transaction and it is marked as live, then the results will include any transaction Feature that applies. | + | |
| - | <strong>Crossing</strong> - The Geometries share some but not all interior points, and the dimension of the intersection is less than that of at least one of the Geometries. | + | |
| - | === Return Value === | + | |
| - | ^ Return Type ^ Description ^ | + | |
| - | | Collection<[[ThinkGeo.MapSuite.PortableCore.Feature|Feature]]><!-- System.Collections.ObjectModel.Collection{ThinkGeo.MapSuite.PortableCore.Feature} --> | The return value is a collection of InternalFeatures that cross the TargetShape you passed in. | | + | |
| - | === Parameters === | + | * //This method returns all of the InternalFeatures that disjoint the target Feature.// |
| - | ^ Name ^ Type ^ Description ^ | + | == Remarks == |
| - | | targetShape | [[ThinkGeo.MapSuite.PortableCore.BaseShape|BaseShape]]<!-- ThinkGeo.MapSuite.PortableCore.BaseShape --> | This parameter specifies the target shape used in the spatial query. | | + | * //This method returns all of the InternalFeatures that disjoint the target shape. If there is a current transaction and it is marked as live, then the results will include any transaction Feature that applies.Disjoint - The Geometries have no point in common.// |
| - | | returningColumnNames | IEnumerable<String><!-- System.Collections.Generic.IEnumerable{System.String} --> | This parameter specifies the columns contained in the return features. | | + | |
| - | <!-- ThinkGeo.MapSuite.PortableCore.QueryTools --> | + | == Return Value == |
| - | [[#Public Methods|Go Back]] | + | * Type:Collection<[[ThinkGeo.MapSuite.Core.Feature|Feature]]> |
| - | ==== GetFeaturesCrossing(Feature, IEnumerable<String>) ==== | + | * Description:The return value is a collection of InternalFeatures that match the spatial query you executed based on the TargetShape. |
| - | This method returns all of the InternalFeatures that cross the target Feature. | + | |
| - | === Overloads === | + | |
| - | This method returns all of the features that cross the target shape. | + | |
| - | === Remarks === | + | |
| - | This method returns all of the Internalfeatures that cross the target shape. If there is a current transaction and it is marked as live, then the results will include any transaction Feature that applies. | + | |
| - | <strong>ReturningColumnsType:</strong> | + | == Parameters == |
| + | * //targetFeature// | ||
| + | * Type:[[ThinkGeo.MapSuite.Core.Feature|Feature]] | ||
| + | * Description:This parameter specifies the target feature used in the spatial query. | ||
| - | <strong>NoColumns</strong> - This method ensures that the returning features contain no column values. | + | * //returningColumnNames// |
| + | * Type:IEnumerable<String> | ||
| + | * Description:This parameter specifies the columns contained in the return features. | ||
| - | <strong>AllColumns</strong> - This method ensures that the returning features contain all column values. | + | <div newline></div> |
| - | === Return Value === | + | ** {{wiki:PublicMethod.gif|}} GetFeaturesDisjointed(Feature,ReturningColumnsType) ** |
| - | ^ Return Type ^ Description ^ | + | |
| - | | Collection<[[ThinkGeo.MapSuite.PortableCore.Feature|Feature]]><!-- System.Collections.ObjectModel.Collection{ThinkGeo.MapSuite.PortableCore.Feature} --> | The return value is a collection of InternalFeatures that match the spatial query you executed based on the TargetShape. | | + | |
| - | === Parameters === | + | * //This method returns all of the InternalFeatures that disjoint the target Feature.// |
| - | ^ Name ^ Type ^ Description ^ | + | == Remarks == |
| - | | targetFeature | [[ThinkGeo.MapSuite.PortableCore.Feature|Feature]]<!-- ThinkGeo.MapSuite.PortableCore.Feature --> | This parameter specifies the target feature used in the spatial query. | | + | * //This method returns all of the InternalFeatures that disjoint the target shape. If there is a current transaction and it is marked as live, then the results will include any transaction Feature that applies.Disjoint - The Geometries have no point in common.// |
| - | | returningColumnNames | IEnumerable<String><!-- System.Collections.Generic.IEnumerable{System.String} --> | This parameter specifies the columns contained in the return features. | | + | |
| - | <!-- ThinkGeo.MapSuite.PortableCore.QueryTools --> | + | == Return Value == |
| - | [[#Public Methods|Go Back]] | + | * Type:Collection<[[ThinkGeo.MapSuite.Core.Feature|Feature]]> |
| - | ==== GetFeaturesCrossing(Feature, ReturningColumnsType) ==== | + | * Description:The return value is a collection of InternalFeatures that match the spatial query you executed based on the TargetShape. |
| - | This method returns all of the InternalFeatures that cross the target Feature. | + | |
| - | === Overloads === | + | |
| - | This method returns all of the features that cross the target shape. | + | |
| - | === Remarks === | + | |
| - | This method returns all of the Internalfeatures that cross the target shape. If there is a current transaction and it is marked as live, then the results will include any transaction Feature that applies. | + | |
| - | <strong>ReturningColumnsType:</strong> | + | == Parameters == |
| + | * //targetFeature// | ||
| + | * Type:[[ThinkGeo.MapSuite.Core.Feature|Feature]] | ||
| + | * Description:This parameter specifies the target feature used in the spatial query. | ||
| - | <strong>NoColumns</strong> - This method ensures that the returning features contain no column values. | + | * //returningColumnNamesType// |
| + | * Type:[[ThinkGeo.MapSuite.Core.ReturningColumnsType|ReturningColumnsType]] | ||
| + | * Description:This parameter specifies the columns contained in the return features. | ||
| - | <strong>AllColumns</strong> - This method ensures that the returning features contain all column values. | + | <div newline></div> |
| - | === Return Value === | + | ** {{wiki:PublicMethod.gif|}} GetFeaturesIntersecting(BaseShape,IEnumerable<String>) ** |
| - | ^ Return Type ^ Description ^ | + | |
| - | | Collection<[[ThinkGeo.MapSuite.PortableCore.Feature|Feature]]><!-- System.Collections.ObjectModel.Collection{ThinkGeo.MapSuite.PortableCore.Feature} --> | The return value is a collection of InternalFeatures that match the spatial query you executed based on the TargetShape. | | + | |
| - | === Parameters === | + | * //This method returns all of the InternalFeatures that intersect the target Feature.// |
| - | ^ Name ^ Type ^ Description ^ | + | == Remarks == |
| - | | targetFeature | [[ThinkGeo.MapSuite.PortableCore.Feature|Feature]]<!-- ThinkGeo.MapSuite.PortableCore.Feature --> | This parameter specifies the target feature used in the spatial query. | | + | * //This method returns all of the InternalFeatures that intersect the target shape. If there is a current transaction and it is marked as live, then the results will include any transaction Feature that applies.Intersecting - The Geometries have at least one point in common (the inverse of Disjoint).// |
| - | | returningColumnNamesType | [[ThinkGeo.MapSuite.PortableCore.ReturningColumnsType|ReturningColumnsType]]<!-- ThinkGeo.MapSuite.PortableCore.ReturningColumnsType --> | This parameter specifies the columns contained in the return features. | | + | |
| - | <!-- ThinkGeo.MapSuite.PortableCore.QueryTools --> | + | == Return Value == |
| - | [[#Public Methods|Go Back]] | + | * Type:Collection<[[ThinkGeo.MapSuite.Core.Feature|Feature]]> |
| - | ==== GetFeaturesDisjointed(Feature, IEnumerable<String>) ==== | + | * Description:The return value is a collection of InternalFeatures that match the spatial query you executed based on the TargetShape. |
| - | This method returns all of the InternalFeatures that disjoint the target Feature. | + | |
| - | === Overloads === | + | |
| - | This method returns all of the features that disjoint the target shape. | + | |
| - | === Remarks === | + | |
| - | This method returns all of the InternalFeatures that disjoint the target shape. If there is a current transaction and it is marked as live, then the results will include any transaction Feature that applies. | + | |
| - | <strong>Disjoint</strong> - The Geometries have no point in common. | + | == 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 return value is a collection of InternalFeatures that match the spatial query you executed based on the TargetShape. | | + | * Description:This parameter specifies the target shape used in the spatial query. |
| - | === Parameters === | + | * //returningColumnNames// |
| - | ^ Name ^ Type ^ Description ^ | + | * Type:IEnumerable<String> |
| - | | targetFeature | [[ThinkGeo.MapSuite.PortableCore.Feature|Feature]]<!-- ThinkGeo.MapSuite.PortableCore.Feature --> | This parameter specifies the target feature used in the spatial query. | | + | * Description:This parameter specifies the column values in the return features. |
| - | | returningColumnNames | IEnumerable<String><!-- System.Collections.Generic.IEnumerable{System.String} --> | This parameter specifies the columns contained in the return features. | | + | |
| - | <!-- ThinkGeo.MapSuite.PortableCore.QueryTools --> | + | <div newline></div> |
| - | [[#Public Methods|Go Back]] | + | ** {{wiki:PublicMethod.gif|}} GetFeaturesIntersecting(BaseShape,ReturningColumnsType) ** |
| - | ==== GetFeaturesDisjointed(BaseShape, IEnumerable<String>) ==== | + | |
| - | This method returns all of the InternalFeatures that disjoint the target Feature. | + | |
| - | === Overloads === | + | |
| - | This method returns all of the features that cross the target shape. | + | |
| - | === Remarks === | + | |
| - | This method returns all of the InternalFeatures that disjoint the target shape. If there is a current transaction and it is marked as live, then the results will include any transaction Feature that applies. | + | |
| - | <strong>Disjoint</strong> - The Geometries have no point in common. | + | * //This method returns all of the InternalFeatures that intersect the target Feature.// |
| - | === Return Value === | + | == Remarks == |
| - | ^ Return Type ^ Description ^ | + | * //This method returns all of the InternalFeatures that intersect the target shape. If there is a current transaction and it is marked as live, then the results will include any transaction Feature that applies.Intersecting - The Geometries have at least one point in common (the inverse of Disjoint).// |
| - | | Collection<[[ThinkGeo.MapSuite.PortableCore.Feature|Feature]]><!-- System.Collections.ObjectModel.Collection{ThinkGeo.MapSuite.PortableCore.Feature} --> | The return value 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:The return value is a collection of InternalFeatures that match the spatial query you executed based on the TargetShape. |
| - | | returningColumnNames | IEnumerable<String><!-- System.Collections.Generic.IEnumerable{System.String} --> | This parameter specifies the columns contained in the return features. | | + | |
| - | <!-- ThinkGeo.MapSuite.PortableCore.QueryTools --> | + | == Parameters == |
| - | [[#Public Methods|Go Back]] | + | * //targetShape// |
| - | ==== GetFeaturesDisjointed(Feature, ReturningColumnsType) ==== | + | * Type:[[ThinkGeo.MapSuite.Core.BaseShape|BaseShape]] |
| - | This method returns all of the InternalFeatures that disjoint the target Feature. | + | * Description:This parameter specifies the target shape used in the spatial query. |
| - | === Overloads === | + | |
| - | This method returns all of the features that disjoint the target shape. | + | |
| - | === Remarks === | + | |
| - | This method returns all of the InternalFeatures that disjoint the target shape. If there is a current transaction and it is marked as live, then the results will include any transaction Feature that applies. | + | |
| - | <strong>Disjoint</strong> - The Geometries have no point in common. | + | * //returningColumnNamesType// |
| - | === Return Value === | + | * Type:[[ThinkGeo.MapSuite.Core.ReturningColumnsType|ReturningColumnsType]] |
| - | ^ Return Type ^ Description ^ | + | * Description:This parameter specifies the column values in the return features. |
| - | | Collection<[[ThinkGeo.MapSuite.PortableCore.Feature|Feature]]><!-- System.Collections.ObjectModel.Collection{ThinkGeo.MapSuite.PortableCore.Feature} --> | The return value is a collection of InternalFeatures that match the spatial query you executed based on the TargetShape. | | + | |
| - | === Parameters === | + | <div newline></div> |
| - | ^ Name ^ Type ^ Description ^ | + | ** {{wiki:PublicMethod.gif|}} GetFeaturesIntersecting(Feature,IEnumerable<String>) ** |
| - | | targetFeature | [[ThinkGeo.MapSuite.PortableCore.Feature|Feature]]<!-- ThinkGeo.MapSuite.PortableCore.Feature --> | This parameter specifies the target feature used in the spatial query. | | + | |
| - | | returningColumnNamesType | [[ThinkGeo.MapSuite.PortableCore.ReturningColumnsType|ReturningColumnsType]]<!-- ThinkGeo.MapSuite.PortableCore.ReturningColumnsType --> | This parameter specifies the columns contained in the return features. | | + | |
| - | <!-- ThinkGeo.MapSuite.PortableCore.QueryTools --> | + | * //This method returns all of the InternalFeatures that intersect the target Feature.// |
| - | [[#Public Methods|Go Back]] | + | == Remarks == |
| - | ==== GetFeaturesDisjointed(BaseShape, ReturningColumnsType) ==== | + | * //This method returns all of the InternalFeatures that intersect the target shape. If there is a current transaction and it is marked as live, then the results will include any transaction Feature that applies.Intersecting - The Geometries have at least one point in common (the inverse of Disjoint).// |
| - | This method returns all of the InternalFeatures that disjoint the target Feature. | + | |
| - | === Overloads === | + | |
| - | This method returns all of the features that disjoint the target shape. | + | |
| - | === Remarks === | + | |
| - | This method returns all of the InternalFeatures that disjoint the target shape. If there is a current transaction and it is marked as live, then the results will include any transaction Feature that applies. | + | |
| - | <strong>Disjoint</strong> - The Geometries have no point in common. | + | == Return Value == |
| + | * Type:Collection<[[ThinkGeo.MapSuite.Core.Feature|Feature]]> | ||
| + | * Description:The return value is a collection of InternalFeatures that match the spatial query you executed based on the TargetShape. | ||
| - | <strong>ReturningColumnsType:</strong> | + | == Parameters == |
| + | * //targetFeature// | ||
| + | * Type:[[ThinkGeo.MapSuite.Core.Feature|Feature]] | ||
| + | * Description:This parameter specifies the target shape used in the spatial query. | ||
| - | <strong>NoColumns</strong> - This method ensures that the returning features contain no column values. | + | * //returningColumnNames// |
| + | * Type:IEnumerable<String> | ||
| + | * Description:This parameter specifies the column values in the return features. | ||
| - | <strong>AllColumns</strong> - This method ensures that the returning features contain all column values. | + | <div newline></div> |
| - | === Return Value === | + | ** {{wiki:PublicMethod.gif|}} GetFeaturesIntersecting(Feature,ReturningColumnsType) ** |
| - | ^ Return Type ^ Description ^ | + | |
| - | | Collection<[[ThinkGeo.MapSuite.PortableCore.Feature|Feature]]><!-- System.Collections.ObjectModel.Collection{ThinkGeo.MapSuite.PortableCore.Feature} --> | The return value is a collection of InternalFeatures that match the spatial query you executed based on the TargetShape. | | + | |
| - | === Parameters === | + | * //This method returns all of the InternalFeatures that intersect the target Feature.// |
| - | ^ Name ^ Type ^ Description ^ | + | == Remarks == |
| - | | targetShape | [[ThinkGeo.MapSuite.PortableCore.BaseShape|BaseShape]]<!-- ThinkGeo.MapSuite.PortableCore.BaseShape --> | This parameter specifies the target shape used in the spatial query. | | + | * //This method returns all of the InternalFeatures that intersect the target shape. If there is a current transaction and it is marked as live, then the results will include any transaction Feature that applies.Intersecting - The Geometries have at least one point in common (the inverse of Disjoint).// |
| - | | returningColumnNamesType | [[ThinkGeo.MapSuite.PortableCore.ReturningColumnsType|ReturningColumnsType]]<!-- ThinkGeo.MapSuite.PortableCore.ReturningColumnsType --> | This parameter specifies the columns contained in the return features. | | + | |
| - | <!-- ThinkGeo.MapSuite.PortableCore.QueryTools --> | + | == Return Value == |
| - | [[#Public Methods|Go Back]] | + | * Type:Collection<[[ThinkGeo.MapSuite.Core.Feature|Feature]]> |
| - | ==== GetFeaturesInsideBoundingBox(RectangleShape, IEnumerable<String>) ==== | + | * Description:The return value is a collection of InternalFeatures that match the spatial query you executed based on the TargetShape. |
| - | This method returns all of the InternalFeatures that are inside of the boundingBox. | + | |
| - | === Overloads === | + | |
| - | This method returns all of the features that are inside of the target rectangle shape. | + | |
| - | === Remarks === | + | |
| - | This method returns all of the InternalFeatures that are inside of the target shape. If there is a current transaction and it is marked as live, then the results will include any transaction Feature that applies. | + | |
| - | === Return Value === | + | |
| - | ^ Return Type ^ Description ^ | + | |
| - | | Collection<[[ThinkGeo.MapSuite.PortableCore.Feature|Feature]]><!-- System.Collections.ObjectModel.Collection{ThinkGeo.MapSuite.PortableCore.Feature} --> | The return value is a collection of InternalFeatures that are inside of the target rectangle shape. | | + | |
| - | === Parameters === | + | == Parameters == |
| - | ^ Name ^ Type ^ Description ^ | + | * //targetFeature// |
| - | | boundingBox | [[ThinkGeo.MapSuite.PortableCore.RectangleShape|RectangleShape]]<!-- ThinkGeo.MapSuite.PortableCore.RectangleShape --> | This parameter specifies the target boundingBox used in the spatial query. | | + | * Type:[[ThinkGeo.MapSuite.Core.Feature|Feature]] |
| - | | returningColumnNames | IEnumerable<String><!-- System.Collections.Generic.IEnumerable{System.String} --> | This parameter specifies the column values in the return features. | | + | * Description:This parameter specifies the target feature used in the spatial query. |
| - | <!-- ThinkGeo.MapSuite.PortableCore.QueryTools --> | + | * //returningColumnNamesType// |
| - | [[#Public Methods|Go Back]] | + | * Type:[[ThinkGeo.MapSuite.Core.ReturningColumnsType|ReturningColumnsType]] |
| - | ==== GetFeaturesInsideBoundingBox(RectangleShape, ReturningColumnsType) ==== | + | * Description:This parameter specifies the column values in the return features. |
| - | This method returns all of the InternalFeatures that are inside of the boundingBox. | + | |
| - | === Overloads === | + | |
| - | This method returns all of the features that are inside of the target rectangle shape. | + | |
| - | === Remarks === | + | |
| - | This method returns all of the InternalFeatures that are inside of the target shape. If there is a current transaction and it is marked as live, then the results will include any transaction Feature that applies. | + | |
| - | === Return Value === | + | |
| - | ^ Return Type ^ Description ^ | + | |
| - | | Collection<[[ThinkGeo.MapSuite.PortableCore.Feature|Feature]]><!-- System.Collections.ObjectModel.Collection{ThinkGeo.MapSuite.PortableCore.Feature} --> | The return value is a collection of InternalFeatures that are inside of the target rectangle shape. | | + | |
| - | === Parameters === | + | <div newline></div> |
| - | ^ Name ^ Type ^ Description ^ | + | ** {{wiki:PublicMethod.gif|}} GetFeaturesOverlapping(BaseShape,IEnumerable<String>) ** |
| - | | boundingBox | [[ThinkGeo.MapSuite.PortableCore.RectangleShape|RectangleShape]]<!-- ThinkGeo.MapSuite.PortableCore.RectangleShape --> | This parameter specifies the target boundingBox used in the spatial query. | | + | |
| - | | returningColumnNamesType | [[ThinkGeo.MapSuite.PortableCore.ReturningColumnsType|ReturningColumnsType]]<!-- ThinkGeo.MapSuite.PortableCore.ReturningColumnsType --> | This parameter specifies the column values in the return features. | | + | |
| - | <!-- ThinkGeo.MapSuite.PortableCore.QueryTools --> | + | * //This method returns all of the InternalFeatures that overlap the target Feature.// |
| - | [[#Public Methods|Go Back]] | + | == Remarks == |
| - | ==== GetFeaturesIntersecting(Feature, IEnumerable<String>) ==== | + | * //This method returns all of the InternalFeatures that overlap the target shape. If there is a current transaction and it is marked as live, then the results will include any transaction Feature that applies.Overlapping - The Geometries share some but not all points in common, and the intersection has the same dimension as the Geometries themselves.// |
| - | This method returns all of the InternalFeatures that intersect the target Feature. | + | |
| - | === Overloads === | + | |
| - | This method returns all of the features that intersect the target shape. | + | |
| - | === Remarks === | + | |
| - | This method returns all of the InternalFeatures that intersect the target shape. If there is a current transaction and it is marked as live, then the results will include any transaction Feature that applies. | + | |
| - | <strong>Intersecting</strong> - The Geometries have at least one point in common (the inverse of Disjoint). | + | == Return Value == |
| - | === Return Value === | + | * Type:Collection<[[ThinkGeo.MapSuite.Core.Feature|Feature]]> |
| - | ^ Return Type ^ Description ^ | + | * Description:The return value is a collection of InternalFeatures that match the spatial query you executed based on the TargetShape. |
| - | | Collection<[[ThinkGeo.MapSuite.PortableCore.Feature|Feature]]><!-- System.Collections.ObjectModel.Collection{ThinkGeo.MapSuite.PortableCore.Feature} --> | The return value is a collection of InternalFeatures that match the spatial query you executed based on the TargetShape. | | + | |
| - | === Parameters === | + | == Parameters == |
| - | ^ Name ^ Type ^ Description ^ | + | * //targetShape// |
| - | | targetFeature | [[ThinkGeo.MapSuite.PortableCore.Feature|Feature]]<!-- ThinkGeo.MapSuite.PortableCore.Feature --> | This parameter specifies the target shape used in the spatial query. | | + | * Type:[[ThinkGeo.MapSuite.Core.BaseShape|BaseShape]] |
| - | | returningColumnNames | IEnumerable<String><!-- System.Collections.Generic.IEnumerable{System.String} --> | This parameter specifies the column values in the return features. | | + | * Description:This parameter specifies the target shape used in the spatial query. |
| - | <!-- ThinkGeo.MapSuite.PortableCore.QueryTools --> | + | * //returningColumnNames// |
| - | [[#Public Methods|Go Back]] | + | * Type:IEnumerable<String> |
| - | ==== GetFeaturesIntersecting(BaseShape, IEnumerable<String>) ==== | + | * Description:This parameter specifies the column values in the return features. |
| - | This method returns all of the InternalFeatures that intersect the target Feature. | + | |
| - | === Overloads === | + | |
| - | This method returns all of the features that intersect the target shape. | + | |
| - | === Remarks === | + | |
| - | This method returns all of the InternalFeatures that intersect the target shape. If there is a current transaction and it is marked as live, then the results will include any transaction Feature that applies. | + | |
| - | <strong>Intersecting</strong> - The Geometries have at least one point in common (the inverse of Disjoint). | + | <div newline></div> |
| - | === Return Value === | + | ** {{wiki:PublicMethod.gif|}} GetFeaturesOverlapping(BaseShape,ReturningColumnsType) ** |
| - | ^ Return Type ^ Description ^ | + | |
| - | | Collection<[[ThinkGeo.MapSuite.PortableCore.Feature|Feature]]><!-- System.Collections.ObjectModel.Collection{ThinkGeo.MapSuite.PortableCore.Feature} --> | The return value is a collection of InternalFeatures that match the spatial query you executed based on the TargetShape. | | + | |
| - | === Parameters === | + | * //This method returns all of the InternalFeatures that overlap the target Feature.// |
| - | ^ Name ^ Type ^ Description ^ | + | == Remarks == |
| - | | targetShape | [[ThinkGeo.MapSuite.PortableCore.BaseShape|BaseShape]]<!-- ThinkGeo.MapSuite.PortableCore.BaseShape --> | This parameter specifies the target shape used in the spatial query. | | + | * //This method returns all of the InternalFeatures that overlap the target shape. If there is a current transaction and it is marked as live, then the results will include any transaction Feature that applies.Overlapping - The Geometries share some but not all points in common, and the intersection has the same dimension as the Geometries themselves.// |
| - | | returningColumnNames | IEnumerable<String><!-- System.Collections.Generic.IEnumerable{System.String} --> | This parameter specifies the column values in the return features. | | + | |
| - | <!-- ThinkGeo.MapSuite.PortableCore.QueryTools --> | + | == Return Value == |
| - | [[#Public Methods|Go Back]] | + | * Type:Collection<[[ThinkGeo.MapSuite.Core.Feature|Feature]]> |
| - | ==== GetFeaturesIntersecting(BaseShape, ReturningColumnsType) ==== | + | * Description:The return value is a collection of InternalFeatures that match the spatial query you executed based on the TargetShape. |
| - | This method returns all of the InternalFeatures that intersect the target Feature. | + | |
| - | === Overloads === | + | |
| - | This method returns all of the features that intersect the target shape. | + | |
| - | === Remarks === | + | |
| - | This method returns all of the InternalFeatures that intersect the target shape. If there is a current transaction and it is marked as live, then the results will include any transaction Feature that applies. | + | |
| - | <strong>Intersecting</strong> - The Geometries have at least one point in common (the inverse of Disjoint). | + | == 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 return value is a collection of InternalFeatures that match the spatial query you executed based on the TargetShape. | | + | * Description:This parameter specifies the target shape used in the spatial query. |
| - | === 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:This parameter specifies the column values in the return features. |
| - | | returningColumnNamesType | [[ThinkGeo.MapSuite.PortableCore.ReturningColumnsType|ReturningColumnsType]]<!-- ThinkGeo.MapSuite.PortableCore.ReturningColumnsType --> | This parameter specifies the column values in the return features. | | + | |
| - | <!-- ThinkGeo.MapSuite.PortableCore.QueryTools --> | + | <div newline></div> |
| - | [[#Public Methods|Go Back]] | + | ** {{wiki:PublicMethod.gif|}} GetFeaturesOverlapping(Feature,IEnumerable<String>) ** |
| - | ==== GetFeaturesIntersecting(Feature, ReturningColumnsType) ==== | + | |
| - | This method returns all of the InternalFeatures that intersect the target Feature. | + | |
| - | === Overloads === | + | |
| - | This method returns all of the features that intersect the target shape. | + | |
| - | === Remarks === | + | |
| - | This method returns all of the InternalFeatures that intersect the target shape. If there is a current transaction and it is marked as live, then the results will include any transaction Feature that applies. | + | |
| - | <strong>Intersecting</strong> - The Geometries have at least one point in common (the inverse of Disjoint). | + | * //This method returns all of the InternalFeatures that overlap the target Feature.// |
| - | === Return Value === | + | == Remarks == |
| - | ^ Return Type ^ Description ^ | + | * //This method returns all of the InternalFeatures that overlap the target shape. If there is a current transaction and it is marked as live, then the results will include any transaction Feature that applies.Overlapping - The Geometries share some but not all points in common, and the intersection has the same dimension as the Geometries themselves.// |
| - | | Collection<[[ThinkGeo.MapSuite.PortableCore.Feature|Feature]]><!-- System.Collections.ObjectModel.Collection{ThinkGeo.MapSuite.PortableCore.Feature} --> | The return value 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]]> |
| - | | targetFeature | [[ThinkGeo.MapSuite.PortableCore.Feature|Feature]]<!-- ThinkGeo.MapSuite.PortableCore.Feature --> | This parameter specifies the target feature used in the spatial query. | | + | * Description:The return value is a collection of InternalFeatures that match the spatial query you executed based on the TargetShape. |
| - | | returningColumnNamesType | [[ThinkGeo.MapSuite.PortableCore.ReturningColumnsType|ReturningColumnsType]]<!-- ThinkGeo.MapSuite.PortableCore.ReturningColumnsType --> | This parameter specifies the column values in the return features. | | + | |
| - | <!-- ThinkGeo.MapSuite.PortableCore.QueryTools --> | + | == Parameters == |
| - | [[#Public Methods|Go Back]] | + | * //targetFeature// |
| - | ==== GetFeaturesNearestTo(BaseShape, GeographyUnit, Int32, IEnumerable<String>, Double, DistanceUnit) ==== | + | * Type:[[ThinkGeo.MapSuite.Core.Feature|Feature]] |
| - | This method returns a user defined number of InternalFeatures that are closest to the TargetShape. | + | * Description:This parameter specifies the target feature used in the spatial query. |
| - | === 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:This parameter specifies the column values in the return features. | ||
| - | 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|}} GetFeaturesOverlapping(Feature,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. | + | * //This method returns all of the InternalFeatures that overlap the target Feature.// |
| - | === Return Value === | + | == Remarks == |
| - | ^ Return Type ^ Description ^ | + | * //This method returns all of the InternalFeatures that overlap the target shape. If there is a current transaction and it is marked as live, then the results will include any transaction Feature that applies.Overlapping - The Geometries share some but not all points in common, and the intersection has the same dimension as the Geometries themselves.// |
| - | | 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]]> |
| - | | targetShape | [[ThinkGeo.MapSuite.PortableCore.BaseShape|BaseShape]]<!-- ThinkGeo.MapSuite.PortableCore.BaseShape --> | This parameter is the shape you want to find InternalFeatures close to. | | + | * Description:The return value is a collection of InternalFeatures that match the spatial query you executed based on the TargetShape. |
| - | | 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.QueryTools --> | + | == Parameters == |
| - | [[#Public Methods|Go Back]] | + | * //targetFeature// |
| - | ==== GetFeaturesNearestTo(Feature, GeographyUnit, Int32, IEnumerable<String>, Double, DistanceUnit) ==== | + | * Type:[[ThinkGeo.MapSuite.Core.Feature|Feature]] |
| - | This method returns a user defined number of InternalFeatures that are closest to the TargetShape. | + | * Description:This parameter specifies the target shape used in the spatial query. |
| - | === 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. | + | * //returningColumnNamesType// |
| + | * Type:[[ThinkGeo.MapSuite.Core.ReturningColumnsType|ReturningColumnsType]] | ||
| + | * Description:This parameter specifies the column values in the return features. | ||
| - | 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|}} GetFeaturesTopologicalEqual(BaseShape,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. | + | * //This method returns all of the InternalFeatures that topologicalEqual the target Feature.// |
| - | === Return Value === | + | == Remarks == |
| - | ^ Return Type ^ Description ^ | + | * //This method returns all of the InternalFeatures that topologicalEqual the target shape. If there is a current transaction and it is marked as live, then the results will include any transaction Feature that applies.// |
| - | | 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:The return value is a collection of InternalFeatures that match the spatial query you executed based on the TargetShape. |
| - | | 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.QueryTools --> | + | == 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 TargetFeature. | + | * Description:This parameter specifies the target shape used in the spatial query. |
| - | === 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 create 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:This parameter specifies the column values in the return features. | ||
| - | 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 the 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|}} GetFeaturesTopologicalEqual(BaseShape,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. | + | * //This method returns all of the InternalFeatures that topologicalEqual the target Feature.// |
| - | === Return Value === | + | == Remarks == |
| - | ^ Return Type ^ Description ^ | + | * //This method returns all of the InternalFeatures that topologicalEqual the target shape. If there is a current transaction and it is marked as live, then the results will include any transaction Feature that applies.// |
| - | | 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 TargetFeature. | | + | |
| - | === 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 the feature you want to find close InternalFeatures to. | | + | * Description:The return value is a collection of InternalFeatures that match the spatial query you executed based on the TargetShape. |
| - | | unitOfData | [[ThinkGeo.MapSuite.PortableCore.GeographyUnit|GeographyUnit]]<!-- ThinkGeo.MapSuite.PortableCore.GeographyUnit --> | This parameter is the unit of data 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 feature. | | + | |
| - | | 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.QueryTools --> | + | == 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:This parameter specifies the target shape used in the spatial query. |
| - | === 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 create 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. | + | * //returningColumnNamesType// |
| + | * Type:[[ThinkGeo.MapSuite.Core.ReturningColumnsType|ReturningColumnsType]] | ||
| + | * Description:This parameter specifies the column values in the return features. | ||
| - | 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 the 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|}} GetFeaturesTopologicalEqual(Feature,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. | + | * //This method returns all of the InternalFeatures that topologicalEqual the target Feature.// |
| - | === Return Value === | + | == Remarks == |
| - | ^ Return Type ^ Description ^ | + | * //This method returns all of the InternalFeatures that topologicalEqual the target shape. If there is a current transaction and it is marked as live, then the results will include any transaction Feature that applies.// |
| - | | 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]]> |
| - | | targetShape | [[ThinkGeo.MapSuite.PortableCore.BaseShape|BaseShape]]<!-- ThinkGeo.MapSuite.PortableCore.BaseShape --> | This parameter is the shape you want to find close InternalFeatures to. | | + | * Description:The return value is a collection of InternalFeatures that match the spatial query you executed based on the TargetShape. |
| - | | unitOfData | [[ThinkGeo.MapSuite.PortableCore.GeographyUnit|GeographyUnit]]<!-- ThinkGeo.MapSuite.PortableCore.GeographyUnit --> | This parameter is the unit of data 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 the field names of the column data you wish to return with each Feature. | | + | |
| - | <!-- ThinkGeo.MapSuite.PortableCore.QueryTools --> | + | == Parameters == |
| - | [[#Public Methods|Go Back]] | + | * //targetFeature// |
| - | ==== GetFeaturesNearestTo(BaseShape, GeographyUnit, Int32, IEnumerable<String>) ==== | + | * Type:[[ThinkGeo.MapSuite.Core.Feature|Feature]] |
| - | This method returns a user defined number of InternalFeatures that are closest to the TargetShape. | + | * Description:This parameter specifies the target shape used in the spatial query. |
| - | === 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 create 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:This parameter specifies the column values in the return features. | ||
| - | 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 the 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|}} GetFeaturesTopologicalEqual(Feature,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. | + | * //This method returns all of the InternalFeatures that topologicalEqual the target Feature.// |
| - | === Return Value === | + | == Remarks == |
| - | ^ Return Type ^ Description ^ | + | * //This method returns all of the InternalFeatures that topologicalEqual the target shape. If there is a current transaction and it is marked as live, then the results will include any transaction Feature that applies.// |
| - | | 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]]> |
| - | | targetShape | [[ThinkGeo.MapSuite.PortableCore.BaseShape|BaseShape]]<!-- ThinkGeo.MapSuite.PortableCore.BaseShape --> | This parameter is the shape you want to find close InternalFeatures to. | | + | * Description:The return value is a collection of InternalFeatures that match the spatial query you executed based on the TargetShape. |
| - | | unitOfData | [[ThinkGeo.MapSuite.PortableCore.GeographyUnit|GeographyUnit]]<!-- ThinkGeo.MapSuite.PortableCore.GeographyUnit --> | This parameter is the unit of data 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.QueryTools --> | + | == Parameters == |
| - | [[#Public Methods|Go Back]] | + | * //targetFeature// |
| - | ==== GetFeaturesNearestTo(Feature, GeographyUnit, Int32, ReturningColumnsType) ==== | + | * Type:[[ThinkGeo.MapSuite.Core.Feature|Feature]] |
| - | This method returns a user defined number of InternalFeatures that are closest to the TargetFeature. | + | * Description:This parameter specifies the target shape used in the spatial query. |
| - | === 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 create 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. | + | * //returningColumnNamesType// |
| + | * Type:[[ThinkGeo.MapSuite.Core.ReturningColumnsType|ReturningColumnsType]] | ||
| + | * Description:This parameter specifies the column values in the return features. | ||
| - | 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 the 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|}} GetFeaturesTouching(BaseShape,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. | + | * //This method returns all of the InternalFeatures that touch the target Feature.// |
| - | === Return Value === | + | == Remarks == |
| - | ^ Return Type ^ Description ^ | + | * //This method returns all of the InternalFeatures that touch the target shape. If there is a current transaction and it is marked as live, then the results will include any transaction Feature that applies.// |
| - | | 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 TargetFeature. | | + | |
| - | === 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 the feature you want to find close InternalFeatures to. | | + | * Description:The return value is a collection of InternalFeatures that match the spatial query you executed based on the TargetShape. |
| - | | unitOfData | [[ThinkGeo.MapSuite.PortableCore.GeographyUnit|GeographyUnit]]<!-- ThinkGeo.MapSuite.PortableCore.GeographyUnit --> | This parameter is the unit of data 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 feature. | | + | |
| - | | returningColumnNamesType | [[ThinkGeo.MapSuite.PortableCore.ReturningColumnsType|ReturningColumnsType]]<!-- ThinkGeo.MapSuite.PortableCore.ReturningColumnsType --> | This parameter allows you to select the field names of the column data you wish to return with each Feature. | | + | |
| - | <!-- ThinkGeo.MapSuite.PortableCore.QueryTools --> | + | == Parameters == |
| - | [[#Public Methods|Go Back]] | + | * //targetShape// |
| - | ==== GetFeaturesOutsideBoundingBox(RectangleShape, ReturningColumnsType) ==== | + | * Type:[[ThinkGeo.MapSuite.Core.BaseShape|BaseShape]] |
| - | This method returns all of the InternalFeatures that are outside of the boundingBox. | + | * Description:This parameter specifies the target shape used in the spatial query. |
| - | === Overloads === | + | |
| - | This method returns all of the features that are outside of the target rectangle shape. | + | |
| - | === Remarks === | + | |
| - | This method returns all of the InternalFeatures that are outside of the target shape. If there is a current transaction and it is marked as live, then the results will include any transaction Feature that applies. | + | |
| - | === Return Value === | + | |
| - | ^ Return Type ^ Description ^ | + | |
| - | | Collection<[[ThinkGeo.MapSuite.PortableCore.Feature|Feature]]><!-- System.Collections.ObjectModel.Collection{ThinkGeo.MapSuite.PortableCore.Feature} --> | The return value is a collection of InternalFeatures that are outside of the target rectangle shape. | | + | |
| - | === Parameters === | + | * //returningColumnNames// |
| - | ^ Name ^ Type ^ Description ^ | + | * Type:IEnumerable<String> |
| - | | boundingBox | [[ThinkGeo.MapSuite.PortableCore.RectangleShape|RectangleShape]]<!-- ThinkGeo.MapSuite.PortableCore.RectangleShape --> | This parameter specifies the target boundingBox used in the spatial query. | | + | * Description:This parameter specifies the column values in the return features. |
| - | | returningColumnNamesType | [[ThinkGeo.MapSuite.PortableCore.ReturningColumnsType|ReturningColumnsType]]<!-- ThinkGeo.MapSuite.PortableCore.ReturningColumnsType --> | This parameter specifies the column values in the return features. | | + | |
| - | <!-- ThinkGeo.MapSuite.PortableCore.QueryTools --> | + | <div newline></div> |
| - | [[#Public Methods|Go Back]] | + | ** {{wiki:PublicMethod.gif|}} GetFeaturesTouching(BaseShape,ReturningColumnsType) ** |
| - | ==== GetFeaturesOutsideBoundingBox(RectangleShape, IEnumerable<String>) ==== | + | |
| - | This method returns all of the InternalFeatures that are outside of the boundingBox. | + | |
| - | === Overloads === | + | |
| - | This method returns all of the features that are outside of the target rectangle shape. | + | |
| - | === Remarks === | + | |
| - | This method returns all of the InternalFeatures that are outside of the target shape. If there is a current transaction and it is marked as live, then the results will include any transaction Feature that applies. | + | |
| - | === Return Value === | + | |
| - | ^ Return Type ^ Description ^ | + | |
| - | | Collection<[[ThinkGeo.MapSuite.PortableCore.Feature|Feature]]><!-- System.Collections.ObjectModel.Collection{ThinkGeo.MapSuite.PortableCore.Feature} --> | The return value is a collection of InternalFeatures that are outside of the target rectangle shape. | | + | |
| - | === Parameters === | + | * //This method returns all of the InternalFeatures that touch the target Feature.// |
| - | ^ Name ^ Type ^ Description ^ | + | == Remarks == |
| - | | boundingBox | [[ThinkGeo.MapSuite.PortableCore.RectangleShape|RectangleShape]]<!-- ThinkGeo.MapSuite.PortableCore.RectangleShape --> | This parameter specifies the target boundingBox used in the spatial query. | | + | * //This method returns all of the InternalFeatures that touch the target shape. If there is a current transaction and it is marked as live, then the results will include any transaction Feature that applies.// |
| - | | returningColumnNames | IEnumerable<String><!-- System.Collections.Generic.IEnumerable{System.String} --> | This parameter specifies the column values in the return features. | | + | |
| - | <!-- ThinkGeo.MapSuite.PortableCore.QueryTools --> | + | == Return Value == |
| - | [[#Public Methods|Go Back]] | + | * Type:Collection<[[ThinkGeo.MapSuite.Core.Feature|Feature]]> |
| - | ==== GetFeaturesOverlapping(Feature, ReturningColumnsType) ==== | + | * Description:The return value is a collection of InternalFeatures that match the spatial query you executed based on the TargetShape. |
| - | This method returns all of the InternalFeatures that overlap the target Feature. | + | |
| - | === Overloads === | + | |
| - | This method returns all of the features that overlap the target shape. | + | |
| - | === Remarks === | + | |
| - | This method returns all of the InternalFeatures that overlap the target shape. If there is a current transaction and it is marked as live, then the results will include any transaction Feature that applies. | + | |
| - | <strong>Overlapping</strong> - The Geometries share some but not all points in common, and the intersection has the same dimension as the Geometries themselves. | + | == 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 return value is a collection of InternalFeatures that match the spatial query you executed based on the TargetShape. | | + | * Description:This parameter specifies the target shape used in the spatial query. |
| - | === Parameters === | + | * //returningColumnNamesType// |
| - | ^ Name ^ Type ^ Description ^ | + | * Type:[[ThinkGeo.MapSuite.Core.ReturningColumnsType|ReturningColumnsType]] |
| - | | targetFeature | [[ThinkGeo.MapSuite.PortableCore.Feature|Feature]]<!-- ThinkGeo.MapSuite.PortableCore.Feature --> | This parameter specifies the target shape used in the spatial query. | | + | * Description:This parameter specifies the column values in the return features. |
| - | | returningColumnNamesType | [[ThinkGeo.MapSuite.PortableCore.ReturningColumnsType|ReturningColumnsType]]<!-- ThinkGeo.MapSuite.PortableCore.ReturningColumnsType --> | This parameter specifies the column values in the return features. | | + | |
| - | <!-- ThinkGeo.MapSuite.PortableCore.QueryTools --> | + | <div newline></div> |
| - | [[#Public Methods|Go Back]] | + | ** {{wiki:PublicMethod.gif|}} GetFeaturesTouching(Feature,IEnumerable<String>) ** |
| - | ==== GetFeaturesOverlapping(Feature, IEnumerable<String>) ==== | + | |
| - | This method returns all of the InternalFeatures that overlap the target Feature. | + | |
| - | === Overloads === | + | |
| - | This method returns all of the features that overlap the target shape. | + | |
| - | === Remarks === | + | |
| - | This method returns all of the InternalFeatures that overlap the target shape. If there is a current transaction and it is marked as live, then the results will include any transaction Feature that applies. | + | |
| - | <strong>Overlapping</strong> - The Geometries share some but not all points in common, and the intersection has the same dimension as the Geometries themselves. | + | * //This method returns all of the InternalFeatures that touch the target Feature.// |
| - | === Return Value === | + | == Remarks == |
| - | ^ Return Type ^ Description ^ | + | * //This method returns all of the InternalFeatures that touch the target shape. If there is a current transaction and it is marked as live, then the results will include any transaction Feature that applies.// |
| - | | Collection<[[ThinkGeo.MapSuite.PortableCore.Feature|Feature]]><!-- System.Collections.ObjectModel.Collection{ThinkGeo.MapSuite.PortableCore.Feature} --> | The return value 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]]> |
| - | | targetFeature | [[ThinkGeo.MapSuite.PortableCore.Feature|Feature]]<!-- ThinkGeo.MapSuite.PortableCore.Feature --> | This parameter specifies the target feature used in the spatial query. | | + | * Description:The return value is a collection of InternalFeatures that match the spatial query you executed based on the TargetShape. |
| - | | returningColumnNames | IEnumerable<String><!-- System.Collections.Generic.IEnumerable{System.String} --> | This parameter specifies the column values in the return features. | | + | |
| - | <!-- ThinkGeo.MapSuite.PortableCore.QueryTools --> | + | == Parameters == |
| - | [[#Public Methods|Go Back]] | + | * //targetFeature// |
| - | ==== GetFeaturesOverlapping(BaseShape, ReturningColumnsType) ==== | + | * Type:[[ThinkGeo.MapSuite.Core.Feature|Feature]] |
| - | This method returns all of the InternalFeatures that overlap the target Feature. | + | * Description:This parameter specifies the target feature used in the spatial query. |
| - | === Overloads === | + | |
| - | This method returns all of the features that overlap the target shape. | + | |
| - | === Remarks === | + | |
| - | This method returns all of the InternalFeatures that overlap the target shape. If there is a current transaction and it is marked as live, then the results will include any transaction Feature that applies. | + | |
| - | <strong>Overlapping</strong> - The Geometries share some but not all points in common, and the intersection has the same dimension as the Geometries themselves. | + | * //returningColumnNames// |
| - | === Return Value === | + | * Type:IEnumerable<String> |
| - | ^ Return Type ^ Description ^ | + | * Description:This parameter specifies the column values in the return features. |
| - | | Collection<[[ThinkGeo.MapSuite.PortableCore.Feature|Feature]]><!-- System.Collections.ObjectModel.Collection{ThinkGeo.MapSuite.PortableCore.Feature} --> | The return value is a collection of InternalFeatures that match the spatial query you executed based on the TargetShape. | | + | |
| - | === Parameters === | + | <div newline></div> |
| - | ^ Name ^ Type ^ Description ^ | + | ** {{wiki:PublicMethod.gif|}} GetFeaturesTouching(Feature,ReturningColumnsType) ** |
| - | | targetShape | [[ThinkGeo.MapSuite.PortableCore.BaseShape|BaseShape]]<!-- ThinkGeo.MapSuite.PortableCore.BaseShape --> | This parameter specifies the target shape used in the spatial query. | | + | |
| - | | returningColumnNamesType | [[ThinkGeo.MapSuite.PortableCore.ReturningColumnsType|ReturningColumnsType]]<!-- ThinkGeo.MapSuite.PortableCore.ReturningColumnsType --> | This parameter specifies the column values in the return features. | | + | |
| - | <!-- ThinkGeo.MapSuite.PortableCore.QueryTools --> | + | * //This method returns all of the InternalFeatures that touch the target Feature.// |
| - | [[#Public Methods|Go Back]] | + | == Remarks == |
| - | ==== GetFeaturesOverlapping(BaseShape, IEnumerable<String>) ==== | + | * //This method returns all of the InternalFeatures that touch the target shape. If there is a current transaction and it is marked as live, then the results will include any transaction Feature that applies.// |
| - | This method returns all of the InternalFeatures that overlap the target Feature. | + | |
| - | === Overloads === | + | |
| - | This method returns all of the features that overlap the target shape. | + | |
| - | === Remarks === | + | |
| - | This method returns all of the InternalFeatures that overlap the target shape. If there is a current transaction and it is marked as live, then the results will include any transaction Feature that applies. | + | |
| - | <strong>Overlapping</strong> - The Geometries share some but not all points in common, and the intersection has the same dimension as the Geometries themselves. | + | == Return Value == |
| - | === Return Value === | + | * Type:Collection<[[ThinkGeo.MapSuite.Core.Feature|Feature]]> |
| - | ^ Return Type ^ Description ^ | + | * Description:The return value is a collection of InternalFeatures that match the spatial query you executed based on the TargetShape. |
| - | | Collection<[[ThinkGeo.MapSuite.PortableCore.Feature|Feature]]><!-- System.Collections.ObjectModel.Collection{ThinkGeo.MapSuite.PortableCore.Feature} --> | The return value is a collection of InternalFeatures that match the spatial query you executed based on the TargetShape. | | + | |
| - | === Parameters === | + | == Parameters == |
| - | ^ Name ^ Type ^ Description ^ | + | * //targetFeature// |
| - | | targetShape | [[ThinkGeo.MapSuite.PortableCore.BaseShape|BaseShape]]<!-- ThinkGeo.MapSuite.PortableCore.BaseShape --> | This parameter specifies the target shape used in the spatial query. | | + | * Type:[[ThinkGeo.MapSuite.Core.Feature|Feature]] |
| - | | returningColumnNames | IEnumerable<String><!-- System.Collections.Generic.IEnumerable{System.String} --> | This parameter specifies the column values in the return features. | | + | * Description:This parameter specifies the target feature used in the spatial query. |
| - | <!-- ThinkGeo.MapSuite.PortableCore.QueryTools --> | + | * //returningColumnNamesType// |
| - | [[#Public Methods|Go Back]] | + | * Type:[[ThinkGeo.MapSuite.Core.ReturningColumnsType|ReturningColumnsType]] |
| - | ==== GetFeaturesTopologicalEqual(BaseShape, ReturningColumnsType) ==== | + | * Description:This parameter specifies the column values in the return features. |
| - | This method returns all of the InternalFeatures that topologicalEqual the target Feature. | + | |
| - | === Overloads === | + | |
| - | This method returns all of the features that topologicalEqual the target shape. | + | |
| - | === Remarks === | + | |
| - | This method returns all of the InternalFeatures that topologicalEqual the target shape. If there is a current transaction and it is marked as live, then the results will include any transaction Feature that applies. | + | |
| - | === Return Value === | + | |
| - | ^ Return Type ^ Description ^ | + | |
| - | | Collection<[[ThinkGeo.MapSuite.PortableCore.Feature|Feature]]><!-- System.Collections.ObjectModel.Collection{ThinkGeo.MapSuite.PortableCore.Feature} --> | The return value is a collection of InternalFeatures that match the spatial query you executed based on the TargetShape. | | + | |
| - | === Parameters === | + | <div newline></div> |
| - | ^ Name ^ Type ^ Description ^ | + | ** {{wiki:PublicMethod.gif|}} GetFeaturesWithin(BaseShape,IEnumerable<String>) ** |
| - | | targetShape | [[ThinkGeo.MapSuite.PortableCore.BaseShape|BaseShape]]<!-- ThinkGeo.MapSuite.PortableCore.BaseShape --> | This parameter specifies the target shape used in the spatial query. | | + | |
| - | | returningColumnNamesType | [[ThinkGeo.MapSuite.PortableCore.ReturningColumnsType|ReturningColumnsType]]<!-- ThinkGeo.MapSuite.PortableCore.ReturningColumnsType --> | This parameter specifies the column values in the return features. | | + | |
| - | <!-- ThinkGeo.MapSuite.PortableCore.QueryTools --> | + | * //This method returns all of the InternalFeatures that are within the target Feature.// |
| - | [[#Public Methods|Go Back]] | + | == Remarks == |
| - | ==== GetFeaturesTopologicalEqual(Feature, IEnumerable<String>) ==== | + | * //This method returns all of the InternalFeatures that are within the target shape. If there is a current transaction and it is marked as live, then the results will include any transaction Feature that applies.// |
| - | This method returns all of the InternalFeatures that topologicalEqual the target Feature. | + | |
| - | === Overloads === | + | |
| - | This method returns all of the features that topologicalEqual the target shape. | + | |
| - | === Remarks === | + | |
| - | This method returns all of the InternalFeatures that topologicalEqual the target shape. If there is a current transaction and it is marked as live, then the results will include any transaction Feature that applies. | + | |
| - | === Return Value === | + | |
| - | ^ Return Type ^ Description ^ | + | |
| - | | Collection<[[ThinkGeo.MapSuite.PortableCore.Feature|Feature]]><!-- System.Collections.ObjectModel.Collection{ThinkGeo.MapSuite.PortableCore.Feature} --> | The return value 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]]> |
| - | | targetFeature | [[ThinkGeo.MapSuite.PortableCore.Feature|Feature]]<!-- ThinkGeo.MapSuite.PortableCore.Feature --> | This parameter specifies the target shape used in the spatial query. | | + | * Description:The return value is a collection of InternalFeatures that match the spatial query you executed based on the TargetShape. |
| - | | returningColumnNames | IEnumerable<String><!-- System.Collections.Generic.IEnumerable{System.String} --> | This parameter specifies the column values in the return features. | | + | |
| - | <!-- ThinkGeo.MapSuite.PortableCore.QueryTools --> | + | == Parameters == |
| - | [[#Public Methods|Go Back]] | + | * //targetShape// |
| - | ==== GetFeaturesTopologicalEqual(Feature, ReturningColumnsType) ==== | + | * Type:[[ThinkGeo.MapSuite.Core.BaseShape|BaseShape]] |
| - | This method returns all of the InternalFeatures that topologicalEqual the target Feature. | + | * Description:This parameter specifies the target shape used in the spatial query. |
| - | === Overloads === | + | |
| - | This method returns all of the features that topologicalEqual the target shape. | + | |
| - | === Remarks === | + | |
| - | This method returns all of the InternalFeatures that topologicalEqual the target shape. If there is a current transaction and it is marked as live, then the results will include any transaction Feature that applies. | + | |
| - | === Return Value === | + | |
| - | ^ Return Type ^ Description ^ | + | |
| - | | Collection<[[ThinkGeo.MapSuite.PortableCore.Feature|Feature]]><!-- System.Collections.ObjectModel.Collection{ThinkGeo.MapSuite.PortableCore.Feature} --> | The return value is a collection of InternalFeatures that match the spatial query you executed based on the TargetShape. | | + | |
| - | === Parameters === | + | * //returningColumnNames// |
| - | ^ Name ^ Type ^ Description ^ | + | * Type:IEnumerable<String> |
| - | | targetFeature | [[ThinkGeo.MapSuite.PortableCore.Feature|Feature]]<!-- ThinkGeo.MapSuite.PortableCore.Feature --> | This parameter specifies the target shape used in the spatial query. | | + | * Description:This parameter specifies the column values in the return features. |
| - | | returningColumnNamesType | [[ThinkGeo.MapSuite.PortableCore.ReturningColumnsType|ReturningColumnsType]]<!-- ThinkGeo.MapSuite.PortableCore.ReturningColumnsType --> | This parameter specifies the column values in the return features. | | + | |
| - | <!-- ThinkGeo.MapSuite.PortableCore.QueryTools --> | + | <div newline></div> |
| - | [[#Public Methods|Go Back]] | + | ** {{wiki:PublicMethod.gif|}} GetFeaturesWithin(BaseShape,ReturningColumnsType) ** |
| - | ==== GetFeaturesTopologicalEqual(BaseShape, IEnumerable<String>) ==== | + | |
| - | This method returns all of the InternalFeatures that topologicalEqual the target Feature. | + | |
| - | === Overloads === | + | |
| - | This method returns all of the features that topologicalEqual the target shape. | + | |
| - | === Remarks === | + | |
| - | This method returns all of the InternalFeatures that topologicalEqual the target shape. If there is a current transaction and it is marked as live, then the results will include any transaction Feature that applies. | + | |
| - | === Return Value === | + | |
| - | ^ Return Type ^ Description ^ | + | |
| - | | Collection<[[ThinkGeo.MapSuite.PortableCore.Feature|Feature]]><!-- System.Collections.ObjectModel.Collection{ThinkGeo.MapSuite.PortableCore.Feature} --> | The return value is a collection of InternalFeatures that match the spatial query you executed based on the TargetShape. | | + | |
| - | === Parameters === | + | * //This method returns all of the InternalFeatures that are within the target Feature.// |
| - | ^ Name ^ Type ^ Description ^ | + | == Remarks == |
| - | | targetShape | [[ThinkGeo.MapSuite.PortableCore.BaseShape|BaseShape]]<!-- ThinkGeo.MapSuite.PortableCore.BaseShape --> | This parameter specifies the target shape used in the spatial query. | | + | * //This method returns all of the InternalFeatures that are within the target shape. If there is a current transaction and it is marked as live, then the results will include any transaction Feature that applies.// |
| - | | returningColumnNames | IEnumerable<String><!-- System.Collections.Generic.IEnumerable{System.String} --> | This parameter specifies the column values in the return features. | | + | |
| - | <!-- ThinkGeo.MapSuite.PortableCore.QueryTools --> | + | == Return Value == |
| - | [[#Public Methods|Go Back]] | + | * Type:Collection<[[ThinkGeo.MapSuite.Core.Feature|Feature]]> |
| - | ==== GetFeaturesTouching(Feature, IEnumerable<String>) ==== | + | * Description:The return value is a collection of InternalFeatures that match the spatial query you executed based on the TargetShape. |
| - | This method returns all of the InternalFeatures that touch the target Feature. | + | |
| - | === Overloads === | + | |
| - | This method returns all of the features that touch the target shape. | + | |
| - | === Remarks === | + | |
| - | This method returns all of the InternalFeatures that touch the target shape. If there is a current transaction and it is marked as live, then the results will include any transaction Feature that applies. | + | |
| - | === Return Value === | + | |
| - | ^ Return Type ^ Description ^ | + | |
| - | | Collection<[[ThinkGeo.MapSuite.PortableCore.Feature|Feature]]><!-- System.Collections.ObjectModel.Collection{ThinkGeo.MapSuite.PortableCore.Feature} --> | The return value is a collection of InternalFeatures that match the spatial query you executed based on the TargetShape. | | + | |
| - | === Parameters === | + | == Parameters == |
| - | ^ Name ^ Type ^ Description ^ | + | * //targetShape// |
| - | | targetFeature | [[ThinkGeo.MapSuite.PortableCore.Feature|Feature]]<!-- ThinkGeo.MapSuite.PortableCore.Feature --> | This parameter specifies the target feature used in the spatial query. | | + | * Type:[[ThinkGeo.MapSuite.Core.BaseShape|BaseShape]] |
| - | | returningColumnNames | IEnumerable<String><!-- System.Collections.Generic.IEnumerable{System.String} --> | This parameter specifies the column values in the return features. | | + | * Description:This parameter specifies the target shape used in the spatial query. |
| - | <!-- ThinkGeo.MapSuite.PortableCore.QueryTools --> | + | * //returningColumnNamesType// |
| - | [[#Public Methods|Go Back]] | + | * Type:[[ThinkGeo.MapSuite.Core.ReturningColumnsType|ReturningColumnsType]] |
| - | ==== GetFeaturesTouching(Feature, ReturningColumnsType) ==== | + | * Description:This parameter specifies the column values in the return features. |
| - | This method returns all of the InternalFeatures that touch the target Feature. | + | |
| - | === Overloads === | + | |
| - | This method returns all of the features that touch the target shape. | + | |
| - | === Remarks === | + | |
| - | This method returns all of the InternalFeatures that touch the target shape. If there is a current transaction and it is marked as live, then the results will include any transaction Feature that applies. | + | |
| - | === Return Value === | + | |
| - | ^ Return Type ^ Description ^ | + | |
| - | | Collection<[[ThinkGeo.MapSuite.PortableCore.Feature|Feature]]><!-- System.Collections.ObjectModel.Collection{ThinkGeo.MapSuite.PortableCore.Feature} --> | The return value is a collection of InternalFeatures that match the spatial query you executed based on the TargetShape. | | + | |
| - | === Parameters === | + | <div newline></div> |
| - | ^ Name ^ Type ^ Description ^ | + | ** {{wiki:PublicMethod.gif|}} GetFeaturesWithin(Feature,IEnumerable<String>) ** |
| - | | targetFeature | [[ThinkGeo.MapSuite.PortableCore.Feature|Feature]]<!-- ThinkGeo.MapSuite.PortableCore.Feature --> | This parameter specifies the target feature used in the spatial query. | | + | |
| - | | returningColumnNamesType | [[ThinkGeo.MapSuite.PortableCore.ReturningColumnsType|ReturningColumnsType]]<!-- ThinkGeo.MapSuite.PortableCore.ReturningColumnsType --> | This parameter specifies the column values in the return features. | | + | |
| - | <!-- ThinkGeo.MapSuite.PortableCore.QueryTools --> | + | * //This method returns all of the InternalFeatures that are within the target Feature.// |
| - | [[#Public Methods|Go Back]] | + | == Remarks == |
| - | ==== GetFeaturesTouching(BaseShape, ReturningColumnsType) ==== | + | * //This method returns all of the InternalFeatures that are within the target shape. If there is a current transaction and it is marked as live, then the results will include any transaction Feature that applies.// |
| - | This method returns all of the InternalFeatures that touch the target Feature. | + | |
| - | === Overloads === | + | |
| - | This method returns all of the features that touch the target shape. | + | |
| - | === Remarks === | + | |
| - | This method returns all of the InternalFeatures that touch the target shape. If there is a current transaction and it is marked as live, then the results will include any transaction Feature that applies. | + | |
| - | === Return Value === | + | |
| - | ^ Return Type ^ Description ^ | + | |
| - | | Collection<[[ThinkGeo.MapSuite.PortableCore.Feature|Feature]]><!-- System.Collections.ObjectModel.Collection{ThinkGeo.MapSuite.PortableCore.Feature} --> | The return value 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:The return value is a collection of InternalFeatures that match the spatial query you executed based on the TargetShape. |
| - | | returningColumnNamesType | [[ThinkGeo.MapSuite.PortableCore.ReturningColumnsType|ReturningColumnsType]]<!-- ThinkGeo.MapSuite.PortableCore.ReturningColumnsType --> | This parameter specifies the column values in the return features. | | + | |
| - | <!-- ThinkGeo.MapSuite.PortableCore.QueryTools --> | + | == Parameters == |
| - | [[#Public Methods|Go Back]] | + | * //targetFeature// |
| - | ==== GetFeaturesTouching(BaseShape, IEnumerable<String>) ==== | + | * Type:[[ThinkGeo.MapSuite.Core.Feature|Feature]] |
| - | This method returns all of the InternalFeatures that touch the target Feature. | + | * Description:This parameter specifies the target feature used in the spatial query. |
| - | === Overloads === | + | |
| - | This method returns all of the features that touch the target shape. | + | |
| - | === Remarks === | + | |
| - | This method returns all of the InternalFeatures that touch the target shape. If there is a current transaction and it is marked as live, then the results will include any transaction Feature that applies. | + | |
| - | === Return Value === | + | |
| - | ^ Return Type ^ Description ^ | + | |
| - | | Collection<[[ThinkGeo.MapSuite.PortableCore.Feature|Feature]]><!-- System.Collections.ObjectModel.Collection{ThinkGeo.MapSuite.PortableCore.Feature} --> | The return value is a collection of InternalFeatures that match the spatial query you executed based on the TargetShape. | | + | |
| - | === Parameters === | + | * //returningColumnNames// |
| - | ^ Name ^ Type ^ Description ^ | + | * Type:IEnumerable<String> |
| - | | targetShape | [[ThinkGeo.MapSuite.PortableCore.BaseShape|BaseShape]]<!-- ThinkGeo.MapSuite.PortableCore.BaseShape --> | This parameter specifies the target shape used in the spatial query. | | + | * Description:This parameter specifies the column values in the return features. |
| - | | returningColumnNames | IEnumerable<String><!-- System.Collections.Generic.IEnumerable{System.String} --> | This parameter specifies the column values in the return features. | | + | |
| - | <!-- ThinkGeo.MapSuite.PortableCore.QueryTools --> | + | <div newline></div> |
| - | [[#Public Methods|Go Back]] | + | ** {{wiki:PublicMethod.gif|}} GetFeaturesWithin(Feature,ReturningColumnsType) ** |
| - | ==== GetFeaturesWithin(Feature, IEnumerable<String>) ==== | + | |
| - | This method returns all of the InternalFeatures that are within the target Feature. | + | |
| - | === Overloads === | + | |
| - | This method returns all of the features that are within the target shape. | + | |
| - | === Remarks === | + | |
| - | This method returns all of the InternalFeatures that are within the target shape. If there is a current transaction and it is marked as live, then the results will include any transaction Feature that applies. | + | |
| - | === Return Value === | + | |
| - | ^ Return Type ^ Description ^ | + | |
| - | | Collection<[[ThinkGeo.MapSuite.PortableCore.Feature|Feature]]><!-- System.Collections.ObjectModel.Collection{ThinkGeo.MapSuite.PortableCore.Feature} --> | The return value is a collection of InternalFeatures that match the spatial query you executed based on the TargetShape. | | + | |
| - | === Parameters === | + | * //This method returns all of the InternalFeatures that are within the target Feature.// |
| - | ^ Name ^ Type ^ Description ^ | + | == Remarks == |
| - | | targetFeature | [[ThinkGeo.MapSuite.PortableCore.Feature|Feature]]<!-- ThinkGeo.MapSuite.PortableCore.Feature --> | This parameter specifies the target feature used in the spatial query. | | + | * //This method returns all of the InternalFeatures that are within the target shape. If there is a current transaction and it is marked as live, then the results will include any transaction Feature that applies.// |
| - | | returningColumnNames | IEnumerable<String><!-- System.Collections.Generic.IEnumerable{System.String} --> | This parameter specifies the column values in the return features. | | + | |
| - | <!-- ThinkGeo.MapSuite.PortableCore.QueryTools --> | + | == Return Value == |
| - | [[#Public Methods|Go Back]] | + | * Type:Collection<[[ThinkGeo.MapSuite.Core.Feature|Feature]]> |
| - | ==== GetFeaturesWithin(Feature, ReturningColumnsType) ==== | + | * Description:The return value is a collection of InternalFeatures that match the spatial query you executed based on the TargetShape. |
| - | This method returns all of the InternalFeatures that are within the target Feature. | + | |
| - | === Overloads === | + | |
| - | This method returns all of the features that are within the target shape. | + | |
| - | === Remarks === | + | |
| - | This method returns all of the InternalFeatures that are within the target shape. If there is a current transaction and it is marked as live, then the results will include any transaction Feature that applies. | + | |
| - | === Return Value === | + | |
| - | ^ Return Type ^ Description ^ | + | |
| - | | Collection<[[ThinkGeo.MapSuite.PortableCore.Feature|Feature]]><!-- System.Collections.ObjectModel.Collection{ThinkGeo.MapSuite.PortableCore.Feature} --> | The return value is a collection of InternalFeatures that match the spatial query you executed based on the TargetShape. | | + | |
| - | === Parameters === | + | == Parameters == |
| - | ^ Name ^ Type ^ Description ^ | + | * //targetFeature// |
| - | | targetFeature | [[ThinkGeo.MapSuite.PortableCore.Feature|Feature]]<!-- ThinkGeo.MapSuite.PortableCore.Feature --> | This parameter specifies the target feature used in the spatial query. | | + | * Type:[[ThinkGeo.MapSuite.Core.Feature|Feature]] |
| - | | returningColumnNamesType | [[ThinkGeo.MapSuite.PortableCore.ReturningColumnsType|ReturningColumnsType]]<!-- ThinkGeo.MapSuite.PortableCore.ReturningColumnsType --> | This parameter specifies the column values in the return features. | | + | * Description:This parameter specifies the target feature used in the spatial query. |
| - | <!-- ThinkGeo.MapSuite.PortableCore.QueryTools --> | + | * //returningColumnNamesType// |
| - | [[#Public Methods|Go Back]] | + | * Type:[[ThinkGeo.MapSuite.Core.ReturningColumnsType|ReturningColumnsType]] |
| - | ==== GetFeaturesWithin(BaseShape, ReturningColumnsType) ==== | + | * Description:This parameter specifies the column values in the return features. |
| - | This method returns all of the InternalFeatures that are within the target Feature. | + | |
| - | === Overloads === | + | |
| - | This method returns all of the features that are within the target shape. | + | |
| - | === Remarks === | + | |
| - | This method returns all of the InternalFeatures that are within the target shape. If there is a current transaction and it is marked as live, then the results will include any transaction Feature that applies. | + | |
| - | === Return Value === | + | |
| - | ^ Return Type ^ Description ^ | + | |
| - | | Collection<[[ThinkGeo.MapSuite.PortableCore.Feature|Feature]]><!-- System.Collections.ObjectModel.Collection{ThinkGeo.MapSuite.PortableCore.Feature} --> | The return value is a collection of InternalFeatures that match the spatial query you executed based on the TargetShape. | | + | |
| - | === Parameters === | + | <div newline></div> |
| - | ^ Name ^ Type ^ Description ^ | + | ** {{wiki:PublicMethod.gif|}} GetFeaturesOutsideBoundingBox(RectangleShape,IEnumerable<String>) ** |
| - | | targetShape | [[ThinkGeo.MapSuite.PortableCore.BaseShape|BaseShape]]<!-- ThinkGeo.MapSuite.PortableCore.BaseShape --> | This parameter specifies the target shape used in the spatial query. | | + | |
| - | | returningColumnNamesType | [[ThinkGeo.MapSuite.PortableCore.ReturningColumnsType|ReturningColumnsType]]<!-- ThinkGeo.MapSuite.PortableCore.ReturningColumnsType --> | This parameter specifies the column values in the return features. | | + | |
| - | <!-- ThinkGeo.MapSuite.PortableCore.QueryTools --> | + | * //This method returns all of the InternalFeatures that are outside of the boundingBox.// |
| - | [[#Public Methods|Go Back]] | + | == Remarks == |
| - | ==== GetFeaturesWithin(BaseShape, IEnumerable<String>) ==== | + | * //This method returns all of the InternalFeatures that are outside of the target shape. If there is a current transaction and it is marked as live, then the results will include any transaction Feature that applies.// |
| - | This method returns all of the InternalFeatures that are within the target Feature. | + | |
| - | === Overloads === | + | |
| - | This method returns all of the features that are within the target shape. | + | |
| - | === Remarks === | + | |
| - | This method returns all of the InternalFeatures that are within the target shape. If there is a current transaction and it is marked as live, then the results will include any transaction Feature that applies. | + | |
| - | === Return Value === | + | |
| - | ^ Return Type ^ Description ^ | + | |
| - | | Collection<[[ThinkGeo.MapSuite.PortableCore.Feature|Feature]]><!-- System.Collections.ObjectModel.Collection{ThinkGeo.MapSuite.PortableCore.Feature} --> | The return value 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:The return value is a collection of InternalFeatures that are outside of the target rectangle shape. |
| - | | returningColumnNames | IEnumerable<String><!-- System.Collections.Generic.IEnumerable{System.String} --> | This parameter specifies the column values in the return features. | | + | |
| - | <!-- ThinkGeo.MapSuite.PortableCore.QueryTools --> | + | == Parameters == |
| - | [[#Public Methods|Go Back]] | + | * //boundingBox// |
| - | ==== GetFeaturesWithinDistanceOf(Feature, GeographyUnit, DistanceUnit, Double, IEnumerable<String>) ==== | + | * Type:[[ThinkGeo.MapSuite.Core.RectangleShape|RectangleShape]] |
| - | This method returns a collection of InternalFeatures that are within a certain distance of the TargetFeature. | + | * Description:This parameter specifies the target boundingBox used in the spatial query. |
| - | === 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. | + | * //returningColumnNames// |
| + | * Type:IEnumerable<String> | ||
| + | * Description:This parameter specifies the column values in the return features. | ||
| - | 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 the 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|}} GetFeaturesOutsideBoundingBox(RectangleShape,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. | + | * //This method returns all of the InternalFeatures that are outside of the boundingBox.// |
| - | === Return Value === | + | == Remarks == |
| - | ^ Return Type ^ Description ^ | + | * //This method returns all of the InternalFeatures that are outside of the target shape. If there is a current transaction and it is marked as live, then the results will include any transaction Feature that applies.// |
| - | | 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 TargetFeature. | | + | |
| - | === Parameters === | + | == Return Value == |
| - | ^ Name ^ Type ^ Description ^ | + | * Type:Collection<[[ThinkGeo.MapSuite.Core.Feature|Feature]]> |
| - | | targetFeature | [[ThinkGeo.MapSuite.PortableCore.Feature|Feature]]<!-- ThinkGeo.MapSuite.PortableCore.Feature --> | The feature you wish to find InternalFeatures within a distance of. | | + | * Description:The return value is a collection of InternalFeatures that are outside of the target rectangle shape. |
| - | | 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 unit of 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.QueryTools --> | + | == Parameters == |
| - | [[#Public Methods|Go Back]] | + | * //boundingBox// |
| - | ==== GetFeaturesWithinDistanceOf(BaseShape, GeographyUnit, DistanceUnit, Double, ReturningColumnsType) ==== | + | * Type:[[ThinkGeo.MapSuite.Core.RectangleShape|RectangleShape]] |
| - | This method returns a collection of InternalFeatures that are within a certain distance of the TargetShape. | + | * Description:This parameter specifies the target boundingBox used in the spatial query. |
| - | === 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. | + | * //returningColumnNamesType// |
| + | * Type:[[ThinkGeo.MapSuite.Core.ReturningColumnsType|ReturningColumnsType]] | ||
| + | * Description:This parameter specifies the column values in the return features. | ||
| - | 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 the 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|}} GetFeaturesInsideBoundingBox(RectangleShape,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. | + | * //This method returns all of the InternalFeatures that are inside of the boundingBox.// |
| - | === Return Value === | + | == Remarks == |
| - | ^ Return Type ^ Description ^ | + | * //This method returns all of the InternalFeatures that are inside of the target shape. If there is a current transaction and it is marked as live, then the results will include any transaction Feature that applies.// |
| - | | 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:The return value is a collection of InternalFeatures that are inside of the target rectangle shape. |
| - | | 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 unit of 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 the field names of the column data you wish to return with each Feature. | | + | |
| - | <!-- ThinkGeo.MapSuite.PortableCore.QueryTools --> | + | == Parameters == |
| - | [[#Public Methods|Go Back]] | + | * //boundingBox// |
| - | ==== GetFeaturesWithinDistanceOf(BaseShape, GeographyUnit, DistanceUnit, Double, IEnumerable<String>) ==== | + | * Type:[[ThinkGeo.MapSuite.Core.RectangleShape|RectangleShape]] |
| - | This method returns a collection of InternalFeatures that are within a certain distance of the TargetShape. | + | * Description:This parameter specifies the target boundingBox used in the spatial query. |
| - | === 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. | + | * //returningColumnNames// |
| + | * Type:IEnumerable<String> | ||
| + | * Description:This parameter specifies the column values in the return features. | ||
| - | 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 the 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|}} GetFeaturesInsideBoundingBox(RectangleShape,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. | + | * //This method returns all of the InternalFeatures that are inside of the boundingBox.// |
| - | === Return Value === | + | == Remarks == |
| - | ^ Return Type ^ Description ^ | + | * //This method returns all of the InternalFeatures that are inside of the target shape. If there is a current transaction and it is marked as live, then the results will include any transaction Feature that applies.// |
| - | | 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:The return value is a collection of InternalFeatures that are inside of the target rectangle shape. |
| - | | 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 unit of 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.QueryTools --> | + | == Parameters == |
| - | [[#Public Methods|Go Back]] | + | * //boundingBox// |
| - | ==== GetFeaturesWithinDistanceOf(Feature, GeographyUnit, DistanceUnit, Double, ReturningColumnsType) ==== | + | * Type:[[ThinkGeo.MapSuite.Core.RectangleShape|RectangleShape]] |
| - | This method returns a collection of InternalFeatures that are within a certain distance of the TargetFeature. | + | * Description:This parameter specifies the target boundingBox used in the spatial query. |
| - | === 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. | + | * //returningColumnNamesType// |
| + | * Type:[[ThinkGeo.MapSuite.Core.ReturningColumnsType|ReturningColumnsType]] | ||
| + | * Description:This parameter specifies the column values in the return features. | ||
| - | 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 the 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,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. | + | * //This method returns a user defined number of InternalFeatures that are closest to the TargetShape.// |
| - | === Return Value === | + | == Remarks == |
| - | ^ Return Type ^ Description ^ | + | * //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 create 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. 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 the GetFeaturesInsideBoundingBoxCore method, we recommend that you use any spatial indexes you have at your disposal to make this method as fast as possible. 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.// |
| - | | 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 TargetFeature. | | + | |
| - | === Parameters === | + | == Return Value == |
| - | ^ Name ^ Type ^ Description ^ | + | * Type:Collection<[[ThinkGeo.MapSuite.Core.Feature|Feature]]> |
| - | | targetFeature | [[ThinkGeo.MapSuite.PortableCore.Feature|Feature]]<!-- ThinkGeo.MapSuite.PortableCore.Feature --> | The feature you wish to find InternalFeatures within a distance of. | | + | * Description:This method returns a user defined number of InternalFeatures that are closest to the TargetShape. |
| - | | 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 unit of 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 the field names of the column data you wish to return with each Feature. | | + | |
| - | <!-- ThinkGeo.MapSuite.PortableCore.QueryTools --> | + | == Parameters == |
| - | [[#Public Methods|Go Back]] | + | * //targetShape// |
| - | ==== GetHashCode() ==== | + | * Type:[[ThinkGeo.MapSuite.Core.BaseShape|BaseShape]] |
| - | === Return Value === | + | * Description:This parameter is the shape you want to find close InternalFeatures to. |
| - | ^ Return Type ^ Description ^ | + | |
| - | | Int32<!-- System.Int32 --> | | | + | |
| - | === Parameters === | + | * //unitOfData// |
| - | ^ Name ^ Type ^ Description ^ | + | * Type:[[ThinkGeo.MapSuite.Core.GeographyUnit|GeographyUnit]] |
| + | * Description:This parameter is the unit of data that the TargetShape and the FeatureSource are in, such as feet, meters, etc. | ||
| - | <!-- System.Object --> | + | * //maxItemsToFind// |
| - | [[#Public Methods|Go Back]] | + | * Type:Int32 |
| - | ==== GetType() ==== | + | * Description:This parameter defines how many close InternalFeatures to find around the TargetShape. |
| - | === Return Value === | + | |
| - | ^ Return Type ^ Description ^ | + | |
| - | | Type<!-- System.Type --> | | | + | |
| - | === Parameters === | + | * //returningColumnNames// |
| - | ^ Name ^ Type ^ Description ^ | + | * Type:IEnumerable<String> |
| + | * Description:This parameter allows you to select the field names of the column data you wish to return with each Feature. | ||
| - | <!-- System.Object --> | + | <div newline></div> |
| - | [[#Public Methods|Go Back]] | + | ** {{wiki:PublicMethod.gif|}} GetFeaturesNearestTo(BaseShape,GeographyUnit,Int32,ReturningColumnsType) ** |
| - | ==== ToString() ==== | + | |
| - | === Return Value === | + | |
| - | ^ Return Type ^ Description ^ | + | |
| - | | String<!-- System.String --> | | | + | |
| - | === Parameters === | + | * //This method returns a user defined number of InternalFeatures that are closest to the TargetShape.// |
| - | ^ Name ^ Type ^ Description ^ | + | == 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 create 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. 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 the GetFeaturesInsideBoundingBoxCore method, we recommend that you use any spatial indexes you have at your disposal to make this method as fast as possible. 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.// | ||
| - | <!-- System.Object --> | + | == Return Value == |
| - | [[#Public Methods|Go Back]] | + | * Type:Collection<[[ThinkGeo.MapSuite.Core.Feature|Feature]]> |
| - | ===== Protected Methods ===== | + | * Description:This method returns a user defined number of InternalFeatures that are closest to the TargetShape. |
| - | ==== Finalize() ==== | + | |
| - | === Return Value === | + | |
| - | ^ Return Type ^ Description ^ | + | |
| - | | Void<!-- System.Void --> | | | + | |
| - | === Parameters === | + | == Parameters == |
| - | ^ Name ^ Type ^ Description ^ | + | * //targetShape// |
| + | * Type:[[ThinkGeo.MapSuite.Core.BaseShape|BaseShape]] | ||
| + | * Description:This parameter is the shape you want to find close InternalFeatures to. | ||
| - | <!-- System.Object --> | + | * //unitOfData// |
| - | [[#Protected Methods|Go Back]] | + | * Type:[[ThinkGeo.MapSuite.Core.GeographyUnit|GeographyUnit]] |
| - | ==== MemberwiseClone() ==== | + | * Description:This parameter is the unit of data that the TargetShape and the FeatureSource are in, such as feet, meters, etc. |
| - | === Return Value === | + | |
| - | ^ Return Type ^ Description ^ | + | |
| - | | Object<!-- System.Object --> | | | + | |
| - | === Parameters === | + | * //maxItemsToFind// |
| - | ^ Name ^ Type ^ Description ^ | + | * Type:Int32 |
| + | * Description:This parameter defines how many close InternalFeatures to find around the TargetShape. | ||
| - | <!-- System.Object --> | + | * //returningColumnNamesType// |
| - | [[#Protected Methods|Go Back]] | + | * Type:[[ThinkGeo.MapSuite.Core.ReturningColumnsType|ReturningColumnsType]] |
| - | ===== Public Properties ===== | + | * Description:This parameter allows you to select the field names of the column data you wish to return with each Feature. |
| - | ==== CanExecuteSqlQuery ==== | + | |
| - | This property specifies whether FeatureSource can excute a SQL query or not. If it is false, then it will throw an exception when the following APIs are called: ExecuteScalar, ExecuteNonQuery, ExecuteQuery | + | |
| - | === Remarks === | + | |
| - | The default implementation is false. | + | |
| - | === Return Value === | + | |
| - | ^ Return Type ^ | + | |
| - | | Boolean<!-- System.Boolean --> | | + | |
| - | <!-- ThinkGeo.MapSuite.PortableCore.QueryTools --> | + | <div newline></div> |
| - | [[#Public Properties|Go Back]] | + | ** {{wiki:PublicMethod.gif|}} GetFeaturesNearestTo(Feature,GeographyUnit,Int32,IEnumerable<String>) ** |
| - | ===== Protected Properties ===== | + | |
| - | ===== Public Events ===== | + | * //This method returns a user defined number of InternalFeatures that are closest to the TargetFeature.// |
| - | __NOTOC__ | + | == Remarks == |
| - | [[Category:MapSuitePortableCore]] | + | * //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 create 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. 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 the GetFeaturesInsideBoundingBoxCore method, we recommend that you use any spatial indexes you have at your disposal to make this method as fast as possible. 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.// |
| - | [[Category:ThinkGeo.MapSuite.PortableCore]] | + | |
| - | [[Category:UpdateDocumentation]] | + | == Return Value == |
| + | * Type:Collection<[[ThinkGeo.MapSuite.Core.Feature|Feature]]> | ||
| + | * Description:This method returns a user defined number of InternalFeatures that are closest to the TargetFeature. | ||
| + | |||
| + | == Parameters == | ||
| + | * //targetFeature// | ||
| + | * Type:[[ThinkGeo.MapSuite.Core.Feature|Feature]] | ||
| + | * Description:This parameter is the feature you want to find close InternalFeatures to. | ||
| + | |||
| + | * //unitOfData// | ||
| + | * Type:[[ThinkGeo.MapSuite.Core.GeographyUnit|GeographyUnit]] | ||
| + | * Description:This parameter is the unit of data that the TargetShape and the FeatureSource are in, such as feet, meters, etc. | ||
| + | |||
| + | * //maxItemsToFind// | ||
| + | * Type:Int32 | ||
| + | * Description:This parameter defines how many close InternalFeatures to find around the feature. | ||
| + | |||
| + | * //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> | ||
| + | ** {{wiki:PublicMethod.gif|}} GetFeaturesNearestTo(Feature,GeographyUnit,Int32,ReturningColumnsType) ** | ||
| + | |||
| + | * //This method returns a user defined number of InternalFeatures that are closest to the TargetFeature.// | ||
| + | == 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 create 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. 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 the GetFeaturesInsideBoundingBoxCore method, we recommend that you use any spatial indexes you have at your disposal to make this method as fast as possible. 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 == | ||
| + | * Type:Collection<[[ThinkGeo.MapSuite.Core.Feature|Feature]]> | ||
| + | * Description:This method returns a user defined number of InternalFeatures that are closest to the TargetFeature. | ||
| + | |||
| + | == Parameters == | ||
| + | * //targetFeature// | ||
| + | * Type:[[ThinkGeo.MapSuite.Core.Feature|Feature]] | ||
| + | * Description:This parameter is the feature you want to find close InternalFeatures to. | ||
| + | |||
| + | * //unitOfData// | ||
| + | * Type:[[ThinkGeo.MapSuite.Core.GeographyUnit|GeographyUnit]] | ||
| + | * Description:This parameter is the unit of data that the TargetShape and the FeatureSource are in, such as feet, meters, etc. | ||
| + | |||
| + | * //maxItemsToFind// | ||
| + | * Type:Int32 | ||
| + | * Description:This parameter defines how many close InternalFeatures to find around the feature. | ||
| + | |||
| + | * //returningColumnNamesType// | ||
| + | * Type:[[ThinkGeo.MapSuite.Core.ReturningColumnsType|ReturningColumnsType]] | ||
| + | * Description:This parameter allows you to select the field names of the column data you wish to return with each Feature. | ||
| + | |||
| + | <div newline></div> | ||
| + | ** {{wiki:PublicMethod.gif|}} GetFeaturesNearestTo(Feature,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. 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. 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 == | ||
| + | * Type:Collection<[[ThinkGeo.MapSuite.Core.Feature|Feature]]> | ||
| + | * Description:This method returns a user defined number of InternalFeatures that are closest to the TargetShape. | ||
| + | |||
| + | == Parameters == | ||
| + | * //targetFeature// | ||
| + | * Type:[[ThinkGeo.MapSuite.Core.Feature|Feature]] | ||
| + | * Description:This parameter is feature you want to find InternalFeatures close to. | ||
| + | |||
| + | * //unitOfData// | ||
| + | * Type:[[ThinkGeo.MapSuite.Core.GeographyUnit|GeographyUnit]] | ||
| + | * Description:This parameter is the unit of measurement that the TargetShape and the FeatureSource are in, such as feet, meters, etc. | ||
| + | |||
| + | * //maxItemsToFind// | ||
| + | * Type:Int32 | ||
| + | * Description:This parameter defines how many close InternalFeatures to find around the TargetShape. | ||
| + | |||
| + | * //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. | ||
| + | |||
| + | * //searchRadius// | ||
| + | * Type:Double | ||
| + | * Description:Limit the maximize distance proximately to search closest records. | ||
| + | |||
| + | * //unitOfSearchRadius// | ||
| + | * Type:[[ThinkGeo.MapSuite.Core.DistanceUnit|DistanceUnit]] | ||
| + | * Description:The unit of searchRadius parameter. | ||
| + | |||
| + | <div newline></div> | ||
| + | ** {{wiki:PublicMethod.gif|}} 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. 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. 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 == | ||
| + | * Type:Collection<[[ThinkGeo.MapSuite.Core.Feature|Feature]]> | ||
| + | * Description:This method returns a user defined number of InternalFeatures that are closest to the TargetShape. | ||
| + | |||
| + | == Parameters == | ||
| + | * //targetShape// | ||
| + | * Type:[[ThinkGeo.MapSuite.Core.BaseShape|BaseShape]] | ||
| + | * Description:This parameter is the shape you want to find InternalFeatures close to. | ||
| + | |||
| + | * //unitOfData// | ||
| + | * Type:[[ThinkGeo.MapSuite.Core.GeographyUnit|GeographyUnit]] | ||
| + | * Description:This parameter is the unit of measurement that the TargetShape and the FeatureSource are in, such as feet, meters, etc. | ||
| + | |||
| + | * //maxItemsToFind// | ||
| + | * Type:Int32 | ||
| + | * Description:This parameter defines how many close InternalFeatures to find around the TargetShape. | ||
| + | |||
| + | * //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. | ||
| + | |||
| + | * //searchRadius// | ||
| + | * Type:Double | ||
| + | * Description:Limit the maximize distance proximately to search closest records. | ||
| + | |||
| + | * //unitOfSearchRadius// | ||
| + | * Type:[[ThinkGeo.MapSuite.Core.DistanceUnit|DistanceUnit]] | ||
| + | * Description:The unit of searchRadius parameter. | ||
| + | |||
| + | <div newline></div> | ||
| + | ** {{wiki:PublicMethod.gif|}} GetFeaturesWithinDistanceOf(BaseShape,GeographyUnit,DistanceUnit,Double,IEnumerable<String>) ** | ||
| + | |||
| + | * //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. 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 the GetFeaturesInsideBoundingBoxCore method, we recommend that you use any spatial indexes you have at your disposal to make this method as fast as possible. 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 == | ||
| + | * Type:Collection<[[ThinkGeo.MapSuite.Core.Feature|Feature]]> | ||
| + | * Description:This method returns a collection of InternalFeatures that are within a certain distance of the TargetShape. | ||
| + | |||
| + | == Parameters == | ||
| + | * //targetShape// | ||
| + | * Type:[[ThinkGeo.MapSuite.Core.BaseShape|BaseShape]] | ||
| + | * Description:The shape you wish to find InternalFeatures within a distance of. | ||
| + | |||
| + | * //unitOfData// | ||
| + | * Type:[[ThinkGeo.MapSuite.Core.GeographyUnit|GeographyUnit]] | ||
| + | * Description:This parameter is the unit of data that the FeatureSource and TargetShape are in. | ||
| + | |||
| + | * //distanceUnit// | ||
| + | * Type:[[ThinkGeo.MapSuite.Core.DistanceUnit|DistanceUnit]] | ||
| + | * Description:This parameter specifies the unit of the distance parameter, such as feet, miles, kilometers, etc. | ||
| + | |||
| + | * //distance// | ||
| + | * Type:Double | ||
| + | * Description:This parameter specifies the distance in which to find InternalFeatures around the TargetShape. | ||
| + | |||
| + | * //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> | ||
| + | ** {{wiki:PublicMethod.gif|}} GetFeaturesWithinDistanceOf(BaseShape,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. 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 the GetFeaturesInsideBoundingBoxCore method, we recommend that you use any spatial indexes you have at your disposal to make this method as fast as possible. 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 == | ||
| + | * Type:Collection<[[ThinkGeo.MapSuite.Core.Feature|Feature]]> | ||
| + | * Description:This method returns a collection of InternalFeatures that are within a certain distance of the TargetShape. | ||
| + | |||
| + | == Parameters == | ||
| + | * //targetShape// | ||
| + | * Type:[[ThinkGeo.MapSuite.Core.BaseShape|BaseShape]] | ||
| + | * Description:The shape you wish to find InternalFeatures within a distance of. | ||
| + | |||
| + | * //unitOfData// | ||
| + | * Type:[[ThinkGeo.MapSuite.Core.GeographyUnit|GeographyUnit]] | ||
| + | * Description:This parameter is the unit of data that the FeatureSource and TargetShape are in. | ||
| + | |||
| + | * //distanceUnit// | ||
| + | * Type:[[ThinkGeo.MapSuite.Core.DistanceUnit|DistanceUnit]] | ||
| + | * Description:This parameter specifies the unit of the distance parameter, such as feet, miles, kilometers, etc. | ||
| + | |||
| + | * //distance// | ||
| + | * Type:Double | ||
| + | * Description:This parameter specifies the distance in which to find InternalFeatures around the TargetShape. | ||
| + | |||
| + | * //returningColumnNamesType// | ||
| + | * Type:[[ThinkGeo.MapSuite.Core.ReturningColumnsType|ReturningColumnsType]] | ||
| + | * Description:This parameter allows you to select the field names of the column data you wish to return with each Feature. | ||
| + | |||
| + | <div newline></div> | ||
| + | ** {{wiki:PublicMethod.gif|}} GetFeaturesWithinDistanceOf(Feature,GeographyUnit,DistanceUnit,Double,IEnumerable<String>) ** | ||
| + | |||
| + | * //This method returns a collection of InternalFeatures that are within a certain distance of the TargetFeature.// | ||
| + | == 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. 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 the GetFeaturesInsideBoundingBoxCore method, we recommend that you use any spatial indexes you have at your disposal to make this method as fast as possible. 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 == | ||
| + | * Type:Collection<[[ThinkGeo.MapSuite.Core.Feature|Feature]]> | ||
| + | * Description:This method returns a collection of InternalFeatures that are within a certain distance of the TargetFeature. | ||
| + | |||
| + | == Parameters == | ||
| + | * //targetFeature// | ||
| + | * Type:[[ThinkGeo.MapSuite.Core.Feature|Feature]] | ||
| + | * Description:The feature you wish to find InternalFeatures within a distance of. | ||
| + | |||
| + | * //unitOfData// | ||
| + | * Type:[[ThinkGeo.MapSuite.Core.GeographyUnit|GeographyUnit]] | ||
| + | * Description:This parameter is the unit of data that the FeatureSource and TargetShape are in. | ||
| + | |||
| + | * //distanceUnit// | ||
| + | * Type:[[ThinkGeo.MapSuite.Core.DistanceUnit|DistanceUnit]] | ||
| + | * Description:This parameter specifies the unit of the distance parameter, such as feet, miles, kilometers, etc. | ||
| + | |||
| + | * //distance// | ||
| + | * Type:Double | ||
| + | * Description:This parameter specifies the distance in which to find InternalFeatures around the TargetShape. | ||
| + | |||
| + | * //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> | ||
| + | ** {{wiki:PublicMethod.gif|}} GetFeaturesWithinDistanceOf(Feature,GeographyUnit,DistanceUnit,Double,ReturningColumnsType) ** | ||
| + | |||
| + | * //This method returns a collection of InternalFeatures that are within a certain distance of the TargetFeature.// | ||
| + | == 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. 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 the GetFeaturesInsideBoundingBoxCore method, we recommend that you use any spatial indexes you have at your disposal to make this method as fast as possible. 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 == | ||
| + | * Type:Collection<[[ThinkGeo.MapSuite.Core.Feature|Feature]]> | ||
| + | * Description:This method returns a collection of InternalFeatures that are within a certain distance of the TargetFeature. | ||
| + | |||
| + | == Parameters == | ||
| + | * //targetFeature// | ||
| + | * Type:[[ThinkGeo.MapSuite.Core.Feature|Feature]] | ||
| + | * Description:The feature you wish to find InternalFeatures within a distance of. | ||
| + | |||
| + | * //unitOfData// | ||
| + | * Type:[[ThinkGeo.MapSuite.Core.GeographyUnit|GeographyUnit]] | ||
| + | * Description:This parameter is the unit of data that the FeatureSource and TargetShape are in. | ||
| + | |||
| + | * //distanceUnit// | ||
| + | * Type:[[ThinkGeo.MapSuite.Core.DistanceUnit|DistanceUnit]] | ||
| + | * Description:This parameter specifies the unit of the distance parameter, such as feet, miles, kilometers, etc.. | ||
| + | |||
| + | * //distance// | ||
| + | * Type:Double | ||
| + | * Description:This parameter specifies the distance in which to find InternalFeatures around the TargetShape. | ||
| + | |||
| + | * //returningColumnNamesType// | ||
| + | * Type:[[ThinkGeo.MapSuite.Core.ReturningColumnsType|ReturningColumnsType]] | ||
| + | * Description:This parameter allows you to select the field names of the column data you wish to return with each Feature. | ||
| + | |||
| + | <div newline></div> | ||
| + | ** {{wiki:PublicMethod.gif|}} GetFeatureById(String,IEnumerable<String>) ** | ||
| + | |||
| + | * //This method returns an InternalFeature based on an Id provided.// | ||
| + | == Remarks == | ||
| + | * //This method returns an InternalFeature based on an Id provided.// | ||
| + | |||
| + | == Return Value == | ||
| + | * Type:[[ThinkGeo.MapSuite.Core.Feature|Feature]] | ||
| + | * Description:This method returns an InternalFeature based on an Id provided. | ||
| + | |||
| + | == Parameters == | ||
| + | * //id// | ||
| + | * Type:String | ||
| + | * Description:This parameter is the unique Id for the feature you want to find. | ||
| + | |||
| + | * //returningColumnNames// | ||
| + | * Type:IEnumerable<String> | ||
| + | * Description:This parameter is a list of column names you want returned with the Feature. | ||
| + | |||
| + | <div newline></div> | ||
| + | ** {{wiki:PublicMethod.gif|}} GetFeatureById(String,ReturningColumnsType) ** | ||
| + | |||
| + | * //This method returns an InternalFeature based on an Id provided.// | ||
| + | == Remarks == | ||
| + | * //This method returns an InternalFeature based on an Id provided.// | ||
| + | |||
| + | == Return Value == | ||
| + | * Type:[[ThinkGeo.MapSuite.Core.Feature|Feature]] | ||
| + | * Description:This method returns an InternalFeature based on an Id provided. | ||
| + | |||
| + | == Parameters == | ||
| + | * //id// | ||
| + | * Type:String | ||
| + | * Description:This parameter is the unique Id for the feature you want to find. | ||
| + | |||
| + | * //returningColumnNamesType// | ||
| + | * Type:[[ThinkGeo.MapSuite.Core.ReturningColumnsType|ReturningColumnsType]] | ||
| + | * Description:This parameter is a list of column names you want returned with the Feature. | ||
| + | |||
| + | <div newline></div> | ||
| + | ** {{wiki:PublicMethod.gif|}} GetFeaturesByIds(IEnumerable<String>,IEnumerable<String>) ** | ||
| + | |||
| + | * //This method returns a collection of InternalFeatures based on the collection of Ids provided.// | ||
| + | == Remarks == | ||
| + | * //This method returns a collection of InternalFeatures based on the collection of Ids provided.// | ||
| + | |||
| + | == Return Value == | ||
| + | * Type:Collection<[[ThinkGeo.MapSuite.Core.Feature|Feature]]> | ||
| + | * Description:This method returns a collection of InternalFeatures based on the collection of Ids provided. | ||
| + | |||
| + | == Parameters == | ||
| + | * //ids// | ||
| + | * Type:IEnumerable<String> | ||
| + | * Description:This parameter is the collection of Ids you want to find. | ||
| + | |||
| + | * //returningColumnNames// | ||
| + | * Type:IEnumerable<String> | ||
| + | * Description:This parameter is a list of column names you want returned with the Features. | ||
| + | |||
| + | <div newline></div> | ||
| + | ** {{wiki:PublicMethod.gif|}} GetFeaturesByIds(IEnumerable<String>,ReturningColumnsType) ** | ||
| + | |||
| + | * //This method returns a collection of InternalFeatures based on the collection of Ids provided.// | ||
| + | == Remarks == | ||
| + | * //This method returns a collection of InternalFeatures based on the collection of Ids provided.// | ||
| + | |||
| + | == Return Value == | ||
| + | * Type:Collection<[[ThinkGeo.MapSuite.Core.Feature|Feature]]> | ||
| + | * Description:This method returns a collection of InternalFeatures based on the collection of Ids provided. | ||
| + | |||
| + | == Parameters == | ||
| + | * //ids// | ||
| + | * Type:IEnumerable<String> | ||
| + | * Description:This parameter is the collection of Ids you want to find. | ||
| + | |||
| + | * //returningColumnNamesType// | ||
| + | * Type:[[ThinkGeo.MapSuite.Core.ReturningColumnsType|ReturningColumnsType]] | ||
| + | * Description:This parameter is a list of column names you want returned with the Features. | ||
| + | |||
| + | <div newline></div> | ||
| + | ** {{wiki:PublicMethod.gif|}} GetBoundingBoxById(String) ** | ||
| + | |||
| + | * //This method returns the bounding box for the Id specified.// | ||
| + | == Remarks == | ||
| + | * //This method returns the bounding box for the Id specified.// | ||
| + | |||
| + | == Return Value == | ||
| + | * Type:[[ThinkGeo.MapSuite.Core.RectangleShape|RectangleShape]] | ||
| + | * Description:This method returns the bounding box for the Id specified. | ||
| + | |||
| + | == Parameters == | ||
| + | * //id// | ||
| + | * Type:String | ||
| + | * Description:This parameter is the unique Id of the feature for which you want to find the bounding box. | ||
| + | |||
| + | <div newline></div> | ||
| + | ** {{wiki:PublicMethod.gif|}} GetBoundingBoxesByIds(IEnumerable<String>) ** | ||
| + | |||
| + | * //This method returns a collection of bounding boxes based on the collection of Ids provided.// | ||
| + | == Remarks == | ||
| + | * //This method returns a collection of bounding boxes based on the collection of Ids provided.// | ||
| + | |||
| + | == Return Value == | ||
| + | * Type:Collection<[[ThinkGeo.MapSuite.Core.RectangleShape|RectangleShape]]> | ||
| + | * Description:This method returns a collection of bounding boxes based on the collection of Ids provided. | ||
| + | |||
| + | == Parameters == | ||
| + | * //ids// | ||
| + | * Type:IEnumerable<String> | ||
| + | * Description:This parameter is the collection of Ids you want to find. | ||
| + | |||
| + | <div newline></div> | ||
| + | ** {{wiki:PublicMethod.gif|}} GetColumns() ** | ||
| + | |||
| + | * //This method returns the collection of columns for this FeatureSource.// | ||
| + | == Remarks == | ||
| + | * //This method returns the collection of columns for this FeatureSource.// | ||
| + | |||
| + | == Return Value == | ||
| + | * Type:Collection<[[ThinkGeo.MapSuite.Core.FeatureSourceColumn|FeatureSourceColumn]]> | ||
| + | * Description:This method returns the collection of columns for this FeatureSource. | ||
| + | |||
| + | == Parameters == | ||
| + | <div newline></div> | ||
| + | ** {{wiki:PublicMethod.gif|}} GetCount() ** | ||
| + | |||
| + | * //This method returns the count of all of the InternalFeatures in the FeatureSource.// | ||
| + | == Remarks == | ||
| + | * //This method returns the count of all of the InternalFeatures in the FeatureSource.// | ||
| + | |||
| + | == Return Value == | ||
| + | * Type:Int32 | ||
| + | * Description:This method returns the count of all of the InternalFeatures in the FeatureSource. | ||
| + | |||
| + | == Parameters == | ||
| + | <div newline></div> | ||
| + | ** {{wiki:PublicMethod.gif|}} GetAllFeatures(IEnumerable<String>) ** | ||
| + | |||
| + | * //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. 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. 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. 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 == | ||
| + | * Type:Collection<[[ThinkGeo.MapSuite.Core.Feature|Feature]]> | ||
| + | * Description:The return value is a collection of all of the InternalFeatures in the FeatureSource. | ||
| + | |||
| + | == 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. | ||
| + | |||
| + | <div newline></div> | ||
| + | ** {{wiki:PublicMethod.gif|}} GetAllFeatures(ReturningColumnsType) ** | ||
| + | |||
| + | * //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. 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. 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. 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 == | ||
| + | * Type:Collection<[[ThinkGeo.MapSuite.Core.Feature|Feature]]> | ||
| + | * Description:The return value is a collection of all of the InternalFeatures in the FeatureSource. | ||
| + | |||
| + | == Parameters == | ||
| + | * //returningColumnNamesType// | ||
| + | * Type:[[ThinkGeo.MapSuite.Core.ReturningColumnsType|ReturningColumnsType]] | ||
| + | * Description:This parameter allows you to select the field names of the column data you wish to return with each Feature. | ||
| + | |||
| + | <div newline></div> | ||
| + | ** {{wiki:PublicMethod.gif|}} ExecuteNonQuery(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 == | ||
| + | * Type:Int32 | ||
| + | * Description:The number of rows affected. | ||
| + | |||
| + | == Parameters == | ||
| + | * //sqlStatement// | ||
| + | * Type:String | ||
| + | * Description:The sqlStatement to be excuted. | ||
| + | |||
| + | <div newline></div> | ||
| + | ** {{wiki:PublicMethod.gif|}} ExecuteScalar(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 use the ExcuteQuery method and then performing the operations necessary to generate the single value using the data.// | ||
| + | |||
| + | == Return Value == | ||
| + | * Type:Object | ||
| + | * Description:The first column of the first row in the result set. | ||
| + | |||
| + | == Parameters == | ||
| + | * //sqlStatement// | ||
| + | * Type:String | ||
| + | * Description:The SQL statement to be excuted. | ||
| + | |||
| + | <div newline></div> | ||
| + | ** {{wiki:PublicMethod.gif|}} ToString() ** | ||
| + | |||
| + | * //N/A// | ||
| + | == Remarks == | ||
| + | * //N/A// | ||
| + | |||
| + | == Return Value == | ||
| + | * Type:String | ||
| + | * Description:N/A | ||
| + | |||
| + | == Parameters == | ||
| + | <div newline></div> | ||
| + | ** {{wiki:PublicMethod.gif|}} Equals(Object) ** | ||
| + | |||
| + | * //N/A// | ||
| + | == Remarks == | ||
| + | * //N/A// | ||
| + | |||
| + | == Return Value == | ||
| + | * Type:Boolean | ||
| + | * Description:N/A | ||
| + | |||
| + | == Parameters == | ||
| + | * //obj// | ||
| + | * Type:Object | ||
| + | * Description:N/A | ||
| + | |||
| + | <div newline></div> | ||
| + | ** {{wiki:PublicMethod.gif|}} GetHashCode() ** | ||
| + | |||
| + | * //N/A// | ||
| + | == Remarks == | ||
| + | * //N/A// | ||
| + | |||
| + | == Return Value == | ||
| + | * Type:Int32 | ||
| + | * Description:N/A | ||
| + | |||
| + | == Parameters == | ||
| + | <div newline></div> | ||
| + | ** {{wiki:PublicMethod.gif|}} GetType() ** | ||
| + | |||
| + | * //N/A// | ||
| + | == Remarks == | ||
| + | * //N/A// | ||
| + | |||
| + | == Return Value == | ||
| + | * Type:Type | ||
| + | * Description:N/A | ||
| + | |||
| + | == Parameters == | ||
| + | <div newline></div> | ||
| + | ==== Protected Methods ==== | ||
| + | ** {{wiki:ProtectedMethod.gif|}} Finalize() ** | ||
| + | |||
| + | * //N/A// | ||
| + | == Remarks == | ||
| + | * //N/A// | ||
| + | |||
| + | == Return Value == | ||
| + | * Type:Void | ||
| + | * Description:N/A | ||
| + | |||
| + | == Parameters == | ||
| + | <div newline></div> | ||
| + | ** {{wiki:ProtectedMethod.gif|}} MemberwiseClone() ** | ||
| + | |||
| + | * //N/A// | ||
| + | == Remarks == | ||
| + | * //N/A// | ||
| + | |||
| + | == Return Value == | ||
| + | * Type:Object | ||
| + | * Description:N/A | ||
| + | |||
| + | == Parameters == | ||
| + | <div newline></div> | ||
| + | ==== Public Properties ==== | ||
| + | ** {{wiki:PublicProperty.gif|}} CanExecuteSqlQuery ** | ||
| + | |||
| + | * //This property specifies whether FeatureSource can excute a SQL query or not. If it is false, then it will throw an exception when the following APIs are called: ExecuteScalar, ExecuteNonQuery, ExecuteQuery// | ||
| + | == Remarks == | ||
| + | * //The default implementation is false.// | ||
| + | == Return Value == | ||
| + | * Type:Boolean | ||
| + | |||
| + | ==== Protected Properties ==== | ||
| + | ==== Public Events ==== | ||
thinkgeo.mapsuite.portablecore.querytools.1440040133.txt.gz · Last modified: 2015/09/21 08:16 (external edit)