Skip to content

concepts#

not_implemented_function#

Source code in src/apps/core/models/concepts.py 
13
14
def not_implemented_function(*args, **kwargs):
    raise NotImplementedError()

ConceptProxyMixin#

Mixin class for Concept-based proxy models.

Source code in src/apps/core/models/concepts.py 
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
class ConceptProxyMixin:
    """Mixin class for Concept-based proxy models."""

    @classmethod
    def get_serializer_class(cls):
        """Make non-url fields read-only"""
        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"
        }
        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
        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/core/models/concepts.py 
20
21
22
23
24
25
26
27
28
29
30
31
32
@classmethod
def get_serializer_class(cls):
    """Make non-url fields read-only"""
    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"
    }
    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
    return serializer_class

get_serializer_field(**kwargs) classmethod #

Return serializer relation field for concept instances.

Source code in src/apps/core/models/concepts.py 
34
35
36
37
38
@classmethod
def get_serializer_field(cls, **kwargs):
    """Return serializer relation field for concept instances."""
    serializer = cls.get_serializer_class()()
    return URLReferencedModelField(child=serializer, **kwargs)

AccessType#

Bases: ConceptProxyMixin, AccessType

Accessibility of the resource

Source code in src/apps/core/models/concepts.py 
44
45
class AccessType(ConceptProxyMixin, refdata.AccessType):
    """Accessibility of the resource"""

Language#

Bases: ConceptProxyMixin, Language

A language of the item.

This refers to the natural language used for textual metadata (i.e. titles, descriptions, etc) of a cataloged resource (i.e. dataset or service) or the textual values of a dataset

Note

Repeat this property if the resource is available in multiple languages.

Note

The value(s) provided for members of a catalog (i.e. dataset or service) override the value(s) provided for the catalog if they conflict.

DRF Property: dcterms:language

Source: DCAT Version 3, Draft 11, https://www.w3.org/TR/vocab-dcat-3/#Property:resource_language

Source code in src/apps/core/models/concepts.py 
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
class Language(ConceptProxyMixin, refdata.Language):
    """A language of the item.

    This refers to the natural language used for textual metadata (i.e. titles, descriptions, etc)
    of a cataloged resource (i.e. dataset or service) or the textual values of a dataset

    Note:
        Repeat this property if the resource is available in multiple languages.

    Note:
        The value(s) provided for members of a catalog (i.e. dataset or service)
        override the value(s) provided for the catalog if they conflict.

    DRF Property: dcterms:language

    Source: DCAT Version 3, Draft 11,
    https://www.w3.org/TR/vocab-dcat-3/#Property:resource_language
    """

Theme#

Bases: ConceptProxyMixin, Theme

Keyword from KOKO ontology.

Source code in src/apps/core/models/concepts.py 
68
69
class Theme(ConceptProxyMixin, refdata.Theme):
    """Keyword from KOKO ontology."""

get_default_license#

Source code in src/apps/core/models/concepts.py 
72
73
74
75
def get_default_license():
    return refdata.License.objects.get(
        url="http://uri.suomi.fi/codelist/fairdata/license/code/other"
    ).id

License#

Bases: ConceptProxyMixin, License

License from reference data.

Source code in src/apps/core/models/concepts.py 
78
79
class License(ConceptProxyMixin, refdata.License):
    """License from reference data."""

DatasetLicense#

Bases: AbstractBaseModel

A legal document under which the resource is made available.

RFD Property: dcterms:license

Source: DCAT Version 3, Draft 11, https://www.w3.org/TR/vocab-dcat-3/#Property:resource_license

Source code in src/apps/core/models/concepts.py 
 82
 83
 84
 85
 86
 87
 88
 89
 90
 91
 92
 93
 94
 95
 96
 97
 98
 99
100
101
102
103
104
105
106
107
108
109
110
class DatasetLicense(AbstractBaseModel):
    """A legal document under which the resource is made available.

    RFD Property: dcterms:license

    Source: DCAT Version 3, Draft 11,
    https://www.w3.org/TR/vocab-dcat-3/#Property:resource_license
    """

    copier = ModelCopier(copied_relations=[], parent_relations=["access_rights"])

    id = models.UUIDField(primary_key=True, default=uuid.uuid4, editable=False)
    custom_url = models.URLField(max_length=512, blank=True, null=True)
    reference = models.ForeignKey(refdata.License, on_delete=models.CASCADE)
    title = HStoreField(help_text='example: {"en":"title", "fi":"otsikko"}', null=True, blank=True)
    description = HStoreField(
        help_text='example: {"en":"description", "fi":"kuvaus"}', null=True, blank=True
    )

    class Meta:
        ordering = ["created"]
        indexes = [
            models.Index(fields=["custom_url"]),
        ]

    def __str__(self):
        if self.custom_url:
            return self.custom_url
        return self.reference.pref_label.get("en", "")

FieldOfScience#

Bases: ConceptProxyMixin, FieldOfScience

Field of Science classification of resource.

Source: https://finto.fi/okm-tieteenala/en/

Source code in src/apps/core/models/concepts.py 
113
114
115
116
117
class FieldOfScience(ConceptProxyMixin, refdata.FieldOfScience):
    """Field of Science classification of resource.

    Source: https://finto.fi/okm-tieteenala/en/
    """

ResearchInfra#

Bases: ConceptProxyMixin, ResearchInfra

Research infrastructure classification of resource.

Source: http://www.yso.fi/onto/koko/p34158

Source code in src/apps/core/models/concepts.py 
120
121
122
123
124
class ResearchInfra(ConceptProxyMixin, refdata.ResearchInfra):
    """Research infrastructure classification of resource.

    Source: http://www.yso.fi/onto/koko/p34158
    """

LifecycleEvent#

Bases: ConceptProxyMixin, LifecycleEvent

Lifecycle event of the resource.

Source code in src/apps/core/models/concepts.py 
127
128
class LifecycleEvent(ConceptProxyMixin, refdata.LifecycleEvent):
    """Lifecycle event of the resource."""

PreservationEvent#

Bases: ConceptProxyMixin, PreservationEvent

Preservation event of the resource.

Source code in src/apps/core/models/concepts.py 
131
132
class PreservationEvent(ConceptProxyMixin, refdata.PreservationEvent):
    """Preservation event of the resource."""

EventOutcome#

Bases: ConceptProxyMixin, EventOutcome

Event outcome of the resource.

Source code in src/apps/core/models/concepts.py 
135
136
class EventOutcome(ConceptProxyMixin, refdata.EventOutcome):
    """Event outcome of the resource."""

IdentifierType#

Bases: ConceptProxyMixin, IdentifierType

Identifier type of the resource.

Source code in src/apps/core/models/concepts.py 
139
140
class IdentifierType(ConceptProxyMixin, refdata.IdentifierType):
    """Identifier type of the resource."""

UseCategory#

Bases: ConceptProxyMixin, UseCategory

Use category type of the resource.

Source code in src/apps/core/models/concepts.py 
143
144
class UseCategory(ConceptProxyMixin, refdata.UseCategory):
    """Use category type of the resource."""

FileType#

Bases: ConceptProxyMixin, FileType

File type of the resource.

Source code in src/apps/core/models/concepts.py 
147
148
class FileType(ConceptProxyMixin, refdata.FileType):
    """File type of the resource."""

Location#

Bases: ConceptProxyMixin, Location

Location from reference data.

Source code in src/apps/core/models/concepts.py 
151
152
class Location(ConceptProxyMixin, refdata.Location):
    """Location from reference data."""

Spatial#

Bases: AbstractBaseModel

The geographical area covered by the dataset.

Attributes:

Name Type Description
reference(refdata.License)

License's reference
full_address(models.CharField)

The complete address written as a string, with or without formatting.
geographic_name(models.CharField)

A geographic name is a proper noun applied to a spatial object.
dataset(Dataset)

Dataset ForeignKey relation
Source code in src/apps/core/models/concepts.py 
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
class Spatial(AbstractBaseModel):
    """The geographical area covered by the dataset.

    Attributes:
        reference(refdata.License): License's reference
        full_address(models.CharField): The complete address written as a string,
            with or without formatting.
        geographic_name(models.CharField): A geographic name is a proper noun applied to
            a spatial object.
        dataset(Dataset): Dataset ForeignKey relation

    """

    copier = ModelCopier(copied_relations=[], parent_relations=["dataset", "provenance"])

    id = models.UUIDField(primary_key=True, default=uuid.uuid4, editable=False)
    reference = models.ForeignKey(
        refdata.Location, on_delete=models.CASCADE, blank=True, null=True
    )
    full_address = models.CharField(max_length=512, blank=True, null=True)
    geographic_name = models.CharField(max_length=512, blank=True, null=True)
    altitude_in_meters = models.FloatField(
        blank=True,
        null=True,
        help_text="The altitude of the geographical area (meters from WGS84 reference)",
    )
    custom_wkt = ArrayField(
        models.TextField(),
        blank=True,
        null=True,
        help_text=_("Additional wkt values according to WGS84"),
    )
    dataset = models.ForeignKey(
        "Dataset", on_delete=models.CASCADE, related_name="spatial", null=True, blank=True
    )

    def __str__(self):
        if self.geographic_name:
            return self.geographic_name
        if self.reference:
            return str(next(iter(self.reference.pref_label.items())))
        return "Spatial"

    class Meta(AbstractBaseModel.Meta):
        indexes = []

RelationType#

Bases: ConceptProxyMixin, RelationType

Entity relation type

Source code in src/apps/core/models/concepts.py 
202
203
class RelationType(ConceptProxyMixin, refdata.RelationType):
    """Entity relation type"""

ResourceType#

Bases: ConceptProxyMixin, ResourceType

Type of related entity

Source code in src/apps/core/models/concepts.py 
206
207
class ResourceType(ConceptProxyMixin, refdata.ResourceType):
    """Type of related entity"""

RestrictionGrounds#

Bases: ConceptProxyMixin, RestrictionGrounds

Reason for access restriction.

Source code in src/apps/core/models/concepts.py 
210
211
class RestrictionGrounds(ConceptProxyMixin, refdata.RestrictionGrounds):
    """Reason for access restriction."""

FunderType#

Bases: ConceptProxyMixin, FunderType

Funder type

Source code in src/apps/core/models/concepts.py 
214
215
class FunderType(ConceptProxyMixin, refdata.FunderType):
    """Funder type"""