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

Class CitedContent

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

Cited content composite

An optional group of data elements which together describe a piece of cited content. The composite is repeatable to describe and link to multiple items of cited material.

Reference name <CitedContent>
Short tag <citedcontent>
Cardinality 0…n

This tag may be included in the following composites:

Possible placements within ONIX message:

See Also:

  • Field Details

  • Constructor Details

    • CitedContent

      public CitedContent()

    • CitedContent

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

    • ifExists

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

    • citedContentType

      public CitedContentType citedContentType()

      An ONIX code indicating the type of content which is being cited. Mandatory in each occurrence of the <CitedContent> composite, and non-repeating.

      Jonix-Comment: this field is required

    • 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 where <CitedContentType> indicates the cited content is a review. Not repeatable.

      Jonix-Comment: this field is required

    • sourceTitles

      public ListOfOnixElement<SourceTitle,String> sourceTitles()

      The title, name or short description of a publication, broadcast, website or other source of cited content. Optional, and repeatable; required unless the cited content refers to a bestseller list, and <ListName> is present. <SourceTitle> may be repeated 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 is required to contain at least one item

    • sequenceNumber

      public SequenceNumber sequenceNumber()

      A number which specifies a single overall sequence of cited content. Optional and non-repeating. It is strongly recommended that if any occurrence of the <CitedContent> composite of a specific <CitedContentType> carries a <SequenceNumber>, then all of that type should carry a <SequenceNumber> – though there is no requirement to number cited content 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 cited content is specifically intended. Optional in each occurrence of the <CitedContent> composite, and non-repeating. If omitted, the content is intended to be cited (linked to) wherever the product may be sold (see Territorial sales rights in Group P.21). If included, the content should be cited by recipients in the specified territory only, and in preference to any cited content 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 citations of the same type marked for use in the same country or region), and to ensure that appropriate citations 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 citation does not have a territory specified. Where multiple citations of the same type are provided, those without specific <Territory> composites are intended for use only where no appropriate targeted citation is present.

      Jonix-Comment: this field is optional

    • sourceType

      public SourceType sourceType()

      An ONIX code indicating the type of source from which the cited material originated, eg radio, TV. Optional, and non-repeating.

      Jonix-Comment: this field is optional

    • positionOnList

      public PositionOnList positionOnList()

      The position that a product has reached on a bestseller list specified in <ListName>. Optional and non-repeating. The <ListName> element must also be present if <PositionOnList> is included.

      Jonix-Comment: this field is optional

    • contentAudiences

      public ListOfOnixCodelist<ContentAudience,ContentAudiences> contentAudiences()

      An ONIX code which identifies the audience for which a piece of cited content is intended. Optional and repeatable.

      Jonix-Comment: this list may be empty

    • listNames

      public ListOfOnixElement<ListName,String> listNames()

      The name of a bestseller list, when the <CitedContent> composite is used to refer to a position which a product has reached on such a list. Optional, and repeatable to provide a parallel list name in multiple languages. The language attribute is optional for a single instance of <ListName>, but must be included in each instance if <ListName> is repeated.

      Jonix-Comment: this list may be empty

    • citationNotes

      public ListOfOnixElement<CitationNote,String> citationNotes()

      A free text note giving any additional information about cited content, for example a detailed volume, issue and page reference to content cited from a periodical. Optional, and repeatable when parallel text is provided in multiple languages. The language attribute is optional for a single instance of <CitationNote>, but must be included in each instance if <CitationNote> is repeated.

      Jonix-Comment: this list may be empty

    • resourceLinks

      public ListOfOnixElement<ResourceLink,String> resourceLinks()

      A URL which provides a link to cited content which is accessible in digital form. Optional, and repeatable if the resource can be linked in more than one way, eg by URL or DOI, or where a cited resource 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

    • contentDates

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

      An optional and repeatable group of data elements which together specify a date associated with cited content, eg date on which it was published or broadcast.

      Jonix-Comment: this list may be empty