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

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

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

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

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

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

class AccessType(AbstractConcept):
    pass

ContributorRole

Bases: AbstractConcept

Source code in src/apps/refdata/models.py

class ContributorRole(AbstractConcept):
    pass

ContributorType

Bases: AbstractConcept

Source code in src/apps/refdata/models.py

class ContributorType(AbstractConcept):
    pass

EventOutcome

Bases: AbstractConcept

Source code in src/apps/refdata/models.py

class EventOutcome(AbstractConcept):
    pass

FileFormatVersion

Bases: AbstractConcept

Source code in src/apps/refdata/models.py

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

class FileType(AbstractConcept):
    pass

FunderType

Bases: AbstractConcept

Source code in src/apps/refdata/models.py

class FunderType(AbstractConcept):
    pass

IdentifierType

Bases: AbstractConcept

Source code in src/apps/refdata/models.py

class IdentifierType(AbstractConcept):
    pass

License

Bases: AbstractConcept

Source code in src/apps/refdata/models.py

class License(AbstractConcept):
    pass

LifecycleEvent

Bases: AbstractConcept

Source code in src/apps/refdata/models.py

class LifecycleEvent(AbstractConcept):
    pass

PreservationEvent

Bases: AbstractConcept

Source code in src/apps/refdata/models.py

class PreservationEvent(AbstractConcept):
    pass

RelationType

Bases: AbstractConcept

Source code in src/apps/refdata/models.py

class RelationType(AbstractConcept):
    pass

ResearchInfra

Bases: AbstractConcept

Source code in src/apps/refdata/models.py

class ResearchInfra(AbstractConcept):
    pass

ResourceType

Bases: AbstractConcept

Source code in src/apps/refdata/models.py

class ResourceType(AbstractConcept):
    pass

RestrictionGrounds

Bases: AbstractConcept

Source code in src/apps/refdata/models.py

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

class UseCategory(AbstractConcept):
    @classmethod
    def get_model_url(cls) -> str:
        return "use-categories"