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

Class TextContent

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

Supporting text content composite

An optional group of data elements which together carry a supporting text related to the product, repeatable in order to deliver multiple texts (often of different types, though for some text types there many be multiple instances of that type).

Reference name <TextContent>
Short tag <textcontent>
Cardinality 0…n

This tag may be included in the following composites:

Possible placements within ONIX message:

See Also:

  • Field Details

  • Constructor Details

    • TextContent

      public TextContent()

    • TextContent

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

    • ifExists

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

    • textType

      public TextType textType()

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

      Jonix-Comment: this field is required

    • contentAudiences

      public ListOfOnixCodelist<ContentAudience,ContentAudiences> contentAudiences()

      An ONIX code which identifies the audience for which the text in the <Text> element is intended. Mandatory in each occurrence of the <TextContent> composite, and repeatable.

      Jonix-Comment: this list is required to contain at least one item

    • texts

      public ListOfOnixElement<Text,String> texts()

      The text specified in the <TextType> element. Mandatory in each occurrence of the <TextContent> composite, and repeatable when essentially identical text is supplied in multiple languages. The language attribute is optional for a single instance of <Text>, but must be included in each instance if <Text> is repeated.

      Jonix-Comment: this list is required to contain at least one item

    • sequenceNumber

      public SequenceNumber sequenceNumber()

      A number which specifies a single overall sequence of supporting texts. Optional and non-repeating. It is strongly recommended that if any occurrence of the <TextContent> composite of a specific <TextType> carries a <SequenceNumber>, then all of that type should carry a <SequenceNumber> – though there is no requirement to number supporting texts where there is a single instance of that type.

      Jonix-Comment: this field is optional

    • territory

      public Territory territory()

      A group of data elements which together define a territory for which the text in the <Text> element is specifically intended. Optional in each occurrence of the <TextContent> composite, and non-repeating. If omitted, the text is intended for use wherever the product may be sold (see Territorial sales rights in Group P.21). If included, the text should be used by recipients in the specified territory only, and in preference to any text that lacks a specified territory.

      For valid combinations of <CountriesIncluded>, <RegionsIncluded> etc within <Territory>, see the notes describing the use of <Territory> within Group P.21.

      Care should be taken to avoid ambiguities (for example two different ‘short descriptions’ – without language attributes or with the same language attribute – marked for use in the same country or region), and to ensure that appropriate descriptions and supporting text are supplied for all countries and regions where the product may be sold. The simplest way to accomplish the latter is to ensure at least one version of the text does not have a territory specified. Where multiple texts of the same type are provided, those without specific <Territory> composites are intended for use only where no appropriate targeted text is present.

      Jonix-Comment: this field is optional

    • reviewRating

      public ReviewRating reviewRating()

      An optional group of data elements which together specify a ‘star rating’ awarded as part of a review of the publication, used when <TextType> indicates the text is a review. Not repeatable.

      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. Optional and non-repeating.

      Jonix-Comment: this field is optional

    • textAuthors

      public ListOfOnixElement<TextAuthor,String> textAuthors()

      The name of an author of text sent in the <Text> element, eg if it is a review or promotional quote. Optional, and repeatable if the text is jointly authored.

      Jonix-Comment: this list may be empty

    • textSourceDescriptions

      public ListOfOnixElement<TextSourceDescription,String> textSourceDescriptions()

      Brief text describing or providing context for the text author or corporate source, at the publisher’s discretion, and intended to be used in addition to <TextAuthor> or <TextSourceCorporate>. Optional, and repeatable to provide parallel descriptions in multiple languages. The language attribute is optional for a single instance of <TextSourceDescription>, but must be included in each instance if <TextSourceDescription> is repeated. The description may be used with either a person or corporate name, to draw attention to any aspect of the text source’s background which provides context for the text in <Text>.

      Jonix-Comment: this list may be empty

    • sourceTitles

      public ListOfOnixElement<SourceTitle,String> sourceTitles()

      The title of a publication from which the text sent in the <Text> element was taken, eg if it is a review quote. Optional, and repeatable to provide the title in multiple languages. The language attribute is optional for a single instance of <SourceTitle>, but must be included in each instance if <SourceTitle> is repeated.

      Jonix-Comment: this list may be empty

    • textSourceLinks

      public ListOfOnixElement<TextSourceLink,String> textSourceLinks()

      A URL which provides a link to a full text accessible in digital form, from which the supporting text in <Text> is an extract. Use, for example, to link to an original review. Optional, and repeatable if the resource can be linked in more than one way, eg by URL or DOI, or where a linked full text is available in multiple parallel languages. Where multiple languages are used, all repeats must carry the language attribute.

      Jonix-Comment: this list may be empty

    • epubUsageConstraints

      public ListOfOnixComposite<EpubUsageConstraint> epubUsageConstraints()

      An optional group of data elements which together describe a usage constraint on the supporting text sent in <Text> (or the absence of such a constraint). Repeatable in order to describe multiple constraints on usage.

      Jonix-Comment: this list may be empty

    • epubLicenses

      public ListOfOnixComposite<EpubLicenseWithDateType> epubLicenses()
      Jonix-Comment: this list may be empty

    • contentDates

      public ListOfOnixDataCompositeWithKey<ContentDate,JonixContentDate,ContentDateRoles> contentDates()

      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.

      Jonix-Comment: this list may be empty