Class PlatformConnectionBase

Base class of all connection classes. Covers functionality encompassed by the MapGuide Geospatial Platform API (ie. Feature Service and Resource Service)

Inheritance

System.Object

PlatformConnectionBase

MgServerConnectionBase

Inherited Members

System.Object.Equals(System.Object)

System.Object.Equals(System.Object, System.Object)

System.Object.GetHashCode()

System.Object.GetType()

System.Object.MemberwiseClone()

System.Object.ReferenceEquals(System.Object, System.Object)

System.Object.ToString()

Namespace: OSGeo.MapGuide.MaestroAPI

Assembly: OSGeo.MapGuide.MaestroAPI.dll

Syntax

public abstract class PlatformConnectionBase

Constructors

PlatformConnectionBase()

Initializes a new instance of the PlatformConnectionBase class.

Declaration

protected PlatformConnectionBase()

Fields

m_cachedSchemas

A lookup table for Xsd Schemas

Declaration

protected Hashtable m_cachedSchemas

Field Value

Type	Description
System.Collections.Hashtable

m_classDefinitionCache

a class definition cache

Declaration

protected Dictionary<string, ClassDefinition> m_classDefinitionCache

Field Value

Type	Description
System.Collections.Generic.Dictionary<System.String, ClassDefinition>

m_disableValidation

A flag indicating if Xsd validation is perfomed

Declaration

protected bool m_disableValidation

Field Value

Type	Description
System.Boolean

m_featureSchemaCache

feature source description cache

Declaration

protected Dictionary<string, FeatureSourceDescription> m_featureSchemaCache

Field Value

Type	Description
System.Collections.Generic.Dictionary<System.String, FeatureSourceDescription>

m_schemasPath

The path of Xsd schemas

Declaration

protected string m_schemasPath

Field Value

Type	Description
System.String

m_serializers

A list of cached serializers

Declaration

protected Hashtable m_serializers

Field Value

Type	Description
System.Collections.Hashtable

m_validator

The current XML validator

Declaration

protected XmlValidator m_validator

Field Value

Type	Description
XmlValidator

Properties

CachedSchemas

Gets or sets the collection of cached schemas. Use the object type for key, and an XmlSchema instance for value.

Declaration

public virtual Hashtable CachedSchemas { get; set; }

Property Value

Type	Description
System.Collections.Hashtable

CacheStats

Gets the cache stats for the current connection

Declaration

public ConnectionCacheStats CacheStats { get; }

Property Value

Type	Description
ConnectionCacheStats

CloneParameters

Gets a collection of name-value parameters required to create another copy of this connection via the ConnectionProviderRegistry

Declaration

public abstract NameValueCollection CloneParameters { get; }

Property Value

Type	Description
System.Collections.Specialized.NameValueCollection

DisableValidation

Gets or sets a flag that indicates if the Xml resources are validated before leaving and entering the server.

Declaration

public bool DisableValidation { get; set; }

Property Value

Type	Description
System.Boolean

FeatureProviders

Gets a list of installed feature providers

Declaration

public abstract FeatureProviderRegistryFeatureProvider[] FeatureProviders { get; }

Property Value

Type	Description
FeatureProviderRegistryFeatureProvider[]

MaxTestedVersion

Gets the highest version the API is currently tested againts

Declaration

public virtual Version MaxTestedVersion { get; }

Property Value

Type	Description
System.Version

ProviderName

Gets the name of the provider of this implementation

Declaration

public abstract string ProviderName { get; }

Property Value

Type	Description
System.String

SessionID

Gets the current SessionID.

Declaration

public abstract string SessionID { get; }

Property Value

Type	Description
System.String

SiteVersion

Gets the site version.

Declaration

public abstract Version SiteVersion { get; }

Property Value

Type	Description
System.Version	The site version.

Methods

AggregateQueryFeatureSource(String, String, String)

Performs an aggregate query on all columns in the datasource

Declaration

public virtual IReader AggregateQueryFeatureSource(string resourceID, string schema, string filter)

Parameters

Type	Name	Description
System.String	resourceID	The resourceID of the FeatureSource to query
System.String	schema	The schema name
System.String	filter	The filter to apply to the

Returns

Type	Description
IReader	A FeatureSetReader with the aggregated values

AggregateQueryFeatureSource(String, String, String, NameValueCollection)

Performs an aggregate query on computed resources

Declaration

public abstract IReader AggregateQueryFeatureSource(string resourceID, string schema, string filter, NameValueCollection aggregateFunctions)

Parameters

Type	Name	Description
System.String	resourceID	The resourceID of the FeatureSource to query
System.String	schema	The schema name
System.String	filter	The filter to apply to the
System.Collections.Specialized.NameValueCollection	aggregateFunctions	A collection of column name and aggregate functions

Returns

Type	Description
IReader	A FeatureSetReader with the aggregated values

AggregateQueryFeatureSource(String, String, String, String[])

Performs an aggregate query on columns in the datasource

Declaration

public abstract IReader AggregateQueryFeatureSource(string resourceID, string schema, string filter, string[] columns)

Parameters

Type	Name	Description
System.String	resourceID	The resourceID of the FeatureSource to query
System.String	schema	The schema name
System.String	filter	The filter to apply to the
System.String[]	columns	The columns to aggregate

Returns

Type	Description
IReader	A IFeatureReader with the aggregated values

Clone()

Clones this instance.

Declaration

public abstract IServerConnection Clone()

Returns

Type	Description
IServerConnection

CopyFolder(String, String, Boolean)

Copies a folder and all its content. This does not update any references.

Declaration

public abstract void CopyFolder(string oldpath, string newpath, bool overwrite)

Parameters

Type	Name	Description
System.String	oldpath	The current folder path, the one copying from
System.String	newpath	The new folder path, the one copying to
System.Boolean	overwrite	True if the copy can overwrite an existing folder, false otherwise

CopyFolderWithReferences(String, String, LengthyOperationCallBack, LengthyOperationProgressCallBack)

Copies folder, and subsequently updates all resources within the folder to use the new folder path instead of the originating one.

Declaration

public bool CopyFolderWithReferences(string oldpath, string newpath, LengthyOperationCallBack callback, LengthyOperationProgressCallBack progress)

Parameters

Type	Name	Description
System.String	oldpath	The current folder path, the one copying from
System.String	newpath	The new folder path, the one copying to
LengthyOperationCallBack	callback	A callback delegate, being called for non progress reporting events.
LengthyOperationProgressCallBack	progress	A callback delegate, being called for progress reporting events.

Returns

Type	Description
System.Boolean

CopyResource(String, String, Boolean)

Copies a resource from one location to another. This does not update any references.

Declaration

public abstract void CopyResource(string oldpath, string newpath, bool overwrite)

Parameters

Type	Name	Description
System.String	oldpath	The current resource path, the one copying from
System.String	newpath	The new resource path, the one copying to
System.Boolean	overwrite	True if the copy can overwrite an existing resource, false otherwise

CreateCommand(Int32)

Creates the command.

Declaration

public virtual ICommand CreateCommand(int cmdType)

Parameters

Type	Name	Description
System.Int32	cmdType	Type of the CMD.

Returns

Type	Description
ICommand

CreateFolder(String)

Creates a folder on the server

Declaration

public virtual void CreateFolder(string resourceID)

Parameters

Type	Name	Description
System.String	resourceID	The path of the folder to create

CreateGeometryReader()

Creates a geometry text reader for creating IGeometryRef instances from WKT text

Declaration

public virtual IGeometryTextReader CreateGeometryReader()

Returns

Type	Description
IGeometryTextReader

CreateMap(IMapDefinition)

Creates a new runtime map instance from an existing map definition. The runtime map resource id is calculated from the current session id and the name component of the Map Definition resource id

Declaration

public RuntimeMap CreateMap(IMapDefinition mdf)

Parameters

Type	Name	Description
IMapDefinition	mdf

Returns

Type	Description
RuntimeMap

CreateMap(IMapDefinition, Boolean)

Creates a new runtime map instance from an existing map definition. The runtime map resource id is calculated from the current session id and the name component of the Map Definition resource id

Declaration

public RuntimeMap CreateMap(IMapDefinition mdf, bool suppressErrors)

Parameters

Type	Name	Description
IMapDefinition	mdf
System.Boolean	suppressErrors

Returns

Type	Description
RuntimeMap

CreateMap(IMapDefinition, Double)

Creates a new runtime map instance from an existing map definition. The runtime map resource id is calculated from the current session id and the name component of the Map Definition resource id

Declaration

public RuntimeMap CreateMap(IMapDefinition mdf, double metersPerUnit)

Parameters

Type	Name	Description
IMapDefinition	mdf	The map definition.
System.Double	metersPerUnit	The meters per unit.

Returns

Type	Description
RuntimeMap

CreateMap(IMapDefinition, Double, Boolean)

Creates a new runtime map instance from an existing map definition. The runtime map resource id is calculated from the current session id and the name component of the Map Definition resource id

Declaration

public RuntimeMap CreateMap(IMapDefinition mdf, double metersPerUnit, bool suppressErrors)

Parameters

Type	Name	Description
IMapDefinition	mdf	The map definition.
System.Double	metersPerUnit	The meters per unit.
System.Boolean	suppressErrors

Returns

Type	Description
RuntimeMap

CreateMap(String, IMapDefinition)

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.

Declaration

public RuntimeMap CreateMap(string runtimeMapResourceId, IMapDefinition mdf)

Parameters

Type	Name	Description
System.String	runtimeMapResourceId
IMapDefinition	mdf

Returns

Type	Description
RuntimeMap

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.

CreateMap(String, IMapDefinition, Boolean)

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.

Declaration

public RuntimeMap CreateMap(string runtimeMapResourceId, IMapDefinition mdf, bool suppressErrors)

Parameters

Type	Name	Description
System.String	runtimeMapResourceId
IMapDefinition	mdf
System.Boolean	suppressErrors

Returns

Type	Description
RuntimeMap

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.

CreateMap(String, IMapDefinition, Double)

Creates a new runtime map instance from an existing map definition

Declaration

public virtual RuntimeMap CreateMap(string runtimeMapResourceId, IMapDefinition mdf, double metersPerUnit)

Parameters

Type	Name	Description
System.String	runtimeMapResourceId
IMapDefinition	mdf
System.Double	metersPerUnit

Returns

Type	Description
RuntimeMap

CreateMap(String, IMapDefinition, Double, Boolean)

Creates a new runtime map instance from an existing map definition

Declaration

public virtual RuntimeMap CreateMap(string runtimeMapResourceId, IMapDefinition mdf, double metersPerUnit, bool suppressErrors)

Parameters

Type	Name	Description
System.String	runtimeMapResourceId
IMapDefinition	mdf
System.Double	metersPerUnit
System.Boolean	suppressErrors

Returns

Type	Description
RuntimeMap

CreateMap(String, String)

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.

Declaration

public RuntimeMap CreateMap(string runtimeMapResourceId, string baseMapDefinitionId)

Parameters

Type	Name	Description
System.String	runtimeMapResourceId
System.String	baseMapDefinitionId

Returns

Type	Description
RuntimeMap

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.

CreateMap(String, String, Boolean)

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.

Declaration

public RuntimeMap CreateMap(string runtimeMapResourceId, string baseMapDefinitionId, bool suppressErrors)

Parameters

Type	Name	Description
System.String	runtimeMapResourceId
System.String	baseMapDefinitionId
System.Boolean	suppressErrors

Returns

Type	Description
RuntimeMap

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.

CreateMap(String, String, Double)

Creates a new runtime map instance from an existing map definition

Declaration

public virtual RuntimeMap CreateMap(string runtimeMapResourceId, string baseMapDefinitionId, double metersPerUnit)

Parameters

Type	Name	Description
System.String	runtimeMapResourceId
System.String	baseMapDefinitionId
System.Double	metersPerUnit

Returns

Type	Description
RuntimeMap

CreateMap(String, String, Double, Boolean)

Creates a new runtime map instance from an existing map definition

Declaration

public virtual RuntimeMap CreateMap(string runtimeMapResourceId, string baseMapDefinitionId, double metersPerUnit, bool suppressErrors)

Parameters

Type	Name	Description
System.String	runtimeMapResourceId
System.String	baseMapDefinitionId
System.Double	metersPerUnit
System.Boolean	suppressErrors

Returns

Type	Description
RuntimeMap

CreateMapGroup(RuntimeMap, IBaseMapGroup)

Creates a new runtime map group

Declaration

public virtual RuntimeMapGroup CreateMapGroup(RuntimeMap parent, IBaseMapGroup group)

Parameters

Type	Name	Description
RuntimeMap	parent	The map.
IBaseMapGroup	group	The group.

Returns

Type	Description
RuntimeMapGroup

CreateMapGroup(RuntimeMap, IMapLayerGroup)

Creates a new runtime map group

Declaration

public virtual RuntimeMapGroup CreateMapGroup(RuntimeMap parent, IMapLayerGroup group)

Parameters

Type	Name	Description
RuntimeMap	parent	The parent runtime map. The runtime map must have been created or opened from this same service instance
IMapLayerGroup	group	The group.

Returns

Type	Description
RuntimeMapGroup

CreateMapGroup(RuntimeMap, String)

Creates the map group.

Declaration

public virtual RuntimeMapGroup CreateMapGroup(RuntimeMap parent, string name)

Parameters

Type	Name	Description
RuntimeMap	parent	The parent runtime map. The runtime map must have been created or opened from this same service instance
System.String	name	The name.

Returns

Type	Description
RuntimeMapGroup

CreateMapLayer(RuntimeMap, ILayerDefinition)

Creates a new runtime map layer from the specified Layer Definition

Declaration

public virtual RuntimeMapLayer CreateMapLayer(RuntimeMap parent, ILayerDefinition ldf)

Parameters

Type	Name	Description
RuntimeMap	parent	The parent runtime map. The runtime map must have been created or opened from this same service instance
ILayerDefinition	ldf	The layer definition

Returns

Type	Description
RuntimeMapLayer

CreateMapLayer(RuntimeMap, ILayerDefinition, Boolean)

Creates a new runtime map layer from the specified Layer Definition

Declaration

public virtual RuntimeMapLayer CreateMapLayer(RuntimeMap parent, ILayerDefinition ldf, bool suppressErrors)

Parameters

Type	Name	Description
RuntimeMap	parent	The parent runtime map. The runtime map must have been created or opened from this same service instance
ILayerDefinition	ldf	The layer definition
System.Boolean	suppressErrors

Returns

Type	Description
RuntimeMapLayer

CreateMapLayer(RuntimeMap, IBaseMapLayer)

Creates a new runtime map layer from the specified IBaseMapLayer instance

Declaration

public RuntimeMapLayer CreateMapLayer(RuntimeMap parent, IBaseMapLayer source)

Parameters

Type	Name	Description
RuntimeMap	parent	The parent runtime map. The runtime map must have been created or opened from this same service instance
IBaseMapLayer	source	The map definition layer

Returns

Type	Description
RuntimeMapLayer

CreateMapLayer(RuntimeMap, IBaseMapLayer, Boolean)

Creates a new runtime map layer from the specified IBaseMapLayer instance

Declaration

public RuntimeMapLayer CreateMapLayer(RuntimeMap parent, IBaseMapLayer source, bool suppressErrors)

Parameters

Type	Name	Description
RuntimeMap	parent	The parent runtime map. The runtime map must have been created or opened from this same service instance
IBaseMapLayer	source	The map definition layer
System.Boolean	suppressErrors

Returns

Type	Description
RuntimeMapLayer

CreateMapLayer(RuntimeMap, IMapLayer)

Creates a new runtime map layer from the specified IBaseMapLayer instance

Declaration

public RuntimeMapLayer CreateMapLayer(RuntimeMap parent, IMapLayer source)

Parameters

Type	Name	Description
RuntimeMap	parent	The parent runtime map. The runtime map must have been created or opened from this same service instance
IMapLayer	source	The map definition layer

Returns

Type	Description
RuntimeMapLayer

CreateMapLayer(RuntimeMap, IMapLayer, Boolean)

Creates a new runtime map layer from the specified IBaseMapLayer instance

Declaration

public RuntimeMapLayer CreateMapLayer(RuntimeMap parent, IMapLayer source, bool suppressErrors)

Parameters

Type	Name	Description
RuntimeMap	parent	The parent runtime map. The runtime map must have been created or opened from this same service instance
IMapLayer	source	The map definition layer
System.Boolean	suppressErrors

Returns

Type	Description
RuntimeMapLayer

DeleteResource(String)

Deletes the resource.

Declaration

public abstract void DeleteResource(string resourceID)

Parameters

Type	Name	Description
System.String	resourceID	The resourceid.

DescribeFeatureSource(String)

Gets the feature source description.

Declaration

public virtual FeatureSourceDescription DescribeFeatureSource(string resourceID)

Parameters

Type	Name	Description
System.String	resourceID	The resource ID.

Returns

Type	Description
FeatureSourceDescription

DescribeFeatureSource(String, String)

Describes the feature source.

Declaration

public abstract FeatureSchema DescribeFeatureSource(string resourceID, string schema)

Parameters

Type	Name	Description
System.String	resourceID	The resource ID.
System.String	schema	The schema.

Returns

Type	Description
FeatureSchema

DescribeFeatureSourceInternal(String)

Calls the actual implementation of the DescribeFeatureSource API

Declaration

protected abstract FeatureSourceDescription DescribeFeatureSourceInternal(string resourceId)

Parameters

Type	Name	Description
System.String	resourceId

Returns

Type	Description
FeatureSourceDescription

DescribeFeatureSourcePartial(String, String, String[])

Describes the specified feature source restricted to only the specified schema and the specified class names

Declaration

public abstract FeatureSchema DescribeFeatureSourcePartial(string resourceID, string schema, string[] classNames)

Parameters

Type	Name	Description
System.String	resourceID
System.String	schema
System.String[]	classNames

Returns

Type	Description
FeatureSchema

DeserializeObject(Type, Stream)

Deserializes an object from a stream.

Declaration

public virtual object DeserializeObject(Type type, Stream data)

Parameters

Type	Name	Description
System.Type	type	The expected object type
System.IO.Stream	data	The stream containing the object

Returns

Type	Description
System.Object	The deserialized object

DeserializeObject<T>(Stream)

Deserializes an object from a stream.

Declaration

public virtual T DeserializeObject<T>(Stream data)

Parameters

Type	Name	Description
System.IO.Stream	data	The stream containing the object

Returns

Type	Description
T	The deserialized object

Type Parameters

Name	Description
T	The expected object type

Dispose()

Releases unmanaged and - optionally - managed resources

Declaration

public void Dispose()

Dispose(Boolean)

Dispose of this instance

Declaration

protected virtual void Dispose(bool disposing)

Parameters

Type	Name	Description
System.Boolean	disposing

EnumerateDataStores(String, String)

Enumerates the data stores.

Declaration

public abstract DataStoreList EnumerateDataStores(string providerName, string partialConnString)

Parameters

Type	Name	Description
System.String	providerName	Name of the provider.
System.String	partialConnString	The partial conn string.

Returns

Type	Description
DataStoreList

EnumerateResourceReferences(String)

Enumereates all references to a given resource

Declaration

public abstract ResourceReferenceList EnumerateResourceReferences(string resourceid)

Parameters

Type	Name	Description
System.String	resourceid	The resource to enumerate references for

Returns

Type	Description
ResourceReferenceList	A list of resources that reference the given resourceID

EnumerateUnmanagedData(String, String, Boolean, UnmanagedDataTypes)

Enumerates all unmanaged folders, meaning alias'ed folders

Declaration

public abstract UnmanagedDataList EnumerateUnmanagedData(string startpath, string filter, bool recursive, UnmanagedDataTypes type)

Parameters

Type	Name	Description
System.String	startpath	The path to retrieve the data from
System.String	filter	A filter applied to the items
System.Boolean	recursive	True if the list should contains recursive results
UnmanagedDataTypes	type	The type of data to return

Returns

Type	Description
UnmanagedDataList	A list of unmanaged data

ExecuteLoadProcedure(ILoadProcedure, LengthyOperationProgressCallBack, Boolean)

Executes the load procedure.

Declaration

public virtual string[] ExecuteLoadProcedure(ILoadProcedure loadProc, LengthyOperationProgressCallBack callback, bool ignoreUnsupported)

Parameters

Type	Name	Description
ILoadProcedure	loadProc	The load proc.
LengthyOperationProgressCallBack	callback	The callback.
System.Boolean	ignoreUnsupported	if set to true [ignore unsupported].

Returns

Type	Description
System.String[]	An array of resource IDs that were created from the execution of this load procedure

ExecuteLoadProcedure(String, LengthyOperationProgressCallBack, Boolean)

Executes the load procedure.

Declaration

public virtual string[] ExecuteLoadProcedure(string resourceID, LengthyOperationProgressCallBack callback, bool ignoreUnsupported)

Parameters

Type	Name	Description
System.String	resourceID	The resource ID.
LengthyOperationProgressCallBack	callback	The callback.
System.Boolean	ignoreUnsupported	if set to true [ignore unsupported].

Returns

Type	Description
System.String[]

Finalize()

Finalizer

Declaration

protected void Finalize()

FixAndValidateFolderPath(String)

Validates the origin of the folder, and ensures the folder path has a trailing slash.

Declaration

protected virtual string FixAndValidateFolderPath(string folderpath)

Parameters

Type	Name	Description
System.String	folderpath	The path to validate and fix

Returns

Type	Description
System.String	The fixed path

GetCalculator()

Gets the MPU calculator

Declaration

public virtual IMpuCalculator GetCalculator()

Returns

Type	Description
IMpuCalculator

GetClassDefinition(String, String)

Gets the class definition.

Declaration

public virtual ClassDefinition GetClassDefinition(string resourceID, string className)

Parameters

Type	Name	Description
System.String	resourceID	The resource ID.
System.String	className	The class name to look for.

Returns

Type	Description
ClassDefinition

GetClassDefinitionInternal(String, String, String)

Fetches the specified class definition

Declaration

protected abstract ClassDefinition GetClassDefinitionInternal(string resourceId, string schemaName, string className)

Parameters

Type	Name	Description
System.String	resourceId
System.String	schemaName
System.String	className

Returns

Type	Description
ClassDefinition

GetClassNames(String, String)

Gets the class names.

Declaration

public abstract string[] GetClassNames(string resourceId, string schemaName)

Parameters

Type	Name	Description
System.String	resourceId	The resource id.
System.String	schemaName	Name of the schema.

Returns

Type	Description
System.String[]

GetCustomProperty(String)

Gets the custom property.

Declaration

public abstract object GetCustomProperty(string name)

Parameters

Type	Name	Description
System.String	name	The name.

Returns

Type	Description
System.Object

GetCustomPropertyNames()

Gets the custom property names.

Declaration

public abstract string[] GetCustomPropertyNames()

Returns

Type	Description
System.String[]

GetCustomPropertyType(String)

Gets the type of the custom property.

Declaration

public abstract Type GetCustomPropertyType(string name)

Parameters

Type	Name	Description
System.String	name	The name.

Returns

Type	Description
System.Type

GetFeatureProvider(String)

Returns an installed provider, given the name of the provider

Declaration

public virtual FeatureProviderRegistryFeatureProvider GetFeatureProvider(string providername)

Parameters

Type	Name	Description
System.String	providername	The name of the provider

Returns

Type	Description
FeatureProviderRegistryFeatureProvider	The first matching provider or null

GetFolderHeader(String)

Gets the folder header.

Declaration

public virtual ResourceFolderHeaderType GetFolderHeader(string resourceID)

Parameters

Type	Name	Description
System.String	resourceID	The resource ID.

Returns

Type	Description
ResourceFolderHeaderType

GetFolderOrResourceHeader(String)

Gets the folder or resource header.

Declaration

public abstract object GetFolderOrResourceHeader(string resourceId)

Parameters

Type	Name	Description
System.String	resourceId	The resource id.

Returns

Type	Description
System.Object

GetIdentityProperties(String, String)

Gets the names of the identity properties from a feature

Declaration

public abstract string[] GetIdentityProperties(string resourceID, string classname)

Parameters

Type	Name	Description
System.String	resourceID	The resourceID for the FeatureSource
System.String	classname	The classname of the feature, including schema

Returns

Type	Description
System.String[]	A string array with the found identities

GetInterface()

Gets the interface of this connection

Declaration

protected abstract IServerConnection GetInterface()

Returns

Type	Description
IServerConnection

GetLongTransactions(String, Boolean)

Gets the long transactions for the specified feature source

Declaration

public abstract ILongTransactionList GetLongTransactions(string resourceId, bool activeOnly)

Parameters

Type	Name	Description
System.String	resourceId	The feature source id
System.Boolean	activeOnly	If true, will only return active long transactions

Returns

Type	Description
ILongTransactionList

GetPreviewUrlGenerator()

Gets the preview URL generator.

Declaration

public virtual IResourcePreviewUrlGenerator GetPreviewUrlGenerator()

Returns

Type	Description
IResourcePreviewUrlGenerator	The preview URL generator. Returns null if this connection does not support browser-based resource previews

GetRepositoryResources()

Gets a full list of resources in the permanent server repository (Library). This method returns the full catalog and should be used sparringly.

Declaration

public virtual ResourceList GetRepositoryResources()

Returns

Type	Description
ResourceList	A list of contained resources

GetRepositoryResources(Int32)

Gets a list of resources in the permanent server repository (Library). This method limits folder recursion to the specified depth.

Declaration

public virtual ResourceList GetRepositoryResources(int depth)

Parameters

Type	Name	Description
System.Int32	depth	The max depth to recurse. Use -1 for no limit.

Returns

Type	Description
ResourceList	A list of contained resources

GetRepositoryResources(String)

Gets a list of resources in the permanent server repository (Library). This method limits folder recursion to the specified depth.

Declaration

public virtual ResourceList GetRepositoryResources(string startingpoint)

Parameters

Type	Name	Description
System.String	startingpoint	The folder from which to return items. Use null for "Library://"

Returns

Type	Description
ResourceList	A list of contained resources

GetRepositoryResources(String, Int32)

Gets a list of resources in the permanent server repository (Library). This method limits folder recursion to the specified depth.

Declaration

public virtual ResourceList GetRepositoryResources(string startingpoint, int depth)

Parameters

Type	Name	Description
System.String	startingpoint	The folder from which to return items. Use null for "Library://"
System.Int32	depth	The max depth to recurse. Use -1 for no limit.

Returns

Type	Description
ResourceList	A list of contained resources

GetRepositoryResources(String, String)

Gets a list of resources in the permanent server repository (Library). This method limits folder recursion to the specified depth.

Declaration

public virtual ResourceList GetRepositoryResources(string startingpoint, string type)

Parameters

Type	Name	Description
System.String	startingpoint	The folder from which to return items. Use null for "Library://"
System.String	type	The type of resource to look for. Basically this is the resource extension, like ".MapDefinition". Use null for all resources.

Returns

Type	Description
ResourceList	A list of contained resources

GetRepositoryResources(String, String, Int32)

Gets a list of resources in the permanent server repository (Library). This method limits folder recursion to the specified depth.

Declaration

public ResourceList GetRepositoryResources(string startingpoint, string type, int depth)

Parameters

Type	Name	Description
System.String	startingpoint	The folder from which to return items. Use null for "Library://"
System.String	type	The type of resource to look for. Basically this is the resource extension, like ".MapDefinition". Use null for all resources.
System.Int32	depth	The max depth to recurse. Use -1 for no limit.

Returns

Type	Description
ResourceList	A list of contained resources

GetRepositoryResources(String, String, Int32, Boolean)

Gets a list of resources in the permanent server repository (Library).

Declaration

public abstract ResourceList GetRepositoryResources(string startingpoint, string type, int depth, bool computeChildren)

Parameters

Type	Name	Description
System.String	startingpoint	The folder from which to return items. Use null for "Library://"
System.String	type	The type of resource to look for. Basically this is the resource extension, like ".MapDefinition". Use null for all resources.
System.Int32	depth	The max depth to recurse. Use -1 for no limit.
System.Boolean	computeChildren	A flag indicating if the count of subfolders and resources should be calculated for leaf nodes

Returns

Type	Description
ResourceList	A list of contained resources

GetResource(String)

Returns an object deserialized from server data. Uses the ResourceID to infer the object type.

Declaration

public virtual IResource GetResource(string resourceID)

Parameters

Type	Name	Description
System.String	resourceID	The full resourceID of the item to retrieve.

Returns

Type	Description
IResource	A deserialized object.

GetResourceData(String, String)

Returns data from a resource as a memorystream

Declaration

public abstract Stream GetResourceData(string resourceID, string dataname)

Parameters

Type	Name	Description
System.String	resourceID	The id of the resource to fetch data from
System.String	dataname	The name of the associated data item

Returns

Type	Description
System.IO.Stream	A stream containing the references resource data

GetResourceHeader(String)

Gets the resource header.

Declaration

public virtual ResourceDocumentHeaderType GetResourceHeader(string resourceID)

Parameters

Type	Name	Description
System.String	resourceID	The resource ID.

Returns

Type	Description
ResourceDocumentHeaderType

GetResourceXmlData(String)

Returns raw data from the server a byte array

Declaration

public abstract Stream GetResourceXmlData(string resourceID)

Parameters

Type	Name	Description
System.String	resourceID	The full resourceID to get data from

Returns

Type	Description
System.IO.Stream	Raw data from the given resource

GetSchema(Type)

Gets the Xsd schema for a given type.

Declaration

protected virtual XmlSchema GetSchema(Type type)

Parameters

Type	Name	Description
System.Type	type	The type to get the schema for

Returns

Type	Description
System.Xml.Schema.XmlSchema	The schema for the given type

GetSchemaMapping(String, String)

Gets the schema mappings for the given FDO provider. These mappings form the basis for a custom configuration document for a feature source that supports configuration

Declaration

public abstract ConfigurationDocument GetSchemaMapping(string provider, string partialConnString)

Parameters

Type	Name	Description
System.String	provider	The FDO provider
System.String	partialConnString	The connection string

Returns

Type	Description
ConfigurationDocument

GetSchemas(String)

Gets the schemas.

Declaration

public abstract string[] GetSchemas(string resourceId)

Parameters

Type	Name	Description
System.String	resourceId	The resource id.

Returns

Type	Description
System.String[]

GetSerializer(Type)

Returns an XmlSerializer for the given type

Declaration

protected virtual XmlSerializer GetSerializer(Type type)

Parameters

Type	Name	Description
System.Type	type	The object type to serialize

Returns

Type	Description
System.Xml.Serialization.XmlSerializer	An XmlSerializer for the given type

GetSpatialContextInfo(String, Boolean)

Returns the spatial info for a given featuresource

Declaration

public abstract FdoSpatialContextList GetSpatialContextInfo(string resourceID, bool activeOnly)

Parameters

Type	Name	Description
System.String	resourceID	The ID of the resource to query
System.Boolean	activeOnly	Query only active items

Returns

Type	Description
FdoSpatialContextList	A list of spatial contexts

GetSpatialExtent(String, String, String)

Gets the spatial extent.

Declaration

public virtual IEnvelope GetSpatialExtent(string resourceID, string schema, string geometry)

Parameters

Type	Name	Description
System.String	resourceID	The resource ID.
System.String	schema	The schema.
System.String	geometry	The geometry.

Returns

Type	Description
IEnvelope

GetSpatialExtent(String, String, String, Boolean)

Gets the spatial extent.

Declaration

public virtual IEnvelope GetSpatialExtent(string resourceID, string schema, string geometry, bool allowFallbackToContextInformation)

Parameters

Type	Name	Description
System.String	resourceID	The resource ID.
System.String	schema	The schema.
System.String	geometry	The geometry.
System.Boolean	allowFallbackToContextInformation	if set to true [allow fallback to context information].

Returns

Type	Description
IEnvelope

GetSpatialExtent(String, String, String, String)

Gets the spatial extent.

Declaration

public virtual IEnvelope GetSpatialExtent(string resourceID, string schema, string geometry, string filter)

Parameters

Type	Name	Description
System.String	resourceID	The resource ID.
System.String	schema	The schema.
System.String	geometry	The geometry.
System.String	filter	The filter.

Returns

Type	Description
IEnvelope

GetSpatialExtent(String, String, String, String, Boolean)

Gets the spatial extent.

Declaration

protected virtual IEnvelope GetSpatialExtent(string resourceID, string schema, string geometry, string filter, bool allowFallbackToContextInformation)

Parameters

Type	Name	Description
System.String	resourceID	The resource ID.
System.String	schema	The schema.
System.String	geometry	The geometry.
System.String	filter	The filter.
System.Boolean	allowFallbackToContextInformation	if set to true [allow fallback to context information].

Returns

Type	Description
IEnvelope

Exceptions

Type	Condition
NullExtentException	Thrown if the geometric extent is null

HasFolder(String)

Returns a value indicating if a given folder exists

Declaration

public virtual bool HasFolder(string folderpath)

Parameters

Type	Name	Description
System.String	folderpath	The path of the folder

Returns

Type	Description
System.Boolean	True if the folder exists, false otherwise. Also returns false on error.

InferMPU(String, Double)

Infers the meters per unit value from the specified coordinate system

Declaration

protected virtual double InferMPU(string csWkt, double units)

Parameters

Type	Name	Description
System.String	csWkt
System.Double	units

Returns

Type	Description
System.Double

MoveFolder(String, String, Boolean)

Moves a folder and its content from one location to another. This does not update any references.

Declaration

public abstract void MoveFolder(string oldpath, string newpath, bool overwrite)

Parameters

Type	Name	Description
System.String	oldpath	The current folder path, the one moving from
System.String	newpath	The new folder path, the one moving to
System.Boolean	overwrite	True if the move can overwrite an existing folder, false otherwise

MoveFolderWithReferences(String, String, LengthyOperationCallBack, LengthyOperationProgressCallBack)

Moves a folder, and subsequently updates all resources pointing to the old resource path

Declaration

public virtual bool MoveFolderWithReferences(string oldpath, string newpath, LengthyOperationCallBack callback, LengthyOperationProgressCallBack progress)

Parameters

Type	Name	Description
System.String	oldpath	The current folder path, the one moving from
System.String	newpath	The new folder path, the one moving to
LengthyOperationCallBack	callback	A callback delegate, being called for non progress reporting events.
LengthyOperationProgressCallBack	progress	A callback delegate, being called for progress reporting events.

Returns

Type	Description
System.Boolean

MoveResource(String, String, Boolean)

Moves a resource from one location to another. This does not update any references.

Declaration

public abstract void MoveResource(string oldpath, string newpath, bool overwrite)

Parameters

Type	Name	Description
System.String	oldpath	The current resource path, the one moving from
System.String	newpath	The new resource path, the one moving to
System.Boolean	overwrite	True if the move can overwrite an existing resource, false otherwise

MoveResourceWithReferences(String, String, LengthyOperationCallBack, LengthyOperationProgressCallBack)

Moves a resource, and subsequently updates all resources pointing to the old resource path

Declaration

public virtual bool MoveResourceWithReferences(string oldpath, string newpath, LengthyOperationCallBack callback, LengthyOperationProgressCallBack progress)

Parameters

Type	Name	Description
System.String	oldpath	The current resource path, the one moving from
System.String	newpath	The new resource path, the one moving to
LengthyOperationCallBack	callback	A callback delegate, being called for non progress reporting events.
LengthyOperationProgressCallBack	progress	A callback delegate, being called for progress reporting events.

Returns

Type	Description
System.Boolean

OnRequestDispatched(String)

Called when [request dispatched].

Declaration

protected void OnRequestDispatched(string data)

Parameters

Type	Name	Description
System.String	data	The data.

OnResourceAdded(String)

Raises the ResourceAdded event

Declaration

protected void OnResourceAdded(string resId)

Parameters

Type	Name	Description
System.String	resId

OnResourceDeleted(String)

Raises the ResourceDeleted event

Declaration

protected void OnResourceDeleted(string resId)

Parameters

Type	Name	Description
System.String	resId

OnResourceUpdated(String)

Raises the ResourceUpdated event

Declaration

protected void OnResourceUpdated(string resId)

Parameters

Type	Name	Description
System.String	resId

OpenMap(String)

Opens the specified runtime map

Declaration

public virtual RuntimeMap OpenMap(string runtimeMapResourceId)

Parameters

Type	Name	Description
System.String	runtimeMapResourceId

Returns

Type	Description
RuntimeMap

PurgeCachedItemsOf(String)

Removes all cached items associated with the given feature source

Declaration

protected int PurgeCachedItemsOf(string resourceId)

Parameters

Type	Name	Description
System.String	resourceId

Returns

Type	Description
System.Int32

QueryFeatureSource(String, String)

Executes a feature query on the specified feature source

Declaration

public IFeatureReader QueryFeatureSource(string resourceID, string className)

Parameters

Type	Name	Description
System.String	resourceID	The Feature Source ID
System.String	className	The feature class name

Returns

Type	Description
IFeatureReader	A IFeatureReader containing the results of the query

QueryFeatureSource(String, String, String)

Executes a feature query on the specified feature source

Declaration

public IFeatureReader QueryFeatureSource(string resourceID, string className, string filter)

Parameters

Type	Name	Description
System.String	resourceID	The Feature Source ID
System.String	className	The feature class name
System.String	filter	The FDO filter string that determines what features will be returned

Returns

Type	Description
IFeatureReader	A IFeatureReader containing the results of the query

QueryFeatureSource(String, String, String, String[])

Executes a feature query on the specified feature source

Declaration

public IFeatureReader QueryFeatureSource(string resourceID, string className, string filter, string[] propertyNames)

Parameters

Type	Name	Description
System.String	resourceID	The Feature Source ID
System.String	className	The feature class name
System.String	filter	The FDO filter string that determines what features will be returned
System.String[]	propertyNames	A list of properties that are to be returned in the query result

Returns

Type	Description
IFeatureReader	A IFeatureReader containing the results of the query

QueryFeatureSource(String, String, String, String[], NameValueCollection)

Executes a feature query on the specified feature source

Declaration

public abstract IFeatureReader QueryFeatureSource(string resourceID, string className, string filter, string[] propertyNames, NameValueCollection computedProperties)

Parameters

Type	Name	Description
System.String	resourceID	The Feature Source ID
System.String	className	The feature class name
System.String	filter	The FDO filter string that determines what features will be returned
System.String[]	propertyNames	A list of properties that are to be returned in the query result
System.Collections.Specialized.NameValueCollection	computedProperties	A list of name/value pairs that contain the alias (name) for an FDO expression (value)

Returns

Type	Description
IFeatureReader	A IFeatureReader containing the results of the query

QueryFeatureSource(String, String, String, String[], NameValueCollection, Int32)

Executes a feature query on the specified feature source

Declaration

public virtual IFeatureReader QueryFeatureSource(string resourceID, string className, string filter, string[] propertyNames, NameValueCollection computedProperties, int limit)

Parameters

Type	Name	Description
System.String	resourceID	The Feature Source ID
System.String	className	The feature class name
System.String	filter	The FDO filter string that determines what features will be returned
System.String[]	propertyNames	A list of properties that are to be returned in the query result
System.Collections.Specialized.NameValueCollection	computedProperties	A list of name/value pairs that contain the alias (name) for an FDO expression (value)
System.Int32	limit	Limits the number of features returned in the reader. -1 for all features

Returns

Type	Description
IFeatureReader	A IFeatureReader containing the results of the query

RemoveVersionFromProviderName(String)

Removes the version numbers from a providername

Declaration

public virtual string RemoveVersionFromProviderName(string providername)

Parameters

Type	Name	Description
System.String	providername	The name of the provider, with or without version numbers

Returns

Type	Description
System.String	The provider name without version numbers

ResetFeatureSourceSchemaCache()

Resets the feature source schema cache.

Declaration

public virtual void ResetFeatureSourceSchemaCache()

ResourceExists(String)

Returns a boolean indicating if a given resource exists

Declaration

public virtual bool ResourceExists(string resourceID)

Parameters

Type	Name	Description
System.String	resourceID	The resource to look for

Returns

Type	Description
System.Boolean	True if the resource exists false otherwise. Also returns false on error.

SaveResource(IResource)

Saves the resource.

Declaration

public void SaveResource(IResource resource)

Parameters

Type	Name	Description
IResource	resource	The resource.

SaveResourceAs(IResource, String)

Saves the resource with the specified resource ID

Declaration

public void SaveResourceAs(IResource resource, string resourceid)

Parameters

Type	Name	Description
IResource	resource	The resource.
System.String	resourceid	The resourceid.

SerializeObject(Object)

Serialize an object into a new memory stream.

Declaration

public virtual MemoryStream SerializeObject(object o)

Parameters

Type	Name	Description
System.Object	o	The object to serialize

Returns

Type	Description
System.IO.MemoryStream	A memorystream with the serialized object

SerializeObject(Object, Stream)

Serializes an object into a stream

Declaration

public virtual void SerializeObject(object o, Stream stream)

Parameters

Type	Name	Description
System.Object	o	The object to serialize
System.IO.Stream	stream	The stream to serialize into

SetCustomProperty(String, Object)

Sets the custom property.

Declaration

public abstract void SetCustomProperty(string name, object value)

Parameters

Type	Name	Description
System.String	name	The name.
System.Object	value	The value.

SetFolderHeader(String, ResourceFolderHeaderType)

Sets the folder header.

Declaration

public virtual void SetFolderHeader(string resourceID, ResourceFolderHeaderType header)

Parameters

Type	Name	Description
System.String	resourceID	The resource ID.
ResourceFolderHeaderType	header	The header.

SetFolderOrResourceHeader(String, Object)

Sets the folder or resource header.

Declaration

public virtual void SetFolderOrResourceHeader(string resourceID, object header)

Parameters

Type	Name	Description
System.String	resourceID	The resource ID.
System.Object	header	The header.

SetResourceData(String, String, ResourceDataType, Stream)

Uploads data to a resource

Declaration

public virtual void SetResourceData(string resourceid, string dataname, ResourceDataType datatype, Stream stream)

Parameters

Type	Name	Description
System.String	resourceid	The id of the resource to update
System.String	dataname	The name of the data to update or create
ResourceDataType	datatype	The type of data
System.IO.Stream	stream	A stream containing the new content of the resource data

SetResourceData(String, String, ResourceDataType, Stream, Utility.StreamCopyProgressDelegate)

Uploads data to a resource

Declaration

public abstract void SetResourceData(string resourceid, string dataname, ResourceDataType datatype, Stream stream, Utility.StreamCopyProgressDelegate callback)

Parameters

Type	Name	Description
System.String	resourceid	The id of the resource to update
System.String	dataname	The name of the data to update or create
ResourceDataType	datatype	The type of data
System.IO.Stream	stream	A stream containing the new content of the resource data
Utility.StreamCopyProgressDelegate	callback	The callback.

SetResourceHeader(String, ResourceDocumentHeaderType)

Sets the resource header.

Declaration

public virtual void SetResourceHeader(string resourceID, ResourceDocumentHeaderType header)

Parameters

Type	Name	Description
System.String	resourceID	The resource ID.
ResourceDocumentHeaderType	header	The header.

SetResourceXmlData(String, Stream)

Writes raw data into a resource.

Declaration

public virtual void SetResourceXmlData(string resourceID, Stream stream)

Parameters

Type	Name	Description
System.String	resourceID	The resourceID to write into
System.IO.Stream	stream	The stream containing the data to write.

SetResourceXmlData(String, Stream, Stream)

Sets the resource XML data.

Declaration

public abstract void SetResourceXmlData(string resourceId, Stream content, Stream header)

Parameters

Type	Name	Description
System.String	resourceId	The resource id.
System.IO.Stream	content	The content.
System.IO.Stream	header	The header.

TestConnection(String)

Tests the connection.

Declaration

public abstract string TestConnection(string featuresource)

Parameters

Type	Name	Description
System.String	featuresource	The featuresource.

Returns

Type	Description
System.String

Touch(String)

Forces a timestamp update of the specified resource. This is akin to setting the resource's content using its existing content.

Declaration

public virtual void Touch(string resourceId)

Parameters

Type	Name	Description
System.String	resourceId

UpdateRepository(String, ResourceFolderHeaderType)

Updates the repository.

Declaration

public abstract void UpdateRepository(string resourceId, ResourceFolderHeaderType header)

Parameters

Type	Name	Description
System.String	resourceId	The resource id.
ResourceFolderHeaderType	header	The header.

UpdateResourceReferences(Object, String, String, Boolean)

Updates all resource references inside an object.

Declaration

public virtual void UpdateResourceReferences(object o, string oldresourcepath, string newresourcepath, bool folderupdates)

Parameters

Type	Name	Description
System.Object	o	The object in which the resource references are to be updated
System.String	oldresourcepath	The current resource path, the one updating from
System.String	newresourcepath	The new resource path, the one updating to
System.Boolean	folderupdates	True if the old and new resource path identifiers are folders, false otherwise

UpdateResourceReferences(Object, String, String, Boolean, Hashtable)

Updates all resource references inside an object.

Declaration

protected void UpdateResourceReferences(object o, string oldresourcepath, string newresourcepath, bool folderupdates, Hashtable visited)

Parameters

Type	Name	Description
System.Object	o	The object in which the resource references are to be updated
System.String	oldresourcepath	The current resource path, the one updating from
System.String	newresourcepath	The new resource path, the one updating to
System.Boolean	folderupdates	True if the old and new resource path identifiers are folders, false otherwise
System.Collections.Hashtable	visited	A hashtable with objects previously visited. Used for recursion, leave as null when calling from outside the API.

UploadPackage(String, Utility.StreamCopyProgressDelegate)

Upload a MapGuide Package file to the server

Declaration

public abstract void UploadPackage(string filename, Utility.StreamCopyProgressDelegate callback)

Parameters

Type	Name	Description
System.String	filename	Name of the file to upload
Utility.StreamCopyProgressDelegate	callback	A callback argument used to display progress. May be null.

ValidateVersion(SiteVersion)

Validates the current server version against the highest tested version.

Declaration

protected virtual void ValidateVersion(SiteVersion version)

Parameters

Type	Name	Description
SiteVersion	version	The version to validate

ValidateVersion(Version)

Validates the current server version against the highest tested version.

Declaration

protected virtual void ValidateVersion(Version version)

Parameters

Type	Name	Description
System.Version	version	The version to validate

WriteResource(String, Object)

Writes an object into a resourceID

Declaration

public virtual void WriteResource(string resourceID, object resource)

Parameters

Type	Name	Description
System.String	resourceID	The resource to write into
System.Object	resource	The resourcec to write

Events

RequestDispatched

Raised when a outbound request has been dispatched

Declaration

public event RequestEventHandler RequestDispatched

Event Type

Type	Description
RequestEventHandler

ResourceAdded

Raised when a resource is added

Declaration

public event ResourceEventHandler ResourceAdded

Event Type

Type	Description
ResourceEventHandler

ResourceDeleted

Raised when a resource is deleted. Note if a folder is deleted, this will only be raised for the folder and not its children. Also note that this is raised on any move operations as the original source is for all intents and purposes, deleted.

Declaration

public event ResourceEventHandler ResourceDeleted

Event Type

Type	Description
ResourceEventHandler

ResourceUpdated

Raised when a resource is updated

Declaration

public event ResourceEventHandler ResourceUpdated

Event Type

Type	Description
ResourceEventHandler