ECSchema.h

Go to the documentation of this file.

/*--------------------------------------------------------------------------------------+
|
|   Supplied under applicable software license agreement.
|
|   Copyright (c) 2018 Bentley Systems, Incorporated. All rights reserved.
|
+---------------------------------------------------------------------------------------*/
#pragma once

#include <ECObjects/ECInstance.h>
#include <ECObjects/ECObjects.h>
#include <ECObjects/ECEnabler.h>
#include <Bentley/RefCounted.h>
#include <Bentley/bvector.h>
#include <Bentley/bmap.h>
#include <Bentley/bset.h>

#define DEFAULT_VERSION_MAJOR   1
#define DEFAULT_VERSION_MINOR   0

EC_TYPEDEFS(QualifiedECAccessor);

BEGIN_BENTLEY_ECOBJECT_NAMESPACE




//=======================================================================================
//=======================================================================================
struct ECNameValidation
    {
private:
public:

    enum ValidationResult
        {
        RESULT_Valid = 0,                   
        RESULT_NullOrEmpty,                 
        RESULT_BeginsWithDigit,             
        RESULT_IncludesInvalidCharacters    
        };

    ECOBJECTS_EXPORT static bool                EncodeToValidName (WStringR encoded, WStringCR name);

    ECOBJECTS_EXPORT static bool                DecodeFromValidName (WStringR decoded, WStringCR name);

    ECOBJECTS_EXPORT static ValidationResult    Validate (WCharCP name);

    ECOBJECTS_EXPORT static bool                IsValidName (WCharCP name);

    ECOBJECTS_EXPORT static bool IsValidAlphaNumericCharacter (WChar c);
    };

//=======================================================================================    
//=======================================================================================
struct ECTypeDescriptor /*__PUBLISH_SEALED__*/
{
private:
    ValueKind       m_typeKind;

    union
        {
        ArrayKind       m_arrayKind;
        PrimitiveType   m_primitiveType;
        };

public:
    ECOBJECTS_EXPORT static ECTypeDescriptor   CreatePrimitiveTypeDescriptor (PrimitiveType primitiveType);

    ECOBJECTS_EXPORT static ECTypeDescriptor   CreatePrimitiveArrayTypeDescriptor (PrimitiveType primitiveType);

    ECOBJECTS_EXPORT static ECTypeDescriptor   CreateStructArrayTypeDescriptor ();
    ECOBJECTS_EXPORT static ECTypeDescriptor   CreateStructTypeDescriptor ();

    ECTypeDescriptor (PrimitiveType primitiveType) : m_typeKind (VALUEKIND_Primitive), m_primitiveType (primitiveType) { };


    inline ValueKind            GetTypeKind() const         { return m_typeKind; }
    inline ArrayKind            GetArrayKind() const        { return (ArrayKind)(m_arrayKind & 0xFF); }
    inline bool                 IsPrimitive() const         { return (GetTypeKind() == VALUEKIND_Primitive ); }
    inline bool                 IsStruct() const            { return (GetTypeKind() == VALUEKIND_Struct ); }
    inline bool                 IsArray() const             { return (GetTypeKind() == VALUEKIND_Array ); }
    inline bool                 IsPrimitiveArray() const    { return (GetTypeKind() == VALUEKIND_Array ) && (GetArrayKind() == ARRAYKIND_Primitive); }
    inline bool                 IsStructArray() const       { return (GetTypeKind() == VALUEKIND_Array ) && (GetArrayKind() == ARRAYKIND_Struct); }
    inline PrimitiveType        GetPrimitiveType() const    { return m_primitiveType; }
};

typedef int64_t ECClassId;
typedef int64_t ECPropertyId;
typedef int64_t ECSchemaId;

typedef bvector<IECInstancePtr> ECCustomAttributeCollection;
struct ECCustomAttributeInstanceIterable;
struct SupplementedSchemaBuilder;

//=======================================================================================
//=======================================================================================
struct IECCustomAttributeContainer
{
private:
    virtual void MakeClassAbstract() = 0;
public:
public:
    ECOBJECTS_EXPORT bool               IsDefined(WStringCR schemaName, WStringCR className) const;
    ECOBJECTS_EXPORT bool               IsDefined(ECClassCR classDefinition) const;

    ECOBJECTS_EXPORT IECInstancePtr     GetCustomAttribute(WStringCR schemaName, WStringCR className) const;

    ECOBJECTS_EXPORT IECInstancePtr     GetCustomAttribute(ECClassCR classDefinition) const;

    ECOBJECTS_EXPORT IECInstancePtr     GetCustomAttributeLocal(WStringCR schemaName, WStringCR className) const;

    ECOBJECTS_EXPORT IECInstancePtr     GetCustomAttributeLocal(ECClassCR classDefinition) const;

    ECOBJECTS_EXPORT IECInstancePtr     GetPrimaryCustomAttribute(WStringCR schemaName, WStringCR className) const;

    ECOBJECTS_EXPORT IECInstancePtr     GetPrimaryCustomAttribute(ECClassCR classDefinition) const;

    ECOBJECTS_EXPORT ECCustomAttributeInstanceIterable GetCustomAttributes(bool includeBase) const;

    ECOBJECTS_EXPORT ECCustomAttributeInstanceIterable GetPrimaryCustomAttributes(bool includeBase) const;

    ECOBJECTS_EXPORT ECObjectsStatus    SetCustomAttribute(IECInstanceR customAttributeInstance);

    ECOBJECTS_EXPORT bool               RemoveCustomAttribute(WStringCR schemaName, WStringCR className);

    ECOBJECTS_EXPORT bool               RemoveCustomAttribute(ECClassCR classDefinition);
                
                ECOBJECTS_EXPORT bool               IsDefined(WStringCR className) const;
                ECOBJECTS_EXPORT IECInstancePtr     GetCustomAttribute(WStringCR className) const;
                ECOBJECTS_EXPORT IECInstancePtr     GetCustomAttributeLocal(WStringCR className) const;
                ECOBJECTS_EXPORT IECInstancePtr     GetPrimaryCustomAttribute(WStringCR className) const;
                ECOBJECTS_EXPORT bool               RemoveCustomAttribute(WStringCR className);
};

//=======================================================================================
//=======================================================================================
struct ECCustomAttributeInstanceIterable
{
private:
    friend struct IECCustomAttributeContainer;

    IECCustomAttributeContainerCR m_container;
    bool                        m_includeBaseContainers;
    bool                        m_includeSupplementalAttributes;
    ECCustomAttributeInstanceIterable( IECCustomAttributeContainerCR container, bool includeBase, bool includeSupplementalAttributes) : m_container(container), m_includeBaseContainers(includeBase),
    m_includeSupplementalAttributes(includeSupplementalAttributes) {};
public:
    struct IteratorState : RefCountedBase
        {
        friend struct const_iterator;

private:
    virtual void MakeClassAbstract() = 0;
public:
        };

    struct const_iterator : std::iterator<std::forward_iterator_tag, IECInstancePtr const>
        {
        private:
            friend struct ECCustomAttributeInstanceIterable;
            RefCountedPtr<IteratorState> m_state;
            bool m_isEnd;

        public:
            ECOBJECTS_EXPORT const_iterator&     operator++(); 
            ECOBJECTS_EXPORT bool                operator!=(const_iterator const& rhs) const; 
            ECOBJECTS_EXPORT bool                operator==(const_iterator const& rhs) const; 
            ECOBJECTS_EXPORT IECInstancePtr const& operator* () const; 
        };

public:
    ECOBJECTS_EXPORT const_iterator begin () const; 
    ECOBJECTS_EXPORT const_iterator end ()   const; 
};

struct PrimitiveECProperty;

/*=================================================================================**/
struct IECTypeAdapterContext : RefCountedBase
    {
    static const uint32_t COMPONENT_INDEX_None = -1;
    };

typedef RefCountedPtr<IECTypeAdapterContext> IECTypeAdapterContextPtr;
    
/*=================================================================================**/
struct IECTypeAdapter : RefCountedBase
    {
    typedef bvector<WString> StandardValuesCollection;
private:
    virtual void MakeClassAbstract() = 0;
public:
public:
    ECOBJECTS_EXPORT bool                 CanConvertToString (IECTypeAdapterContextCR context) const;

    ECOBJECTS_EXPORT bool                 CanConvertFromString (IECTypeAdapterContextCR context) const;

    ECOBJECTS_EXPORT        bool ConvertToString (WStringR str, ECValueCR v, IECTypeAdapterContextCR context, IECInstanceCP formatter = NULL) const;

    ECOBJECTS_EXPORT        bool ConvertFromString (ECValueR v, WCharCP str, IECTypeAdapterContextCR context) const;

    ECOBJECTS_EXPORT        bool RequiresExpressionTypeConversion (EvaluationOptions evalOptions = EVALOPT_Legacy) const;

    ECOBJECTS_EXPORT        bool ConvertToExpressionType (ECValueR v, IECTypeAdapterContextCR context) const;

    ECOBJECTS_EXPORT        bool ConvertFromExpressionType (ECValueR v, IECTypeAdapterContextCR context) const;

    ECOBJECTS_EXPORT ECN::IECInstancePtr   CreateDefaultFormatter (bool includeAllValues, bool forDwg = false) const;

    ECOBJECTS_EXPORT bool                 HasStandardValues() const;


    ECOBJECTS_EXPORT bool                 IsStruct() const;

    ECOBJECTS_EXPORT bool                 IsTreatedAsString() const;

    ECOBJECTS_EXPORT ECN::IECInstancePtr    CondenseFormatterForSerialization (ECN::IECInstanceCR formatter) const;

    ECOBJECTS_EXPORT ECN::IECInstancePtr    PopulateDefaultFormatterProperties (ECN::IECInstanceCR formatter) const;

    ECOBJECTS_EXPORT bool                   SupportsUnits() const;

    ECOBJECTS_EXPORT bool                   GetUnits (UnitSpecR unit, IECTypeAdapterContextCR context) const;
    };

//=======================================================================================
//=======================================================================================
struct ECProperty /*abstract*/ : public IECCustomAttributeContainer
{
public:
    ECOBJECTS_EXPORT bool               IsCalculated() const;

    ECOBJECTS_EXPORT bool                                SetCalculatedPropertySpecification (IECInstanceP expressionAttribute);

    ECOBJECTS_EXPORT ECPropertyId       GetId() const;
    ECOBJECTS_EXPORT ECClassCR          GetClass() const;
    // ECClass implementation will index property by name so publicly name can not be reset
    ECOBJECTS_EXPORT WStringCR          GetName() const;
    ECOBJECTS_EXPORT bool               GetIsDisplayLabelDefined() const;
    ECOBJECTS_EXPORT bool               GetIsStruct() const;
    ECOBJECTS_EXPORT bool               GetIsArray() const;
    ECOBJECTS_EXPORT bool               GetIsPrimitive() const;

    ECOBJECTS_EXPORT ECObjectsStatus    SetTypeName(WString value);
    ECOBJECTS_EXPORT WString            GetTypeName() const;
    ECOBJECTS_EXPORT ECObjectsStatus    SetDescription(WStringCR value);
    ECOBJECTS_EXPORT WStringCR          GetDescription() const;
    ECOBJECTS_EXPORT WStringCR          GetInvariantDescription() const;
    ECOBJECTS_EXPORT ECObjectsStatus    SetDisplayLabel(WStringCR value);
    ECOBJECTS_EXPORT WStringCR          GetDisplayLabel() const;
    ECOBJECTS_EXPORT WStringCR          GetInvariantDisplayLabel() const;
    ECOBJECTS_EXPORT ECObjectsStatus    SetIsReadOnly(bool value);
    ECOBJECTS_EXPORT bool               GetIsReadOnly() const;
    ECOBJECTS_EXPORT ECObjectsStatus    SetBaseProperty(ECPropertyCP value);
    ECOBJECTS_EXPORT ECPropertyCP       GetBaseProperty() const;

    //@param[in]    isReadOnly  Valid values are 'True' and 'False' (case insensitive)
    ECOBJECTS_EXPORT ECObjectsStatus    SetIsReadOnly (WCharCP isReadOnly);

    ECOBJECTS_EXPORT PrimitiveECPropertyCP  GetAsPrimitiveProperty () const; 
    ECOBJECTS_EXPORT PrimitiveECPropertyP   GetAsPrimitivePropertyP (); 
    ECOBJECTS_EXPORT ArrayECPropertyCP      GetAsArrayProperty () const; 
    ECOBJECTS_EXPORT ArrayECPropertyP       GetAsArrayPropertyP (); 
    ECOBJECTS_EXPORT StructECPropertyCP     GetAsStructProperty () const; 
    ECOBJECTS_EXPORT StructECPropertyP      GetAsStructPropertyP (); 
};

//=======================================================================================
//=======================================================================================
struct PrimitiveECProperty : public ECProperty
{
    DEFINE_T_SUPER(ECProperty)
private:
    virtual void MakeClassAbstract() = 0;
public:
public:
    ECOBJECTS_EXPORT ECObjectsStatus SetType(PrimitiveType value);
    ECOBJECTS_EXPORT PrimitiveType GetType() const;
};

//=======================================================================================
//=======================================================================================
struct StructECProperty : public ECProperty
{
    DEFINE_T_SUPER(ECProperty)
private:
    virtual void MakeClassAbstract() = 0;
public:
public:
    ECOBJECTS_EXPORT ECObjectsStatus    SetType(ECClassCR value);
    ECOBJECTS_EXPORT ECClassCR          GetType() const; 
};

//=======================================================================================
//=======================================================================================
struct ArrayECProperty : public ECProperty
{
    DEFINE_T_SUPER(ECProperty)
public:
    ECOBJECTS_EXPORT ArrayKind GetKind() const;

    ECOBJECTS_EXPORT ECObjectsStatus    SetPrimitiveElementType(PrimitiveType value);
    ECOBJECTS_EXPORT PrimitiveType      GetPrimitiveElementType() const;
    ECOBJECTS_EXPORT ECObjectsStatus    SetStructElementType(ECClassCP value);
    ECOBJECTS_EXPORT ECClassCP          GetStructElementType() const;
    ECOBJECTS_EXPORT ECObjectsStatus    SetMinOccurs(uint32_t value);
    ECOBJECTS_EXPORT uint32_t           GetMinOccurs() const;
    ECOBJECTS_EXPORT ECObjectsStatus    SetMaxOccurs(uint32_t value);
    ECOBJECTS_EXPORT uint32_t           GetMaxOccurs() const;
};

//=======================================================================================
//=======================================================================================
struct ECPropertyIterable
{
private:
    friend struct ECClass;

    ECClassCR       m_ecClass;
    bool            m_includeBaseProperties;

    ECPropertyIterable(ECClassCR ecClass, bool includeBaseProperties);

public:
    struct IteratorState : RefCountedBase
        {
        friend struct const_iterator;
private:
    virtual void MakeClassAbstract() = 0;
public:
        };

    struct const_iterator : std::iterator<std::forward_iterator_tag, const ECPropertyP>
        {
        private:
            friend struct ECPropertyIterable;
            RefCountedPtr<IteratorState>   m_state;
            bool m_isEnd;


        public:
            ECOBJECTS_EXPORT const_iterator&     operator++(); 
            ECOBJECTS_EXPORT bool                operator!=(const_iterator const& rhs) const; 
            ECOBJECTS_EXPORT bool                operator==(const_iterator const& rhs) const; 
            ECOBJECTS_EXPORT ECPropertyP const&  operator* () const; 
        };

public:
    ECOBJECTS_EXPORT const_iterator begin () const; 
    ECOBJECTS_EXPORT const_iterator end ()   const; 

    ECOBJECTS_EXPORT ECPropertyCP   FindByDisplayLabel (WCharCP label) const;
    };

typedef bvector<ECClassP> ECBaseClassesList;
typedef bvector<ECClassP> ECDerivedClassesList;
typedef bvector<ECClassP> ECConstraintClassesList;


struct StandaloneECEnabler;
struct SearchPathSchemaFileLocater;
typedef RefCountedPtr<StandaloneECEnabler>  StandaloneECEnablerPtr;
typedef StandaloneECEnabler*                StandaloneECEnablerP;
typedef RefCountedPtr<ECSchema>             ECSchemaPtr;
typedef RefCountedPtr<SearchPathSchemaFileLocater> SearchPathSchemaFileLocaterPtr;

//=======================================================================================
//=======================================================================================
struct ECClass : IECCustomAttributeContainer
{
private:
    virtual void MakeClassAbstract() = 0;
public:
public:
    ECOBJECTS_EXPORT ECClassId             GetId() const;
    ECOBJECTS_EXPORT StandaloneECEnablerP  GetDefaultStandaloneEnabler() const;
    ECOBJECTS_EXPORT ECRelationshipClassCP GetRelationshipClassCP() const;
    ECOBJECTS_EXPORT ECRelationshipClassP GetRelationshipClassP();
    ECOBJECTS_EXPORT ECSchemaCR         GetSchema() const;
    // schemas index class by name so publicly name can not be reset
    ECOBJECTS_EXPORT WStringCR          GetName() const;
    ECOBJECTS_EXPORT WCharCP            GetFullName() const;
    ECOBJECTS_EXPORT bool               GetIsDisplayLabelDefined() const;
    ECOBJECTS_EXPORT ECPropertyIterable GetProperties() const;
    ECOBJECTS_EXPORT size_t GetPropertyCount (bool includeBaseProperties = true) const;
    ECOBJECTS_EXPORT const ECBaseClassesList& GetBaseClasses() const;
    ECOBJECTS_EXPORT const ECDerivedClassesList& GetDerivedClasses() const;

    ECOBJECTS_EXPORT ECObjectsStatus    SetDescription(WStringCR value);
    ECOBJECTS_EXPORT WStringCR          GetDescription() const;
    ECOBJECTS_EXPORT WStringCR          GetInvariantDescription() const;
    ECOBJECTS_EXPORT ECObjectsStatus    SetDisplayLabel(WStringCR value);
    ECOBJECTS_EXPORT WStringCR          GetDisplayLabel() const;
    ECOBJECTS_EXPORT WStringCR          GetInvariantDisplayLabel() const;

    ECOBJECTS_EXPORT ECPropertyIterable GetProperties(bool includeBaseProperties) const;

    ECOBJECTS_EXPORT ECObjectsStatus    SetIsStruct (WCharCP isStruct);
    ECOBJECTS_EXPORT ECObjectsStatus    SetIsStruct(bool value);
    ECOBJECTS_EXPORT bool               GetIsStruct() const;

    ECOBJECTS_EXPORT ECObjectsStatus    SetIsCustomAttributeClass (WCharCP isCustomAttribute);
    ECOBJECTS_EXPORT ECObjectsStatus    SetIsCustomAttributeClass(bool value);
    ECOBJECTS_EXPORT bool               GetIsCustomAttributeClass() const;

    ECOBJECTS_EXPORT ECObjectsStatus    SetIsDomainClass (WCharCP isDomainClass);
    ECOBJECTS_EXPORT ECObjectsStatus    SetIsDomainClass(bool value);
    ECOBJECTS_EXPORT bool               GetIsDomainClass() const;

    ECOBJECTS_EXPORT ECObjectsStatus    SetIsFinal(WCharCP isFinal);
    ECOBJECTS_EXPORT ECObjectsStatus    SetIsFinal(bool value);
    ECOBJECTS_EXPORT bool               GetIsFinal() const;

    ECOBJECTS_EXPORT ECObjectsStatus AddBaseClass(ECClassCR baseClass);

    ECOBJECTS_EXPORT bool            HasBaseClasses() const;

    ECOBJECTS_EXPORT ECObjectsStatus RemoveBaseClass(ECClassCR baseClass);

    ECOBJECTS_EXPORT bool            Is(ECClassCP targetClass) const;

    ECOBJECTS_EXPORT bool            Is(WCharCP name) const;
    ECOBJECTS_EXPORT bool            Is (WCharCP schemaName, WCharCP className) const;

    ECOBJECTS_EXPORT ECObjectsStatus CreatePrimitiveProperty(PrimitiveECPropertyP& ecProperty, WStringCR name);

    ECOBJECTS_EXPORT ECObjectsStatus CreatePrimitiveProperty(PrimitiveECPropertyP& ecProperty, WStringCR name, PrimitiveType primitiveType);

    ECOBJECTS_EXPORT ECObjectsStatus CreateStructProperty(StructECPropertyP& ecProperty, WStringCR name);

    ECOBJECTS_EXPORT ECObjectsStatus CreateStructProperty(StructECPropertyP& ecProperty, WStringCR name, ECClassCR structType);

    ECOBJECTS_EXPORT ECObjectsStatus CreateArrayProperty(ArrayECPropertyP& ecProperty, WStringCR name);

    ECOBJECTS_EXPORT ECObjectsStatus CreateArrayProperty(ArrayECPropertyP& ecProperty, WStringCR name, PrimitiveType primitiveType);

    ECOBJECTS_EXPORT ECObjectsStatus CreateArrayProperty(ArrayECPropertyP& ecProperty, WStringCR name, ECClassCP structType);

    ECOBJECTS_EXPORT ECObjectsStatus RemoveProperty(WStringCR name);

    ECOBJECTS_EXPORT ECPropertyP     GetPropertyP (WCharCP name, bool includeBaseClasses=true) const;

    ECOBJECTS_EXPORT ECPropertyP     GetPropertyP (WStringCR name, bool includeBaseClasses=true) const;

    ECOBJECTS_EXPORT ECPropertyP     GetPropertyP (Utf8CP name, bool includeBaseClasses=true) const;

    // ************************************************************************************************************************
    // ************************************  STATIC METHODS *******************************************************************
    // ************************************************************************************************************************

    ECOBJECTS_EXPORT static ECObjectsStatus ParseClassName (WStringR prefix, WStringR className, WStringCR qualifiedClassName);

    ECOBJECTS_EXPORT static WString GetQualifiedClassName(ECSchemaCR primarySchema, ECClassCR ecClass);

    ECOBJECTS_EXPORT static bool    ClassesAreEqualByName(ECClassCP currentBaseClass, const void * arg);


}; // ECClass

enum OrderIdStorageMode: uint8_t
    {
    ORDERIDSTORAGEMODE_None                     = 0,
    ORDERIDSTORAGEMODE_ProvidedByPersistence    = 1,         
    ORDERIDSTORAGEMODE_ProvidedByClient         = 2,
    };

enum ECRelationshipEnd 
    { 
    ECRelationshipEnd_Source = 0, 
    ECRelationshipEnd_Target  
    };

enum ECRelatedInstanceDirection
    {
    STRENGTHDIRECTION_Forward = 1,
    STRENGTHDIRECTION_Backward = 2
    };

enum StrengthType
    {
    STRENGTHTYPE_Referencing,
    STRENGTHTYPE_Holding,
    STRENGTHTYPE_Embedding
    } ;

//=======================================================================================
//=======================================================================================
struct RelationshipCardinality
{
private:
    uint32_t   m_lowerLimit;
    uint32_t   m_upperLimit;

public:
    ECOBJECTS_EXPORT RelationshipCardinality();

    ECOBJECTS_EXPORT RelationshipCardinality(uint32_t lowerLimit, uint32_t upperLimit);

    ECOBJECTS_EXPORT uint32_t GetLowerLimit() const;
    ECOBJECTS_EXPORT uint32_t GetUpperLimit() const;

    ECOBJECTS_EXPORT bool     IsUpperLimitUnbounded() const;

    ECOBJECTS_EXPORT WString ToString() const;

    // ************************************************************************************************************************
    // ************************************  STATIC METHODS *******************************************************************
    // ************************************************************************************************************************

    ECOBJECTS_EXPORT static RelationshipCardinalityCR ZeroOne();
    ECOBJECTS_EXPORT static RelationshipCardinalityCR ZeroMany();
    ECOBJECTS_EXPORT static RelationshipCardinalityCR OneOne();
    ECOBJECTS_EXPORT static RelationshipCardinalityCR OneMany();
};


//=======================================================================================
//=======================================================================================
struct ECRelationshipConstraint : IECCustomAttributeContainer
{
public:
 
    ECOBJECTS_EXPORT virtual ~ECRelationshipConstraint(); 

    ECOBJECTS_EXPORT bool                       GetIsMultiple() const;

    ECOBJECTS_EXPORT ECObjectsStatus            SetRoleLabel (WStringCR value);
    ECOBJECTS_EXPORT WString const              GetRoleLabel() const;
    ECOBJECTS_EXPORT WString const              GetInvariantRoleLabel() const;

    ECOBJECTS_EXPORT bool                       IsRoleLabelDefined() const;

    ECOBJECTS_EXPORT ECObjectsStatus            SetIsPolymorphic(bool value);
    ECOBJECTS_EXPORT bool                       GetIsPolymorphic() const;

    ECOBJECTS_EXPORT ECObjectsStatus            SetIsPolymorphic(WCharCP isPolymorphic);

    ECOBJECTS_EXPORT ECObjectsStatus            SetCardinality(RelationshipCardinalityCR value);
    ECOBJECTS_EXPORT ECObjectsStatus            SetCardinality(WCharCP cardinality);

    ECOBJECTS_EXPORT RelationshipCardinalityCR  GetCardinality() const;

    ECOBJECTS_EXPORT ECObjectsStatus            AddClass(ECClassCR classConstraint);

    ECOBJECTS_EXPORT ECObjectsStatus            RemoveClass(ECClassCR classConstraint);

    ECOBJECTS_EXPORT const                      ECConstraintClassesList& GetClasses() const;

    ECOBJECTS_EXPORT ECObjectsStatus            CopyTo(ECRelationshipConstraintR toRelationshipConstraint);

    ECOBJECTS_EXPORT bool                       GetIsOrdered () const;

    ECOBJECTS_EXPORT OrderIdStorageMode         GetOrderIdStorageMode () const;

    ECOBJECTS_EXPORT ECObjectsStatus            GetOrderedRelationshipPropertyName (WString& propertyName)  const;
};

//=======================================================================================
//=======================================================================================
struct ECRelationshipClass : public ECClass
{
    DEFINE_T_SUPER(ECClass)
private:
    virtual void MakeClassAbstract() = 0;
public:
public:
    ECOBJECTS_EXPORT ECObjectsStatus            GetOrderedRelationshipPropertyName (WString& propertyName, ECRelationshipEnd end)  const;
    ECOBJECTS_EXPORT ECObjectsStatus            SetStrength(StrengthType value);
    ECOBJECTS_EXPORT StrengthType               GetStrength() const;
    ECOBJECTS_EXPORT ECObjectsStatus            SetStrengthDirection(ECRelatedInstanceDirection value);
    ECOBJECTS_EXPORT ECRelatedInstanceDirection GetStrengthDirection() const;
    ECOBJECTS_EXPORT ECRelationshipConstraintR  GetTarget() const;
    ECOBJECTS_EXPORT ECRelationshipConstraintR  GetSource() const;

    ECOBJECTS_EXPORT bool                       GetIsExplicit() const;
    ECOBJECTS_EXPORT bool                       GetIsOrdered () const;

}; // ECRelationshipClass

typedef RefCountedPtr<ECRelationshipClass>      ECRelationshipClassPtr;

enum SchemaMatchType
    {
    SCHEMAMATCHTYPE_Identical           =   0,
    SCHEMAMATCHTYPE_Exact               =   1, //WIP: Rename this to NameAndVersion
    SCHEMAMATCHTYPE_LatestCompatible    =   2,
    SCHEMAMATCHTYPE_Latest              =   3, //WIP:Rename this to Name
    };

/*=================================================================================**/
struct SchemaKey
    {
    WString       m_schemaName;
    uint32_t      m_versionMajor;
    uint32_t      m_versionMinor;
    uint32_t      m_checkSum;

    SchemaKey (WCharCP name, uint32_t major, uint32_t minor) : m_schemaName(name), m_versionMajor(major), m_versionMinor(minor), m_checkSum(0){}

    SchemaKey () : m_versionMajor(DEFAULT_VERSION_MAJOR), m_versionMinor(DEFAULT_VERSION_MINOR), m_checkSum(0) {}

    ECOBJECTS_EXPORT static ECObjectsStatus ParseSchemaFullName (SchemaKey& key, WCharCP schemaFullName);

    ECOBJECTS_EXPORT bool LessThan (SchemaKeyCR rhs, SchemaMatchType matchType) const;
    
    ECOBJECTS_EXPORT bool Matches (SchemaKeyCR rhs, SchemaMatchType matchType) const;

    ECOBJECTS_EXPORT int  CompareByName (WString schemaName) const;

    bool operator == (SchemaKeyCR rhs) const
        {
        return Matches(rhs, SCHEMAMATCHTYPE_Identical);
        }

    bool operator != (SchemaKeyCR rhs) const
        {
        return !(*this == rhs);
        }

    bool operator < (SchemaKeyCR rhs) const
        {
        return LessThan (rhs, SCHEMAMATCHTYPE_Identical);
        }
    };

template <SchemaMatchType MatchType>
struct SchemaKeyMatch : std::binary_function<SchemaKey, SchemaKey, bool>
    {
    bool operator () (SchemaKeyCR lhs, SchemaKeyCR rhs) const
        {
        return lhs.Matches (rhs, MatchType);
        }
    };

template <SchemaMatchType MatchType>
struct SchemaKeyLessThan : std::binary_function<SchemaKey, SchemaKey, bool>
    {
    bool operator () (SchemaKeyCR lhs, SchemaKeyCR rhs) const
        {
        return lhs.LessThan (rhs, MatchType);
        }
    };


typedef bmap<SchemaKey , ECSchemaPtr> SchemaMap;

/*---------------------------------------------------------------------------------**/
struct SchemaKeyMatchPredicate
    {
    SchemaKeyCR     m_key;
    SchemaMatchType m_matchType;

    SchemaKeyMatchPredicate(SchemaKeyCR key, SchemaMatchType matchType) :m_key(key), m_matchType(matchType) {}

    typedef bpair<SchemaKey, ECSchemaPtr> MapVal;

    bool operator () (MapVal const& rhs)
        {
        return rhs.first.Matches (m_key, m_matchType);
        }
    };

/*---------------------------------------------------------------------------------**/
struct SchemaNameClassNamePair
    {
public:
    WString m_schemaName;
    WString m_className;

    SchemaNameClassNamePair (WStringCR schemaName, WStringCR className) : m_schemaName (schemaName), m_className  (className) {}
    SchemaNameClassNamePair (WCharCP schemaName, WCharCP className) : m_schemaName (schemaName), m_className  (className) {}
    SchemaNameClassNamePair() { }
    SchemaNameClassNamePair (WStringCR schemaAndClassNameSeparatedByColon)
        {
        BeAssert (WString::npos != schemaAndClassNameSeparatedByColon.find (':'));
        Parse (schemaAndClassNameSeparatedByColon);
        }

    bool Parse (WStringCR schemaAndClassNameSeparatedByColon)
        {
        size_t pos = schemaAndClassNameSeparatedByColon.find (':');
        if (WString::npos != pos)
            {
            m_schemaName = schemaAndClassNameSeparatedByColon.substr (0, pos);
            m_className = schemaAndClassNameSeparatedByColon.substr (pos+1);
            return true;
            }
        else
            return false;
        }

    bool operator<(SchemaNameClassNamePair other) const
        {
        if (m_schemaName < other.m_schemaName)
            return true;

        if (m_schemaName > other.m_schemaName)
            return false;

        return m_className < other.m_className;
        };

    bool operator==(SchemaNameClassNamePair const& rhs) const
        {
        return 0 == m_schemaName.CompareTo(rhs.m_schemaName) && 0 == m_className.CompareTo(rhs.m_className);
        }

    WString     ToColonSeparatedString() const
        {
        WString str;
        str.Sprintf (L"%ls:%ls", m_schemaName.c_str(), m_className.c_str());
        return str;
        }

    };

/*---------------------------------------------------------------------------------**/
struct QualifiedECAccessor
    {
protected:
    WString         m_schemaName;
    WString         m_className;
    WString         m_accessString;
public:
    QualifiedECAccessor() { }
    QualifiedECAccessor (WCharCP schemaName, WCharCP className, WCharCP accessString)
        : m_schemaName(schemaName), m_className(className), m_accessString(accessString) { }

    WCharCP     GetSchemaName() const           { return m_schemaName.c_str(); }
    WCharCP     GetClassName() const            { return m_className.c_str(); }
    WCharCP     GetAccessString() const         { return m_accessString.c_str(); }

    void        SetSchemaName (WCharCP name)    { m_schemaName = name; }
    void        SetClassName (WCharCP name)     { m_className = name; }
    void        SetAccessString (WCharCP acStr) { m_accessString = acStr; }

    ECOBJECTS_EXPORT WString    ToString() const;
    ECOBJECTS_EXPORT bool       FromString (WCharCP str);

    ECOBJECTS_EXPORT bool       FromAccessString (ECN::ECEnablerCR rootEnabler, WCharCP accessString);
    };

typedef bvector<QualifiedECAccessor> QualifiedECAccessorList;
typedef QualifiedECAccessorList const& QualifiedECAccessorListCR;

/*---------------------------------------------------------------------------------**/
struct SchemaMapExact:bmap<SchemaKey, ECSchemaPtr, SchemaKeyLessThan <SCHEMAMATCHTYPE_Exact> >
    {
    SchemaMapExact::const_iterator Find (SchemaKeyCR key, SchemaMatchType matchType) const
        {
        switch (matchType)
            {
            case SCHEMAMATCHTYPE_Exact:
                return find(key);
            default:
                return std::find_if(begin(), end(), SchemaKeyMatchPredicate(key, matchType));
            }
        }

    ECOBJECTS_EXPORT ECClassP  FindClassP (ECN::SchemaNameClassNamePair const& classNamePair) const;
    };

typedef SchemaMapExact                  ECSchemaReferenceList;
typedef const ECSchemaReferenceList&    ECSchemaReferenceListCR;

//=======================================================================================
//=======================================================================================
struct ECClassContainer
{
private:
    virtual void MakeClassAbstract() = 0;
public:
public:
    //=======================================================================================
    // @bsistruct
    //=======================================================================================
    struct IteratorState : RefCountedBase
        {
        friend struct const_iterator;
private:
    virtual void MakeClassAbstract() = 0;
public:
        };

    //=======================================================================================
    // @bsistruct
    //=======================================================================================
    struct const_iterator : std::iterator<std::forward_iterator_tag, ECClassP const>
    {
    private:
        friend struct ECClassContainer;
        RefCountedPtr<IteratorState>   m_state;


    public:
        ECOBJECTS_EXPORT const_iterator&     operator++(); 
        ECOBJECTS_EXPORT bool                operator!=(const_iterator const& rhs) const; 
        ECOBJECTS_EXPORT bool                operator==(const_iterator const& rhs) const; 
        ECOBJECTS_EXPORT ECClassP const&     operator* () const; 
    };

public:
    ECOBJECTS_EXPORT const_iterator begin () const; 
    ECOBJECTS_EXPORT const_iterator end ()   const; 

};


//=======================================================================================
//=======================================================================================
struct IStandaloneEnablerLocater
{
private:
    virtual void MakeClassAbstract() = 0;
public:

public:
    ECOBJECTS_EXPORT StandaloneECEnablerPtr  LocateStandaloneEnabler (SchemaKeyCR schemaKey, WCharCP className);
};


//=======================================================================================
//=======================================================================================
struct IECSchemaLocater
{
protected:
    virtual ECSchemaPtr _LocateSchema(SchemaKeyR key, SchemaMatchType matchType, ECSchemaReadContextR schemaContext) = 0;

public:
    ECOBJECTS_EXPORT ECSchemaPtr LocateSchema(SchemaKeyR key, SchemaMatchType matchType, ECSchemaReadContextR schemaContext);
};

typedef RefCountedPtr<ECSchemaCache>        ECSchemaCachePtr;
//=======================================================================================
//=======================================================================================
struct ECSchemaCache : public RefCountedBase
{
private:
    virtual void MakeClassAbstract() = 0;
public:
public:
    ECOBJECTS_EXPORT ECObjectsStatus AddSchema   (ECSchemaR schema);

    ECOBJECTS_EXPORT ECObjectsStatus DropSchema  (SchemaKeyCR key );

    ECOBJECTS_EXPORT ECSchemaP       GetSchema   (SchemaKeyCR key);

    ECOBJECTS_EXPORT ECSchemaP       GetSchema   (SchemaKeyCR key, SchemaMatchType matchType);

    ECOBJECTS_EXPORT virtual ~ECSchemaCache (); 
    ECOBJECTS_EXPORT static  ECSchemaCachePtr Create (); 
    ECOBJECTS_EXPORT int     GetCount(); 
    ECOBJECTS_EXPORT void    Clear(); 
    ECOBJECTS_EXPORT IECSchemaLocater& GetSchemaLocater(); 
    ECOBJECTS_EXPORT size_t GetSchemas (bvector<ECSchemaP>& schemas) const;
};


struct SupplementalSchemaInfo;
typedef RefCountedPtr<SupplementalSchemaInfo> SupplementalSchemaInfoPtr;

//=======================================================================================
//=======================================================================================
struct ECSchema : RefCountedBase
{
private:
    ECSchema (ECSchema const&);
    ECSchema& operator= (ECSchema const&);

private:
    virtual void MakeClassAbstract() = 0;
public:
public:
    ECOBJECTS_EXPORT SchemaKeyCR        GetSchemaKey() const; 
    ECOBJECTS_EXPORT void               DebugDump() const; 

    ECOBJECTS_EXPORT static void        SetErrorHandling (bool showMessages, bool doAssert);

    ECOBJECTS_EXPORT ECSchemaId         GetId() const;

    ECOBJECTS_EXPORT ECObjectsStatus    SetName(WStringCR value);
    ECOBJECTS_EXPORT WStringCR          GetName() const;
    ECOBJECTS_EXPORT ECObjectsStatus    SetNamespacePrefix(WStringCR value);
    ECOBJECTS_EXPORT WStringCR          GetNamespacePrefix() const;
    ECOBJECTS_EXPORT ECObjectsStatus    SetDescription(WStringCR value);
    ECOBJECTS_EXPORT WStringCR          GetDescription() const;
    ECOBJECTS_EXPORT WStringCR          GetInvariantDescription() const;
    ECOBJECTS_EXPORT ECObjectsStatus    SetDisplayLabel(WStringCR value);
    ECOBJECTS_EXPORT WStringCR          GetDisplayLabel() const;
    ECOBJECTS_EXPORT WStringCR          GetInvariantDisplayLabel() const;
    ECOBJECTS_EXPORT ECObjectsStatus    SetVersionMajor(uint32_t value);
    ECOBJECTS_EXPORT uint32_t           GetVersionMajor() const;
    ECOBJECTS_EXPORT ECObjectsStatus    SetVersionMinor(uint32_t value);
    ECOBJECTS_EXPORT uint32_t           GetVersionMinor() const;
    ECOBJECTS_EXPORT ECClassContainerCR GetClasses() const;

    ECOBJECTS_EXPORT uint32_t           GetClassCount() const;

    ECOBJECTS_EXPORT bool               GetIsDisplayLabelDefined() const;

    ECOBJECTS_EXPORT bool               IsStandardSchema() const;

    ECOBJECTS_EXPORT bool               IsSamePrimarySchema(ECSchemaR primarySchema) const;

    ECOBJECTS_EXPORT bool IsSupplementalSchema() const;

    ECOBJECTS_EXPORT bool               IsSupplemented() const;

    ECOBJECTS_EXPORT SupplementalSchemaInfoPtr const GetSupplementalInfo() const;

    ECOBJECTS_EXPORT bool               ShouldNotBeStored() const;

    ECOBJECTS_EXPORT static bool        ShouldNotBeStored (SchemaKeyCR key);

    ECOBJECTS_EXPORT ECObjectsStatus    CreateClass (ECClassP& ecClass, WStringCR name);

    ECOBJECTS_EXPORT ECObjectsStatus    CreateRelationshipClass (ECRelationshipClassP& relationshipClass, WStringCR name);

    ECOBJECTS_EXPORT ECSchemaCP         GetSchemaByNamespacePrefixP(WStringCR namespacePrefix) const;

    ECOBJECTS_EXPORT ECObjectsStatus    ResolveNamespacePrefix (ECSchemaCR schema, WStringR namespacePrefix) const;

    ECOBJECTS_EXPORT ECClassCP          GetClassCP (WCharCP name) const;

    ECOBJECTS_EXPORT ECClassP           GetClassP (WCharCP name);

    ECOBJECTS_EXPORT ECSchemaReferenceListCR GetReferencedSchemas() const;

    ECOBJECTS_EXPORT ECObjectsStatus            AddReferencedSchema(ECSchemaR refSchema);

    ECOBJECTS_EXPORT ECObjectsStatus            AddReferencedSchema(ECSchemaR refSchema, WStringCR prefix);

    ECOBJECTS_EXPORT ECObjectsStatus            RemoveReferencedSchema(ECSchemaR refSchema);

    //          will contain the serialized schema.  Otherwise, ecSchemaXml will be unmodified
    ECOBJECTS_EXPORT SchemaWriteStatus  WriteToXmlString (WStringR ecSchemaXml) const;

    //          will contain the serialized schema.  Otherwise, ecSchemaXml will be unmodified
    ECOBJECTS_EXPORT SchemaWriteStatus  WriteToXmlString (Utf8StringR ecSchemaXml) const;

    //          to by ecSchemaXmlFile will contain the serialized schema.  Otherwise, the file will be unmodified
    ECOBJECTS_EXPORT SchemaWriteStatus  WriteToXmlFile (WCharCP ecSchemaXmlFile, bool utf16 = false);


    ECOBJECTS_EXPORT SchemaWriteStatus  WriteToXmlStream (IStreamP ecSchemaXmlStream, bool utf16 = false);


    ECOBJECTS_EXPORT WString               GetFullSchemaName () const;

    ECOBJECTS_EXPORT ECObjectsStatus        CopyClass(ECClassP& targetClass, ECClassCR sourceClass);

    ECOBJECTS_EXPORT ECObjectsStatus        CopySchema(ECSchemaPtr& schemaOut) const;

    ECOBJECTS_EXPORT IECCustomAttributeContainer&   GetCustomAttributeContainer();
    ECOBJECTS_EXPORT IECCustomAttributeContainer const& GetCustomAttributeContainer() const;

    // ************************************************************************************************************************
    // ************************************  STATIC METHODS *******************************************************************
    // ************************************************************************************************************************
    ECOBJECTS_EXPORT static uint32_t        ComputeSchemaXmlStringCheckSum(WCharCP str, size_t len);

    ECOBJECTS_EXPORT static ECObjectsStatus CreateSchema (ECSchemaPtr& schemaOut, WStringCR schemaName,
                                                          uint32_t versionMajor, uint32_t versionMinor);

    ECOBJECTS_EXPORT static WString        FormatSchemaVersion (uint32_t& versionMajor, uint32_t& versionMinor);

    ECOBJECTS_EXPORT static ECObjectsStatus ParseSchemaFullName (WString& schemaName, uint32_t& versionMajor, uint32_t& versionMinor, WCharCP fullName);

    ECOBJECTS_EXPORT static ECObjectsStatus ParseSchemaFullName (WString& schemaName, uint32_t& versionMajor, uint32_t& versionMinor, WStringCR fullName);

    ECOBJECTS_EXPORT static ECObjectsStatus ParseVersionString (uint32_t& versionMajor, uint32_t& versionMinor, WCharCP versionString);

    ECOBJECTS_EXPORT static bool                        IsSchemaReferenced (ECSchemaCR thisSchema, ECSchemaCR potentiallyReferencedSchema);


    ECOBJECTS_EXPORT static SchemaReadStatus ReadFromXmlFile (ECSchemaPtr& schemaOut, WCharCP ecSchemaXmlFile, ECSchemaReadContextR schemaContext);

     ECOBJECTS_EXPORT static ECSchemaPtr  LocateSchema (SchemaKeyR schema, ECSchemaReadContextR schemaContext);

    ECOBJECTS_EXPORT static SchemaReadStatus ReadFromXmlString (ECSchemaPtr& schemaOut, Utf8CP ecSchemaXml, ECSchemaReadContextR schemaContext);

    ECOBJECTS_EXPORT static SchemaReadStatus ReadFromXmlString (ECSchemaPtr& schemaOut, WCharCP ecSchemaXml, ECSchemaReadContextR schemaContext);

    ECOBJECTS_EXPORT static SchemaReadStatus ReadFromXmlString (ECSchemaPtr& schemaOut, WCharCP ecSchemaXml, ECSchemaCacheR schemaCache);

    ECOBJECTS_EXPORT static SchemaReadStatus ReadFromXmlStream (ECSchemaPtr& schemaOut, IStreamP ecSchemaXmlStream, ECSchemaReadContextR schemaContext);

    ECOBJECTS_EXPORT static bool IsStandardSchema(WStringCR schemaName);

    ECOBJECTS_EXPORT void FindAllSchemasInGraph (bvector<ECN::ECSchemaCP>& allSchemas, bool includeRootSchema=true) const;
    ECOBJECTS_EXPORT void FindAllSchemasInGraph (bvector<ECN::ECSchemaP>& allSchemas, bool includeRootSchema=true);

    ECOBJECTS_EXPORT ECSchemaCP FindSchema (SchemaKeyCR schema, SchemaMatchType matchType) const;

    ECOBJECTS_EXPORT ECSchemaP FindSchemaP (SchemaKeyCR schema, SchemaMatchType matchType);

    ECOBJECTS_EXPORT void   SetImmutable();
}; // ECSchema

END_BENTLEY_ECOBJECT_NAMESPACE