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

Class NameIdentifier

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

Name identifier composite

A group of data elements which together specify a name identifier, used here to carry an identifier for a person or organization name given in an occurrence of the <Contributor> composite. Optional: see Group P.7 introductory text for valid options. Repeatable to specify name identifiers of different types for the same person or organization name.

Reference name <NameIdentifier>
Short tag <nameidentifier>
Cardinality 0…n

This tag may be included in the following composites:

Possible placements within ONIX message:

See Also:

  • Field Details

  • Constructor Details

    • NameIdentifier

      public NameIdentifier()

    • NameIdentifier

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

    • ifExists

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

    • nameIDType

      public NameIDType nameIDType()

      An ONIX code which identifies the scheme from which the value in the <IDValue> element is taken. Mandatory in each occurrence of the <NameIdentifier> composite, and non-repeating.

      Jonix-Comment: this field is required

    • idValue

      public IDValue idValue()

      A code value taken from the scheme specified in the <NameIDType> element. Mandatory in each occurrence of the composite, and non-repeating.

      Jonix-Comment: this field is required

    • idTypeName

      public IDTypeName idTypeName()

      A name which identifies a proprietary identifier scheme (ie a scheme which is not a standard and for which there is no individual ID type code). Must be included when, and only when, the code in the <NameIDType> element indicates a proprietary scheme. Optional and non-repeating.

      Jonix-Comment: this field is optional

    • asStruct

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

    • structKey

      public NameIdentifierTypes structKey()
      Specified by:
      structKey in interface OnixComposite.OnixDataCompositeWithKey<JonixNameIdentifier,NameIdentifierTypes>