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

Class Title

java.lang.Object
com.tectonica.jonix.onix2.Title
All Implemented Interfaces:
OnixComposite, OnixComposite.OnixDataComposite<JonixTitle>, OnixComposite.OnixDataCompositeWithKey<JonixTitle,TitleTypes>, OnixTag, Serializable
public class Title extends Object implements OnixComposite.OnixDataCompositeWithKey<JonixTitle,TitleTypes>, Serializable

Title composite

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.

Reference name <Title>
Short tag <title>

This tag may be included in the following composites:

Possible placements within ONIX message:

Since:
Onix-2.1
See Also:

  • Field Details

  • Constructor Details

    • Title

      public Title()

    • Title

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

    • ifExists

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

    • titleType

      public TitleType titleType()

      An ONIX code indicating the type of a title. Mandatory in each occurrence of the <Title> composite, and non-repeating. Additional types of title can now be defined by adding code values without requiring a new ONIX release.

      Jonix-Comment: this field is required

    • titleText

      public TitleText titleText()

      The text of the title specified by the <TitleType> code; and excluding the subtitle, if any. Optional and non-repeating: see text at the head of the <Title> composite for details of valid title text options. The <TitleText> element may carry any of the following ONIX attributes: textformat, language, transliteration, textcase.

      Jonix-Comment: this field is required

    • abbreviatedLength

      public AbbreviatedLength abbreviatedLength()

      If the <Title> composite is used to carry an abbreviated title, the length to which the title is abbreviated may be indicated by giving the maximum number of characters (regardless of whether in each specific instance abbreviation has been required in order to meet this limit). The <TitleType> code should indicate the form of the title that has been abbreviated. Optional and non-repeating. If this element is present, the <TitleText> element must be used to carry the abbreviated form. [The option also exists to send an abbreviated title as a separate <TitleType> without using <AbbreviatedLength>, which is simpler, but less informative.]

      Jonix-Comment: this field is optional

    • textCaseFlag

      public TextCaseFlag textCaseFlag()

      An ONIX code indicating the case in which the text elements in an occurrence of the <Title> composite are sent. The default is “unspecified”. Optional and non-repeating. Text case can now be indicated by an XML attribute on any text element, and this method is preferred. See ONIX for Books – Product Information Message – XML Message Specification, Section 4.

      Jonix-Comment: this field is optional

    • titlePrefix

      public TitlePrefix titlePrefix()

      Text at the beginning of a title which is to be ignored for alphabetical sorting. Optional and non-repeating; can only be used if the <TitleWithoutPrefix> element is also present. These two elements may be used in combination in applications where it is necessary to distinguish an initial word or character string which is to be ignored for filing purposes, eg in library systems and in some bookshop databases. The <TitlePrefix> element may carry any of the following ONIX attributes: textformat, language, transliteration, textcase.

      Jonix-Comment: this field is optional

    • titleWithoutPrefix

      public TitleWithoutPrefix titleWithoutPrefix()

      Full text of a title, without abbreviation or abridgement, and without the title prefix; and excluding the subtitle, if any. Optional and non-repeating; can only be used if the <TitlePrefix> element is also present. The <TitleWithoutPrefix> element may carry any of the following ONIX attributes: textformat, language, transliteration, textcase.

      Jonix-Comment: this field is optional

    • subtitle

      public Subtitle subtitle()

      The full text of a subtitle, if any. “Subtitle” means any added words which appear with the title given in an occurrence of the <Title> composite, and which amplify and explain the title, but which are not considered to be part of the title itself. Optional and non-repeating. The <Subtitle> element may carry any of the following ONIX attributes: textformat, language, transliteration, textcase.

      Jonix-Comment: this field is optional

    • asStruct

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

    • structKey

      public TitleTypes structKey()
      Specified by:
      structKey in interface OnixComposite.OnixDataCompositeWithKey<JonixTitle,TitleTypes>