UT_ORMContentType.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_ORMContentType.h
 *
 * COMMENTS:
 *
 *
 */

#ifndef __UT_ORMCONTENTTYPE_H__
#define __UT_ORMCONTENTTYPE_H__

#include "UT_API.h"

#include "UT_ORMModelMeta.h"
#include "UT_SQLORM.h"

/// A simple mechanism to link models to unrelated concepts. When a model is
/// added or removed a content-type is inserted. If you have a model that
/// applies to another model indirectly this allows that model to be
/// added/removed by the foreign key to this content type. It would also allow
/// for backtracking as you could lookup the model from the content type.
/// The primary purpose is to remove some of the admin work required to have
/// two models indirectly related to each other.
class UT_API UT_ORMContentType : public UT_ORMModel<UT_ORMContentType>
{
    UT_DECLARE_MODEL();
public:
    class Meta : public UT_ORMModelMeta
    {
    public:
        using primary_key_t = int;

        Meta() : UT_ORMModelMeta("sidefx_content_type") {}
        void doBuild() override;
        void doPostMigrate() override;
        void collectMigrations(UT_ORMMigrationBuilder& builder) const override;
    };

    UT_ORMContentType(const UT_ORMModelMeta& meta = metaInfo())
        : UT_ORMModel<UT_ORMContentType>(meta), myNamespace("sidefx")
    {
    }
    UT_ORMContentType(const UT_StringHolder& ns, const UT_StringHolder& model)
        : myNamespace(ns), myModelName(model)
    {
    }

    void setModelName(const UT_StringHolder& name)
    {
        myModelName = name;
    }
    void setNamespace(const UT_StringHolder& ns)
    {
        myNamespace = ns;
    }

    int id() const
    {
        return myID;
    }

    const UT_StringHolder& contentTypeNamespace() const
    {
        return myNamespace;
    }
    const UT_StringHolder& modelName() const
    {
        return myModelName;
    }

    static UT_Optional<UT_ORMContentType> findFromMeta(
            const UT_ORMModelMeta& meta,
            UT_ErrorCode& ec,
            const UT_StringHolder& ns = "sidefx")
    {
        using namespace UT::Literal;
        return filter({"namespace"_f=ns, "model"_f=meta.tableName()}, ec);
    }

    static UT_Optional<UT_ORMContentType> findByNaturalKey(
            const UT_StringHolder& ns,
            const UT_StringHolder& table_name,
            UT_ErrorCode& ec)
    {
        using namespace UT::Literal;
        return filter({"namespace"_f = ns, "model"_f = table_name}, ec);
    }

private:
    int myID = 0;
    UT_StringHolder myNamespace;
    UT_StringHolder myModelName;
};

#endif // __UT_ORMCONTENTTYPE_H__