[mapguide-commits] r8363 - in sandbox/jng/convenience_apis/Common: MapGuideCommon/MapLayer PlatformBase/MapLayer PlatformBase/Services
svn_mapguide at osgeo.org
svn_mapguide at osgeo.org
Sun Sep 28 10:59:28 PDT 2014
Author: jng
Date: 2014-09-28 10:59:28 -0700 (Sun, 28 Sep 2014)
New Revision: 8363
Modified:
sandbox/jng/convenience_apis/Common/MapGuideCommon/MapLayer/Layer.h
sandbox/jng/convenience_apis/Common/PlatformBase/MapLayer/LayerBase.h
sandbox/jng/convenience_apis/Common/PlatformBase/Services/ResourceService.h
Log:
- Fix incorrect documentation remarks in new convenience APIs
- Clarify the coordinateSystem parameter in MgLayerBase::SelectFeatures()
- Fix EnumerateResourceDocuments being incorrectly promoted to PUBLISHED_API. It is supposed to be EXTERNAL_API.
Modified: sandbox/jng/convenience_apis/Common/MapGuideCommon/MapLayer/Layer.h
===================================================================
--- sandbox/jng/convenience_apis/Common/MapGuideCommon/MapLayer/Layer.h 2014-09-27 08:00:59 UTC (rev 8362)
+++ sandbox/jng/convenience_apis/Common/MapGuideCommon/MapLayer/Layer.h 2014-09-28 17:59:28 UTC (rev 8363)
@@ -154,7 +154,7 @@
/// containing all required filters for this
/// select operation.
/// \param coordinateSystem (String/string)
- /// The coordinate system to transform features to
+ /// The WKT string of the coordinate system to transform features to
///
/// \return
/// Returns an MgFeatureReader containing the set of selected
@@ -370,13 +370,14 @@
///
/// \param properties (MgPropertyCollection)
/// The collection of property values to insert
+ /// \param transaction (MgTransaction)
+ /// An optional transaction to execute this operation under
///
/// \return
/// Returns a feature reader object that contains the set of properties
/// inserted into the datastore by the insert command.
///
/// \remarks
- /// Transactions will be used internally if the provider supports them.
/// Remember to close any feature readers returned by this method, even if you don't intend
/// to do anything with them
///
@@ -406,13 +407,14 @@
/// \param properties (MgBatchPropertyCollection)
/// The collection of property values to insert. Each MgPropertyCollection within
/// this collection represents property values for a single feature to insert
+ /// \param transaction (MgTransaction)
+ /// An optional transaction to execute this operation under
///
/// \return
/// Returns a feature reader object that contains the set of properties
/// inserted into the datastore by the insert command.
///
/// \remarks
- /// Transactions will be used internally if the provider supports them.
/// Remember to close any feature readers returned by this method, even if you don't intend
/// to do anything with them
///
@@ -428,9 +430,6 @@
/// \brief
/// Updates all features that match the given filter with the specified property values
///
- /// \remarks
- /// Transactions will be used internally if the provider supports them
- ///
/// <!-- Syntax in .Net, Java, and PHP -->
/// \htmlinclude DotNetSyntaxTop.html
/// virtual int UpdateMatchingFeatures(MgPropertyCollection properties, string filter);
@@ -446,6 +445,8 @@
/// The property values to update matching features with
/// \param filter (String/string)
/// The FDO filter string that detemines what features will be updated
+ /// \param transaction (MgTransaction)
+ /// An optional transaction to execute this operation under
///
/// \return
/// Returns the number of features updated by this operation
@@ -462,9 +463,6 @@
/// \brief
/// Deletes all features that match the given filter
///
- /// \remarks
- /// Transactions will be used internally if the provider supports them
- ///
/// <!-- Syntax in .Net, Java, and PHP -->
/// \htmlinclude DotNetSyntaxTop.html
/// virtual int DeleteFeatures(string filter);
@@ -478,6 +476,8 @@
///
/// \param filter (String/string)
/// The FDO filter string that detemines what features will be deleted
+ /// \param transaction (MgTransaction)
+ /// An optional transaction to execute this operation under
///
/// \return
/// Returns the number of features deleted by this operation
Modified: sandbox/jng/convenience_apis/Common/PlatformBase/MapLayer/LayerBase.h
===================================================================
--- sandbox/jng/convenience_apis/Common/PlatformBase/MapLayer/LayerBase.h 2014-09-27 08:00:59 UTC (rev 8362)
+++ sandbox/jng/convenience_apis/Common/PlatformBase/MapLayer/LayerBase.h 2014-09-28 17:59:28 UTC (rev 8363)
@@ -802,7 +802,7 @@
/// containing all required filters for this
/// select operation.
/// \param coordinateSystem (String/string)
- /// The coordinate system to transform features to
+ /// The WKT string of the coordinate system to transform features to
///
/// \return
/// Returns an MgFeatureReader containing the set of selected
@@ -1024,7 +1024,6 @@
/// inserted into the datastore by the insert command.
///
/// \remarks
- /// Transactions will be used internally if the provider supports them.
/// Remember to close any feature readers returned by this method, even if you don't intend
/// to do anything with them
///
@@ -1062,7 +1061,6 @@
/// inserted into the datastore by the insert command.
///
/// \remarks
- /// Transactions will be used internally if the provider supports them.
/// Remember to close any feature readers returned by this method, even if you don't intend
/// to do anything with them
///
@@ -1078,9 +1076,6 @@
/// \brief
/// Updates all features that match the given filter with the specified property values
///
- /// \remarks
- /// Transactions will be used internally if the provider supports them
- ///
/// <!-- Syntax in .Net, Java, and PHP -->
/// \htmlinclude DotNetSyntaxTop.html
/// virtual int UpdateMatchingFeatures(MgPropertyCollection properties, string filter);
Modified: sandbox/jng/convenience_apis/Common/PlatformBase/Services/ResourceService.h
===================================================================
--- sandbox/jng/convenience_apis/Common/PlatformBase/Services/ResourceService.h 2014-09-27 08:00:59 UTC (rev 8362)
+++ sandbox/jng/convenience_apis/Common/PlatformBase/Services/ResourceService.h 2014-09-28 17:59:28 UTC (rev 8363)
@@ -1710,35 +1710,6 @@
/// \since 1.2
virtual MgByteReader* EnumerateUnmanagedData(CREFSTRING path, bool recursive, CREFSTRING type, CREFSTRING filter);
- ///////////////////////////////////////////////////////////////////////////
- /// \brief
- /// Enumerate the resource documents in the specified repository.
- ///
- /// \remarks
- /// This method only works on "Library".
- ///
- /// \param resources
- /// Resource identifiers specifying the resources to enumerate.
- /// \n If it is null or contains no resource, then the type must be specified.
- /// \n If it is not null and contains some resource, then the type will be ignored.
- /// \param type
- /// Type of the resource to be enumerated. See MgResourceType for valid types.
- /// No folder type is allowed.
- /// \param properties
- /// Flag to specify which properties of the resource header should be filtered.
- /// It may be set to 0 or by bitwise inclusively OR'ing together one or
- /// more of the MgResourceHeaderProperties values.
- ///
- /// \return
- /// Returns a string containing a description of the WMS layer definitions
- /// in XML format using the \link ResourceList_schema ResourceList \endlink
- /// schema.
- ///
- /// \exception MgInvalidResourceTypeException
- ///
- virtual STRING EnumerateResourceDocuments(MgStringCollection* resources,
- CREFSTRING type, INT32 properties);
-
INTERNAL_API:
///////////////////////////////////////////////////////////////////////////
/// \brief
@@ -1880,12 +1851,43 @@
virtual bool HasPermission(MgResourceIdentifier* resource, CREFSTRING permission);
EXTERNAL_API:
-
///////////////////////////////////////////////////////////////////////////
/// \brief
+ /// Enumerate the resource documents in the specified repository.
+ ///
+ /// \remarks
+ /// This method only works on "Library".
+ /// This API has been promoted from internal to un-published status for MapGuide Open Source 3.0
+ ///
+ /// \param resources
+ /// Resource identifiers specifying the resources to enumerate.
+ /// \n If it is null or contains no resource, then the type must be specified.
+ /// \n If it is not null and contains some resource, then the type will be ignored.
+ /// \param type
+ /// Type of the resource to be enumerated. See MgResourceType for valid types.
+ /// No folder type is allowed.
+ /// \param properties
+ /// Flag to specify which properties of the resource header should be filtered.
+ /// It may be set to 0 or by bitwise inclusively OR'ing together one or
+ /// more of the MgResourceHeaderProperties values.
+ ///
+ /// \return
+ /// Returns a string containing a description of the WMS layer definitions
+ /// in XML format using the \link ResourceList_schema ResourceList \endlink
+ /// schema.
+ ///
+ /// \exception MgInvalidResourceTypeException
+ ///
+ virtual STRING EnumerateResourceDocuments(MgStringCollection* resources,
+ CREFSTRING type, INT32 properties);
+
+ ///////////////////////////////////////////////////////////////////////////
+ /// \brief
/// Returns the modified date of the specified resource.
///
+ /// \remarks
/// This method only works on "Library" repository.
+ /// This API has been promoted from internal to un-published status for MapGuide Open Source 3.0
///
/// <!-- Syntax in .Net, Java, and PHP -->
/// \htmlinclude DotNetSyntaxTop.html
More information about the mapguide-commits
mailing list