[mapguide-commits] r5840 -
trunk/Tools/Maestro/OSGeo.MapGuide.MaestroAPI/SchemaOverrides
svn_mapguide at osgeo.org
svn_mapguide at osgeo.org
Tue May 24 07:10:02 EDT 2011
Author: jng
Date: 2011-05-24 04:10:02 -0700 (Tue, 24 May 2011)
New Revision: 5840
Modified:
trunk/Tools/Maestro/OSGeo.MapGuide.MaestroAPI/SchemaOverrides/ConfigurationDocument.cs
trunk/Tools/Maestro/OSGeo.MapGuide.MaestroAPI/SchemaOverrides/GdalConfigurationDocument.cs
trunk/Tools/Maestro/OSGeo.MapGuide.MaestroAPI/SchemaOverrides/GdalRasterItem.cs
trunk/Tools/Maestro/OSGeo.MapGuide.MaestroAPI/SchemaOverrides/GenericConfigurationDocument.cs
trunk/Tools/Maestro/OSGeo.MapGuide.MaestroAPI/SchemaOverrides/OdbcConfigurationDocument.cs
trunk/Tools/Maestro/OSGeo.MapGuide.MaestroAPI/SchemaOverrides/OdbcTableItem.cs
trunk/Tools/Maestro/OSGeo.MapGuide.MaestroAPI/SchemaOverrides/WmsConfigurationDocument.cs
Log:
#1319: API docs for classes in SchemaOverrides namespace
Modified: trunk/Tools/Maestro/OSGeo.MapGuide.MaestroAPI/SchemaOverrides/ConfigurationDocument.cs
===================================================================
--- trunk/Tools/Maestro/OSGeo.MapGuide.MaestroAPI/SchemaOverrides/ConfigurationDocument.cs 2011-05-24 10:49:54 UTC (rev 5839)
+++ trunk/Tools/Maestro/OSGeo.MapGuide.MaestroAPI/SchemaOverrides/ConfigurationDocument.cs 2011-05-24 11:10:02 UTC (rev 5840)
@@ -26,6 +26,9 @@
namespace OSGeo.MapGuide.MaestroAPI.SchemaOverrides
{
+ /// <summary>
+ /// The base class of all configuration documents
+ /// </summary>
public abstract class ConfigurationDocument : IFdoSerializable
{
protected List<IFdoSpatialContext> _spatialContexts;
Modified: trunk/Tools/Maestro/OSGeo.MapGuide.MaestroAPI/SchemaOverrides/GdalConfigurationDocument.cs
===================================================================
--- trunk/Tools/Maestro/OSGeo.MapGuide.MaestroAPI/SchemaOverrides/GdalConfigurationDocument.cs 2011-05-24 10:49:54 UTC (rev 5839)
+++ trunk/Tools/Maestro/OSGeo.MapGuide.MaestroAPI/SchemaOverrides/GdalConfigurationDocument.cs 2011-05-24 11:10:02 UTC (rev 5840)
@@ -25,10 +25,19 @@
namespace OSGeo.MapGuide.MaestroAPI.SchemaOverrides
{
+ /// <summary>
+ /// A configuration document for the GDAL raster provider. A GDAL configuration document serves as a raster image catalog. Allowing
+ /// the GDAL provider to optimally select the correct raster images to return for the given queried extents.
+ /// </summary>
public class GdalConfigurationDocument : ConfigurationDocument
{
private Dictionary<string, GdalRasterLocationItem> _items = new Dictionary<string, GdalRasterLocationItem>();
+ /// <summary>
+ /// Adds the specified raster location to this document
+ /// </summary>
+ /// <param name="item"></param>
+ /// <returns></returns>
public GdalRasterLocationItem AddLocation(GdalRasterLocationItem item)
{
if (!_items.ContainsKey(item.Location))
@@ -38,6 +47,11 @@
return _items[item.Location];
}
+ /// <summary>
+ /// Removes the specified raster location from this document
+ /// </summary>
+ /// <param name="item"></param>
+ /// <returns></returns>
public bool RemoveLocation(GdalRasterLocationItem item)
{
return _items.Remove(item.Location);
@@ -60,6 +74,11 @@
return env;
}
+ /// <summary>
+ /// Adds the specified directory to this document
+ /// </summary>
+ /// <param name="directory"></param>
+ /// <returns></returns>
public GdalRasterLocationItem AddLocation(string directory)
{
if (_items.ContainsKey(directory))
@@ -68,6 +87,9 @@
return AddLocation(new GdalRasterLocationItem() { Location = directory });
}
+ /// <summary>
+ /// Gets an array of all the raster locations for this document
+ /// </summary>
public GdalRasterLocationItem[] RasterLocations { get { return new List<GdalRasterLocationItem>(_items.Values).ToArray(); } }
protected override void WriteSchemaMappings(System.Xml.XmlDocument doc, System.Xml.XmlNode currentNode)
Modified: trunk/Tools/Maestro/OSGeo.MapGuide.MaestroAPI/SchemaOverrides/GdalRasterItem.cs
===================================================================
--- trunk/Tools/Maestro/OSGeo.MapGuide.MaestroAPI/SchemaOverrides/GdalRasterItem.cs 2011-05-24 10:49:54 UTC (rev 5839)
+++ trunk/Tools/Maestro/OSGeo.MapGuide.MaestroAPI/SchemaOverrides/GdalRasterItem.cs 2011-05-24 11:10:02 UTC (rev 5840)
@@ -28,14 +28,24 @@
namespace OSGeo.MapGuide.MaestroAPI.SchemaOverrides
{
+ /// <summary>
+ /// Represents a directory of raster images in a GDAL configuration document
+ /// </summary>
public class GdalRasterLocationItem : IFdoSerializable
{
private Dictionary<string, GdalRasterItem> _items = new Dictionary<string, GdalRasterItem>();
private IEnvelope _extents;
+ /// <summary>
+ /// Gets or sets the directory
+ /// </summary>
public string Location { get; set; }
+ /// <summary>
+ /// Adds the specified raster image reference
+ /// </summary>
+ /// <param name="item"></param>
public void AddItem(GdalRasterItem item)
{
if (!_items.ContainsKey(item.FileName))
@@ -61,11 +71,18 @@
return env;
}
+ /// <summary>
+ /// Removes the specified raster image reference
+ /// </summary>
+ /// <param name="item"></param>
public void RemoveItem(GdalRasterItem item)
{
_items.Remove(item.FileName);
}
+ /// <summary>
+ /// Gets all the raster image references in this location
+ /// </summary>
public GdalRasterItem[] Items { get { return new List<GdalRasterItem>(_items.Values).ToArray(); } }
public void WriteXml(System.Xml.XmlDocument doc, System.Xml.XmlNode currentNode)
@@ -100,22 +117,44 @@
}
}
+ /// <summary>
+ /// Removes the specified raster image
+ /// </summary>
+ /// <param name="fileName"></param>
public void RemoveItem(string fileName)
{
_items.Remove(fileName);
}
}
+ /// <summary>
+ /// Represents a raster image location and its extents.
+ /// </summary>
public class GdalRasterItem : IFdoSerializable
{
+ /// <summary>
+ /// Gets or sets the raster image file name
+ /// </summary>
public string FileName { get; set; }
+ /// <summary>
+ /// Gets or sets the minimum X value of this raster extent
+ /// </summary>
public double MinX { get; set; }
+ /// <summary>
+ /// Gets or sets the minimum Y value of this raster extent
+ /// </summary>
public double MinY { get; set; }
+ /// <summary>
+ /// Gets or sets the maximum X value of this raster extent
+ /// </summary>
public double MaxX { get; set; }
+ /// <summary>
+ /// Gets or sets the maximum Y value of this raster extent
+ /// </summary>
public double MaxY { get; set; }
public void WriteXml(System.Xml.XmlDocument doc, System.Xml.XmlNode currentNode)
Modified: trunk/Tools/Maestro/OSGeo.MapGuide.MaestroAPI/SchemaOverrides/GenericConfigurationDocument.cs
===================================================================
--- trunk/Tools/Maestro/OSGeo.MapGuide.MaestroAPI/SchemaOverrides/GenericConfigurationDocument.cs 2011-05-24 10:49:54 UTC (rev 5839)
+++ trunk/Tools/Maestro/OSGeo.MapGuide.MaestroAPI/SchemaOverrides/GenericConfigurationDocument.cs 2011-05-24 11:10:02 UTC (rev 5840)
@@ -24,6 +24,10 @@
namespace OSGeo.MapGuide.MaestroAPI.SchemaOverrides
{
+ /// <summary>
+ /// Represents a generic configuration document. Customisation is done by manipulating the individual
+ /// XML content.
+ /// </summary>
public class GenericConfigurationDocument : ConfigurationDocument
{
private XmlNode[] _mappings;
Modified: trunk/Tools/Maestro/OSGeo.MapGuide.MaestroAPI/SchemaOverrides/OdbcConfigurationDocument.cs
===================================================================
--- trunk/Tools/Maestro/OSGeo.MapGuide.MaestroAPI/SchemaOverrides/OdbcConfigurationDocument.cs 2011-05-24 10:49:54 UTC (rev 5839)
+++ trunk/Tools/Maestro/OSGeo.MapGuide.MaestroAPI/SchemaOverrides/OdbcConfigurationDocument.cs 2011-05-24 11:10:02 UTC (rev 5840)
@@ -25,20 +25,36 @@
namespace OSGeo.MapGuide.MaestroAPI.SchemaOverrides
{
+ /// <summary>
+ /// Represents a configuration document for the ODBC provider. The ODBC configuration document allows you to declare
+ /// certain tables as point feature classes by specifying the X, Y and optionally Z columns of the table
+ /// </summary>
public class OdbcConfigurationDocument : ConfigurationDocument
{
private List<OdbcTableItem> _tables;
public OdbcConfigurationDocument() { _tables = new List<OdbcTableItem>(); }
+ /// <summary>
+ /// Adds the specified table override
+ /// </summary>
+ /// <param name="item"></param>
public void AddOverride(OdbcTableItem item)
{
_tables.Add(item);
item.Parent = this;
}
+ /// <summary>
+ /// Removes all table overrides
+ /// </summary>
public void ClearMappings() { _tables.Clear(); }
+ /// <summary>
+ /// Gets the table overrides for the specified schema
+ /// </summary>
+ /// <param name="schemaName"></param>
+ /// <returns></returns>
public List<OdbcTableItem> GetMappingsForSchema(string schemaName)
{
List<OdbcTableItem> items = new List<OdbcTableItem>();
@@ -103,6 +119,12 @@
}
}
+ /// <summary>
+ /// Gets the table override for the specific feature class name.
+ /// </summary>
+ /// <param name="schemaName"></param>
+ /// <param name="className"></param>
+ /// <returns></returns>
public OdbcTableItem GetOverride(string schemaName, string className)
{
foreach (var item in _tables)
Modified: trunk/Tools/Maestro/OSGeo.MapGuide.MaestroAPI/SchemaOverrides/OdbcTableItem.cs
===================================================================
--- trunk/Tools/Maestro/OSGeo.MapGuide.MaestroAPI/SchemaOverrides/OdbcTableItem.cs 2011-05-24 10:49:54 UTC (rev 5839)
+++ trunk/Tools/Maestro/OSGeo.MapGuide.MaestroAPI/SchemaOverrides/OdbcTableItem.cs 2011-05-24 11:10:02 UTC (rev 5840)
@@ -24,20 +24,41 @@
namespace OSGeo.MapGuide.MaestroAPI.SchemaOverrides
{
+ /// <summary>
+ /// Represents a table override. A table override allows a table to be configured as a point feature class
+ /// </summary>
public class OdbcTableItem : IFdoSerializable
{
internal OdbcConfigurationDocument Parent { get; set; }
+ /// <summary>
+ /// Gets or sets the name of the feature schema
+ /// </summary>
public string SchemaName { get; set; }
+ /// <summary>
+ /// Gets or sets the name of the feature class this override is applicable to
+ /// </summary>
public string ClassName { get; set; }
+ /// <summary>
+ /// Gets or sets the name of the spatial context the point geometries will be applicable to
+ /// </summary>
public string SpatialContextName { get; set; }
+ /// <summary>
+ /// Gets or sets the name of the column which contains the X coordinates of the point features
+ /// </summary>
public string XColumn { get; set; }
+ /// <summary>
+ /// Gets or sets the name of the column which contains the Y coordinates of the point features
+ /// </summary>
public string YColumn { get; set; }
-
+
+ /// <summary>
+ /// Gets or sets the name of the column which contains the Z coordinates of the point features
+ /// </summary>
public string ZColumn { get; set; }
public void WriteXml(System.Xml.XmlDocument doc, System.Xml.XmlNode currentNode)
Modified: trunk/Tools/Maestro/OSGeo.MapGuide.MaestroAPI/SchemaOverrides/WmsConfigurationDocument.cs
===================================================================
--- trunk/Tools/Maestro/OSGeo.MapGuide.MaestroAPI/SchemaOverrides/WmsConfigurationDocument.cs 2011-05-24 10:49:54 UTC (rev 5839)
+++ trunk/Tools/Maestro/OSGeo.MapGuide.MaestroAPI/SchemaOverrides/WmsConfigurationDocument.cs 2011-05-24 11:10:02 UTC (rev 5840)
@@ -24,14 +24,28 @@
namespace OSGeo.MapGuide.MaestroAPI.SchemaOverrides
{
+ /// <summary>
+ /// Represents a configuration document for the WMS provider.
+ /// </summary>
public class WmsConfigurationDocument : ConfigurationDocument
{
private List<RasterWmsItem> _rasterItems = new List<RasterWmsItem>();
+ /// <summary>
+ /// Gets an array of the added override items
+ /// </summary>
public RasterWmsItem[] RasterOverrides { get { return _rasterItems.ToArray(); } }
+ /// <summary>
+ /// Adds the specified override item
+ /// </summary>
+ /// <param name="item"></param>
public void AddRasterItem(RasterWmsItem item) { _rasterItems.Add(item); }
+ /// <summary>
+ /// Removes the specified override item
+ /// </summary>
+ /// <param name="item"></param>
public void RemoveRasterItem(RasterWmsItem item) { _rasterItems.Remove(item); }
protected override void WriteSchemaMappings(System.Xml.XmlDocument doc, System.Xml.XmlNode currentNode)
More information about the mapguide-commits
mailing list