A file in MediaHaven consists of a list of metadata fields. Each metadata field has a key and the keys are unique in the list of metadata fields from a file. An overview of all the fields that are standard in MediaHaven is documented in Metadata Fields.
Field Definitions
A field definition describes the properties of a field.
Property | Description |
|---|---|
Key |
|
Sub | Metadata fields can be nested inside other metadata fields (see complex field). Such nested fields are called sub fields or child fields and have a parent field. |
Top | Inverse of the property sub. Each file consists of a list of top fields whose key is unique. |
Flattened Key | A sub field cannot be uniquely determined by its own key because the key for sub fields is not unique across all fields. By concatenating the key of the parent field(s) with the key of the sub field, you obtain a unique flattened key. For example the field The flattened key is allowed in the MediaHaven REST API 2.0 but the dotted key is the preferred format |
Dotted Key | Same principle as for flattened keys but now the concatenation contains a dot
The dotted key is the reference format for the MediaHaven REST API 2.0 |
Lucene Key |
The Lucene key is no longer allowed in the MediaHaven REST API 2.0 |
Required | If true, this field will always be present for every record with a non empty value. |
Read Only | The value of this field cannot be changed using metadata updates. |
Index |
|
Global | When using the standard search, it searches in a hidden virtual field which contains as value a join of all fields marked as global |
Advanced Search | If true, make it available in the advanced search. Requires the field to be indexed. |
Tokenize | Informally speaking, tokenizing means splitting the string value of the field on white space in tokens. Requires the field to be indexed. For example the field Description with value "Alice Bob Cedric" is split into the ordered tokens "Alice", "Bob" and "Cedric". The file can matched in the index:
|
Family | Describes the family to which the field belongs. See the section Metadata Families below for more information. |
Metadata Families
Metadata Field
A metadata field is either:
Simple: which means it has a scalar value, for example a string, long or boolean
Complex: which means the value consists of a list of other fields termed sub fields.
The types SimpleField and ComplexField are each further specialised into additional types.
Base Class | Sub Class #1 | Sub Class #2 | Comment | Examples |
|---|---|---|---|---|
| Contains a string value with less than 32K characters. | Title | ||
|
| Contains a boolean value. In MediaHaven 1.0 web site and the old External Metadata [deprecated] this shown as either "0" or "1". | IsFragment, ContainsGeoData | |
|
| Contains a string value. The value is limited to a specific set of values defined on the fielddefinition | ||
|
| Contains a timecode in ISO timecode format, e.g. "00:25:12.840" | StartTimeCode | |
|
| Contains a long value, e.g. "5845988" | Width, Height, FileSize | |
|
|
| Contains a long value with up 10 zeroes prepadded, e.g. "0000000025" The rationale is to make it lexicographically sortable in Lucene, because regular long values are not. | FragmentStartFrames |
|
| Contains a full ISO8601 date in microsecond precision and Zulu time. The machine specification of the format is |
| |
|
| Contains a string value of any length or when the value is tokenized | Description | |
| Contains as value a list of metadata fields | Browses | ||
|
|
| Authors | |
|
|
|
| Keywords, Categories, Publications |
|
|
|
| Browses/Browse |