Class ClassDefinition

Represents a FDO class definition. A Class Definition defines the structure of features that originate from it in feature queries. Class Definitions usually contain a Geometry property for spatial features.

Class Definitions belong to a Feature Schema

Inheritance

System.Object

SchemaElement

ClassDefinition

Implements

IFdoSerializable

Inherited Members

SchemaElement.Name

SchemaElement.Description

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.Schema

Assembly: OSGeo.MapGuide.MaestroAPI.dll

Syntax

public sealed class ClassDefinition : SchemaElement, IFdoSerializable

Constructors

| Improve this Doc View Source

ClassDefinition(String, String)

Initializes a new instance of the ClassDefinition class.

Declaration

public ClassDefinition(string name, string description)

Parameters

Type	Name	Description
System.String	name	The name.
System.String	description	The description.

Properties

| Improve this Doc View Source

BaseClass

Gets or sets the base class

Declaration

public ClassDefinition BaseClass { get; set; }

Property Value

Type	Description
ClassDefinition

| Improve this Doc View Source

DefaultGeometryPropertyName

Gets or sets the name of the default geometry property.

Declaration

public string DefaultGeometryPropertyName { get; set; }

Property Value

Type	Description
System.String

| Improve this Doc View Source

IdentityProperties

Gets the identity properties

Declaration

public ReadOnlyCollection<DataPropertyDefinition> IdentityProperties { get; }

Property Value

Type	Description
System.Collections.ObjectModel.ReadOnlyCollection<DataPropertyDefinition>

| Improve this Doc View Source

IsAbstract

Gets or sets whether this is abstract

Declaration

public bool IsAbstract { get; set; }

Property Value

Type	Description
System.Boolean

| Improve this Doc View Source

IsComputed

Gets or sets whether this is computed. Computed classes should have its properties checked out (and possibly modified) before serving as a basis for a new class definition

Declaration

public bool IsComputed { get; set; }

Property Value

Type	Description
System.Boolean

| Improve this Doc View Source

Item[Int32]

Gets the property definition at the specified index

Declaration

public PropertyDefinition this[int index] { get; }

Parameters

Type	Name	Description
System.Int32	index

Property Value

Type	Description
PropertyDefinition

| Improve this Doc View Source

Parent

Gets the parent schema

Declaration

public FeatureSchema Parent { get; }

Property Value

Type	Description
FeatureSchema

| Improve this Doc View Source

Properties

Gets the properties

Declaration

public ReadOnlyCollection<PropertyDefinition> Properties { get; }

Property Value

Type	Description
System.Collections.ObjectModel.ReadOnlyCollection<PropertyDefinition>

| Improve this Doc View Source

QualifiedName

Gets the qualified name of this class. The qualified name takes the form [Schema Name]:[Class Name]

Declaration

public string QualifiedName { get; }

Property Value

Type	Description
System.String

Methods

| Improve this Doc View Source

AddProperty(DataPropertyDefinition, Boolean)

Adds the specified data property, with an option to include it as an identity property

Declaration

public void AddProperty(DataPropertyDefinition prop, bool identity)

Parameters

Type	Name	Description
DataPropertyDefinition	prop
System.Boolean	identity

| Improve this Doc View Source

AddProperty(PropertyDefinition)

Adds the specified property definition

Declaration

public void AddProperty(PropertyDefinition prop)

Parameters

Type	Name	Description
PropertyDefinition	prop

| Improve this Doc View Source

ClearIdentityProperties()

Removes the assigned identity properties

Declaration

public void ClearIdentityProperties()

| Improve this Doc View Source

Clone(ClassDefinition)

Creates a clone of the specified instance

Declaration

public static ClassDefinition Clone(ClassDefinition source)

Parameters

Type	Name	Description
ClassDefinition	source	The instance to clone.

Returns

Type	Description
ClassDefinition

| Improve this Doc View Source

FindProperty(String)

Gets a Property Definition by its name

Declaration

public PropertyDefinition FindProperty(string name)

Parameters

Type	Name	Description
System.String	name

Returns

Type	Description
PropertyDefinition	The matching property definition. null if none found

| Improve this Doc View Source

GetOrdinal(String)

Gets the ordinal of the specified property name

Declaration

public int GetOrdinal(string name)

Parameters

Type	Name	Description
System.String	name	The property name.

Returns

Type	Description
System.Int32

| Improve this Doc View Source

IndexOfProperty(PropertyDefinition)

Gets the index of the specified property

Declaration

public int IndexOfProperty(PropertyDefinition prop)

Parameters

Type	Name	Description
PropertyDefinition	prop

Returns

Type	Description
System.Int32

| Improve this Doc View Source

RemoveProperty(PropertyDefinition)

Removes the specified property from the properties collection. If it is a data property definition, it is also removed from the identity properties collection

Declaration

public bool RemoveProperty(PropertyDefinition prop)

Parameters

Type	Name	Description
PropertyDefinition	prop

Returns

Type	Description
System.Boolean

| Improve this Doc View Source

RemoveProperty(String)

Removes the property definition of the specified name. If it is a data property it is also removed from the identity properties (if it is specified as one)

Declaration

public void RemoveProperty(string propertyName)

Parameters

Type	Name	Description
System.String	propertyName

| Improve this Doc View Source

RemovePropertyAt(Int32)

Removes the property definition at the specified index. If it is a data property is is also removed from the identity properties (if it is specified as one)

Declaration

public void RemovePropertyAt(int index)

Parameters

Type	Name	Description
System.Int32	index

Explicit Interface Implementations

| Improve this Doc View Source

IFdoSerializable.ReadXml(XmlNode, XmlNamespaceManager)

Set the current element's content from the current XML node

Declaration

void IFdoSerializable.ReadXml(XmlNode node, XmlNamespaceManager mgr)

Parameters

Type	Name	Description
System.Xml.XmlNode	node
System.Xml.XmlNamespaceManager	mgr

| Improve this Doc View Source

IFdoSerializable.WriteXml(XmlDocument, XmlNode)

Writes the current element's content

Declaration

void IFdoSerializable.WriteXml(XmlDocument doc, XmlNode currentNode)

Parameters

Type	Name	Description
System.Xml.XmlDocument	doc
System.Xml.XmlNode	currentNode

Implements

IFdoSerializable