- All Implemented Interfaces:
OnixComposite
,OnixComposite.OnixDataComposite<JonixMediaFile>
,OnixComposite.OnixDataCompositeWithKey<JonixMediaFile,
,ImageAudioVideoFileTypes> OnixTag
,Serializable
Image/audio/video file link composite
A repeatable group of data elements which together identify and provide pointers to, an image, audio or video file related to the product.
Reference name | <MediaFile> |
Short tag | <mediafile> |
- <
Product
> - <
ContentItem
> - <
Reissue
>
Product
⯈MediaFile
Product
⯈ContentItem
⯈MediaFile
Product
⯈SupplyDetail
⯈Reissue
⯈MediaFile
- See Also:
-
Nested Class Summary
Nested classes/interfaces inherited from interface com.tectonica.jonix.common.OnixComposite
OnixComposite.OnixDataComposite<V extends JonixStruct>, OnixComposite.OnixDataCompositeUncommon, OnixComposite.OnixDataCompositeWithKey<V extends JonixKeyedStruct<K>,
K extends Enum<K> & OnixCodelist>, OnixComposite.OnixSuperComposite -
Field Summary
-
Constructor Summary
-
Method Summary
Modifier and TypeMethodDescriptionvoid
This is an internal API.asStruct()
Text of a caption associated with a download file, and intended to be displayed whenever the file content is used.Text of a copyright notice associated with a download file, and intended to be displayed whenever the file content is used.Text of a personal or corporate credit associated with a download file, and intended to be displayed whenever the file content is used.Text of any terms and conditions associated with a download file.boolean
exists()
indicates whether this tag exists in the ONIX recordFor advanced use-cases only.void
The resolution of an image file which is linked by the <MediaFileLink> element, expressed as dots or pixels per inch.The date when the image referenced by the <MediaFileLink> element was last changed.An ONIX code which identifies the format of the image/audio/video file which is linked by the <MediaFileLink> element.A link to the image/audio/video file specified by the <MediaFileTypeCode>, using the link type specified by the <MediaFileLinkTypeCode>.An ONIX code which identifies the type of link which is given in the <MediaFileLink> element, for example a URL, DOI, filename etc.An ONIX code which identifies the type of image/audio/video file which is linked by the <MediaFileLink> element.Unstructured text associated with a file which is available for download, and intended to be displayed whenever the file content is used.
-
Field Details
-
refname
- See Also:
-
shortname
- See Also:
-
textformat
-
textcase
-
language
-
transliteration
-
datestamp
(type: DateOrDateTime) -
sourcetype
-
sourcename
-
EMPTY
-
-
Constructor Details
-
MediaFile
public MediaFile() -
MediaFile
-
-
Method Details
-
_initialize
public void _initialize()Description copied from interface:OnixComposite
This is an internal API. Since Jonix 8.0, composite objects are being populated lazily. This method initiates the population process, and is invoked internally by the accessor APIs of the composites- Specified by:
_initialize
in interfaceOnixComposite
-
exists
public boolean exists()Description copied from interface:OnixTag
indicates whether this tag exists in the ONIX record -
ifExists
-
getXmlElement
Description copied from interface:OnixComposite
For advanced use-cases only.- Specified by:
getXmlElement
in interfaceOnixComposite
- Returns:
- native representation of the XML element underlying to this tag
-
mediaFileTypeCode
An ONIX code which identifies the type of image/audio/video file which is linked by the <MediaFileLink> element. Mandatory in each occurrence of the <MediaFile> composite, and non-repeating.
Jonix-Comment: this field is required -
mediaFileLinkTypeCode
An ONIX code which identifies the type of link which is given in the <MediaFileLink> element, for example a URL, DOI, filename etc. Mandatory in each occurrence of the <MediaFile> composite, and non-repeating.
Jonix-Comment: this field is required -
mediaFileLink
A link to the image/audio/video file specified by the <MediaFileTypeCode>, using the link type specified by the <MediaFileLinkTypeCode>. Mandatory in each occurrence of the <MediaFile> composite, and non-repeating.
Jonix-Comment: this field is required -
downloadCaption
Text of a caption associated with a download file, and intended to be displayed whenever the file content is used. Optional and non-repeating. The <DownloadCaption> element may be sent together with either or both of fields <DownloadCredit>, or <DownloadCopyrightNotice>.
Jonix-Comment: this field is required -
mediaFileFormatCode
An ONIX code which identifies the format of the image/audio/video file which is linked by the <MediaFileLink> element. For image files, JPEG, GIF and TIF are supported. Optional and non-repeating.
Jonix-Comment: this field is optional -
imageResolution
The resolution of an image file which is linked by the <MediaFileLink> element, expressed as dots or pixels per inch. Optional and non-repeating.
Jonix-Comment: this field is optional -
textWithDownload
Unstructured text associated with a file which is available for download, and intended to be displayed whenever the file content is used. Optional and non-repeating. Text may include credits, copyright notice, etc. If this field is sent, the individual elements <DownloadCaption>, <DownloadCredit>, and <DownloadCopyrightNotice> must not be sent, and vice versa.
Jonix-Comment: this field is optional -
downloadCredit
Text of a personal or corporate credit associated with a download file, and intended to be displayed whenever the file content is used. Optional and non-repeating.
Jonix-Comment: this field is optional -
downloadCopyrightNotice
Text of a copyright notice associated with a download file, and intended to be displayed whenever the file content is used. Optional and non-repeating.
Jonix-Comment: this field is optional -
downloadTerms
Text of any terms and conditions associated with a download file. Optional and non-repeating. This field may be sent alone, or with the <TextWithDownload> element, or with any combination of the <DownloadCaption>, <DownloadCredit>, and <DownloadCopyrightNotice> elements.
Jonix-Comment: this field is optional -
mediaFileDate
The date when the image referenced by the <MediaFileLink> element was last changed. Optional and non-repeating. This element is intended to allow the receiver of an updated ONIX record to determine whether it is necessary to download a new copy of the file.
Jonix-Comment: this field is optional -
asStruct
- Specified by:
asStruct
in interfaceOnixComposite.OnixDataComposite<JonixMediaFile>
-
structKey
- Specified by:
structKey
in interfaceOnixComposite.OnixDataCompositeWithKey<JonixMediaFile,
ImageAudioVideoFileTypes>
-