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

Class ContentDate

java.lang.Object
com.tectonica.jonix.onix3.ContentDate
All Implemented Interfaces:
OnixComposite, OnixComposite.OnixDataComposite<JonixContentDate>, OnixComposite.OnixDataCompositeWithKey<JonixContentDate,ContentDateRoles>, OnixTag, Serializable
public class ContentDate extends Object implements OnixComposite.OnixDataCompositeWithKey<JonixContentDate,ContentDateRoles>, Serializable

Content date composite

An optional group of data elements which together specify a date associated with the text carried in an occurrence of the <TextContent> composite, eg date when quoted text was published. Repeatable to specify different dates with their various roles.

Reference name <ContentDate>
Short tag <contentdate>
Cardinality 0…n

This tag may be included in the following composites:

Possible placements within ONIX message:

See Also:

  • Field Details

  • Constructor Details

    • ContentDate

      public ContentDate()

    • ContentDate

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

    • ifExists

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

    • contentDateRole

      public ContentDateRole contentDateRole()

      An ONIX code indicating the significance of the date in relation to the text content. Mandatory in each occurrence of the <ContentDate> composite, and non-repeating.

      Jonix-Comment: this field is required

    • date

      public Date date()

      The date specified in the <ContentDateRole> field. Mandatory in each occurrence of the <ContentDate> composite, and non-repeating. <Date> may carry a dateformat attribute: if the attribute is missing, then the default format is YYYYMMDD.

      Jonix-Comment: this field is required

    • asStruct

      public JonixContentDate asStruct()
      Specified by:
      asStruct in interface OnixComposite.OnixDataComposite<JonixContentDate>

    • structKey

      public ContentDateRoles structKey()
      Specified by:
      structKey in interface OnixComposite.OnixDataCompositeWithKey<JonixContentDate,ContentDateRoles>