Skip to content

models#

AbstractConcept#

Bases: AbstractBaseModel

Base model for Reference Data objects

Source: skos:Concept https://www.w3.org/TR/skos-reference/#concepts

Source code in src/apps/refdata/models.py 
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
class AbstractConcept(AbstractBaseModel):
    """
    Base model for Reference Data objects

    Source: skos:Concept
    https://www.w3.org/TR/skos-reference/#concepts
    """

    id = models.UUIDField(primary_key=True, default=uuid.uuid4, editable=False)
    url = models.URLField(max_length=255)
    in_scheme = models.URLField(max_length=255, default="", blank=True)
    pref_label = HStoreField(help_text=_('example: {"en":"title", "fi":"otsikko"}'))
    broader = models.ManyToManyField(
        "self",
        related_name="narrower",
        symmetrical=False,
        blank=True,
    )
    same_as = ArrayField(models.CharField(max_length=255), default=list, blank=True)  # owl:sameAs
    deprecated = models.DateTimeField(
        blank=True,
        null=True,
        help_text=_("If set, entry is not shown in reference data list by default."),
    )

    class Meta:
        indexes = [
            models.Index(fields=["url"]),
        ]
        abstract = True
        get_latest_by = "modified"
        ordering = ["created"]

        constraints = [
            # All concepts should have a URL.
            models.CheckConstraint(
                check=~models.Q(url=""),
                name="%(app_label)s_%(class)s_require_url",
            ),
            # URLs should be unique within reference data.
            models.UniqueConstraint(
                fields=["url"],
                name="%(app_label)s_%(class)s_unique_reference_data_url",
            ),
            # Reference data should have a scheme.
            models.CheckConstraint(
                check=~models.Q(in_scheme=""),
                name="%(app_label)s_%(class)s_require_reference_data_scheme",
            ),
        ]

    @classmethod
    def get_serializer_class(cls):
        return get_refdata_serializer_class(refdata_model=cls)

    def get_label(self):
        pref_label = self.pref_label if isinstance(self.pref_label, dict) else {}
        return pref_label.get("en") or pref_label.get("fi") or next(iter(pref_label.values()), "")

    def __str__(self):
        return f"{self.id}: {self.get_label()}"

    @classmethod
    def get_model_url(cls) -> str:
        return f"{inflection.dasherize(inflection.underscore(cls.__name__))}s"

FieldOfScience#

Bases: AbstractConcept

Source code in src/apps/refdata/models.py 
81
82
83
84
85
86
87
88
89
90
91
92
93
94
class FieldOfScience(AbstractConcept):
    # TODO: Add codes (skos:notation)

    is_essential_choice = models.BooleanField(
        default=False, help_text=_("If the field of science should be selectable in model forms")
    )

    @classmethod
    def get_model_url(cls) -> str:
        return "fields-of-science"

    class Meta(AbstractConcept.Meta):
        verbose_name = "field of science"
        verbose_name_plural = "fields of science"

Language#

Bases: AbstractConcept

Source code in src/apps/refdata/models.py 
 97
 98
 99
100
class Language(AbstractConcept):
    is_essential_choice = models.BooleanField(
        default=False, help_text=_("If the language should be selectable in model forms")
    )

Theme#

Bases: AbstractConcept

Source code in src/apps/refdata/models.py 
103
104
105
106
class Theme(AbstractConcept):
    is_essential_choice = models.BooleanField(
        default=False, help_text=_("If the theme should be selectable in model forms")
    )

Location#

Bases: AbstractConcept

Source code in src/apps/refdata/models.py 
109
110
111
class Location(AbstractConcept):
    as_wkt = models.TextField(null=True, blank=True)
    serializer_extra_fields = ("as_wkt",)

AccessType#

Bases: AbstractConcept

Source code in src/apps/refdata/models.py 
114
115
class AccessType(AbstractConcept):
    pass

ContributorRole#

Bases: AbstractConcept

Source code in src/apps/refdata/models.py 
118
119
class ContributorRole(AbstractConcept):
    pass

ContributorType#

Bases: AbstractConcept

Source code in src/apps/refdata/models.py 
122
123
class ContributorType(AbstractConcept):
    pass

EventOutcome#

Bases: AbstractConcept

Source code in src/apps/refdata/models.py 
126
127
class EventOutcome(AbstractConcept):
    pass

FileFormatVersion#

Bases: AbstractConcept

Source code in src/apps/refdata/models.py 
130
131
132
133
class FileFormatVersion(AbstractConcept):
    file_format = models.CharField(max_length=255)
    format_version = models.CharField(max_length=255, default="", blank=True)
    serializer_extra_fields = ("file_format", "format_version")

FileType#

Bases: AbstractConcept

Source code in src/apps/refdata/models.py 
136
137
class FileType(AbstractConcept):
    pass

FunderType#

Bases: AbstractConcept

Source code in src/apps/refdata/models.py 
140
141
class FunderType(AbstractConcept):
    pass

IdentifierType#

Bases: AbstractConcept

Source code in src/apps/refdata/models.py 
144
145
class IdentifierType(AbstractConcept):
    pass

License#

Bases: AbstractConcept

Source code in src/apps/refdata/models.py 
148
149
class License(AbstractConcept):
    pass

LifecycleEvent#

Bases: AbstractConcept

Source code in src/apps/refdata/models.py 
152
153
class LifecycleEvent(AbstractConcept):
    pass

PreservationEvent#

Bases: AbstractConcept

Source code in src/apps/refdata/models.py 
156
157
class PreservationEvent(AbstractConcept):
    pass

RelationType#

Bases: AbstractConcept

Source code in src/apps/refdata/models.py 
160
161
class RelationType(AbstractConcept):
    pass

ResearchInfra#

Bases: AbstractConcept

Source code in src/apps/refdata/models.py 
164
165
class ResearchInfra(AbstractConcept):
    pass

ResourceType#

Bases: AbstractConcept

Source code in src/apps/refdata/models.py 
168
169
class ResourceType(AbstractConcept):
    pass

RestrictionGrounds#

Bases: AbstractConcept

Source code in src/apps/refdata/models.py 
172
173
174
175
176
177
178
179
class RestrictionGrounds(AbstractConcept):
    @classmethod
    def get_model_url(cls) -> str:
        return "restriction-grounds"

    class Meta(AbstractConcept.Meta):
        verbose_name = "restriction grounds"
        verbose_name_plural = "restriction grounds"

UseCategory#

Bases: AbstractConcept

Source code in src/apps/refdata/models.py 
182
183
184
185
class UseCategory(AbstractConcept):
    @classmethod
    def get_model_url(cls) -> str:
        return "use-categories"

not_implemented_function#

Source code in src/apps/refdata/models.py 
212
213
def not_implemented_function(*args, **kwargs):
    raise NotImplementedError()

ConceptProxyMixin#

Mixin class for Concept-based proxy models for reference data.

Source code in src/apps/refdata/models.py 
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
class ConceptProxyMixin:
    """Mixin class for Concept-based proxy models for reference data."""

    @classmethod
    def get_serializer_class(cls):
        """Make non-url fields read-only"""
        if serializer_class := getattr(cls, "_serializer_class", None):
            return serializer_class  # Reuse class instead of always creating new

        serializer_class = super(ConceptProxyMixin, cls).get_serializer_class()
        serializer_class.omit_related = True
        serializer_class.Meta.extra_kwargs = {
            field: {"read_only": True} for field in serializer_class.Meta.fields if field != "url"
        }
        # Remove uniqueness validator since we're not creating new reference data
        serializer_class.Meta.extra_kwargs["url"] = {"validators": []}

        serializer_class.Meta.list_serializer_class = URLReferencedModelListField
        serializer_class.save = not_implemented_function
        serializer_class.create = not_implemented_function
        serializer_class.update = not_implemented_function
        cls._serializer_class = serializer_class
        return serializer_class

    @classmethod
    def get_serializer_field(cls, **kwargs):
        """Return serializer relation field for concept instances."""
        serializer = cls.get_serializer_class()()
        return URLReferencedModelField(child=serializer, **kwargs)

    class Meta:
        proxy = True

get_serializer_class() classmethod #

Make non-url fields read-only

Source code in src/apps/refdata/models.py 
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
@classmethod
def get_serializer_class(cls):
    """Make non-url fields read-only"""
    if serializer_class := getattr(cls, "_serializer_class", None):
        return serializer_class  # Reuse class instead of always creating new

    serializer_class = super(ConceptProxyMixin, cls).get_serializer_class()
    serializer_class.omit_related = True
    serializer_class.Meta.extra_kwargs = {
        field: {"read_only": True} for field in serializer_class.Meta.fields if field != "url"
    }
    # Remove uniqueness validator since we're not creating new reference data
    serializer_class.Meta.extra_kwargs["url"] = {"validators": []}

    serializer_class.Meta.list_serializer_class = URLReferencedModelListField
    serializer_class.save = not_implemented_function
    serializer_class.create = not_implemented_function
    serializer_class.update = not_implemented_function
    cls._serializer_class = serializer_class
    return serializer_class

get_serializer_field(**kwargs) classmethod #

Return serializer relation field for concept instances.

Source code in src/apps/refdata/models.py 
240
241
242
243
244
@classmethod
def get_serializer_field(cls, **kwargs):
    """Return serializer relation field for concept instances."""
    serializer = cls.get_serializer_class()()
    return URLReferencedModelField(child=serializer, **kwargs)