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

Class Set

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

Set composite

A repeatable group of data elements which together describe a set of which the product is part.

Reference name <Set>
Short tag <set>

This tag may be included in the following composites:

Possible placements within ONIX message:

See Also:

  • Field Details

  • Constructor Details

    • Set

      public Set()

    • Set

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

    • ifExists

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

    • titleOfSet

      public TitleOfSet titleOfSet()

      The full title of the set, without abbreviation or abridgement. Non-repeating. Either the <TitleOfSet> element or at least one occurrence of the <Title> composite must occur in each occurrence of the <Set> composite. The <Title> composite provides a more comprehensive representation of a set title, and allows alternative forms to be sent.

      Jonix-Comment: this field is required

    • isbnOfSet

      public ISBNOfSet isbnOfSet()

      A 10-character ISBN identifying a set of which the product forms part. Optional and non-repeating. The <ProductIdentifier> composite on the next page provides a more general method of handling this and other product codes, and is to be preferred.

      Jonix-Comment: this field is optional

    • ean13OfSet

      public EAN13OfSet ean13OfSet()

      EAN.UCC-13 article number identifying a set of which the product forms part. Optional and non-repeating. The <ProductIdentifier> composite on the next page provides a more general method of handling this and other product codes, and is to be preferred.

      Jonix-Comment: this field is optional

    • setPartNumber

      public SetPartNumber setPartNumber()

      The distinctive enumeration of a “subset” of which the product is a member, used only when a set is itself divided into two levels, eg A History of Western Europe, Part II: The Dark Ages, Volume I: After Rome. Optional and non-repeating. Note that this element is used for the first subdivision of a set which has two levels, regardless of the nomenclature (part, volume, etc) which the publisher uses at each level.

      Jonix-Comment: this field is optional

    • setPartTitle

      public SetPartTitle setPartTitle()

      The title of a “subset” of which the product is a member, used only when a set is itself divided into two levels, eg A History of Western Europe, Part II: The Dark Ages, Volume I: After Rome. Use this field only for the section of the whole title which is shared by, and only by, the members of the subset. Optional and non-repeating. Note that this element is used for the first subdivision of a set which has two levels, regardless of the nomenclature (part, volume, etc) which the publisher uses at each level.

      Jonix-Comment: this field is optional

    • itemNumberWithinSet

      public ItemNumberWithinSet itemNumberWithinSet()

      The distinctive enumeration of the product as an item within a set (or within a part of a set). Optional and non-repeating.

      Jonix-Comment: this field is optional

    • levelSequenceNumber

      public LevelSequenceNumber levelSequenceNumber()

      A number which specifies the position of an item in a set within a multi-level hierarchy of such items. Numbering starts at the top level in the hierarchy, and the first item at the top level is numbered 1. Optional and non-repeating. The purpose of this element is to make it possible to describe structured sets in a normalized way, since enumeration carried as <ItemNumberWithinSet> may take a wide variety of forms.

      Jonix-Comment: this field is optional

    • setItemTitle

      public SetItemTitle setItemTitle()

      The title which the product carries as an item within a set, eg After Rome in A History of Western Europe, Part II: The Dark Ages, Volume I: After Rome. This will invariably duplicate at least part of the product title in Group PR.7, but by entering it in this group it is possible to assure a correctly structured entry for the set. Optional and non-repeating.

      Jonix-Comment: this field is optional

    • productIdentifiers

      public ListOfOnixDataCompositeWithKey<ProductIdentifier,JonixProductIdentifier,ProductIdentifierTypes> productIdentifiers()

      A repeatable group of data elements which together define the identifier of a product in accordance with a specified scheme, used here to carry the product identifier for a set. See notes on the <ProductIdentifier> composite in section PR.2 for details of the handling of ISBN-13.

      Jonix-Comment: this list may be empty

    • titles

      public ListOfOnixDataCompositeWithKey<Title,JonixTitle,TitleTypes> titles()

      A repeatable group of data elements which together give the text of a title, including a subtitle where applicable, and specify its type. Please see Group PR.7 for details.

      Jonix-Comment: this list may be empty