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

Class Series

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

Series composite

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

Reference name <Series>
Short tag <series>

This tag may be included in the following composites:

Possible placements within ONIX message:

See Also:

  • Field Details

  • Constructor Details

    • Series

      public Series()

    • Series

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

    • ifExists

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

    • titleOfSeries

      public TitleOfSeries titleOfSeries()

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

      Jonix-Comment: this field is required

    • seriesISSN

      public SeriesISSN seriesISSN()

      International Standard Serial Number identifying a series of which the product forms part. ISSNs are the standard numbering scheme for journals, and most publishers’ book series are not eligible to be identified by an ISSN. ISSNs may be used, however, for established scholarly series such as Annual Reviews of… or Methods in… which are shelved in libraries as if they were journals. The field is optional and non-repeating. The <SeriesIdentifier> composite on the next page provides a more general method of handling this and other series identifiers, and is to be preferred.

      Jonix-Comment: this field is optional

    • publisherSeriesCode

      public PublisherSeriesCode publisherSeriesCode()

      A code or mnemonic assigned by the publisher to designate a series (and therefore not guaranteed to be unique). Optional and non-repeating. The <SeriesIdentifier> composite on the next page provides a more general method of handling this and other series identifiers, and is to be preferred.

      Jonix-Comment: this field is optional

    • numberWithinSeries

      public NumberWithinSeries numberWithinSeries()

      The distinctive enumeration of a product within a series. Optional and non-repeating.

      Jonix-Comment: this field is optional

    • yearOfAnnual

      public YearOfAnnual yearOfAnnual()

      The nominal year of an annual publication. May be entered as either a single year YYYY or a span of two consecutive years YYYY-YYYY. Optional and non-repeating.

      Jonix-Comment: this field is optional

    • seriesIdentifiers

      public ListOfOnixDataCompositeWithKey<SeriesIdentifier,JonixSeriesIdentifier,CollectionIdentifierTypes> seriesIdentifiers()

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

      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

    • contributors

      public ListOfOnixComposite<Contributor> contributors()

      A repeatable group of data elements which together describe a personal or corporate contributor to the series. The composite is optional in any occurrence of the <Series> composite. Please see Group PR.8 for details.

      Jonix-Comment: this list may be empty