User Tools

Site Tools


api:thinkgeo.mapsuite.layers.wfsfeaturesource

ThinkGeo.MapSuite.Layers.WfsFeatureSource

Inheritance Hierarchy

  • System.Object
    • ThinkGeo.MapSuite.Layers.FeatureSource
      • ThinkGeo.MapSuite.Layers.WfsFeatureSource

Members Summary

Public Constructors

WfsFeatureSource()

  • WfsFeatureSource Constructor.
Remarks
  • N/A
Parameters

WfsFeatureSource(String,String)

  • WfsFeatureSource Constructor
Remarks
  • The parameters can not be null.
Parameters
  • serviceLocationUrl
    • Type:String
    • Description:The url of wfs service.
  • typeName
    • Type:String
    • Description:The typename in the specify wfs service.

Protected Constructors

Public Methods

CanGetBoundingBoxQuickly()

  • N/A
Remarks
  • N/A
Return Value
  • Type:Boolean
  • Description:N/A
Parameters

CanGetCountQuickly()

  • N/A
Remarks
  • N/A
Return Value
  • Type:Boolean
  • Description:N/A
Parameters

GetDistinctColumnValues(String)

  • N/A
Remarks
  • N/A
Return Value
Parameters
  • columnName
    • Type:String
    • Description:N/A

GetAllFeatures(ReturningColumnsType,Int32)

  • N/A
Remarks
  • N/A
Return Value
  • Type:Collection<Feature>
  • Description:N/A
Parameters
  • startIndex
    • Type:Int32
    • Description:N/A

GetAllFeatures(ReturningColumnsType,Int32,Int32)

  • N/A
Remarks
  • N/A
Return Value
  • Type:Collection<Feature>
  • Description:N/A
Parameters
  • startIndex
    • Type:Int32
    • Description:N/A
  • takeCount
    • Type:Int32
    • Description:N/A

GetAllFeatures(IEnumerable<String>,Int32,Int32)

  • N/A
Remarks
  • N/A
Return Value
  • Type:Collection<Feature>
  • Description:N/A
Parameters
  • returningColumnNames
    • Type:IEnumerable<String>
    • Description:N/A
  • startIndex
    • Type:Int32
    • Description:N/A
  • takeCount
    • Type:Int32
    • Description:N/A

RollbackTransaction()

  • N/A
Remarks
  • N/A
Return Value
  • Type:Void
  • Description:N/A
Parameters

CommitTransaction()

  • N/A
Remarks
  • N/A
Return Value
Parameters

AddColumn(FeatureSourceColumn)

  • N/A
Remarks
  • N/A
Return Value
  • Type:Void
  • Description:N/A
Parameters

DeleteColumn(String)

  • N/A
Remarks
  • N/A
Return Value
  • Type:Void
  • Description:N/A
Parameters
  • columnName
    • Type:String
    • Description:N/A

UpdateColumn(String,FeatureSourceColumn)

  • N/A
Remarks
  • N/A
Return Value
  • Type:Void
  • Description:N/A
Parameters
  • columnName
    • Type:String
    • Description:N/A

GetAllFeatures(IEnumerable<String>)

  • N/A
Remarks
  • N/A
Return Value
  • Type:Collection<Feature>
  • Description:N/A
Parameters
  • returningColumnNames
    • Type:IEnumerable<String>
    • Description:N/A

GetAllFeatures(ReturningColumnsType)

  • N/A
Remarks
  • N/A
Return Value
  • Type:Collection<Feature>
  • Description:N/A
Parameters

GetFeaturesOutsideBoundingBox(RectangleShape,IEnumerable<String>)

  • N/A
Remarks
  • N/A
Return Value
  • Type:Collection<Feature>
  • Description:N/A
Parameters
  • returningColumnNames
    • Type:IEnumerable<String>
    • Description:N/A

GetFeaturesOutsideBoundingBox(RectangleShape,ReturningColumnsType)

  • N/A
Remarks
  • N/A
Return Value
  • Type:Collection<Feature>
  • Description:N/A
Parameters

GetFeaturesInsideBoundingBox(RectangleShape,IEnumerable<String>)

  • N/A
Remarks
  • N/A
Return Value
  • Type:Collection<Feature>
  • Description:N/A
Parameters
  • returningColumnNames
    • Type:IEnumerable<String>
    • Description:N/A

GetFeaturesInsideBoundingBox(RectangleShape,ReturningColumnsType)

  • N/A
Remarks
  • N/A
Return Value
  • Type:Collection<Feature>
  • Description:N/A
Parameters

GetFeatureIdsInsideBoundingBox(RectangleShape)

  • N/A
Remarks
  • N/A
Return Value
  • Type:Collection<String>
  • Description:N/A
Parameters

GetFeaturesForDrawing(RectangleShape,Double,Double,IEnumerable<String>)

  • N/A
Remarks
  • N/A
Return Value
  • Type:Collection<Feature>
  • Description:N/A
Parameters
  • screenWidth
    • Type:Double
    • Description:N/A
  • screenHeight
    • Type:Double
    • Description:N/A
  • returningColumnNames
    • Type:IEnumerable<String>
    • Description:N/A

GetFeaturesForDrawing(RectangleShape,Double,Double,ReturningColumnsType)

  • N/A
Remarks
  • N/A
Return Value
  • Type:Collection<Feature>
  • Description:N/A
Parameters
  • screenWidth
    • Type:Double
    • Description:N/A
  • screenHeight
    • Type:Double
    • Description:N/A

SpatialQuery(BaseShape,QueryType,IEnumerable<String>)

  • N/A
Remarks
  • N/A
Return Value
  • Type:Collection<Feature>
  • Description:N/A
Parameters
  • returningColumnNames
    • Type:IEnumerable<String>
    • Description:N/A

SpatialQuery(BaseShape,QueryType,ReturningColumnsType)

  • N/A
Remarks
  • N/A
Return Value
  • Type:Collection<Feature>
  • Description:N/A
Parameters

SpatialQuery(Feature,QueryType,IEnumerable<String>)

  • N/A
Remarks
  • N/A
Return Value
  • Type:Collection<Feature>
  • Description:N/A
Parameters
  • feature
  • returningColumnNames
    • Type:IEnumerable<String>
    • Description:N/A

SpatialQuery(Feature,QueryType,ReturningColumnsType)

  • N/A
Remarks
  • N/A
Return Value
  • Type:Collection<Feature>
  • Description:N/A
Parameters
  • feature

GetFeaturesNearestTo(BaseShape,GeographyUnit,Int32,IEnumerable<String>)

  • N/A
Remarks
  • N/A
Return Value
  • Type:Collection<Feature>
  • Description:N/A
Parameters
  • maxItemsToFind
    • Type:Int32
    • Description:N/A
  • returningColumnNames
    • Type:IEnumerable<String>
    • Description:N/A

GetFeaturesNearestTo(BaseShape,GeographyUnit,Int32,ReturningColumnsType)

  • N/A
Remarks
  • N/A
Return Value
  • Type:Collection<Feature>
  • Description:N/A
Parameters
  • maxItemsToFind
    • Type:Int32
    • Description:N/A

GetFeaturesNearestTo(Feature,GeographyUnit,Int32,IEnumerable<String>)

  • N/A
Remarks
  • N/A
Return Value
  • Type:Collection<Feature>
  • Description:N/A
Parameters
  • targetFeature
  • maxItemsToFind
    • Type:Int32
    • Description:N/A
  • returningColumnNames
    • Type:IEnumerable<String>
    • Description:N/A

GetFeaturesNearestTo(Feature,GeographyUnit,Int32,ReturningColumnsType)

  • N/A
Remarks
  • N/A
Return Value
  • Type:Collection<Feature>
  • Description:N/A
Parameters
  • targetFeature
  • maxItemsToFind
    • Type:Int32
    • Description:N/A

GetFeaturesNearestTo(BaseShape,GeographyUnit,Int32,IEnumerable<String>,Double,DistanceUnit)

  • N/A
Remarks
  • N/A
Return Value
  • Type:Collection<Feature>
  • Description:N/A
Parameters
  • maxItemsToFind
    • Type:Int32
    • Description:N/A
  • returningColumnNames
    • Type:IEnumerable<String>
    • Description:N/A
  • searchRadius
    • Type:Double
    • Description:N/A

GetFeaturesNearestTo(Feature,GeographyUnit,Int32,IEnumerable<String>,Double,DistanceUnit)

  • N/A
Remarks
  • N/A
Return Value
  • Type:Collection<Feature>
  • Description:N/A
Parameters
  • targetFeature
  • maxItemsToFind
    • Type:Int32
    • Description:N/A
  • returningColumnNames
    • Type:IEnumerable<String>
    • Description:N/A
  • searchRadius
    • Type:Double
    • Description:N/A

GetFeaturesWithinDistanceOf(BaseShape,GeographyUnit,DistanceUnit,Double,IEnumerable<String>)

  • N/A
Remarks
  • N/A
Return Value
  • Type:Collection<Feature>
  • Description:N/A
Parameters
  • distance
    • Type:Double
    • Description:N/A
  • returningColumnNames
    • Type:IEnumerable<String>
    • Description:N/A

GetFeaturesWithinDistanceOf(BaseShape,GeographyUnit,DistanceUnit,Double,ReturningColumnsType)

  • N/A
Remarks
  • N/A
Return Value
  • Type:Collection<Feature>
  • Description:N/A
Parameters
  • distance
    • Type:Double
    • Description:N/A

GetFeaturesWithinDistanceOf(Feature,GeographyUnit,DistanceUnit,Double,IEnumerable<String>)

  • N/A
Remarks
  • N/A
Return Value
  • Type:Collection<Feature>
  • Description:N/A
Parameters
  • targetFeature
  • distance
    • Type:Double
    • Description:N/A
  • returningColumnNames
    • Type:IEnumerable<String>
    • Description:N/A

GetFeaturesWithinDistanceOf(Feature,GeographyUnit,DistanceUnit,Double,ReturningColumnsType)

  • N/A
Remarks
  • N/A
Return Value
  • Type:Collection<Feature>
  • Description:N/A
Parameters
  • targetFeature
  • distance
    • Type:Double
    • Description:N/A

GetFeatureById(String,IEnumerable<String>)

  • N/A
Remarks
  • N/A
Return Value
Parameters
  • id
    • Type:String
    • Description:N/A
  • returningColumnNames
    • Type:IEnumerable<String>
    • Description:N/A

GetFeatureById(String,ReturningColumnsType)

  • N/A
Remarks
  • N/A
Return Value
Parameters
  • id
    • Type:String
    • Description:N/A

GetFeaturesByIds(IEnumerable<String>,IEnumerable<String>)

  • N/A
Remarks
  • N/A
Return Value
  • Type:Collection<Feature>
  • Description:N/A
Parameters
  • ids
    • Type:IEnumerable<String>
    • Description:N/A
  • returningColumnNames
    • Type:IEnumerable<String>
    • Description:N/A

GetFeaturesByIds(IEnumerable<String>,ReturningColumnsType)

  • N/A
Remarks
  • N/A
Return Value
  • Type:Collection<Feature>
  • Description:N/A
Parameters
  • ids
    • Type:IEnumerable<String>
    • Description:N/A

GetBoundingBoxById(String)

  • N/A
Remarks
  • N/A
Return Value
Parameters
  • id
    • Type:String
    • Description:N/A

GetBoundingBoxByIds(IEnumerable<String>)

  • N/A
Remarks
  • N/A
Return Value
Parameters
  • ids
    • Type:IEnumerable<String>
    • Description:N/A

RemoveEmptyAndExcludedFeatures(Collection<Feature>)

  • N/A
Remarks
  • N/A
Return Value
  • Type:Void
  • Description:N/A
Parameters
  • features
    • Type:Collection<Feature>
    • Description:N/A

GetColumnNamesOutsideFeatureSource(IEnumerable<String>)

  • N/A
Remarks
  • N/A
Return Value
  • Type:Collection<String>
  • Description:N/A
Parameters
  • returningColumnNames
    • Type:IEnumerable<String>
    • Description:N/A

GetBoundingBoxesByIds(IEnumerable<String>)

  • N/A
Remarks
  • N/A
Return Value
Parameters
  • ids
    • Type:IEnumerable<String>
    • Description:N/A

GetFirstFeaturesWellKnownType()

  • N/A
Remarks
  • N/A
Return Value
Parameters

ExecuteNonQuery(String)

  • N/A
Remarks
  • N/A
Return Value
  • Type:Int32
  • Description:N/A
Parameters
  • sqlStatement
    • Type:String
    • Description:N/A

GetFeaturesByColumnValue(String,String,ReturningColumnsType)

  • N/A
Remarks
  • N/A
Return Value
  • Type:Collection<Feature>
  • Description:N/A
Parameters
  • columnName
    • Type:String
    • Description:N/A
  • columnValue
    • Type:String
    • Description:N/A

GetFeaturesByColumnValue(String,String,IEnumerable<String>)

  • N/A
Remarks
  • N/A
Return Value
  • Type:Collection<Feature>
  • Description:N/A
Parameters
  • columnName
    • Type:String
    • Description:N/A
  • columnValue
    • Type:String
    • Description:N/A
  • returningColumnNames
    • Type:IEnumerable<String>
    • Description:N/A

GetFeaturesByColumnValue(String,String)

  • N/A
Remarks
  • N/A
Return Value
  • Type:Collection<Feature>
  • Description:N/A
Parameters
  • columnName
    • Type:String
    • Description:N/A
  • columnValue
    • Type:String
    • Description:N/A

ExecuteScalar(String)

  • N/A
Remarks
  • N/A
Return Value
  • Type:Object
  • Description:N/A
Parameters
  • sqlStatement
    • Type:String
    • Description:N/A

ExecuteQuery(String)

  • N/A
Remarks
  • N/A
Return Value
Parameters
  • sqlStatement
    • Type:String
    • Description:N/A

GetColumns()

  • N/A
Remarks
  • N/A
Return Value
Parameters

RefreshColumns()

  • N/A
Remarks
  • N/A
Return Value
  • Type:Void
  • Description:N/A
Parameters

GetCount()

  • N/A
Remarks
  • N/A
Return Value
  • Type:Int32
  • Description:N/A
Parameters

GetBoundingBox()

  • N/A
Remarks
  • N/A
Return Value
Parameters

CloneDeep()

  • N/A
Remarks
  • N/A
Return Value
Parameters

Open()

  • N/A
Remarks
  • N/A
Return Value
  • Type:Void
  • Description:N/A
Parameters

Close()

  • N/A
Remarks
  • N/A
Return Value
  • Type:Void
  • Description:N/A
Parameters

BeginTransaction()

  • N/A
Remarks
  • N/A
Return Value
  • Type:Void
  • Description:N/A
Parameters

AddFeature(Feature)

  • N/A
Remarks
  • N/A
Return Value
  • Type:String
  • Description:N/A
Parameters
  • feature

AddFeature(BaseShape)

  • N/A
Remarks
  • N/A
Return Value
  • Type:String
  • Description:N/A
Parameters

AddFeature(BaseShape,IDictionary<String,String>)

  • N/A
Remarks
  • N/A
Return Value
  • Type:String
  • Description:N/A
Parameters
  • columnValues
    • Type:IDictionary<String,String>
    • Description:N/A

DeleteFeature(String)

  • N/A
Remarks
  • N/A
Return Value
  • Type:Void
  • Description:N/A
Parameters
  • id
    • Type:String
    • Description:N/A

UpdateFeature(Feature)

  • N/A
Remarks
  • N/A
Return Value
  • Type:Void
  • Description:N/A
Parameters
  • feature

UpdateFeature(BaseShape)

  • N/A
Remarks
  • N/A
Return Value
  • Type:Void
  • Description:N/A
Parameters

UpdateFeature(BaseShape,IDictionary<String,String>)

  • N/A
Remarks
  • N/A
Return Value
  • Type:Void
  • Description:N/A
Parameters
  • columnValues
    • Type:IDictionary<String,String>
    • Description:N/A

ToString()

  • N/A
Remarks
  • N/A
Return Value
  • Type:String
  • Description:N/A
Parameters

Equals(Object)

  • N/A
Remarks
  • N/A
Return Value
  • Type:Boolean
  • Description:N/A
Parameters
  • obj
    • Type:Object
    • Description:N/A

GetHashCode()

  • N/A
Remarks
  • N/A
Return Value
  • Type:Int32
  • Description:N/A
Parameters

GetType()

  • N/A
Remarks
  • N/A
Return Value
  • Type:Type
  • Description:N/A
Parameters

GetCapabilities(String)

  • N/A
Remarks
  • Every OGC Web Service (OWS), including a Web Feature Service, must have the ability to describe its capabilities by returning service metadata in response to a GetCapabilities request. Specifically, every web feature service must support the KVP encoded form of the GetCapabilities request over HTTP GET so that a client can always know how to obtain a capabilities document. The capabilities response document contains the following sections: 1. Service Identification section The service identification section provides information about the WFS service itself. 2. Service Provider section The service provider section provides metadata about the organization operating the WFS server. 3. Operation Metadata section The operations metadata section provides metadata about the operations defined in this specification and implemented by a particular WFS server. This metadata includes the DCP, parameters and constraints for each operation. 4. FeatureType list section This section defines the list of feature types (and operations on each feature type) that are available from a web feature service. Additional information, such as the default SRS, any other supported SRSs, or no SRS whatsoever (for non-spatial feature types), for WFS requests is provided for each feature type. 5. ServesGMLObjectType list section This section defines the list of GML Object types, not derived from gml:AbstractFeatureType, that are available from a web feature service that supports the GetGMLObject operation. These types may be defined in a base GML schema, or in an application schema using its own namespace. 6. SupportsGMLObjectType list section The Supports GML Object Type section defines the list of GML Object types that a WFS server would be capable of serving if it was deployed to serve data. described by an application schema that either used those GML Object types directly (for non-abstract types), or defined derived types based on those types. 7. Filter capabilities section The schema of the Filter Capabilities Section is defined in the Filter Encoding Implementation Specification [3]. This is an optional section. If it exists, then the WFS should support the operations advertised therein. If the Filter Capabilities Section is not defined, then the client should assume that the server only supports the minimum default set of filter operators.
Return Value
  • Type:String
  • Description:The xml text represents capabilities of this wfs server.
Parameters
  • serviceLocationUrl
    • Type:String
    • Description:The url of wfs service.

GetCapabilities(Uri)

  • N/A
Remarks
  • Every OGC Web Service (OWS), including a Web Feature Service, must have the ability to describe its capabilities by returning service metadata in response to a GetCapabilities request. Specifically, every web feature service must support the KVP encoded form of the GetCapabilities request over HTTP GET so that a client can always know how to obtain a capabilities document. The capabilities response document contains the following sections: 1. Service Identification section The service identification section provides information about the WFS service itself. 2. Service Provider section The service provider section provides metadata about the organization operating the WFS server. 3. Operation Metadata section The operations metadata section provides metadata about the operations defined in this specification and implemented by a particular WFS server. This metadata includes the DCP, parameters and constraints for each operation. 4. FeatureType list section This section defines the list of feature types (and operations on each feature type) that are available from a web feature service. Additional information, such as the default SRS, any other supported SRSs, or no SRS whatsoever (for non-spatial feature types), for WFS requests is provided for each feature type. 5. ServesGMLObjectType list section This section defines the list of GML Object types, not derived from gml:AbstractFeatureType, that are available from a web feature service that supports the GetGMLObject operation. These types may be defined in a base GML schema, or in an application schema using its own namespace. 6. SupportsGMLObjectType list section The Supports GML Object Type section defines the list of GML Object types that a WFS server would be capable of serving if it was deployed to serve data. described by an application schema that either used those GML Object types directly (for non-abstract types), or defined derived types based on those types. 7. Filter capabilities section The schema of the Filter Capabilities Section is defined in the Filter Encoding Implementation Specification [3]. This is an optional section. If it exists, then the WFS should support the operations advertised therein. If the Filter Capabilities Section is not defined, then the client should assume that the server only supports the minimum default set of filter operators.
Return Value
  • Type:String
  • Description:The xml text represents capabilities of this wfs server.
Parameters
  • serverUri
    • Type:Uri
    • Description:The url of wfs service.

GetCapabilities(Uri,IWebProxy)

  • N/A
Remarks
  • Every OGC Web Service (OWS), including a Web Feature Service, must have the ability to describe its capabilities by returning service metadata in response to a GetCapabilities request. Specifically, every web feature service must support the KVP encoded form of the GetCapabilities request over HTTP GET so that a client can always know how to obtain a capabilities document. The capabilities response document contains the following sections: 1. Service Identification section The service identification section provides information about the WFS service itself. 2. Service Provider section The service provider section provides metadata about the organization operating the WFS server. 3. Operation Metadata section The operations metadata section provides metadata about the operations defined in this specification and implemented by a particular WFS server. This metadata includes the DCP, parameters and constraints for each operation. 4. FeatureType list section This section defines the list of feature types (and operations on each feature type) that are available from a web feature service. Additional information, such as the default SRS, any other supported SRSs, or no SRS whatsoever (for non-spatial feature types), for WFS requests is provided for each feature type. 5. ServesGMLObjectType list section This section defines the list of GML Object types, not derived from gml:AbstractFeatureType, that are available from a web feature service that supports the GetGMLObject operation. These types may be defined in a base GML schema, or in an application schema using its own namespace. 6. SupportsGMLObjectType list section The Supports GML Object Type section defines the list of GML Object types that a WFS server would be capable of serving if it was deployed to serve data. described by an application schema that either used those GML Object types directly (for non-abstract types), or defined derived types based on those types. 7. Filter capabilities section The schema of the Filter Capabilities Section is defined in the Filter Encoding Implementation Specification [3]. This is an optional section. If it exists, then the WFS should support the operations advertised therein. If the Filter Capabilities Section is not defined, then the client should assume that the server only supports the minimum default set of filter operators.
Return Value
  • Type:String
  • Description:The xml text represents capabilities of this wfs server.
Parameters
  • serverUri
    • Type:Uri
    • Description:The url of wfs service.
  • webProxy
    • Type:IWebProxy
    • Description:The proxy of the wfs service.

GetLayers(String)

  • N/A
Remarks
  • N/A
Return Value
  • Type:Collection<String>
  • Description:The collection represent layer names.
Parameters
  • serviceLocationUrl
    • Type:String
    • Description:The url of wfs service.

GetLayers(Uri)

  • N/A
Remarks
  • N/A
Return Value
  • Type:Collection<String>
  • Description:The collection represent layer names.
Parameters
  • serverUri
    • Type:Uri
    • Description:The url of wfs service.

GetLayers(Uri,IWebProxy)

  • N/A
Remarks
  • N/A
Return Value
  • Type:Collection<String>
  • Description:The collection represent layer names.
Parameters
  • serverUri
    • Type:Uri
    • Description:The url of wfs service.
  • webProxy
    • Type:IWebProxy
    • Description:The proxy of the wfs service.

Protected Methods

CanGetBoundingBoxQuicklyCore()

  • N/A
Remarks
  • N/A
Return Value
  • Type:Boolean
  • Description:N/A
Parameters

OnRequestingData(RequestingDataWfsFeatureSourceEventArgs)

  • N/A
Remarks
  • You can call this method from a derived class to enable it to raise the RequestingData event. This may be useful if you plan to extend the FeatureSource and you need access to the event. Details on the event: This event is called before the requesting data by url from wfs server.
Return Value
  • Type:Void
  • Description:None
Parameters
  • requestingDataWfsFeatureSourceEventArgs

OnRequestedData(RequestedDataWfsFeatureSourceEventArgs)

  • N/A
Remarks
  • You can call this method from a derived class to enable it to raise the RequestedData event. This may be useful if you plan to extend the FeatureSource and you need access to the event. Details on the event: This event is called after the requesting data by url from wfs server.
Return Value
  • Type:Void
  • Description:None
Parameters
  • requestedDataWfsFeatureSourceEventArgs

SendWebRequest(WebRequest)

  • N/A
Remarks
  • N/A
Return Value
  • Type:WebResponse
  • Description:N/A
Parameters
  • webRequest
    • Type:WebRequest
    • Description:N/A

SendWebRequestCore(WebRequest)

  • N/A
Remarks
  • N/A
Return Value
  • Type:WebResponse
  • Description:N/A
Parameters
  • webRequest
    • Type:WebRequest
    • Description:N/A

OnSendingWebRequest(SendingWebRequestEventArgs)

  • N/A
Remarks
  • N/A
Return Value
  • Type:Void
  • Description:N/A
Parameters

OnSentWebRequest(SentWebRequestEventArgs)

  • N/A
Remarks
  • N/A
Return Value
  • Type:Void
  • Description:N/A
Parameters

OpenCore()

  • N/A
Remarks
  • This protected virtual method is called from the concrete public method Open. The Open method plays an important role, as it is responsible for initializing the FeatureSource. Most methods on the FeatureSource will throw an exception if the state of the FeatureSource is not opened. When the map draws each layer, it will open the FeatureSource as one of its first steps, then after it is finished drawing with that layer it will close it. In this way we are sure to release all resources used by the FeatureSource. When implementing this virtual method ,consider opening files for file-based sources, connecting to databases in the database-based sources and so on. You will get a chance to close these in the Close method of the FeatureSource.
Return Value
  • Type:Void
  • Description:None
Parameters

CloseCore()

  • N/A
Remarks
  • This protected virtual method is called from the concrete public method Close. The close method plays an important role in the life cycle of the FeatureSource. It may be called after drawing to release any memory and other resources that were allocated since the Open method was called. If you override this method, it is recommended that you take the following things into account: This method may be called multiple times, so we suggest you write the method so that that a call to a closed FeatureSource is ignored and does not generate an error. We also suggest that in the Close you free all resources that have been opened. Remember that the object will not be destroyed, but will be re-opened possibly in the near future.
Return Value
  • Type:Void
  • Description:None
Parameters

GetBoundingBoxCore()

  • N/A
Remarks
  • This protected virtual method is called from the concrete public method GetBoundingBox. It does not take into account any transaction activity, as this is the responsibility of the concrete public method GetBoundingBox. In this way, as a developer, if you choose to override this method you do not have to consider transactions at all. The default implementation of GetBoundingBoxCore uses the GetAllRecordsCore method to calculate the bounding box of the FeatureSource. We strongly recommend that you provide your own implementation for this method that will be more efficient. If you do not override this method, it will get the BoundingBox by calling the GetAllFeatureCore method and deriving it from each feature. This is a very inefficient way to get the BoundingBox in most data sources. It is highly recommended that you override this method and replace it with a highly optimized version. For example, in a ShapeFile the BoundingBox is in the main header of the file. Similarly, if you are using Oracle Spatial, you can execute a simple query to get the BoundingBox of all the records without returning them. In these ways you can greatly improve the performance of this method.
Return Value
  • Description:This method returns the bounding box which encompasses all of the features in the FeatureSource.
Parameters

GetColumnsCore()

  • N/A
Remarks
  • As this is the virtual core version of the Columns method, it is intended to be overridden in inherited version of the class. When overriding, you will be responsible for getting a list of all of the columns supported by the FeatureSource. In this way, the FeatureSource will know what columns are available and will remove any extra columns when making calls to other core methods. For example, if you have a FeatureSource that has three columns of information and the user calls a method that requests four columns of information (something they can do with custom fields), we will first compare what they are asking for to the results of the GetColumnsCore. This way we can strip out custom columns before calling other Core methods, which are only responsible for returning data in the FeatureSource. For more information on custom fields, please see the documentation on OnCustomFieldsFetch.
Return Value
  • Type:Collection<FeatureSourceColumn>
  • Description:This method returns the columns available for the FeatureSource.
Parameters

GetFeaturesByIdsCore(IEnumerable<String>,IEnumerable<String>)

  • N/A
Remarks
  • This method returns a collection of InternalFeatures by providing a group of Ids. The internal implementation calls the GetAllFeaturesCore. Because of this, if you want a more efficient version of this method, then we highly suggest you override the GetFeaturesByIdsCore method and provide a fast way to find a group of InternalFeatures by their Id.
Return Value
  • Type:Collection<Feature>
  • Description:This method returns a collection of InternalFeatures by providing a group of Ids.
Parameters
  • ids
    • Type:IEnumerable<String>
    • Description:This parameter represents the group of Ids which uniquely identified the InternalFeatures in the FeatureSource.
  • 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.

GetFirstFeaturesWellKnownTypeCore()

  • N/A
Remarks
  • This protected virtual method is called from the concrete public method GetFirstFeaturesWellKnownType. It does not take into account any transaction activity, as this is the responsibility of the concrete public method GetFirstFeaturesWellKnownType. This way, as a developer, if you choose to override this method you do not have to consider transactions at all. The default implementation of GetCountCore uses the GetAllRFeaturesCore method to get WellKnownType of the first feature from all features. We strongly recommend that you provide your own implementation for this method that will be more efficient. If you do not override this method, it will get the count by calling the GetAllFeaturesCore method and get WellKnownType of the first feature from all features. This is a very inefficient way to get the count in most data sources. It is highly recommended that you override this method and replace it with a highly optimized version. For example, in a ShapeFile the record count is in the main header of the file. Similarly, if you are using Oracle Spatial, you can execute a simple query to get the count of all of the records without returning them. In these ways you can greatly improve the performance of this method.
Return Value
  • Description:This method returns the well known type that represents the first feature from FeatureSource.
Parameters

GetAllFeaturesCore(IEnumerable<String>)

  • N/A
Remarks
  • This method returns all of the InternalFeatures in the FeatureSource. You will not need to consider anything about pending transactions as this will be handled in the non Core version of the method. The main purpose of this method is to be the anchor of all of our default virtual implementations within this class. We wanted as the framework developers to provide you the user with as much default virtual implementation as possible. To do this we needed a way to get access to all of the features. For example, we want to create a default implementation for finding all of the InternalFeatures in a bounding box. Because this is an abstract class we do not know the specifics of the underlying data or how its spatial indexes work. What we do know is that if we get all the records then we can brute force the answer. In this way if you inherited form this class and only implemented this one method we can provide default implementations for virtually every other API. While this is nice for you the developer if you decide to create your own FeatureSource it comes with a price. The price is that it is very inefficient. In the case we just discussed about finding all of the InternalFeatures in a bounding box we would not want to look at every record to fulfil this method. Instead we would want to override the GetFeaturesInsideBoundingBoxCore and implement specific code that would be fast. For example in Oracle Spatial there is a specific SQL statement to do this operation very quickly. The same holds true with other specific FeatureSource examples. Most default implementations in the FeatureSource call the GetFeaturesInsideBoundingBoxCore which by default calls the GetAllFeaturesCore. It is our advice that if you create your own FeatureSource that you ALWAYS override the GetFeatureInsideBoundingBox. It will ensure that nearly every other API will operate efficiently. Please see the specific API to determine what method it uses.
Return Value
  • Type:Collection<Feature>
  • Description:The return decimalDegreesValue 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.

GetFeaturesInsideBoundingBoxCore(RectangleShape,IEnumerable<String>)

  • N/A
Remarks
  • This method returns all of the InternalFeatures of this FeatureSource that are inside of the specified bounding box. If you are overriding this method you will not need to consider anything about transactions, as this is handled by the concrete version of this method. The default implementation of GetFeaturesInsideBoundingBoxCore uses the GetAllRecordsCore method to determine which InternalFeatures are inside of the bounding box. We strongly recommend that you provide your own implementation for this method that will be more efficient. That is especially important for this method, as many other default virtual methods use this for their calculations. When you override this method, we highly recommend that you use any spatial indexes you have at your disposal to make this method as fast as possible.
Return Value
  • Type:Collection<Feature>
  • Description:The returned decimalDegreesValue is a collection of all of the InternalFeatures that are inside of the bounding box.
Parameters
  • boundingBox
    • Description:This parameter represents the bounding box that you wish to find InternalFeatures inside of.
  • returningColumnNames
    • Type:IEnumerable<String>
    • Description:This parameter allows you to select the field names of the column data that you wish to return with each Feature.

GetFeaturesByColumnValueCore(String,String,IEnumerable<String>)

  • N/A
Remarks
  • N/A
Return Value
  • Type:Collection<Feature>
  • Description:N/A
Parameters
  • columnName
    • Type:String
    • Description:N/A
  • columnValue
    • Type:String
    • Description:N/A
  • returningColumnNames
    • Type:IEnumerable<String>
    • Description:N/A

CanGetCountQuicklyCore()

  • N/A
Remarks
  • N/A
Return Value
  • Type:Boolean
  • Description:N/A
Parameters

GetDistinctColumnValuesCore(String)

  • N/A
Remarks
  • N/A
Return Value
Parameters
  • columnName
    • Type:String
    • Description:N/A

GetAllFeaturesCore(IEnumerable<String>,Int32,Int32)

  • N/A
Remarks
  • N/A
Return Value
  • Type:Collection<Feature>
  • Description:N/A
Parameters
  • returningColumnNames
    • Type:IEnumerable<String>
    • Description:N/A
  • startIndex
    • Type:Int32
    • Description:N/A
  • takeCount
    • Type:Int32
    • Description:N/A

CommitTransactionCore(TransactionBuffer)

  • N/A
Remarks
  • N/A
Return Value
Parameters

RaiseCustomColumnFetchEvent(Collection<Feature>,Collection<String>)

  • N/A
Remarks
  • N/A
Return Value
  • Type:Collection<Feature>
  • Description:N/A
Parameters
  • sourceFeatures
    • Type:Collection<Feature>
    • Description:N/A
  • fieldNamesOutsideOfSource
    • Type:Collection<String>
    • Description:N/A

GetFeaturesOutsideBoundingBoxCore(RectangleShape,IEnumerable<String>)

  • N/A
Remarks
  • N/A
Return Value
  • Type:Collection<Feature>
  • Description:N/A
Parameters
  • returningColumnNames
    • Type:IEnumerable<String>
    • Description:N/A

GetFeatureIdsInsideBoundingBoxCore(RectangleShape)

  • N/A
Remarks
  • N/A
Return Value
  • Type:Collection<String>
  • Description:N/A
Parameters

ConvertToExternalProjectionIfNecessary(Collection<Feature>)

  • N/A
Remarks
  • N/A
Return Value
  • Type:Collection<Feature>
  • Description:N/A
Parameters
  • returnFeatures
    • Type:Collection<Feature>
    • Description:N/A

GetFeaturesForDrawingCore(RectangleShape,Double,Double,IEnumerable<String>)

  • N/A
Remarks
  • N/A
Return Value
  • Type:Collection<Feature>
  • Description:N/A
Parameters
  • screenWidth
    • Type:Double
    • Description:N/A
  • screenHeight
    • Type:Double
    • Description:N/A
  • returningColumnNames
    • Type:IEnumerable<String>
    • Description:N/A

SpatialQueryCore(BaseShape,QueryType,IEnumerable<String>)

  • N/A
Remarks
  • N/A
Return Value
  • Type:Collection<Feature>
  • Description:N/A
Parameters
  • returningColumnNames
    • Type:IEnumerable<String>
    • Description:N/A

GetFeaturesNearestToCore(BaseShape,GeographyUnit,Int32,IEnumerable<String>)

  • N/A
Remarks
  • N/A
Return Value
  • Type:Collection<Feature>
  • Description:N/A
Parameters
  • maxItemsToFind
    • Type:Int32
    • Description:N/A
  • returningColumnNames
    • Type:IEnumerable<String>
    • Description:N/A

GetFeaturesWithinDistanceOfCore(BaseShape,GeographyUnit,DistanceUnit,Double,IEnumerable<String>)

  • N/A
Remarks
  • N/A
Return Value
  • Type:Collection<Feature>
  • Description:N/A
Parameters
  • distance
    • Type:Double
    • Description:N/A
  • returningColumnNames
    • Type:IEnumerable<String>
    • Description:N/A

GetBoundingBoxByIdCore(String)

  • N/A
Remarks
  • N/A
Return Value
Parameters
  • id
    • Type:String
    • Description:N/A

ConvertToExternalProjection(IEnumerable<RectangleShape>)

  • N/A
Remarks
  • N/A
Return Value
Parameters

ConvertToInternalProjection(IEnumerable<RectangleShape>)

  • N/A
Remarks
  • N/A
Return Value
Parameters

ConvertToExternalProjection(RectangleShape)

  • N/A
Remarks
  • N/A
Return Value
Parameters

ConvertToInternalProjection(RectangleShape)

  • N/A
Remarks
  • N/A
Return Value
Parameters

ConvertToInternalProjection(BaseShape)

  • N/A
Remarks
  • N/A
Return Value
Parameters

ConvertToExternalProjection(IEnumerable<Feature>)

  • N/A
Remarks
  • N/A
Return Value
  • Type:Collection<Feature>
  • Description:N/A
Parameters
  • features
    • Type:IEnumerable<Feature>
    • Description:N/A

ConvertToInternalProjection(IEnumerable<Feature>)

  • N/A
Remarks
  • N/A
Return Value
  • Type:Collection<Feature>
  • Description:N/A
Parameters
  • features
    • Type:IEnumerable<Feature>
    • Description:N/A

ConvertToExternalProjection(Feature)

  • N/A
Remarks
  • N/A
Return Value
Parameters
  • feature

ConvertToInternalProjection(Feature)

  • N/A
Remarks
  • N/A
Return Value
Parameters
  • feature

GetColumnNamesInsideFeatureSource(IEnumerable<String>)

  • N/A
Remarks
  • N/A
Return Value
  • Type:Collection<String>
  • Description:N/A
Parameters
  • returningColumnNames
    • Type:IEnumerable<String>
    • Description:N/A

GetReturningColumnNames(ReturningColumnsType)

  • N/A
Remarks
  • N/A
Return Value
  • Type:Collection<String>
  • Description:N/A
Parameters

OnDrawingProgressChanged(DrawingProgressChangedEventArgs)

  • N/A
Remarks
  • N/A
Return Value
  • Type:Void
  • Description:N/A
Parameters

GetColumnNamesOutsideFeatureSourceCall(IEnumerable<String>)

  • N/A
Remarks
  • N/A
Return Value
  • Type:Collection<String>
  • Description:N/A
Parameters
  • returningColumnNames
    • Type:IEnumerable<String>
    • Description:N/A

OnGettingColumns(GettingColumnsFeatureSourceEventArgs)

  • N/A
Remarks
  • N/A
Return Value
  • Type:Void
  • Description:N/A
Parameters

OnGottenColumns(GottenColumnsFeatureSourceEventArgs)

  • N/A
Remarks
  • N/A
Return Value
  • Type:Void
  • Description:N/A
Parameters

OnCustomColumnFetch(CustomColumnFetchEventArgs)

  • N/A
Remarks
  • N/A
Return Value
  • Type:Void
  • Description:N/A
Parameters

OnCommittingTransaction(CommittingTransactionEventArgs)

  • N/A
Remarks
  • N/A
Return Value
  • Type:Void
  • Description:N/A
Parameters

OnCommittedTransaction(CommittedTransactionEventArgs)

  • N/A
Remarks
  • N/A
Return Value
  • Type:Void
  • Description:N/A
Parameters

OnOpeningFeatureSource(OpeningFeatureSourceEventArgs)

  • N/A
Remarks
  • N/A
Return Value
  • Type:Void
  • Description:N/A
Parameters

OnOpenedFeatureSource(OpenedFeatureSourceEventArgs)

  • N/A
Remarks
  • N/A
Return Value
  • Type:Void
  • Description:N/A
Parameters

OnClosingFeatureSource(ClosingFeatureSourceEventArgs)

  • N/A
Remarks
  • N/A
Return Value
  • Type:Void
  • Description:N/A
Parameters

OnClosedFeatureSource(ClosedFeatureSourceEventArgs)

  • N/A
Remarks
  • N/A
Return Value
  • Type:Void
  • Description:N/A
Parameters

OnGettingFeaturesByIds(GettingFeaturesByIdsFeatureSourceEventArgs)

  • N/A
Remarks
  • N/A
Return Value
  • Type:Void
  • Description:N/A
Parameters

OnGettingFeaturesForDrawing(GettingFeaturesForDrawingFeatureSourceEventArgs)

  • N/A
Remarks
  • N/A
Return Value
  • Type:Void
  • Description:N/A
Parameters

ExecuteNonQueryCore(String)

  • N/A
Remarks
  • N/A
Return Value
  • Type:Int32
  • Description:N/A
Parameters
  • sqlStatement
    • Type:String
    • Description:N/A

ExecuteScalarCore(String)

  • N/A
Remarks
  • N/A
Return Value
  • Type:Object
  • Description:N/A
Parameters
  • sqlStatement
    • Type:String
    • Description:N/A

ExecuteQueryCore(String)

  • N/A
Remarks
  • N/A
Return Value
Parameters
  • sqlStatement
    • Type:String
    • Description:N/A

GetCountCore()

  • N/A
Remarks
  • N/A
Return Value
  • Type:Int32
  • Description:N/A
Parameters

CloneDeepCore()

  • N/A
Remarks
  • N/A
Return Value
Parameters

Finalize()

  • N/A
Remarks
  • N/A
Return Value
  • Type:Void
  • Description:N/A
Parameters

MemberwiseClone()

  • N/A
Remarks
  • N/A
Return Value
  • Type:Object
  • Description:N/A
Parameters

Public Properties

ServiceLocationUrl

  • N/A
Remarks
  • N/A
Return Value
  • Type:String

WfsNamespace

  • N/A
Remarks
  • N/A
Return Value

TypeName

  • N/A
Remarks
  • N/A
Return Value
  • Type:String

LastXmlResponse

  • N/A
Remarks
  • N/A
Return Value
  • Type:String

TimeoutInSeconds

  • N/A
Remarks
  • N/A
Return Value
  • Type:Int32

WebProxy

  • N/A
Remarks
  • N/A
Return Value
  • Type:IWebProxy

Id

  • N/A
Remarks
  • N/A
Return Value
  • Type:String

CanExecuteSqlQuery

  • N/A
Remarks
  • N/A
Return Value
  • Type:Boolean

IsOpen

  • N/A
Remarks
  • N/A
Return Value
  • Type:Boolean

CanModifyColumnStructure

  • N/A
Remarks
  • N/A
Return Value
  • Type:Boolean

IsInTransaction

  • N/A
Remarks
  • N/A
Return Value
  • Type:Boolean

IsTransactionLive

  • N/A
Remarks
  • N/A
Return Value
  • Type:Boolean

IsEditable

  • N/A
Remarks
  • N/A
Return Value
  • Type:Boolean

Projection

  • N/A
Remarks
  • N/A
Return Value

GeoCache

  • N/A
Remarks
  • N/A
Return Value

FeatureIdsToExclude

  • N/A
Remarks
  • N/A
Return Value
  • Type:Collection<String>

TransactionBuffer

  • N/A
Remarks
  • N/A
Return Value

MaxRecordsToDraw

  • N/A
Remarks
  • N/A
Return Value
  • Type:Int32

GeometryValidationMode

  • N/A
Remarks
  • N/A
Return Value

Protected Properties

CanExecuteSqlQueryCore

  • N/A
Remarks
  • N/A
Return Value
  • Type:Boolean

IsOpenCore

  • N/A
Remarks
  • N/A
Return Value
  • Type:Boolean

CanModifyColumnStructureCore

  • N/A
Remarks
  • N/A
Return Value
  • Type:Boolean

FeatureSourceColumns

  • N/A
Remarks
  • N/A
Return Value

Public Events

SendingWebRequest

  • N/A
Remarks
  • N/A

Event Arguments:SendingWebRequestEventArgs

SentWebRequest

  • N/A
Remarks
  • N/A

Event Arguments:SentWebRequestEventArgs

RequestingData

  • N/A
Remarks
  • This event is called before the requesting data by url from wfs server.

Event Arguments:RequestingDataWfsFeatureSourceEventArgs

RequestedData

  • N/A
Remarks
  • This event is called after the requesting data by url from wfs server.

Event Arguments:RequestedDataWfsFeatureSourceEventArgs

DrawingProgressChanged

  • N/A
Remarks
  • N/A

Event Arguments:DrawingProgressChangedEventArgs

GettingColumns

  • N/A
Remarks
  • N/A

Event Arguments:GettingColumnsFeatureSourceEventArgs

GottenColumns

  • N/A
Remarks
  • N/A

Event Arguments:GottenColumnsFeatureSourceEventArgs

GettingFeaturesByIds

  • N/A
Remarks
  • N/A

Event Arguments:GettingFeaturesByIdsFeatureSourceEventArgs

GettingFeaturesForDrawing

  • N/A
Remarks
  • N/A

Event Arguments:GettingFeaturesForDrawingFeatureSourceEventArgs

CustomColumnFetch

  • N/A
Remarks
  • N/A

Event Arguments:CustomColumnFetchEventArgs

CommittingTransaction

  • N/A
Remarks
  • N/A

Event Arguments:CommittingTransactionEventArgs

CommittedTransaction

  • N/A
Remarks
  • N/A

Event Arguments:CommittedTransactionEventArgs

OpeningFeatureSource

  • N/A
Remarks
  • N/A

Event Arguments:OpeningFeatureSourceEventArgs

OpenedFeatureSource

  • N/A
Remarks
  • N/A

Event Arguments:OpenedFeatureSourceEventArgs

ClosingFeatureSource

  • N/A
Remarks
  • N/A

Event Arguments:ClosingFeatureSourceEventArgs

ClosedFeatureSource

  • N/A
Remarks
  • N/A

Event Arguments:ClosedFeatureSourceEventArgs

api/thinkgeo.mapsuite.layers.wfsfeaturesource.txt · Last modified: 2017/01/11 06:53 (external edit)