Module jonix.onix3

Package com.tectonica.jonix.onix3

Class TimeRun

java.lang.Object

com.tectonica.jonix.onix3.TimeRun

All Implemented Interfaces:

OnixComposite, OnixComposite.OnixDataComposite<JonixTimeRun>, OnixTag, Serializable

public class TimeRun
extends Object
implements OnixComposite.OnixDataComposite<JonixTimeRun>, Serializable

Time run composite

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.

Reference name	<TimeRun>
Short tag	<timerun>
Cardinality	0…n

This tag may be included in the following composites:

• <AVItem>

Possible placements within ONIX message:

• Product ⯈ ContentDetail ⯈ ContentItem ⯈ AVItem ⯈ TimeRun

Since:

Onix-3.05

See Also:

• Serialized Form

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

Fields

Modifier and Type	Field	Description
String	datestamp	(type: dt.DateOrDateTime)
static final TimeRun	EMPTY
static final String	refname
static final String	shortname
String	sourcename	(type: dt.NonEmptyString)
RecordSourceTypes	sourcetype

Constructor Summary

Constructors

Constructor	Description
TimeRun()
TimeRun(Element element)

Method Summary

Modifier and Type	Method	Description
void	_initialize()	This is an internal API.
JonixTimeRun	asStruct()
EndTime	endTime()	The time (relative to the beginning of the product’s audio or audiovisual content) of the end of a continuous sequence of audio or audiovisual content.
boolean	exists()	indicates whether this tag exists in the ONIX record
Element	getXmlElement()	For advanced use-cases only.
void	ifExists(Consumer<TimeRun> action)
StartTime	startTime()	The time (relative to the beginning of the product’s audio or audiovisual content) of the beginning of a continuous sequence of audiovisual content.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Details

refname

public static final String refname

See Also:

• Constant Field Values

shortname

public static final String shortname

See Also:

• Constant Field Values

datestamp

public String datestamp

(type: dt.DateOrDateTime)

sourcename

public String sourcename

(type: dt.NonEmptyString)

sourcetype

public RecordSourceTypes sourcetype

EMPTY

public static final TimeRun EMPTY

Constructor Details

TimeRun

public TimeRun()

TimeRun

public TimeRun(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 (<TimeRun> or <timerun>) is explicitly provided in the ONIX XML

ifExists

public void ifExists(Consumer<TimeRun> 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

startTime

public StartTime startTime()

The time (relative to the beginning of the product’s audio or audiovisual content) of the beginning of a continuous sequence of audiovisual content. Mandatory in each occurrence of the <TimeRun> composite, and non-repeating.

Jonix-Comment: this field is required

endTime

public EndTime endTime()

The time (relative to the beginning of the product’s audio or audiovisual content) of the end of a continuous sequence of audio or audiovisual content. Optional in each occurrence of the <TimeRun> composite, and non-repeating.

Jonix-Comment: this field is optional

asStruct

public JonixTimeRun asStruct()

Specified by:

asStruct in interface OnixComposite.OnixDataComposite<JonixTimeRun>