Class ConfigurationDocument
The base class of all configuration documents
Inheritance
Implements
Inherited Members
Namespace: OSGeo.MapGuide.MaestroAPI.SchemaOverrides
Assembly: OSGeo.MapGuide.MaestroAPI.dll
Syntax
public abstract class ConfigurationDocument : IFdoSerializable
Constructors
| Improve this Doc View SourceConfigurationDocument()
Initializes a new instance of the ConfigurationDocument class.
Declaration
protected ConfigurationDocument()
Fields
| Improve this Doc View Source_schemas
The list of logical schemas
Declaration
protected List<FeatureSchema> _schemas
Field Value
Type | Description |
---|---|
System.Collections.Generic.List<FeatureSchema> |
_spatialContexts
The list of spatial contexts
Declaration
protected List<IFdoSpatialContext> _spatialContexts
Field Value
Type | Description |
---|---|
System.Collections.Generic.List<IFdoSpatialContext> |
Properties
| Improve this Doc View SourceSchemas
Gets the array of logical schemas.
Declaration
public FeatureSchema[] Schemas { get; }
Property Value
Type | Description |
---|---|
FeatureSchema[] |
SpatialContexts
Gets the array of spatial contexts.
Declaration
public IFdoSpatialContext[] SpatialContexts { get; }
Property Value
Type | Description |
---|---|
IFdoSpatialContext[] |
Methods
| Improve this Doc View SourceAddSchema(FeatureSchema)
Adds the logical schema.
Declaration
public void AddSchema(FeatureSchema schema)
Parameters
Type | Name | Description |
---|---|---|
FeatureSchema | schema | The schema. |
AddSpatialContext(IFdoSpatialContext)
Adds the spatial context.
Declaration
public void AddSpatialContext(IFdoSpatialContext context)
Parameters
Type | Name | Description |
---|---|---|
IFdoSpatialContext | context | The context. |
GetClass(String, String)
Gets the class definition by schema and class names
Declaration
public ClassDefinition GetClass(string schemaName, string className)
Parameters
Type | Name | Description |
---|---|---|
System.String | schemaName | Name of the schema. |
System.String | className | Name of the class. |
Returns
Type | Description |
---|---|
ClassDefinition |
GetSchema(String)
Gets the schema by name.
Declaration
public FeatureSchema GetSchema(string name)
Parameters
Type | Name | Description |
---|---|---|
System.String | name | The name. |
Returns
Type | Description |
---|---|
FeatureSchema |
GetSpatialContext(String)
Gets the spatial context by name
Declaration
public IFdoSpatialContext GetSpatialContext(string name)
Parameters
Type | Name | Description |
---|---|---|
System.String | name | The name. |
Returns
Type | Description |
---|---|
IFdoSpatialContext |
GetSpatialContextNames()
Gets the array spatial context names.
Declaration
public string[] GetSpatialContextNames()
Returns
Type | Description |
---|---|
System.String[] |
Load(Stream)
Creates a configuration document from the specified stream.
Declaration
public static ConfigurationDocument Load(Stream stream)
Parameters
Type | Name | Description |
---|---|---|
System.IO.Stream | stream | The stream. |
Returns
Type | Description |
---|---|
ConfigurationDocument | The configuration document |
LoadXml(String)
Creates a configuration document from XML.
Declaration
public static ConfigurationDocument LoadXml(string xml)
Parameters
Type | Name | Description |
---|---|---|
System.String | xml | The XML. |
Returns
Type | Description |
---|---|
ConfigurationDocument | The configuration document |
ReadSchemaMappings(XmlNode, XmlNamespaceManager)
Write this document's schema mappings from the given XML document
Declaration
protected abstract void ReadSchemaMappings(XmlNode node, XmlNamespaceManager mgr)
Parameters
Type | Name | Description |
---|---|---|
System.Xml.XmlNode | node | The node. |
System.Xml.XmlNamespaceManager | mgr | The namespace manager. |
ReadXml(XmlNode, XmlNamespaceManager)
Set the current element's content from the current XML node
Declaration
public void ReadXml(XmlNode node, XmlNamespaceManager mgr)
Parameters
Type | Name | Description |
---|---|---|
System.Xml.XmlNode | node | |
System.Xml.XmlNamespaceManager | mgr |
RemoveSchema(FeatureSchema)
Removes the logical schema.
Declaration
public void RemoveSchema(FeatureSchema schema)
Parameters
Type | Name | Description |
---|---|---|
FeatureSchema | schema | The schema. |
RemoveSpatialContext(IFdoSpatialContext)
Removes the spatial context.
Declaration
public void RemoveSpatialContext(IFdoSpatialContext context)
Parameters
Type | Name | Description |
---|---|---|
IFdoSpatialContext | context | The context. |
ToXml()
Returns the XML form of this document
Declaration
public string ToXml()
Returns
Type | Description |
---|---|
System.String |
WriteSchemaMappings(XmlDocument, XmlNode)
Write this document's schema mappings to the given XML document
Declaration
protected abstract void WriteSchemaMappings(XmlDocument doc, XmlNode currentNode)
Parameters
Type | Name | Description |
---|---|---|
System.Xml.XmlDocument | doc | |
System.Xml.XmlNode | currentNode |
WriteXml(XmlDocument, XmlNode)
Writes the current element's content
Declaration
public virtual void WriteXml(XmlDocument doc, XmlNode currentNode)
Parameters
Type | Name | Description |
---|---|---|
System.Xml.XmlDocument | doc | |
System.Xml.XmlNode | currentNode |