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

Class Collection

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

Collection composite

An optional group of data elements which carry attributes of a collection of which the product is part. (For a publisher collection, these attributes may or may not include the collection title.) The composite is repeatable, to provide details when the product belongs to multiple collections.

Collection-related data elements within a <Collection> composite that does not carry collection title information must relate to a publisher collection whose title is included in Group P.6.

Reference name <Collection>
Short tag <collection>
Cardinality 0…n

This tag may be included in the following composites:

Possible placements within ONIX message:

See Also:

  • Field Details

  • Constructor Details

    • Collection

      public Collection()

    • Collection

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

    • ifExists

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

    • collectionType

      public CollectionType collectionType()

      An ONIX code indicating the type of a collection: publisher collection, ascribed collection, or unspecified. Mandatory in each occurrence of the <Collection> composite, and non-repeating.

      Jonix-Comment: this field is required

    • contributors

      public ListOfOnixComposite<Contributor> contributors()

      A group of data elements which together describe a personal or corporate contributor to a collection. Optional, and repeatable to describe multiple contributors. The <Contributor> composite is included here for use only by those ONIX communities whose national practice requires contributors to the collection as a whole (eg Series editors) to be identified at collection level. In many countries, including the UK, USA, Canada and Spain, the required practice is to identify all contributors at product level in Group P.7.

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

    • collectionFrequency

      public CollectionFrequency collectionFrequency()

      An ONIX code specifying the approximate or expected publication frequency for addition of new products to the collection. Optional, and non-repeating.

      Jonix-Comment: this field is optional

    • sourceName

      public SourceName sourceName()

      If the <CollectionType> code indicates an ascribed collection (ie a collection which has been identified and described by a supply chain organization other than the publisher), this element may be used to carry the name of the organization responsible. Optional and non-repeating.

      Jonix-Comment: this field is optional

    • noContributor

      public NoContributor noContributor()

      An empty element that provides a positive indication that a collection has no stated authorship. Optional and non-repeating. Must only be sent in a record that has no <Contributor> data in Group P.5.

      The <NoContributor/> element is provided here for use only by those ONIX communities whose national practice requires contributors to the collection to be identified at collection level. It should not be sent in a context where collection contributors are normally identified in Group P.6.

      Jonix-Comment: this field is optional

    • isNoContributor

      public boolean isNoContributor()

    • collectionIdentifiers

      public ListOfOnixDataCompositeWithKey<CollectionIdentifier,JonixCollectionIdentifier,CollectionIdentifierTypes> collectionIdentifiers()

      A repeatable group of data elements which together specify an identifier of a bibliographic collection. The composite is optional, and may only repeat if two or more identifiers of different types are sent for the same collection. It is not permissible to have two identifiers of the same type.

      Jonix-Comment: this list may be empty

    • collectionSequences

      public ListOfOnixDataCompositeWithKey<CollectionSequence,JonixCollectionSequence,CollectionSequenceTypes> collectionSequences()

      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.

      Jonix-Comment: this list may be empty

    • titleDetails

      public ListOfOnixComposite<TitleDetail> titleDetails()

      A group of data elements which together give the text of a collection title and specify its type. Optional, but the composite is required unless the only collection title is carried in full, and word-for-word, as an integral part of the product title in P.6, in which case it should not be repeated in P.5. The composite is repeatable with different title types.

      Jonix-Comment: this list may be empty

    • contributorStatements

      public ListOfOnixElement<ContributorStatement,String> contributorStatements()

      Free text showing how the collection authorship should be described in an online display, when a standard concatenation of individual collection contributor elements would not give a satisfactory presentation. Optional but must only be used if one or more instances of <Contributor> are present within <Collection>, and repeatable where parallel text is provided in multiple languages. The language attribute is optional for a single instance of <ContributorStatement>, but must be included in each instance if <ContributorStatement> is repeated. When the <ContributorStatement> element is sent, the recipient should use it to replace all name detail sent in the <Contributor> composites within <Collection> for display purposes only. It does not replace the <Contributor> composite (or any element within it) for individual contributors. The individual name detail must also be sent in one or more <Contributor> composites for indexing and retrieval purposes.

      The <ContributorStatement> element is provided here for use only by those ONIX communities whose national practice requires contributors to the collection to be identified at collection level. It should not be sent in a context where collection contributors are normally identified in Group P.6.

      Jonix-Comment: this list may be empty