[mapguide-commits] r7664 - in trunk/Tools/Maestro/OSGeo.MapGuide.MaestroAPI: Mapping Services
svn_mapguide at osgeo.org
svn_mapguide at osgeo.org
Sat Jul 6 09:46:47 PDT 2013
Author: jng
Date: 2013-07-06 09:46:47 -0700 (Sat, 06 Jul 2013)
New Revision: 7664
Modified:
trunk/Tools/Maestro/OSGeo.MapGuide.MaestroAPI/Mapping/RuntimeMap.cs
trunk/Tools/Maestro/OSGeo.MapGuide.MaestroAPI/Services/IFeatureService.cs
trunk/Tools/Maestro/OSGeo.MapGuide.MaestroAPI/Services/IMappingService.cs
trunk/Tools/Maestro/OSGeo.MapGuide.MaestroAPI/Services/IResourceService.cs
trunk/Tools/Maestro/OSGeo.MapGuide.MaestroAPI/Services/ITileService.cs
Log:
#1319: API doc cleanup
Modified: trunk/Tools/Maestro/OSGeo.MapGuide.MaestroAPI/Mapping/RuntimeMap.cs
===================================================================
--- trunk/Tools/Maestro/OSGeo.MapGuide.MaestroAPI/Mapping/RuntimeMap.cs 2013-07-04 15:23:22 UTC (rev 7663)
+++ trunk/Tools/Maestro/OSGeo.MapGuide.MaestroAPI/Mapping/RuntimeMap.cs 2013-07-06 16:46:47 UTC (rev 7664)
@@ -1621,7 +1621,7 @@
/// <param name="selection"></param>
/// <param name="format"></param>
/// <param name="selectionColor"></param>
- /// <param name="behaviour"></param>
+ /// <param name="behaviour">A bitmask for the rendering behaviour (1 = Render Selection, 2 = Render Layers, 4 = Keep Selection, 8 = Render Base Layers)</param>
/// <returns></returns>
public System.IO.Stream RenderDynamicOverlay(MapSelection selection, string format, Color selectionColor, int behaviour)
{
Modified: trunk/Tools/Maestro/OSGeo.MapGuide.MaestroAPI/Services/IFeatureService.cs
===================================================================
--- trunk/Tools/Maestro/OSGeo.MapGuide.MaestroAPI/Services/IFeatureService.cs 2013-07-04 15:23:22 UTC (rev 7663)
+++ trunk/Tools/Maestro/OSGeo.MapGuide.MaestroAPI/Services/IFeatureService.cs 2013-07-06 16:46:47 UTC (rev 7664)
@@ -93,112 +93,116 @@
/// <summary>
/// Executes a SQL query
/// </summary>
- /// <param name="featureSourceID"></param>
- /// <param name="sql"></param>
- /// <returns></returns>
+ /// <remarks>
+ /// No validation is done on the SQL query string. The calling application should validate the SQL string to ensure
+ /// that it does not contain any malicious operations.
+ /// </remarks>
+ /// <param name="featureSourceID">The Feature Source ID</param>
+ /// <param name="sql">The SQL query string</param>
+ /// <returns>A <see cref="T:OSGeo.MapGuide.MaestroAPI.Feature.IReader"/> containing the results of the query</returns>
IReader ExecuteSqlQuery(string featureSourceID, string sql);
/// <summary>
/// Executes a feature query on the specified feature source
/// </summary>
- /// <param name="resourceID"></param>
- /// <param name="className"></param>
- /// <param name="filter"></param>
- /// <returns></returns>
+ /// <param name="resourceID">The Feature Source ID</param>
+ /// <param name="className">The feature class name</param>
+ /// <param name="filter">The FDO filter string that determines what features will be returned</param>
+ /// <returns>A <see cref="T:OSGeo.MapGuide.MaestroAPI.Feature.IFeatureReader"/> containing the results of the query</returns>
IFeatureReader QueryFeatureSource(string resourceID, string className, string filter);
/// <summary>
/// Executes a feature query on the specified feature source
/// </summary>
- /// <param name="resourceID"></param>
- /// <param name="className"></param>
- /// <returns></returns>
+ /// <param name="resourceID">The Feature Source ID</param>
+ /// <param name="className">The feature class name</param>
+ /// <returns>A <see cref="T:OSGeo.MapGuide.MaestroAPI.Feature.IFeatureReader"/> containing the results of the query</returns>
IFeatureReader QueryFeatureSource(string resourceID, string className);
/// <summary>
/// Executes a feature query on the specified feature source
/// </summary>
- /// <param name="resourceID"></param>
- /// <param name="className"></param>
- /// <param name="filter"></param>
- /// <param name="propertyNames"></param>
- /// <returns></returns>
+ /// <param name="resourceID">The Feature Source ID</param>
+ /// <param name="className">The feature class name</param>
+ /// <param name="filter">The FDO filter string that determines what features will be returned</param>
+ /// <param name="propertyNames">A list of properties that are to be returned in the query result</param>
+ /// <returns>A <see cref="T:OSGeo.MapGuide.MaestroAPI.Feature.IFeatureReader"/> containing the results of the query</returns>
IFeatureReader QueryFeatureSource(string resourceID, string className, string filter, string[] propertyNames);
/// <summary>
/// Executes a feature query on the specified feature source
/// </summary>
- /// <param name="resourceID"></param>
- /// <param name="schema"></param>
- /// <param name="query"></param>
- /// <param name="columns"></param>
- /// <param name="computedProperties"></param>
- /// <returns></returns>
- IFeatureReader QueryFeatureSource(string resourceID, string schema, string query, string[] columns, NameValueCollection computedProperties);
+ /// <param name="resourceID">The Feature Source ID</param>
+ /// <param name="className">The feature class name</param>
+ /// <param name="filter">The FDO filter string that determines what features will be returned</param>
+ /// <param name="propertyNames">A list of properties that are to be returned in the query result</param>
+ /// <param name="computedProperties">A list of name/value pairs that contain the alias (name) for an FDO expression (value)</param>
+ /// <returns>A <see cref="T:OSGeo.MapGuide.MaestroAPI.Feature.IFeatureReader"/> containing the results of the query</returns>
+ IFeatureReader QueryFeatureSource(string resourceID, string className, string filter, string[] propertyNames, NameValueCollection computedProperties);
/// <summary>
/// Executes an aggregate query on the specified feature source
/// </summary>
- /// <param name="resourceID"></param>
- /// <param name="schema"></param>
- /// <param name="filter"></param>
- /// <returns></returns>
- IReader AggregateQueryFeatureSource(string resourceID, string schema, string filter);
+ /// <param name="resourceID">The Feature Source ID</param>
+ /// <param name="className">The feature class name</param>
+ /// <param name="filter">The FDO filter string that determines what features will be returned</param>
+ /// <returns>A <see cref="T:OSGeo.MapGuide.MaestroAPI.Feature.IReader"/> containing the results of the query</returns>
+ IReader AggregateQueryFeatureSource(string resourceID, string className, string filter);
/// <summary>
/// Executes an aggregate query on the specified feature source
/// </summary>
- /// <param name="resourceID"></param>
- /// <param name="schema"></param>
- /// <param name="filter"></param>
- /// <param name="columns"></param>
- /// <returns></returns>
- IReader AggregateQueryFeatureSource(string resourceID, string schema, string filter, string[] columns);
+ /// <param name="resourceID">The Feature Source ID</param>
+ /// <param name="className">The feature class name</param>
+ /// <param name="filter">The FDO filter string that determines what features will be returned</param>
+ /// <param name="propertyNames">An array of property names to include in the result</param>
+ /// <returns>A <see cref="T:OSGeo.MapGuide.MaestroAPI.Feature.IReader"/> containing the results of the query</returns>
+ IReader AggregateQueryFeatureSource(string resourceID, string className, string filter, string[] propertyNames);
/// <summary>
/// Executes an aggregate query on the specified feature source
/// </summary>
- /// <param name="resourceID"></param>
- /// <param name="schema"></param>
- /// <param name="filter"></param>
- /// <param name="aggregateFunctions"></param>
- /// <returns></returns>
- IReader AggregateQueryFeatureSource(string resourceID, string schema, string filter, NameValueCollection aggregateFunctions);
+ /// <param name="resourceID">The Feature Source ID</param>
+ /// <param name="className">The feature class name</param>
+ /// <param name="filter">The FDO filter string that determines what features will be returned</param>
+ /// <param name="aggregateFunctions">A list of name/value pairs that contain the alias (name) for an FDO aggregate expression (value)</param>
+ /// <returns>A <see cref="T:OSGeo.MapGuide.MaestroAPI.Feature.IReader"/> containing the results of the query</returns>
+ IReader AggregateQueryFeatureSource(string resourceID, string className, string filter, NameValueCollection aggregateFunctions);
/// <summary>
/// Gets the geometric extent of the specified feature source
/// </summary>
- /// <param name="resourceID"></param>
- /// <param name="schema"></param>
- /// <param name="geometry"></param>
+ /// <param name="resourceID">The Feature Source ID</param>
+ /// <param name="className">The feature class name</param>
+ /// <param name="geometryPropertyName">The geometry property to get the geometric extent of</param>
/// <returns></returns>
- ObjCommon.IEnvelope GetSpatialExtent(string resourceID, string schema, string geometry);
+ ObjCommon.IEnvelope GetSpatialExtent(string resourceID, string className, string geometryPropertyName);
/// <summary>
/// Gets the geometric extent of the specified feature source
/// </summary>
- /// <param name="resourceID"></param>
- /// <param name="schema"></param>
- /// <param name="geometry"></param>
- /// <param name="filter"></param>
+ /// <param name="resourceID">The Feature Source ID</param>
+ /// <param name="className">The feature class name</param>
+ /// <param name="geometryPropertyName">The geometry property to get the geometric extent of</param>
+ /// <param name="filter">The FDO filter string that determines what features will be returned</param>
/// <returns></returns>
- ObjCommon.IEnvelope GetSpatialExtent(string resourceID, string schema, string geometry, string filter);
+ ObjCommon.IEnvelope GetSpatialExtent(string resourceID, string className, string geometryPropertyName, string filter);
/// <summary>
/// Gets the geometric extent of the specified feature source
/// </summary>
- /// <param name="resourceID"></param>
- /// <param name="schema"></param>
- /// <param name="geometry"></param>
- /// <param name="allowFallbackToContextInformation"></param>
+ /// <param name="resourceID">The Feature Source ID</param>
+ /// <param name="className">The feature class name</param>
+ /// <param name="geometryPropertyName">The geometry property to get the geometric extent of</param>
+ /// <param name="allowFallbackToContextInformation">If true, the geometric extent of the feature class's spatial context will be used in the event that computing the extents fails</param>
/// <exception cref="T:OSGeo.MapGuide.MaestroAPI.Exceptions.NullExtentException">Thrown if the geometric extent is null</exception>
/// <returns></returns>
- ObjCommon.IEnvelope GetSpatialExtent(string resourceID, string schema, string geometry, bool allowFallbackToContextInformation);
+ ObjCommon.IEnvelope GetSpatialExtent(string resourceID, string className, string geometryPropertyName, bool allowFallbackToContextInformation);
/// <summary>
/// Describes the specified feature source
/// </summary>
- /// <param name="resourceID"></param>
+ /// <param name="resourceID">The Feature Source ID</param>
/// <remarks>
/// If you only need to list schemas and class names, use the respective <see cref="M:OSGeo.MapGuide.MaestroAPI.Services.IFeatureService.GetSchemas" /> and
/// <see cref="M:OSGeo.MapGuide.MaestroAPI.Services.IFeatureService.GetClassNames" /> methods. Using this API will have a noticeable performance impact on
@@ -210,8 +214,8 @@
/// <summary>
/// Describes the specified feature source
/// </summary>
- /// <param name="resourceID"></param>
- /// <param name="schema"></param>
+ /// <param name="resourceID">The Feature Source ID</param>
+ /// <param name="schema">The name of the schema to describe</param>
/// <remarks>
/// If you only need to list schemas and class names, use the respective <see cref="M:OSGeo.MapGuide.MaestroAPI.Services.IFeatureService.GetSchemas" /> and
/// <see cref="M:OSGeo.MapGuide.MaestroAPI.Services.IFeatureService.GetClassNames" /> methods. Using this API will have a noticeable performance impact on
@@ -237,7 +241,7 @@
/// <summary>
/// Gets the specified class definition
/// </summary>
- /// <param name="resourceID"></param>
+ /// <param name="resourceID">The Feature Source ID</param>
/// <param name="className">The feature class name. You can pass a qualified class name to be explicit about which class definition you are after</param>
/// <returns></returns>
ClassDefinition GetClassDefinition(string resourceID, string className);
@@ -245,15 +249,15 @@
/// <summary>
/// Get the spatial context information for the specified feature source
/// </summary>
- /// <param name="resourceID"></param>
- /// <param name="activeOnly"></param>
+ /// <param name="resourceID">The Feature Source ID</param>
+ /// <param name="activeOnly">If true, will only return the active spatial context</param>
/// <returns></returns>
ObjCommon.FdoSpatialContextList GetSpatialContextInfo(string resourceID, bool activeOnly);
/// <summary>
/// Gets the names of the identity properties from a feature
/// </summary>
- /// <param name="resourceID">The resourceID for the FeatureSource</param>
+ /// <param name="resourceID">The Feature Source ID</param>
/// <param name="classname">The classname of the feature, including schema</param>
/// <returns>A string array with the found identities</returns>
string[] GetIdentityProperties(string resourceID, string classname);
@@ -261,36 +265,36 @@
/// <summary>
/// Enumerates all the data stores and if they are FDO enabled for the specified provider and partial connection string
/// </summary>
- /// <param name="providerName"></param>
- /// <param name="partialConnString"></param>
+ /// <param name="providerName">The FDO provider name</param>
+ /// <param name="partialConnString">The partial connection string. Certain providers require a partial conection string in order to be able to enumerate data stores</param>
/// <returns></returns>
OSGeo.MapGuide.ObjectModels.Common.DataStoreList EnumerateDataStores(string providerName, string partialConnString);
/// <summary>
/// Gets an array of schema names from the specified feature source
/// </summary>
- /// <param name="resourceId"></param>
+ /// <param name="resourceID">The Feature Source ID</param>
/// <returns></returns>
- string[] GetSchemas(string resourceId);
+ string[] GetSchemas(string resourceID);
/// <summary>
/// Gets an array of qualified feature class names from the specified feature source
/// </summary>
- /// <param name="resourceId">The feature source id</param>
+ /// <param name="resourceID">The feature source id</param>
/// <param name="schemaName">
/// The name of the schema whose class names are to be returned. If null, class names from all schemas in the feature source
/// are returned
/// </param>
/// <returns></returns>
- string[] GetClassNames(string resourceId, string schemaName);
+ string[] GetClassNames(string resourceID, string schemaName);
/// <summary>
/// Gets the long transactions for the specified feature source
/// </summary>
- /// <param name="resourceId">The feature source id</param>
+ /// <param name="resourceID">The Feature Source ID</param>
/// <param name="activeOnly">If true, will only return active long transactions</param>
/// <returns></returns>
- ILongTransactionList GetLongTransactions(string resourceId, bool activeOnly);
+ ILongTransactionList GetLongTransactions(string resourceID, bool activeOnly);
/// <summary>
/// Gets the schema mappings for the given FDO provider. These mappings form the basis for a custom configuration document
Modified: trunk/Tools/Maestro/OSGeo.MapGuide.MaestroAPI/Services/IMappingService.cs
===================================================================
--- trunk/Tools/Maestro/OSGeo.MapGuide.MaestroAPI/Services/IMappingService.cs 2013-07-04 15:23:22 UTC (rev 7663)
+++ trunk/Tools/Maestro/OSGeo.MapGuide.MaestroAPI/Services/IMappingService.cs 2013-07-06 16:46:47 UTC (rev 7664)
@@ -94,6 +94,25 @@
/// <summary>
/// Creates a new runtime map instance from an existing map definition.
/// </summary>
+ /// <remarks>
+ /// Calculation of meters-per-unit may differ between implementations. This may have an adverse
+ /// effect on things such as rendering and measuring depending on the underlying implementation
+ ///
+ /// If you are certain of the meters-per-unit value required, use the overloaded method that
+ /// accepts a metersPerUnit parameter.
+ /// </remarks>
+ /// <example>
+ /// This example shows how to create a new runtime map instance
+ /// <code>
+ /// <![CDATA[
+ /// IServerConnection conn;
+ /// ...
+ /// IMappingService mappingSvc = (IMappingService)conn.GetService((int)ServiceType.Mapping);
+ /// IMapDefinition mapDef = (IMapDefinition)conn.ResourceService.GetResource("Library://Path/To/My.MapDefinition");
+ /// RuntimeMap map = mappingSvc.CreateMap(mapDef);
+ /// ]]>
+ /// </code>
+ /// </example>
/// <param name="mapDef"></param>
/// <returns></returns>
RuntimeMap CreateMap(IMapDefinition mapDef);
@@ -102,6 +121,19 @@
/// Creates a new runtime map instance from an existing map definition. Meters per unit
/// is calculated from the Coordinate System WKT of the map definition.
/// </summary>
+ /// <example>
+ /// This example shows how to create a new runtime map instance
+ /// <code>
+ /// <![CDATA[
+ /// IServerConnection conn;
+ /// ...
+ /// IMappingService mappingSvc = (IMappingService)conn.GetService((int)ServiceType.Mapping);
+ /// IMapDefinition mapDef = (IMapDefinition)conn.ResourceService.GetResource("Library://Path/To/My.MapDefinition");
+ /// double metersPerUnit = 1.0;
+ /// RuntimeMap map = mappingSvc.CreateMap(mapDef, metersPerUnit);
+ /// ]]>
+ /// </code>
+ /// </example>
/// <param name="mapDef"></param>
/// <param name="metersPerUnit"></param>
/// <returns></returns>
@@ -118,6 +150,20 @@
/// If you are certain of the meters-per-unit value required, use the overloaded method that
/// accepts a metersPerUnit parameter.
/// </remarks>
+ /// <example>
+ /// This example shows how to create a new runtime map instance
+ /// <code>
+ /// <![CDATA[
+ /// IServerConnection conn;
+ /// ...
+ /// IMappingService mappingSvc = (IMappingService)conn.GetService((int)ServiceType.Mapping);
+ /// string mapName = "MyMap";
+ /// string rtMapId = "Session:" + conn.SessionID + "//" + mapName + ".Map";
+ /// string baseMapDefId = "Library://Path/To/My.MapDefinition";
+ /// RuntimeMap map = mappingSvc.CreateMap(rtMapId, baseMapDefId);
+ /// ]]>
+ /// </code>
+ /// </example>
/// <param name="runtimeMapResourceId"></param>
/// <param name="baseMapDefinitionId"></param>
/// <returns></returns>
@@ -126,6 +172,21 @@
/// <summary>
/// Creates a new runtime map instance from an existing map definition
/// </summary>
+ /// <example>
+ /// This example shows how to create a new runtime map instance
+ /// <code>
+ /// <![CDATA[
+ /// IServerConnection conn;
+ /// ...
+ /// IMappingService mappingSvc = (IMappingService)conn.GetService((int)ServiceType.Mapping);
+ /// string mapName = "MyMap";
+ /// string rtMapId = "Session:" + conn.SessionID + "//" + mapName + ".Map";
+ /// string baseMapDefId = "Library://Path/To/My.MapDefinition";
+ /// double metersPerUnit = 1.0;
+ /// RuntimeMap map = mappingSvc.CreateMap(rtMapId, baseMapDefId);
+ /// ]]>
+ /// </code>
+ /// </example>
/// <param name="runtimeMapResourceId"></param>
/// <param name="baseMapDefinitionId"></param>
/// <param name="metersPerUnit"></param>
@@ -143,6 +204,20 @@
/// If you are certain of the meters-per-unit value required, use the overloaded method that
/// accepts a metersPerUnit parameter.
/// </remarks>
+ /// <example>
+ /// This example shows how to create a new runtime map instance
+ /// <code>
+ /// <![CDATA[
+ /// IServerConnection conn;
+ /// ...
+ /// IMappingService mappingSvc = (IMappingService)conn.GetService((int)ServiceType.Mapping);
+ /// string mapName = "MyMap";
+ /// string rtMapId = "Session:" + conn.SessionID + "//" + mapName + ".Map";
+ /// IMapDefinition mdf = (IMapDefinition)conn.ResourceService.GetResource("Library://Path/To/My.MapDefinition");
+ /// RuntimeMap map = mappingSvc.CreateMap(rtMapId, mdf);
+ /// ]]>
+ /// </code>
+ /// </example>
/// <param name="runtimeMapResourceId"></param>
/// <param name="mdf"></param>
/// <returns></returns>
@@ -151,6 +226,21 @@
/// <summary>
/// Creates a new runtime map instance from an existing map definition
/// </summary>
+ /// <example>
+ /// This example shows how to create a new runtime map instance
+ /// <code>
+ /// <![CDATA[
+ /// IServerConnection conn;
+ /// ...
+ /// IMappingService mappingSvc = (IMappingService)conn.GetService((int)ServiceType.Mapping);
+ /// double metersPerUnit = 1.0;
+ /// string mapName = "MyMap";
+ /// string rtMapId = "Session:" + conn.SessionID + "//" + mapName + ".Map";
+ /// IMapDefinition mdf = (IMapDefinition)conn.ResourceService.GetResource("Library://Path/To/My.MapDefinition");
+ /// RuntimeMap map = mappingSvc.CreateMap(rtMapId, mdf, metersPerUnit);
+ /// ]]>
+ /// </code>
+ /// </example>
/// <param name="runtimeMapResourceId"></param>
/// <param name="mdf"></param>
/// <param name="metersPerUnit"></param>
@@ -160,6 +250,19 @@
/// <summary>
/// Opens an existing runtime map instance
/// </summary>
+ /// <example>
+ /// This example shows how to open a RuntimeMap instance from a resource id
+ /// <code>
+ /// <![CDATA[
+ /// IServerConnection conn;
+ /// ...
+ /// IMappingService mappingSvc = (IMappingService)conn.GetService((int)ServiceType.Mapping);
+ /// string mapName = "MyMap";
+ /// string rtMapId = "Session:" + conn.SessionID + "//" + mapName + ".Map";
+ /// RuntimeMap map = mappingSvc.OpenMap(rtMapId);
+ /// ]]>
+ /// </code>
+ /// </example>
/// <param name="runtimeMapResourceId"></param>
/// <returns></returns>
RuntimeMap OpenMap(string runtimeMapResourceId);
@@ -188,15 +291,38 @@
/// <summary>
/// Renders a dynamic overlay image of the map
/// </summary>
+ /// <remarks>
+ /// The render base layers bitmask behaviour (8) is only supported from MapGuide Open Source 2.5 onwards
+ /// </remarks>
+ /// <example>
+ /// This example shows how to create a render a dynamic overlay image from a map and load it into a System.Drawing.Image
+ /// <code>
+ /// <![CDATA[
+ /// IServerConnection conn;
+ /// ...
+ /// IMappingService mappingSvc = (IMappingService)conn.GetService((int)ServiceType.Mapping);
+ /// string mapName = "MyMap";
+ /// string rtMapId = "Session:" + conn.SessionID + "//" + mapName + ".Map";
+ /// RuntimeMap map = mappingSvc.OpenMap(rtMapId);
+ /// string format = "PNG";
+ /// Color selectionColor = Color.Blue;
+ /// int behaviour = 1 | 2 | 4;
+ /// using(Stream stream = mappingSvc.RenderDynamicOverlay(map, map.Selection, format, selectionColor, behaviour))
+ /// {
+ /// Image img = Image.FromStream(stream);
+ /// }
+ /// ]]>
+ /// </code>
+ /// </example>
/// <param name="map">The runtime map instance</param>
/// <param name="selection">The map selection</param>
/// <param name="format">The image format</param>
/// <param name="selectionColor">The color of the selection</param>
- /// <param name="behaviour">The rendering behaviour</param>
+ /// <param name="behaviour">A bitmask for the rendering behaviour (1 = Render Selection, 2 = Render Layers, 4 = Keep Selection, 8 = Render Base Layers)</param>
/// <returns></returns>
/// <exception cref="T:System.NotSupportedException">Thrown if the service is too old to be able to support this API</exception>
System.IO.Stream RenderDynamicOverlay(RuntimeMap map, MapSelection selection, string format, Color selectionColor, int behaviour);
-
+
/// <summary>
/// Renders the runtime map.
/// </summary>
@@ -303,7 +429,7 @@
System.Drawing.Image GetLegendImage(double scale, string layerdefinition, int themeIndex, int type);
/// <summary>
- ///Renders a minature bitmap of the layers style
+ /// Renders a minature bitmap of the layers style
/// </summary>
/// <param name="scale">The scale for the bitmap to match</param>
/// <param name="layerdefinition">The layer definition resource id</param>
@@ -316,14 +442,17 @@
System.Drawing.Image GetLegendImage(double scale, string layerdefinition, int themeIndex, int type, int width, int height, string format);
/// <summary>
- /// Identifies features that meet the specified spatial selection criteria. These features can be persisted as selected features in a map. QueryMapFeatures returns an XML document describing the set of selected features. If a single feature is selected, the XML contains the tooltip, hyperlink, and properties of the feature.
+ /// Identifies features that meet the specified spatial selection criteria. These features can be persisted as selected features in a map.
+ /// This operation is generally used to implement selection/tooltip functionality for a client-side map viewer.
+ /// QueryMapFeatures returns an XML document describing the set of selected features.
+ /// If a single feature is selected, the XML contains the tooltip, hyperlink, and properties of the feature.
/// </summary>
- /// <param name="map"></param>
- /// <param name="maxFeatures"></param>
- /// <param name="wkt"></param>
- /// <param name="persist"></param>
- /// <param name="selectionVariant"></param>
- /// <param name="extraOptions"></param>
+ /// <param name="map">The RuntimeMap instance</param>
+ /// <param name="maxFeatures">The maximum number of features to return</param>
+ /// <param name="wkt">The WKT of the filter geometry, specifying the selection area</param>
+ /// <param name="persist">Indicates whether the selection should be persisted as part of the map</param>
+ /// <param name="selectionVariant">The spatial operator to use against the selection geometry</param>
+ /// <param name="extraOptions">Extra options for controlling selection criteria</param>
/// <returns></returns>
string QueryMapFeatures(RuntimeMap map, int maxFeatures, string wkt, bool persist, string selectionVariant, QueryMapOptions extraOptions);
}
Modified: trunk/Tools/Maestro/OSGeo.MapGuide.MaestroAPI/Services/IResourceService.cs
===================================================================
--- trunk/Tools/Maestro/OSGeo.MapGuide.MaestroAPI/Services/IResourceService.cs 2013-07-04 15:23:22 UTC (rev 7663)
+++ trunk/Tools/Maestro/OSGeo.MapGuide.MaestroAPI/Services/IResourceService.cs 2013-07-06 16:46:47 UTC (rev 7664)
@@ -180,19 +180,19 @@
/// Sets the resource data of a specified resource
/// </summary>
/// <remarks>For the HTTP implementation of this API, the input stream must be seekable</remarks>
- /// <param name="resourceid"></param>
- /// <param name="dataname"></param>
- /// <param name="datatype"></param>
+ /// <param name="resourceID"></param>
+ /// <param name="dataName"></param>
+ /// <param name="dataType"></param>
/// <param name="stream"></param>
/// <param name="callback"></param>
- void SetResourceData(string resourceid, string dataname, ObjCommon.ResourceDataType datatype, System.IO.Stream stream, Utility.StreamCopyProgressDelegate callback);
+ void SetResourceData(string resourceID, string dataName, ObjCommon.ResourceDataType dataType, System.IO.Stream stream, Utility.StreamCopyProgressDelegate callback);
/// <summary>
/// Sets the raw XML data of the specified resource
/// </summary>
- /// <param name="resourceid"></param>
+ /// <param name="resourceID"></param>
/// <param name="stream"></param>
- void SetResourceXmlData(string resourceid, System.IO.Stream stream);
+ void SetResourceXmlData(string resourceID, System.IO.Stream stream);
/// <summary>
/// Sets the header for the specified folder
@@ -211,9 +211,9 @@
/// <summary>
/// Updates the repository
/// </summary>
- /// <param name="resourceId"></param>
+ /// <param name="resourceID"></param>
/// <param name="header"></param>
- void UpdateRepository(string resourceId, ObjCommon.ResourceFolderHeaderType header);
+ void UpdateRepository(string resourceID, ObjCommon.ResourceFolderHeaderType header);
/// <summary>
/// Deletes the specified attached resource data
@@ -238,54 +238,54 @@
/// <summary>
/// Gets a listing of all resources dependent on the specified resource
/// </summary>
- /// <param name="resourceid"></param>
+ /// <param name="resourceID"></param>
/// <returns></returns>
- ObjCommon.ResourceReferenceList EnumerateResourceReferences(string resourceid);
+ ObjCommon.ResourceReferenceList EnumerateResourceReferences(string resourceID);
/// <summary>
/// Copies the specified resource to the specified path
/// </summary>
- /// <param name="oldpath"></param>
- /// <param name="newpath"></param>
+ /// <param name="oldResourceID"></param>
+ /// <param name="newResourceID"></param>
/// <param name="overwrite"></param>
- void CopyResource(string oldpath, string newpath, bool overwrite);
+ void CopyResource(string oldResourceID, string newResourceID, bool overwrite);
/// <summary>
/// Moves the specified resources to the specified path
/// </summary>
- /// <param name="oldpath"></param>
- /// <param name="newpath"></param>
+ /// <param name="oldResourceID"></param>
+ /// <param name="newResourceID"></param>
/// <param name="overwrite"></param>
- void MoveResource(string oldpath, string newpath, bool overwrite);
+ void MoveResource(string oldResourceID, string newResourceID, bool overwrite);
/// <summary>
/// Moves the specified resources to the specified path. Any resources referencing this resource
/// are updated to reference the resource's new location
/// </summary>
- /// <param name="oldpath"></param>
- /// <param name="newpath"></param>
+ /// <param name="oldResourceID"></param>
+ /// <param name="newResourceID"></param>
/// <param name="callback"></param>
/// <param name="progress"></param>
/// <returns></returns>
- bool MoveResourceWithReferences(string oldpath, string newpath, LengthyOperationCallBack callback, LengthyOperationProgressCallBack progress);
+ bool MoveResourceWithReferences(string oldResourceID, string newResourceID, LengthyOperationCallBack callback, LengthyOperationProgressCallBack progress);
/// <summary>
/// Copies the specified folder to the specified path. Any resources referencing this folder
/// are updated to reference the resources's new location
/// </summary>
- /// <param name="oldpath"></param>
- /// <param name="newpath"></param>
+ /// <param name="oldResourceID"></param>
+ /// <param name="newResourceID"></param>
/// <param name="callback"></param>
/// <param name="progress"></param>
/// <returns></returns>
- bool CopyFolderWithReferences(string oldpath, string newpath, LengthyOperationCallBack callback, LengthyOperationProgressCallBack progress);
+ bool CopyFolderWithReferences(string oldResourceID, string newResourceID, LengthyOperationCallBack callback, LengthyOperationProgressCallBack progress);
/// <summary>
/// Gets whether the specified resource id exists
/// </summary>
- /// <param name="resourceid"></param>
+ /// <param name="resourceID"></param>
/// <returns></returns>
- bool ResourceExists(string resourceid);
+ bool ResourceExists(string resourceID);
/// <summary>
/// Saves an object into the repository
@@ -296,29 +296,29 @@
/// Saves an object into the repository using the specified resource id.
/// </summary>
/// <remarks>
- /// The <paramref name="resourceid"/> parameter only instructs this method where to save the resource to. It does
+ /// The <paramref name="resourceID"/> parameter only instructs this method where to save the resource to. It does
/// not modify the <see cref="P:IResource.ResourceID"/> property of the input resource does not get
/// updated as a result of this operation.
/// </remarks>
/// <param name="resource">The object to save</param>
- /// <param name="resourceid">The resourceId to save the object as</param>
- void SaveResourceAs(IResource resource, string resourceid);
+ /// <param name="resourceID">The resourceId to save the object as</param>
+ void SaveResourceAs(IResource resource, string resourceID);
/// <summary>
/// Enumerates all unmanaged folders, meaning alias'ed folders
/// </summary>
- /// <param name="type">The type of data to return</param>
+ /// <param name="startpath">The path to retrieve the data from</param>
/// <param name="filter">A filter applied to the items</param>
/// <param name="recursive">True if the list should contains recursive results</param>
- /// <param name="startpath">The path to retrieve the data from</param>
+ /// <param name="type">The type of data to return</param>
/// <returns>A list of unmanaged data</returns>
ObjCommon.UnmanagedDataList EnumerateUnmanagedData(string startpath, string filter, bool recursive, UnmanagedDataTypes type);
/// <summary>
/// Upload a MapGuide Package file to the server
/// </summary>
- /// <param name="filename">Name of the file to upload</param>
+ /// <param name="fileName">Name of the file to upload</param>
/// <param name="callback">A callback argument used to display progress. May be null.</param>
- void UploadPackage(string filename, Utility.StreamCopyProgressDelegate callback);
+ void UploadPackage(string fileName, Utility.StreamCopyProgressDelegate callback);
}
}
Modified: trunk/Tools/Maestro/OSGeo.MapGuide.MaestroAPI/Services/ITileService.cs
===================================================================
--- trunk/Tools/Maestro/OSGeo.MapGuide.MaestroAPI/Services/ITileService.cs 2013-07-04 15:23:22 UTC (rev 7663)
+++ trunk/Tools/Maestro/OSGeo.MapGuide.MaestroAPI/Services/ITileService.cs 2013-07-06 16:46:47 UTC (rev 7664)
@@ -42,13 +42,13 @@
/// <summary>
/// Reads a tile from MapGuide
/// </summary>
- /// <param name="mapdefinition">A map with baselayergroups</param>
- /// <param name="baselayergroup">The name of a baselayergroup</param>
- /// <param name="col">The column index of the tile</param>
+ /// <param name="mapDefinition">A map with baselayergroups</param>
+ /// <param name="baseLayerGroup">The name of a baselayergroup</param>
+ /// <param name="column">The column index of the tile</param>
/// <param name="row">The row index of the tile</param>
- /// <param name="scaleindex">The scale index for the tile set</param>
+ /// <param name="scaleIndex">The scale index for the tile set</param>
/// <param name="format">The format to return the tile in, either JPG, GIF, PNG or PNG8</param>
/// <returns>An image stream</returns>
- System.IO.Stream GetTile(string mapdefinition, string baselayergroup, int col, int row, int scaleindex, string format);
+ System.IO.Stream GetTile(string mapDefinition, string baseLayerGroup, int column, int row, int scaleIndex, string format);
}
}
More information about the mapguide-commits
mailing list