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

Class Contributor

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

Contributor composite

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.

Reference name <Contributor>
Short tag <contributor>

This tag may be included in the following composites:

Possible placements within ONIX message:

See Also:

  • Field Details

  • Constructor Details

    • Contributor

      public Contributor()

    • Contributor

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

    • ifExists

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

    • personName

      public PersonName personName()

      The name of a person who contributed to the creation of the product, unstructured, and presented in normal order. Optional and non-repeating: see Group PR.8 introductory text for valid options.

      Jonix-Comment: this field is required

    • contributorRoles

      public ListOfOnixCodelist<ContributorRole,ContributorRoles> contributorRoles()

      An ONIX code indicating the role played by a person or corporate body in the creation of the product. Mandatory in each occurrence of a <Contributor> composite, and may be repeated if the same person or corporate body has more than one role in relation to the product. Note, however, that if the <SequenceNumberWithinRole> element is used to establish individual sequences of contributor names by role, the <ContributorRole> element must not be repeated. There must instead be separate occurrences of the <Contributor> composite if the same person has two or more roles.

      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 contributor names. Optional and non-repeating. There are two ways of approaching the sequencing of contributor names: by defining a single sequence across all contributors, which is the general ONIX practise; or by defining an individual sequence for each contributor role, using the element <SequenceNumberWithinRole> on the next page. Some applications require this more precise sequencing. Where it is not required, it is strongly recommended that each occurrence of the <Contributor> composite should carry an overall <SequenceNumber>.

      Jonix-Comment: this field is optional

    • sequenceNumberWithinRole

      public SequenceNumberWithinRole sequenceNumberWithinRole()

      A number which specifies the sequence of contributor names within a specified role, for applications which require this form of numbering. Optional and non-repeating.

      Jonix-Comment: this field is optional

    • personNameInverted

      public PersonNameInverted personNameInverted()

      The name of a person who contributed to the creation of the product, presented in inverted order, with the element used for alphabetical sorting placed first. Optional and non-repeating: see Group PR.8 introductory text for valid options.

      Jonix-Comment: this field is optional

    • titlesBeforeNames

      public TitlesBeforeNames titlesBeforeNames()

      The first part of a structured name of a person who contributed to the creation of the product: qualifications and/or titles preceding a person’s names, eg Professor or HRH Prince or Saint. Optional and non-repeating: see Group PR.8 introductory text for valid options.

      Jonix-Comment: this field is optional

    • namesBeforeKey

      public NamesBeforeKey namesBeforeKey()

      The second part of a structured name of a person who contributed to the creation of the product: name(s) and/or initial(s) preceding a person’s key name(s), eg James J. Optional and non-repeating.

      Jonix-Comment: this field is optional

    • prefixToKey

      public PrefixToKey prefixToKey()

      The third part of a structured name of a person who contributed to the creation of the product: a prefix which precedes the key name(s) but which is not to be treated as part of the key name, eg van in Ludwig van Beethoven. Optional and non-repeating.

      Jonix-Comment: this field is optional

    • keyNames

      public KeyNames keyNames()

      The fourth part of a structured name of a person who contributed to the creation of the product: key name(s), ie the name elements normally used to open an entry in an alphabetical list, eg Smith or Garcia Marquez or Madonna or Francis de Sales (in Saint Francis de Sales). Optional and non-repeating.

      Jonix-Comment: this field is optional

    • namesAfterKey

      public NamesAfterKey namesAfterKey()

      The fifth part of a structured name of a person who contributed to the creation of the product: name suffix, or name(s) following a person’s key name(s), eg Ibrahim (in Anwar Ibrahim). Optional and non-repeating.

      Jonix-Comment: this field is optional

    • suffixToKey

      public SuffixToKey suffixToKey()

      The sixth part of a structured name of a person who contributed to the creation of the product: a suffix following a person’s key name(s), eg Jr or III. Optional and non-repeating.

      Jonix-Comment: this field is optional

    • lettersAfterNames

      public LettersAfterNames lettersAfterNames()

      The seventh part of a structured name of a person who contributed to the creation of the product: qualifications and honors following a person’s names, eg CBE FRS. Optional and non-repeating.

      Jonix-Comment: this field is optional

    • titlesAfterNames

      public TitlesAfterNames titlesAfterNames()

      The eighth part of a structured name of a person who contributed to the creation of the product: titles following a person’s names, eg Duke of Edinburgh. Optional and non-repeating.

      Jonix-Comment: this field is optional

    • corporateName

      public CorporateName corporateName()

      The name of a corporate body which contributed to the creation of the product, unstructured. Optional and non-repeating: see Group PR.8 introductory text for valid options.

      Jonix-Comment: this field is optional

    • biographicalNote

      public BiographicalNote biographicalNote()

      A biographical note about a contributor to the product. (See the <OtherText> composite in Group PR.15 for a biographical note covering all contributors to a product in a single text.) Optional and non-repeating. May occur with a person name or with a corporate name. A biographical note in ONIX should always contain the name of the person or body concerned, and it should always be presented as a piece of continuous text consisting of full sentences. Some recipients of ONIX data feeds will not accept text which has embedded URLs. A contributor website link can be sent using the <Website> composite on the next page.

      The <BiographicalNote> element may carry any of the following ONIX attributes: textformat, language, transliteration, textcase.

      Jonix-Comment: this field is optional

    • professionalPosition

      public ProfessionalPosition professionalPosition()

      A professional position held by a contributor to the product at the time of its creation. Optional and non-repeating. May only occur with a person name, not with a corporate name.

      The <ProfessionalAffiliation> composite below provides a more general method of handling positions and affiliations, and is to be preferred.

      Jonix-Comment: this field is optional

    • affiliation

      public Affiliation affiliation()

      An organisation to which a contributor to the product was affiliated at the time of its creation. Optional and non-repeating. May only occur with a person name, not with a corporate name.

      The <ProfessionalAffiliation> composite below provides a more general method of handling positions and affiliations, and is to be preferred.

      Jonix-Comment: this field is optional

    • contributorDescription

      public ContributorDescription contributorDescription()

      Brief text describing a contributor to the product, at the publisher’s discretion. Optional and non-repeating. It may be used with either a person or corporate name, to draw attention to any aspect of a contributor’s background which supports the promotion of the book.

      Jonix-Comment: this field is optional

    • unnamedPersons

      public UnnamedPersons unnamedPersons()

      An ONIX code allowing a positive indication to be given when authorship is unknown or anonymous, or when as a matter of editorial policy only a limited number of contributors are named. Optional and non-repeating: see Group PR.8 introductory text for valid options.

      Jonix-Comment: this field is optional

    • languageCodes

      public ListOfOnixCodelist<LanguageCode,Languages> languageCodes()

      Used only when the <ContributorRole> code value is B06, B08 or B10 indicating a translator, to specify the language from which the translation was made. This makes it possible to specify a translator’s exact responsibility when a work involved translation from two or more languages. Optional and repeatable in the unlikely event that a single person has been responsible for translation from two or more languages.

      Jonix-Comment: this list may be empty

    • names

      public ListOfOnixComposite<Name> names()

      A repeatable group of data elements which together represent a personal name, and specify its type. The <Name> composite may be used to send alternate names for the same person, eg to handle such cases as Ian Rankin writing as Jack Harvey.

      Jonix-Comment: this list may be empty

    • personNameIdentifiers

      public ListOfOnixDataCompositeWithKey<PersonNameIdentifier,JonixPersonNameIdentifier,PersonNameIdentifierTypes> personNameIdentifiers()

      A repeatable group of data elements which together specify a party name identifier, used here to carry an identifier for a name given in an occurrence of the <Contributor> composite. Optional: see Group PR.8 introductory text for valid options.

      Jonix-Comment: this list may be empty

    • personDates

      public ListOfOnixDataCompositeWithKey<PersonDate,JonixPersonDate,PersonDateRoles> personDates()

      A repeatable group of data elements which together specify a date associated with the person identified in an occurrence of the <Contributor> composite, eg birth or death.

      Jonix-Comment: this list may be empty

    • professionalAffiliations

      public ListOfOnixComposite<ProfessionalAffiliation> professionalAffiliations()

      A repeatable group of data elements which together identify a contributor’s professional position and/or affiliation, allowing multiple positions and affiliations to be specified.

      Jonix-Comment: this list may be empty

    • websites

      public ListOfOnixDataComposite<Website,JonixWebsite> websites()

      A repeatable group of data elements which together identify and provide pointers to a website which is related to the party identified in an occurrence of the <Contributor> composite.

      Jonix-Comment: this list may be empty

    • countryCodes

      public ListOfOnixCodelist<CountryCode,Countrys> countryCodes()

      A code identifying a country with which a contributor is particularly associated, when this is significant for the marketing of a product. Optional and repeatable.

      Jonix-Comment: this list may be empty

    • regionCodes

      public ListOfOnixElement<RegionCode,Set<String>> regionCodes()

      An ONIX code identifying a region with which a contributor is particularly associated, when this is significant for the marketing of a product. Optional and repeatable.

      Jonix-Comment: this list may be empty