Skip to content

AVefi data model

Metadata schema for persistent film identifiers developed in the AVefi project. See also the corresponding Entity relation diagram. Additionally, consult the FIAF Moving Image Cataloguing Manual and the FIAF Glossary of Filmographic Terms as indicated in the documentation below for definitions, usage instructions and best practices

URI: https://github.io/av-efi-schema/model

Name: model

Classes

Class Description
WorkVariant FIAF Moving Image Cataloguing Manual 1.0
Manifestation Manifestation as defined in FIAF Moving Image Cataloguing Manual 2.0. Note that manifestation type is recorded as publication event type
Item FIAF Moving Image Cataloguing Manual 3.0
Title FIAF Moving Image Cataloguing Manual 1.3.2, 2.3.2, 3.1.2
GeographicName Name of country, region or other location.
ProductionEvent Production event of a work/variant (or manifestation produced as a restoration).
PreservationEvent Preservation event originating a manifestation or possibly a vaniant.
PublicationEvent Publication event of a manifestation or possibly the first known publication of a work.
ManufactureEvent Manufacture event of a manifestation.
RightsCopyrightRegistrationEvent Copyright and related rights registration event of a manifestation or possibly of a work/variant.
Event Significant event in the lifecycle of moving image work / variant, manifestation or item.
AnimationActivity Activity types / roles.
CastActivity Activity types / roles.
CensorshipActivity Activity types / roles.
CinematographyActivity Activity types / roles.
CopyrightAndDistributionActivity Activity types / roles.
DirectingActivity Activity types / roles.
EditingActivity Activity types / roles.
LaboratoryActivity Activity types / roles.
MusicActivity Activity types / roles.
ProducingActivity Activity types / roles.
ProductionDesignActivity Activity types / roles.
PuppetActivity Activity types / roles.
SoundActivity Activity types / roles.
SpecialEffectsActivity Activity types / roles.
WritingActivity Activity types / roles.
ManifestationActivity Activity types / roles.
Activity FIAF Moving Image Cataloguing Manual 1.4.1.1
Agent Agent involved in some activity related to the moving image resource.
Language Provide language code from ISO 639-2 (Part 2: Alpha-3) and a list of language usage terms from our controlled vocabulary.
Subject Subject descriptor terms for the content of a film specifying its period, themes, locations, etc. Not to be confused with Genre.
Genre Genre describes categories of Works, characterized by similar plots, themes, settings, situations, and characters.
Format FIAF Moving Image Cataloguing Manual 2.3.4.1, 3.1.5.1
Audio FIAF Moving Image Cataloguing Manual D.7.2
DigitalFile FIAF Moving Image Cataloguing Manual D.7.2
DigitalFileEncoding FIAF Moving Image Cataloguing Manual D.7.2
Film FIAF Moving Image Cataloguing Manual D.7.2
Optical FIAF Moving Image Cataloguing Manual D.7.2
Video FIAF Moving Image Cataloguing Manual D.7.2
Duration Total running time of the described object in ISO 8601 duration format.
Extent Physical length or size of the described object.
AVefiResource Handle with the prefix allocated for AVefi (eventually).
DOIResource Digital Object Identifier maintained by the DOI Foundation and commonly used for scientific publications including films.
EIDRResource Entertainment Identifier Registry ID.
FilmportalResource Identifier of the German Filmportal.de.
GNDResource Gemeinsame Normdatei (GND) identifier maintained by Deutsche Nationalbibliothek (German National Library)
ISILResource International Standard Identifier for Libraries and Related Organizations including (film) archives.
LocalResource Some identifier used by data provider to represent relations between work/variant, manifestation and item when PIDs have not been assigned yet.
TGNResource Getty Thesaurus of Geographic Names ID.
VIAFResource Virtual International Authority File identifier hosted by OCLC.
WikidataResource Identifier for Wikidata entities.
MovingImageRecordContainer A holder for MovingImageRecord objects
CategorizedThing Root for all classes with subclasses in this schema
MovingImageRecord Base class defining slots that are common to all levels of the WVMI metadata model
DescriptionResource Metadata about the PID rather than the identified object, i.e. who modified the PID metadata record when, making what changes
ManifestationOrItem Base class defining common slots for manifestations and items
AuthorityResource Root class for all identifiers from some kind of authority or public register widely accepted in the community
MovingImageResource Either a persistent or local identifier for AVefi compliant moving image records.

Slots

Slot Description
has_record Root slot holding the moving image metadata record, i.e. metadata describing a work/variant, manifestation or item.
category Designates type, e.g. to distinguish different identifiers (GNDResource vs.
has_primary_title Primary title to be displayed in search results etc. The type should be PreferredTitle for works / variants and TitleProper for manifestations / items.
has_alternative_title Additional title(s) associated with the work / variant, manifestation, or item.
has_name Human-readable name for a thing.
has_ordering_name Provide normalised form, e.g. for sorting by title.
id A unique identifier for a thing
has_identifier Record PID in this slot when exporting data from the PID system.
has_source_key Indicate a dataset this record has been generated or derived from.
type See specific class documentation for controlled vocabulary applicable to the type slot, respectively
same_as See AuthorityResource doucmentation for accepted identifiers
has_event Associate event(s) with a moving image record
has_date Date (or interval/period) when an event has taken place.
located_in Location associated with an event, e.g. the country where the principal offices or production facilities of the production company are located should be associated with the production event
has_activity Associate activity (and subsequently agents) with event
has_agent Agent involved in some activity related to the moving image resource
has_alternate_name Alternative human-readable name(s) for a thing.
in_language FIAF Moving Image Cataloguing Manual 1.3.5, 2.3.3
code ISO 639-2 code for the Representation of Names of Languages (Part 2: Alpha-3)
usage FIAF Moving Image Cataloguing Manual 2.3.3.2
has_form Form describes the format and/or purpose of a Work, e.g., “non-fiction”, “short” and “animation”.
has_subject Subject descriptor terms for the content of a film specifying its period, themes, locations, etc. Not to be confused with Genre.
has_genre Genre describes categories of Works, characterized by similar plots, themes, settings, situations, and characters.
is_part_of Relate, for instance, episodes to a series / serial.
is_variant_of Link to the reference WorkVariant for the currently described variant.
variant_type FIAF Moving Image Cataloguing Manual D.2
is_manifestation_of Indicate AVefi WorkVariant (possibly more but no less than one) that is subject of the manifestation
has_item Indicate AVefi Items the institution has registered as part of the manifestation
has_format FIAF Moving Image Cataloguing Manual 2.3.4.1, 3.1.5.1
has_duration Total running time of the described object in ISO 8601 duration format.
has_extent Physical length or size of the described object.
has_value Value of some quantity
has_unit Unit of some quantity
has_precision Qualifier indicating the precision of an extent value or duration
has_colour_type FIAF Moving Image Cataloguing Manual 2.3.4.4, 3.1.5.6, D.7.11
has_sound_type FIAF Moving Image Cataloguing Manual 2.3.4.3, 3.1.5.3, D.7.4
has_webresource Link to data provider's own presentation of manifestation or item on the web
has_note FIAF Moving Image Cataloguing Manual Appendix B
is_item_of Indicate AVefi Manifestation the item belongs to.
element_type FIAF Moving Image Cataloguing Manual D.7.8
has_access_status Status of item determining access conditions.
is_copy_of Link to AVefi item registered by another institution indicating that the two are known to be copies of each other
is_derivative_of Link to AVefi item from which this one has been derived in whole or in part, e.g. as a result of a restoration or digitasation project
described_by Also record some metadata about the PID itself rather than the identified object
has_history Link to revision history of this PID
has_issuer_id Identifier for the responsible party as an URI suitable for linked data
has_issuer_name Name of the responsible party
last_modified Timestamp (in UTC) for the latest modification to any field in the PID metadata record

Enumerations

Enumeration Description
WorkVariantTypeEnum Work/Variant description type.
TitleTypeEnum FIAF Moving Image Cataloguing Manual A.2
ManufactureEventTypeEnum FIAF Moving Image Cataloguing Manual D.4.7, D.14
PreservationEventTypeEnum FIAF Moving Image Cataloguing Manual D.4.5
ProductionEventTypeEnum Leave unset for main production event, otherwise see FIAF Moving Image Cataloguing Manual D.4.3, D.11
PublicationEventTypeEnum FIAF Moving Image Cataloguing Manual D.4.1, D.10
AnimationActivityTypeEnum Activity types / roles.
CastActivityTypeEnum Activity types / roles.
CensorshipActivityTypeEnum Activity types / roles.
CinematographyActivityTypeEnum Activity types / roles.
CopyrightAndDistributionActivityTypeEnum Activity types / roles.
DirectingActivityTypeEnum Activity types / roles.
EditingActivityTypeEnum Activity types / roles.
LaboratoryActivityTypeEnum Activity types / roles.
MusicActivityTypeEnum Activity types / roles.
ProducingActivityTypeEnum Activity types / roles.
ProductionDesignActivityTypeEnum Activity types / roles.
PuppetActivityTypeEnum Activity types / roles.
SoundActivityTypeEnum Activity types / roles.
SpecialEffectsActivityTypeEnum Activity types / roles.
WritingActivityTypeEnum Activity types / roles.
ManifestationActivityTypeEnum Activity types / roles.
AgentTypeEnum FIAF Moving Image Cataloguing Manual 1.4.1
LanguageUsageEnum FIAF Moving Image Cataloguing Manual 2.3.3, D.6
WorkFormEnum FIAF Glossary of Filmographic Terms D.1.9
VariantTypeEnum FIAF Moving Image Cataloguing Manual D.2
FormatAudioTypeEnum FIAF Moving Image Cataloguing Manual D.7.2
FormatDigitalFileEncodingTypeEnum FIAF Moving Image Cataloguing Manual D.7.2
FormatDigitalFileTypeEnum FIAF Moving Image Cataloguing Manual D.7.2
FormatFilmTypeEnum FIAF Moving Image Cataloguing Manual D.7.2
FormatOpticalTypeEnum FIAF Moving Image Cataloguing Manual D.7.2
FormatVideoTypeEnum FIAF Moving Image Cataloguing Manual D.7.2
PrecisionEnum Qualifier indicating the precision of an extent value or duration
UnitEnum Units of measurement.
ColourTypeEnum FIAF Moving Image Cataloguing Manual 2.3.4.4, 3.1.5.6, D.7.11
SoundTypeEnum FIAF Moving Image Cataloguing Manual 2.3.4.3, 3.1.5.3, D.7.4
ItemElementTypeEnum FIAF Moving Image Cataloguing Manual D.7.8
ItemAccessStatusEnum FIAF Moving Image Cataloguing Manual D.7.3
LanguageCodeEnum ISO 639-2 code for the Representation of Names of Languages (Part 2: Alpha-3)

Types

Type Description
TextLine Non-empty string without line breaks intended for names and similar data
TextArea Non-empty string possibly containing line breaks
HttpUri Full URI starting with http or https
AVefiCurie To be used as range for type designator slots, i.e. const values
Decimal Decimal numbers
ISODate ISO 8601 date or interval/period, more specifically, EDTF conformance level 0 as well as qualifiers ?
ISODateTimeUTC Timestamp in UTC
ISODurationInHours ISO 8601 duration format.
IDString ASCII string suitable for identifiers
AVefi Handle with the prefix allocated for AVefi (eventually)
DOI Digital Object Identifier maintained by the DOI Foundation and commonly used for scientific publications including films
EIDR Entertainment Identifier Registry ID
FilmportalID Identifier of the German Filmportal.de
GNDID Gemeinsame Normdatei (GND) identifier maintained by Deutsche Nationalbibliothek (German National Library)
ISIL International Standard Identifier for Libraries and Related Organizations including (film) archives
TGNID Getty Thesaurus of Geographic Names ID
VIAFID Virtual International Authority File identifier
WikidataID Identifier for Wikidata entities
String A character string
Integer An integer
Boolean A binary (true or false) value
Float A real number that conforms to the xsd:float specification
Double A real number that conforms to the xsd:double specification
Decimal A real number with arbitrary precision that conforms to the xsd:decimal specification
Time A time object represents a (local) time of day, independent of any particular day
Date a date (year, month and day) in an idealized calendar
Datetime The combination of a date and time
DateOrDatetime Either a date or a datetime
Uriorcurie a URI or a CURIE
Curie a compact URI
Uri a complete URI
Ncname Prefix part of CURIE
Objectidentifier A URI or CURIE that represents an object in the model.
Nodeidentifier A URI, CURIE or BNODE that represents a node in a model.
Jsonpointer A string encoding a JSON Pointer.
Jsonpath A string encoding a JSON Path.
Sparqlpath A string encoding a SPARQL Property Path.

Subsets

Subset Description
TypeRegistrySubset Classes that are to be implemented as infoTypes in the type registry