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

Class CollectionSequence

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

Collection sequence composite

An optional and repeatable group of data elements which indicates some ordinal position of a product within a collection. Different ordinal positions may be specified using separate repeats of the composite – for example, a product may be published first while also being third in narrative order within a collection.

Reference name <CollectionSequence>
Short tag <collectionsequence>
Cardinality 0…n

This tag may be included in the following composites:

Possible placements within ONIX message:

Since:
Onix-3.01
See Also:

  • Field Details

  • Constructor Details

    • CollectionSequence

      public CollectionSequence()

    • CollectionSequence

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

    • ifExists

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

    • collectionSequenceType

      public CollectionSequenceType collectionSequenceType()

      An ONIX code identifying the type of ordering used for the product’s sequence number within the collection. Mandatory and non-repeating within the <CollectionSequence> composite.

      Jonix-Comment: this field is required

    • collectionSequenceNumber

      public CollectionSequenceNumber collectionSequenceNumber()

      A number which specifies the ordinal position of the product in a collection. The ordinal position may be a simple number (1st, 2nd, 3rd etc) or may be multi-level (eg 3.2) if the collection has a multi-level structure (ie there are both collection and sub-collection title elements). Mandatory and non-repeating within the <CollectionSequence> composite.

      New from 3.0.4 A hyphen may be used in place of an integer within a multi-level number, where a particular level of the hierarchy is unnumbered, for example -.3 where a product is the third in a sub-collection, and the sub-collections are in no particular order within the collection.

      Jonix-Comment: this field is required

    • collectionSequenceTypeName

      public CollectionSequenceTypeName collectionSequenceTypeName()

      A name which describes a proprietary order used for the product’s sequence number within the collection. Must be included when, and only when, the code in the <CollectionSequenceType> field indicates a proprietary scheme. Optional and non-repeating.

      Jonix-Comment: this field is optional

    • asStruct

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

    • structKey

      public CollectionSequenceTypes structKey()
      Specified by:
      structKey in interface OnixComposite.OnixDataCompositeWithKey<JonixCollectionSequence,CollectionSequenceTypes>