Module jonix.onix3
Package com.tectonica.jonix.onix3

Class AVItem

java.lang.Object
com.tectonica.jonix.onix3.AVItem
All Implemented Interfaces:
OnixComposite, OnixComposite.OnixSuperComposite, OnixTag, Serializable
public class AVItem extends Object implements OnixComposite.OnixSuperComposite, Serializable

AV item composite

An optional group of data elements which are specific to audio or audiovisual (ie time-based) content. Exactly one of either the <AVItem> composite or the similar <TextItem> composite must occur in a <ContentItem> composite which describes a content item.

Reference name <AVItem>
Short tag <avitem>
Cardinality 0…1

This tag may be included in the following composites:

Possible placements within ONIX message:

Since:
Onix-3.05
See Also:

  • Field Details

  • Constructor Details

    • AVItem

      public AVItem()

    • AVItem

      public AVItem(Element element)

  • 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 interface OnixComposite

    • exists

      public boolean exists()
      Description copied from interface: OnixTag
      indicates whether this tag exists in the ONIX record
      Specified by:
      exists in interface OnixTag
      Returns:
      whether this tag (<AVItem> or <avitem>) is explicitly provided in the ONIX XML

    • ifExists

      public void ifExists(Consumer<AVItem> action)

    • getXmlElement

      public Element getXmlElement()
      Description copied from interface: OnixComposite
      For advanced use-cases only.
      Specified by:
      getXmlElement in interface OnixComposite
      Returns:
      native representation of the XML element underlying to this tag

    • avItemType

      public AVItemType avItemType()

      An ONIX code which identifies the nature of an audio or audiovisual content item. Mandatory in each occurrence of the <AVItem> composite, and non-repeatable.

      Jonix-Comment: this field is required

    • avDuration

      public AVDuration avDuration()

      The duration of an audio or audiovisual item within the time-based content of a product. Optional and non-repeating, but normally expected when the AV content item is being referenced as part of a structured table of contents.

      Jonix-Comment: this field is optional

    • avItemIdentifiers

      public ListOfOnixDataCompositeWithKey<AVItemIdentifier,JonixAVItemIdentifier,AvItemIdentifierTypes> avItemIdentifiers()

      A group of data elements which together define an identifier of an audio or audiovisual content item in accordance with a specified identifier scheme. The composite is optional, and repeatable in order to provide multiple identifiers for the content item.

      Jonix-Comment: this list may be empty

    • timeRuns

      public ListOfOnixDataComposite<TimeRun,JonixTimeRun> timeRuns()

      A repeatable group of data elements which together define the time period which an AV item takes up. The composite is optional, but may be repeated where the AV item covers two or more separate periods of time.

      Jonix-Comment: this list may be empty