UT_ORMConstraint.h

Go to the documentation of this file.

/*
 * PROPRIETARY INFORMATION.  This software is proprietary to
 * Side Effects Software Inc., and is not to be reproduced,
 * transmitted, or disclosed in any way without written permission.
 *
 * NAME:        UT_ORMConstraint.h
 *
 * COMMENTS:
 *
 *
 */

#ifndef __UT_ORMCONSTRAINT_H__
#define __UT_ORMCONSTRAINT_H__

#include "UT_API.h"

#include "UT_NonCopyable.h"
#include "UT_ORMDDLReference.h"
#include "UT_StringArray.h"
#include "UT_StringHolder.h"
#include "UT_UniquePtr.h"

class UT_IORMSchemaEditor;
class UT_ORMModelState;

class UT_API UT_IORMConstraint
{
public:
    virtual ~UT_IORMConstraint() = default;
    UT_NON_COPYABLE(UT_IORMConstraint);
    UT_IORMConstraint(UT_IORMConstraint&&) = default;
    UT_IORMConstraint& operator=(UT_IORMConstraint&&) = default;

    virtual UT_UniquePtr<UT_IORMConstraint> clone() const = 0;

    virtual UT_StringHolder constraintSql(
            const UT_ORMModelState& model,
            UT_IORMSchemaEditor& editor) const
            = 0;
    virtual UT_UniquePtr<UT_ORMDDLStatement> createSql(
            const UT_ORMModelState& model,
            const UT_IORMSchemaEditor& editor)
            = 0;
    virtual UT_UniquePtr<UT_ORMDDLStatement> removeSql(
            const UT_ORMModelState& model,
            const UT_IORMSchemaEditor& editor)
            = 0;

    const UT_StringHolder& name() const { return myName; }
protected:
    UT_IORMConstraint(const UT_StringHolder& name) :
        myName(name)
    {}

    UT_StringHolder myName;
};

class UT_API UT_ORMUniqueConstraint : public UT_IORMConstraint
{
public:
    UT_ORMUniqueConstraint(
            const UT_StringHolder& name,
            const std::initializer_list<UT_StringHolder>& fields,
            const UT_StringHolder& condition = UT_StringHolder::theEmptyString);
    UT_ORMUniqueConstraint(const UT_StringHolder& name);

    UT_UniquePtr<UT_IORMConstraint> clone() const override;

    UT_StringHolder constraintSql(
            const UT_ORMModelState& model,
            UT_IORMSchemaEditor& editor) const override;
    UT_UniquePtr<UT_ORMDDLStatement> createSql(
            const UT_ORMModelState& model,
            const UT_IORMSchemaEditor& editor) override;
    UT_UniquePtr<UT_ORMDDLStatement> removeSql(
            const UT_ORMModelState& model,
            const UT_IORMSchemaEditor& editor) override;

    const UT_StringHolder& condition() const { return myCondition; }

private:
    UT_StringArray myFields;
    UT_StringHolder myCondition;
};

#endif // __UT_ORMCONSTRAINT_H__