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

Class ContributorPlace

java.lang.Object
com.tectonica.jonix.onix3.ContributorPlace
All Implemented Interfaces:
OnixComposite, OnixComposite.OnixDataComposite<JonixContributorPlace>, OnixTag, Serializable
public class ContributorPlace extends Object implements OnixComposite.OnixDataComposite<JonixContributorPlace>, Serializable

Contributor place composite

An optional group of data elements which together identify a geographical location with which a contributor is associated, used to support ‘local interest’ promotions. Repeatable to identify multiple geographical locations, each usually with a different relationship to the contributor.

Reference name <ContributorPlace>
Short tag <contributorplace>
Cardinality 0…n

This tag may be included in the following composites:

Possible placements within ONIX message:

See Also:

  • Field Details

  • Constructor Details

    • ContributorPlace

      public ContributorPlace()

    • ContributorPlace

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

    • ifExists

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

    • contributorPlaceRelator

      public ContributorPlaceRelator contributorPlaceRelator()

      An ONIX code identifying the relationship between a contributor and a geographical location. Mandatory in each occurrence of <ContributorPlace> and non-repeating.

      Jonix-Comment: this field is required

    • countryCode

      public CountryCode countryCode()

      An ONIX code identifying a country with which a contributor is particularly associated. Optional and non-repeatable. There must be an occurrence of either the <CountryCode> or the <RegionCode> elements in each occurrence of <ContributorPlace>.

      Jonix-Comment: this field is required

    • regionCode

      public RegionCode regionCode()

      An ONIX code identifying a region with which a contributor is particularly associated. Optional and non-repeatable. There must be an occurrence of either the <CountryCode> or the <RegionCode> elements in each occurrence of <ContributorPlace>. A region is an area which is not a country, but which is precisely defined in geographical terms, eg Northern Ireland, Australian Capital Territory. If both country and region are specified, the region must be within the country. Note that US States have region codes, while US overseas territories have distinct ISO Country Codes.

      Jonix-Comment: this field is optional

    • locationNames

      public ListOfOnixElement<LocationName,String> locationNames()

      The name of a city or town location within the specified country or region with which a contributor is particularly associated. Optional, and repeatable to provide parallel names for a single location in multiple languages (eg Baile Átha Cliath and Dublin, or Bruxelles and Brussel). The language attribute is optional for a single instance of <LocationName>, but must be included in each instance if <LocationName> is repeated.

      Jonix-Comment: this list may be empty

    • asStruct

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