mex.extractors.datenkompass.models package¶
Submodules¶
mex.extractors.datenkompass.models.item module¶
- class mex.extractors.datenkompass.models.item.DatenkompassActivity(*, Beschreibung: str, datenhalter: str, kontakt: str | None = None, Organisationseinheit: str, Titel: str, Schlagwort: str | None = None, datenbank: str | None = None, Startdatum: str | None = None, Enddatum: str | None = None, voraussetzungen: str, frequenz: str, Hauptkategorie: str, Unterkategorie: str, rechtsgrundlage: str, datenerhalt: str, status: str, Datennutzungszweck: str, Herausgeber: str, Kommentar: str, dk_format: str, identifier: MergedIdentifier)¶
Bases:
BaseModelModel for Datenkompass Activities.
- beschreibung: str¶
- datenbank: str | None¶
- datenerhalt: str¶
- datenhalter: str¶
- datennutzungszweck: str¶
- dk_format: str¶
- enddatum: str | None¶
- frequenz: str¶
- hauptkategorie: str¶
- herausgeber: str¶
- identifier: MergedIdentifier¶
- kommentar: str¶
- kontakt: str | None¶
- model_config = {'extra': 'ignore', 'populate_by_name': True, 'str_max_length': 100000, 'str_min_length': 1, 'str_strip_whitespace': True, 'use_enum_values': True, 'validate_assignment': True, 'validate_by_alias': True, 'validate_by_name': True, 'validate_default': True}¶
Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].
- organisationseinheit: str¶
- rechtsgrundlage: str¶
- schlagwort: str | None¶
- startdatum: str | None¶
- status: str¶
- titel: str¶
- unterkategorie: str¶
- voraussetzungen: str¶
- class mex.extractors.datenkompass.models.item.DatenkompassBibliographicResource(*, Beschreibung: str | None = None, kontakt: str | None = None, Organisationseinheit: str | None = None, Titel: str, datenhalter: str, dk_format: str, frequenz: str, Schlagwort: str | None = None, datenbank: str | None = None, rechtsgrundlagen_benennung: str | None = None, datennutzungszweck_erweitert: str | None = None, voraussetzungen: str | None = None, Hauptkategorie: str, Unterkategorie: str, datenerhalt: str, status: str, Datennutzungszweck: str, rechtsgrundlage: str, Herausgeber: str, Kommentar: str, identifier: MergedIdentifier)¶
Bases:
BaseModelModel for Datenkompass Bibliographic Resources.
- beschreibung: str | None¶
- datenbank: str | None¶
- datenerhalt: str¶
- datenhalter: str¶
- datennutzungszweck: str¶
- datennutzungszweck_erweitert: str | None¶
- dk_format: str¶
- frequenz: str¶
- hauptkategorie: str¶
- herausgeber: str¶
- identifier: MergedIdentifier¶
- kommentar: str¶
- kontakt: str | None¶
- model_config = {'extra': 'ignore', 'populate_by_name': True, 'str_max_length': 100000, 'str_min_length': 1, 'str_strip_whitespace': True, 'use_enum_values': True, 'validate_assignment': True, 'validate_by_alias': True, 'validate_by_name': True, 'validate_default': True}¶
Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].
- organisationseinheit: str | None¶
- rechtsgrundlage: str¶
- rechtsgrundlagen_benennung: str | None¶
- schlagwort: str | None¶
- status: str¶
- titel: str¶
- unterkategorie: str¶
- voraussetzungen: str | None¶
- class mex.extractors.datenkompass.models.item.DatenkompassResource(*, Beschreibung: str, datenhalter: str, frequenz: str | None = None, kontakt: str | None = None, Organisationseinheit: str, Startdatum: str | None = None, Titel: str, Schlagwort: str, voraussetzungen: str, datenbank: str | None = None, rechtsgrundlagen_benennung: str | None = None, datennutzungszweck_erweitert: str | None = None, dk_format: str | None = None, Hauptkategorie: str, Unterkategorie: str, rechtsgrundlage: str, datenerhalt: str, status: str, Datennutzungszweck: str, Herausgeber: str, Kommentar: str, identifier: MergedIdentifier)¶
Bases:
BaseModelModel for Datenkompass Resources.
- beschreibung: str¶
- datenbank: str | None¶
- datenerhalt: str¶
- datenhalter: str¶
- datennutzungszweck: str¶
- datennutzungszweck_erweitert: str | None¶
- dk_format: str | None¶
- frequenz: str | None¶
- hauptkategorie: str¶
- herausgeber: str¶
- identifier: MergedIdentifier¶
- kommentar: str¶
- kontakt: str | None¶
- model_config = {'extra': 'ignore', 'populate_by_name': True, 'str_max_length': 100000, 'str_min_length': 1, 'str_strip_whitespace': True, 'use_enum_values': True, 'validate_assignment': True, 'validate_by_alias': True, 'validate_by_name': True, 'validate_default': True}¶
Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].
- organisationseinheit: str¶
- rechtsgrundlage: str¶
- rechtsgrundlagen_benennung: str | None¶
- schlagwort: str¶
- startdatum: str | None¶
- status: str¶
- titel: str¶
- unterkategorie: str¶
- voraussetzungen: str¶
mex.extractors.datenkompass.models.mapping module¶
- class mex.extractors.datenkompass.models.mapping.DatenkompassFilterMapping(*, fields: list[DatenkompassFilterMappingField])¶
Bases:
BaseModelA mapping for the Datenkompass mapping and filter yamls.
- fields: list[DatenkompassFilterMappingField]¶
- model_config = {'extra': 'forbid'}¶
Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].
- class mex.extractors.datenkompass.models.mapping.DatenkompassFilterMappingField(*, fieldInMEx: Annotated[str, MinLen(min_length=1)], filterRules: Annotated[list[MappingOrFilterRule], MinLen(min_length=1)], comment: str | None = None)¶
Bases:
BaseModelModel subclass for datenkompass filter.
- comment: Annotated[str | None, FieldInfo(annotation=NoneType, required=True, title='comment')]¶
- fieldInMEx: Annotated[str, FieldInfo(annotation=NoneType, required=True, title='fieldInMEx', metadata=[MinLen(min_length=1)])]¶
- filterRules: Annotated[list[MappingOrFilterRule], FieldInfo(annotation=NoneType, required=True, title='filterRules', metadata=[MinLen(min_length=1)])]¶
- model_config = {'extra': 'forbid'}¶
Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].
- class mex.extractors.datenkompass.models.mapping.DatenkompassMapping(*, fields: list[DatenkompassMappingField])¶
Bases:
BaseModelA mapping for the Datenkompass mapping yamls.
- fields: list[DatenkompassMappingField]¶
- model_config = {'extra': 'forbid'}¶
Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].
- class mex.extractors.datenkompass.models.mapping.DatenkompassMappingField(*, fieldInTarget: Annotated[str, MinLen(min_length=1)], fieldInMEx: str | None = None, mappingRules: Annotated[list[MappingOrFilterRule], MinLen(min_length=1)], comment: str | None = None)¶
Bases:
BaseModelModel subclass for each datenkompass field mapping.
- comment: Annotated[str | None, FieldInfo(annotation=NoneType, required=True, title='comment')]¶
- fieldInMEx: Annotated[str | None, FieldInfo(annotation=NoneType, required=True, title='fieldInMEx')]¶
- fieldInTarget: Annotated[str, FieldInfo(annotation=NoneType, required=True, title='fieldInTarget', metadata=[MinLen(min_length=1)])]¶
- mappingRules: Annotated[list[MappingOrFilterRule], FieldInfo(annotation=NoneType, required=True, title='mappingRules', metadata=[MinLen(min_length=1)])]¶
- model_config = {'extra': 'forbid'}¶
Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].
- class mex.extractors.datenkompass.models.mapping.MappingOrFilterRule(*, forValues: list[str] | None = None, setValues: list[str] | str | None = None, rule: str | None = None, expectedOutputExample: str | None = None, forPrimarySource: str | None = None, comment: str | None = None)¶
Bases:
BaseModelGeneric mapping rule model.
- comment: Annotated[str | None, FieldInfo(annotation=NoneType, required=True, title='comment')]¶
- expectedOutputExample: Annotated[str | None, FieldInfo(annotation=NoneType, required=True, title='expectedOutputExample')]¶
- forPrimarySource: Annotated[str | None, FieldInfo(annotation=NoneType, required=True, title='forPrimarySource')]¶
- forValues: Annotated[list[str] | None, FieldInfo(annotation=NoneType, required=True, title='forValues')]¶
- model_config = {'extra': 'forbid'}¶
Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].
- rule: Annotated[str | None, FieldInfo(annotation=NoneType, required=True, title='rule')]¶
- setValues: Annotated[list[str] | str | None, FieldInfo(annotation=NoneType, required=True, title='setValues')]¶