PID model_serializers

Modul model_serializers.

Třídy

class ModelSerializer

Implementuje komponentu ModelSerializer v rámci aplikace.

Metody:

__init__()

Inicializuje instanci třídy.

Parametry:

record – Doménový objekt (Dokument, Lokalita, SamostatnyNalez), jehož metadata budou serializována.

format_date()

Naformátuje datum do řetězce ve formátu ISO 8601 (YYYY-MM-DD).

Parametry:

date – Objekt typu date určený k formátování.

Vrací:

Vrací výsledek volání strftime().

format_date_time()

Naformátuje datum a čas do řetězce ve formátu ISO 8601 včetně časové zóny.

Parametry:

date_time – Objekt typu datetime určený k formátování.

Vrací:

Vrací výsledek volání strftime().

_get_creators()

Vrací creators.

Vrací:

Načtená data odpovídající zadaným vstupům.

_get_historie_queryset()

Vrací historie queryset.

Vrací:

Načtená data odpovídající zadaným vstupům.

get_ident_cely()

Vrací ident cely.

_get_publication_year()

Vrací publication year.

Vrací:

Načtená data odpovídající zadaným vstupům.

_get_language()

Vrací language.

Vrací:

Načtená data odpovídající zadaným vstupům.

_get_prefix()

Vrací prefix.

Vrací:

Načtená data odpovídající zadaným vstupům.

_get_soubory_queryset()

Vrací soubory queryset.

Vrací:

Načtená data odpovídající zadaným vstupům.

_get_title()

Vrací title.

Parametry:

language – Textový název, klíč nebo zpráva language používaná v rámci operace.

Vrací:

Načtená data odpovídající zadaným vstupům.

_serialize_alternate_identifiers()

Sestaví seznam alternativních identifikátorů záznamu pro DataCite, obsahující přístupové číslo AMČR.

Vrací:

Výstup funkce odpovídající implementované logice.

_serialize_contributors()

Sestaví seznam přispěvatelů záznamu pro DataCite, zahrnující AIS CR jako hostitelskou instituci.

Vrací:

Výstup funkce odpovídající implementované logice.

_serialize_creators()

Sestaví seznam tvůrců záznamu pro DataCite.

Vrací:

Výstup funkce odpovídající implementované logice.

_serialize_dates()

Sestaví seznam dat (vznik, odeslání, archivace apod.) pro DataCite metadata.

Vrací:

Výstup funkce odpovídající implementované logice.

_serialize_descriptions()

Sestaví seznam popisů záznamu pro DataCite (abstrakt, technické informace apod.).

Vrací:

Výstup funkce odpovídající implementované logice.

_serialize_geolocations()

Sestaví seznam geografických souřadnic a lokalit záznamu pro DataCite metadata.

Vrací:

Výstup funkce odpovídající implementované logice.

Sestaví seznam souvisejících identifikátorů záznamu pro DataCite, včetně odkazu na OAI-PMH metadata.

Vrací:

Výstup funkce odpovídající implementované logice.

_serialize_rightslist()

Sestaví seznam licenčních práv záznamu pro DataCite metadata.

Vrací:

Výstup funkce odpovídající implementované logice.

_serialize_subjects()

Sestaví základní seznam tematických klíčových slov pro DataCite, obsahující klasifikaci oboru archeologie.

Vrací:

Výstup funkce odpovídající implementované logice.

_serialize_types()

Sestaví slovník s typem zdroje záznamu pro DataCite metadata.

Vrací:

Výstup funkce odpovídající implementované logice.

_get_formats()

Vrací formats.

Vrací:

Načtená data odpovídající zadaným vstupům.

serialize_delete()

Sestaví DataCite payload pro skrytí záznamu s doplněním zprávy o odstranění z repozitáře AMČR.

Vrací:

Vrací slovník.

serialize_hide()

Sestaví minimální DataCite payload s událostí hide pro skrytí záznamu.

Vrací:

Vrací slovník.

serialize_publish()

Sestaví kompletní DataCite payload pro publikaci záznamu včetně všech povinných metadat.

Vrací:

Vrací proměnná data.

serialize_update()

Sestaví DataCite payload pro aktualizaci záznamu (bez pole event oproti publish).

Vrací:

Vrací proměnná result.

class PartialSerializer

Implementuje komponentu PartialSerializer v rámci aplikace.

Metody:

__init__()

Inicializuje instanci třídy.

Parametry:

record – Doménový objekt, jehož metadata budou částečně serializována.

serialize_publish()

Sestaví částečný DataCite payload pro publikaci záznamu (abstraktní implementace).

class DokumentSerializer

Implementuje komponentu DokumentSerializer v rámci aplikace.

Metody:

__init__()

Inicializuje instanci třídy.

Parametry:

record – Parametr record předává se do volání __init__().

_get_creators()

Vrací creators.

Vrací:

Načtená data odpovídající zadaným vstupům.

_get_historie_queryset()

Vrací historie queryset.

Vrací:

Načtená data odpovídající zadaným vstupům.

get_ident_cely()

Vrací ident cely.

Vrací:

Vrací atribut objektu.

_get_language()

Vrací language.

Vrací:

Načtená data odpovídající zadaným vstupům.

_get_publication_year()

Vrací publication year.

Vrací:

Načtená data odpovídající zadaným vstupům.

_get_prefix()

Vrací prefix.

Vrací:

Načtená data odpovídající zadaným vstupům.

_get_soubory_queryset()

Vrací soubory queryset.

Vrací:

Načtená data odpovídající zadaným vstupům.

_get_title()

Vrací title.

Parametry:

language – Textový název, klíč nebo zpráva language používaná v rámci operace.

Vrací:

Načtená data odpovídající zadaným vstupům.

_serialize_alternate_identifiers()

Sestaví seznam alternativních identifikátorů dokumentu pro DataCite, včetně označení originálu.

Vrací:

Výstup funkce odpovídající implementované logice.

_serialize_contributors()

Sestaví seznam přispěvatelů dokumentu pro DataCite, zahrnující pozorovatele letu, vedoucí neidentifikovatelných akcí a vedoucí projektů.

Vrací:

Výstup funkce odpovídající implementované logice.

_serialize_creators()

Sestaví seznam tvůrců dokumentu pro DataCite ze seznamu autorů dokumentu.

Vrací:

Výstup funkce odpovídající implementované logice.

_serialize_dates()

Sestaví seznam dat dokumentu pro DataCite z jeho historie (zápis, odeslání, archivace, vrácení) a z období komponent.

Vrací:

Výstup funkce odpovídající implementované logice.

_serialize_descriptions()

Serializuje popisy dokumentu (abstrakt a technické informace).

Vrací:

Seznam slovníků obsahujících jazykové varianty popisu.

_serialize_geolocations()

Serializuje geografické lokalizace dokumentu z projektů, akcí a lokalit.

Vrací:

Seznam slovníků s geografickými souřadnicemi a metadaty.

Serializuje související identifikátory (soubory, archivní odkaz, související akce).

Vrací:

Seznam slovníků s identifikátory související obsahu.

_serialize_rightslist()

Serializuje informace o právech a licencích dokumentu.

Vrací:

Seznam slovníků s údaji o licencích a právech.

_serialize_subjects()

Serializuje předmětová hesla z posudků, osob, typů událostí a komponent.

Vrací:

Seznam slovníků s předmětovými hesly.

_serialize_types()

Serializuje typ dokumentu do DataCite schématu.

Vrací:

Slovník s ResourceType a ResourceTypeGeneral.

_get_formats()

Vrací formats.

Vrací:

Načtená data odpovídající zadaným vstupům.

class SamostatnyNalezSerializer

Implementuje komponentu SamostatnyNalezSerializer v rámci aplikace.

Metody:

__init__()

Inicializuje instanci třídy.

Parametry:

record – Parametr record předává se do volání __init__().

_get_creators()

Vrací creators.

Vrací:

Načtená data odpovídající zadaným vstupům.

_get_historie_queryset()

Vrací historie queryset.

Vrací:

Načtená data odpovídající zadaným vstupům.

get_ident_cely()

Vrací ident cely.

Vrací:

Vrací atribut objektu.

_get_soubory_queryset()

Vrací soubory queryset.

Vrací:

Načtená data odpovídající zadaným vstupům.

_get_prefix()

Vrací prefix.

Vrací:

Načtená data odpovídající zadaným vstupům.

_get_publication_year()

Vrací publication year.

Vrací:

Načtená data odpovídající zadaným vstupům.

_get_title()

Vrací title.

Parametry:

language – Textový název, klíč nebo zpráva language používaná v rámci operace.

Vrací:

Načtená data odpovídající zadaným vstupům.

_serialize_alternate_identifiers()

Serializuje alternativní identifikátory nálezu (evidenční čísla).

Vrací:

Seznam slovníků s alternativními identifikátory.

_serialize_contributors()

Serializuje přispěvatele (vedoucí projektu, organizaci, která nálezy převzala).

Vrací:

Seznam slovníků s informacemi o přispěvatelích.

_serialize_creators()

Serializuje tvůrce nálezu (nálezce a jeho organizaci).

Vrací:

Seznam slovníků s údaji o nálezci.

_serialize_dates()

Serializuje data nálezu (datum nálezu, vytvoření, potvrzení, archivace).

Vrací:

Seznam slovníků s daty a jejich typy.

_serialize_descriptions()

Serializuje popisy nálezu (poznámky, okolnosti, hloubku, počet).

Vrací:

Seznam slovníků s jazykovými variantami popisu.

_serialize_geolocations()

Serializuje geografické lokalizace dokumentu z projektů, akcí a lokalit.

Vrací:

Seznam slovníků s geografickými souřadnicemi a metadaty.

Serializuje související identifikátory (soubory, archivní odkaz, související akce).

Vrací:

Seznam slovníků s identifikátory související obsahu.

_serialize_rightslist()

Serializuje informace o právech a licencích dokumentu.

Vrací:

Seznam slovníků s údaji o licencích a právech.

_serialize_subjects()

Serializuje předmětová hesla z posudků, osob, typů událostí a komponent.

Vrací:

Seznam slovníků s předmětovými hesly.

_serialize_types()

Serializuje typ nálezu do DataCite schématu.

Vrací:

Slovník s ResourceType a ResourceTypeGeneral.

_get_formats()

Vrací formats.

Vrací:

Načtená data odpovídající zadaným vstupům.

class LokalitaSerializer

Implementuje komponentu LokalitaSerializer v rámci aplikace.

Metody:

__init__()

Inicializuje instanci třídy.

Parametry:

record – Parametr record předává se do volání __init__().

_get_creators()

Vrací creators.

Vrací:

Načtená data odpovídající zadaným vstupům.

get_ident_cely()

Vrací ident cely.

Vrací:

Vrací atribut objektu.

_get_historie_queryset()

Vrací historie queryset.

Vrací:

Načtená data odpovídající zadaným vstupům.

_get_prefix()

Vrací prefix.

Vrací:

Načtená data odpovídající zadaným vstupům.

_serialize_contributors()

Serializuje přispěvatele (vedoucí projektu, organizaci, která nálezy převzala).

Vrací:

Seznam slovníků s informacemi o přispěvatelích.

_get_soubory_queryset()

Vrací soubory queryset.

Vrací:

Načtená data odpovídající zadaným vstupům.

_serialize_dates()

Serializuje data lokality (vytvoření, změny, archivace z historie archeologické akce).

Vrací:

Seznam slovníků s daty a jejich typy.

_serialize_descriptions()

Serializuje popisy nálezu (poznámky, okolnosti, hloubku, počet).

Vrací:

Seznam slovníků s jazykovými variantami popisu.

_get_externi_odkaz_query()

Vrací externi odkaz query.

Vrací:

Načtená data odpovídající zadaným vstupům.

_serialize_geolocations()

Serializuje geografické lokalizace dokumentu z projektů, akcí a lokalit.

Vrací:

Seznam slovníků s geografickými souřadnicemi a metadaty.

_get_publication_year()

Vrací publication year.

Vrací:

Načtená data odpovídající zadaným vstupům.

_serialize_rightslist()

Serializuje informace o právech a licencích dokumentu.

Vrací:

Seznam slovníků s údaji o licencích a právech.

_get_title()

Vrací title.

Parametry:

language – Textový název, klíč nebo zpráva language používaná v rámci operace.

Vrací:

Načtená data odpovídající zadaným vstupům.

_serialize_alternate_identifiers()

Serializuje alternativní identifikátory nálezu (evidenční čísla).

Vrací:

Seznam slovníků s alternativními identifikátory.

_serialize_creators()

Serializuje tvůrce nálezu (nálezce a jeho organizaci).

Vrací:

Seznam slovníků s údaji o nálezci.

Serializuje související identifikátory (soubory, archivní odkaz, související akce).

Vrací:

Seznam slovníků s identifikátory související obsahu.

Serializuje související položky (externí zdroje související s lokalitou).

Vrací:

Seznam slovníků se související obsahu.

_serialize_subjects()

Serializuje předmětová hesla z posudků, osob, typů událostí a komponent.

Vrací:

Seznam slovníků s předmětovými hesly.

_serialize_types()

Serializuje typ nálezu do DataCite schématu.

Vrací:

Slovník s ResourceType a ResourceTypeGeneral.

_get_formats()

Vrací formats.

Vrací:

Načtená data odpovídající zadaným vstupům.

serialize_publish()

Serializuje lokalitu pro publikaci s přidáním souvisejících položek.

Vrací:

Slovník s připraveným datovým balíčkem pro DataCite.

serialize_update()

Serializuje lokalitu pro aktualizaci se smazáním pole event.

Vrací:

Slovník s připraveným datovým balíčkem pro DataCite.

Funkce

convert_geo_location_to_dict(item)

Převede geo location to dict.

Parametry:

item – Jedna položka zpracovávané kolekce.

Vrací:

Výstup funkce odpovídající implementované logice.

serialize_ez_creator(autor)

Serializuje osobu jako tvůrce externího zdroje do formátu DataCite.

Parametry:

autor – Osoba vystupující jako autor externího zdroje v systému AMČR.

Vrací:

Výstup funkce odpovídající implementované logice.

serialize_ez_contributor(contributor)

Serializuje osobu jako přispěvatele (editora) externího zdroje do formátu DataCite.

Parametry:

contributor – Osoba vystupující jako editor externího zdroje v systému AMČR.

Vrací:

Výstup funkce odpovídající implementované logice.

serialize_geom(geom, katastr, verejne)

Serializuje geometrii a katastr do formátu geoLocationPoint/geoLocationPlace pro DataCite metadata.

Parametry:

  • geom – Geometrie záznamu (bod nebo polygon), z níž se použije centroid; None přeskočí souřadnice.

  • katastr – Katastrální území záznamu použité pro textový popis polohy; None přeskočí lokalitu.

  • verejne – Příznak, zda má být záznam zobrazen veřejně — ovlivňuje úroveň detailu souřadnic.

Vrací:

Výstup funkce odpovídající implementované logice.

serialize_affiliation(organizace)

Serializuje organizaci jako institucionální příslušnost osoby do formátu DataCite.

Parametry:

organizace – Organizace AMČR, jejíž název a případný ROR identifikátor budou zahrnuty.

Vrací:

Vrací proměnná serialized_affiliation.

serialize_organizace_contributor(organizace, contributor_type)

Serializuje organizaci jako přispěvatele záznamu do formátu DataCite.

Parametry:

  • organizace – Organizace AMČR, která má být zahrnuta jako přispěvatel.

  • contributor_type – Typ přispěvatele dle schématu DataCite (např. DataCurator, HostingInstitution).

Vrací:

Vrací slovník.

serialize_osoba_identifiers(osoba)

Sestaví seznam identifikátorů osoby (AMČR, ORCID, Wikidata) pro DataCite metadata.

Parametry:

osoba – Osoba z číselníku AMČR, jejíž identifikátory mají být zahrnuty.

Vrací:

Vrací proměnná result.

serialize_osoba(osoba, organizace, contributor_type)

Serializuje osobu (autora nebo přispěvatele) do formátu DataCite včetně identifikátorů a příslušnosti.

Parametry:

  • osoba – Osoba z číselníku AMČR, která má být serializována.

  • organizace – Organizace, ke které je osoba přiřazena; None vynechá příslušnost.

  • contributor_type – Typ přispěvatele dle DataCite; pokud je zadán, bude přidán do výsledku.

Vrací:

Výstup funkce odpovídající implementované logice.

serialize_subject(serialized_record, subject_attr, lang)

Serializuje heslo ze slovníku AMČR jako tematické klíčové slovo pro DataCite metadata.

Parametry:

  • serialized_record – Heslo ze slovníku AMČR (Heslar), které má být serializováno; None vrátí prázdnou množinu.

  • subject_attr – Název atributu objektu serialized_record, jehož hodnota bude použita jako text hesla.

  • lang – Kód jazyka dle ISO 639-1 pro pole lang ve výstupu DataCite.

Vrací:

Vrací výsledek volání frozenset().

serialize_subjects_komponenty(komp)

Sestaví seznam tematických klíčových slov ze všech atributů komponenty (období, areál, aktivity, objekty, předměty).

Parametry:

komp – Komponenta dokumentační jednotky nebo části dokumentu v systému AMČR.

Vrací:

Vrací proměnná result.

serialize_dates_coverage(datace)

Serializuje časové pokrytí komponenty (období) do formátu DataCite date Coverage.

Parametry:

datace – Heslo ze slovníku AMČR reprezentující dataci s vazbou na rozsah let.

Vrací:

Výstup funkce odpovídající implementované logice.