Module jonix.onix2
Package com.tectonica.jonix.onix2

Class OtherText

java.lang.Object
com.tectonica.jonix.onix2.OtherText
All Implemented Interfaces:
OnixComposite, OnixComposite.OnixDataComposite<JonixOtherText>, OnixComposite.OnixDataCompositeWithKey<JonixOtherText,OtherTextTypes>, OnixTag, Serializable
public class OtherText extends Object implements OnixComposite.OnixDataCompositeWithKey<JonixOtherText,OtherTextTypes>, Serializable

Other text composite

An optional and repeatable group of data elements which together identify and either include, or provide pointers to, text related to the product.

Reference name <OtherText>
Short tag <othertext>

This tag may be included in the following composites:

Possible placements within ONIX message:

See Also:

  • Field Details

  • Constructor Details

    • OtherText

      public OtherText()

    • OtherText

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

    • ifExists

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

    • textTypeCode

      public TextTypeCode textTypeCode()

      An ONIX code which identifies the type of text which is sent in the <Text> element, or referenced in the <TextLink> element. Mandatory in each occurrence of the <OtherText> composite, and non-repeating.

      Jonix-Comment: this field is required

    • textLinkType

      public TextLinkType textLinkType()

      An ONIX code which identifies the type of link which is given in the <TextLink> element.

      Jonix-Comment: this field is required

    • textLink

      public TextLink textLink()

      A link to the text item specified in the <TextTypeCode> element, using the link type specified in <TextLinkType>.

      Jonix-Comment: this field is required

    • textFormat

      public TextFormat textFormat()

      An ONIX code which identifies the format of text which is sent in the <Text> element, or referenced in the <TextLink> element. Optional and non-repeating. It is now possible to use a “textformat” attribute in the <Text> element for this purpose, and this is the recommended practise when the text is sent in the ONIX record. The <TextFormat> element may still be used when the text is held outside the ONIX record, and referenced by the <TextLink> element.

      Jonix-Comment: this field is optional

    • text

      public Text text()

      The text specified in the <TextTypeCode> element, if it is suitable to be sent in full as part of the ONIX record. Either the <Text> element or both of the <TextLinkType> and <TextLink> elements must be present in any occurrence of the <OtherText> composite. Non-repeating.

      The <Text> element may carry any of the following ONIX attributes: textformat, language, transliteration, textcase.

      Jonix-Comment: this field is optional

    • textAuthor

      public TextAuthor textAuthor()

      The name of the author of text sent in the <Text> element, or referenced in the <TextLink> element, eg if it is a review or promotional quote.

      Jonix-Comment: this field is optional

    • textSourceCorporate

      public TextSourceCorporate textSourceCorporate()

      The name of a company or corporate body responsible for the text sent in the <Text> element, or referenced in the <TextLink> element, eg if it is part of a Reading Group Guide. Optional and non-repeating.

      Jonix-Comment: this field is optional

    • textSourceTitle

      public TextSourceTitle textSourceTitle()

      The title of a publication from which the text sent in the <Text> element, or referenced in the <TextLink> element, was taken, eg if it is a review quote. Optional and non-repeating.

      Jonix-Comment: this field is optional

    • textPublicationDate

      public TextPublicationDate textPublicationDate()

      The date on which text sent in the <Text> element, or referenced in the <TextLink> element, was published. Optional and non-repeating.

      Jonix-Comment: this field is optional

    • startDate

      public StartDate startDate()

      The date from which text sent in the <Text> element, or referenced in the <TextLink> element, is intended to be used, eg for date-limited promotions. Optional and non-repeating, but either both or neither of <StartDate> and <EndDate> must be present.

      Jonix-Comment: this field is optional

    • endDate

      public EndDate endDate()

      The date until which text sent in the <Text> element, or referenced in the <TextLink> element, is intended to be used, eg for date-limited promotions. Optional and non-repeating, but either both or neither of <StartDate> and <EndDate> must be present.

      Jonix-Comment: this field is optional

    • asStruct

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

    • structKey

      public OtherTextTypes structKey()
      Specified by:
      structKey in interface OnixComposite.OnixDataCompositeWithKey<JonixOtherText,OtherTextTypes>