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

Class TitleText

java.lang.Object
com.tectonica.jonix.onix3.TitleText
All Implemented Interfaces:
OnixElement<String>, OnixTag, Serializable
@Deprecated public class TitleText extends Object implements OnixElement<String>, Serializable
Deprecated.

Title text

The text of a title element, excluding any subtitle. Optional and non-repeating, may only be used where <TitlePrefix>, <NoPrefix/> and <TitleWithoutPrefix> are not used.

This element is deprecated – except in cases where the language of the title does not use explicit definite or indefinite articles articles (eg The, A). Other than in such languages, the element is intended to be used only when the sending system cannot reliably provide prefixes that are ignored for sorting purposes in a separate data element. If the system can reliably separate prefixes, it should state whether a prefix is present (using <TitlePrefix> and <TitleWithoutPrefix>) or absent (using <NoPrefix/> and <TitleWithoutPrefix>).

Format Variable length text, suggested maximum 300 characters
Reference name <TitleText>
Short tag <b203>
Cardinality 0…1
Attributes collationkey, language, textscript, textcase
Example <b203 language="eng" textcase="01">Dickens classics</b203>

Technical notes about <TitleText> from the schema author: Full text of a title element, without any subtitle, used only when <TitleWithoutPrefix> and one of <TitlePrefix> or <NoPrefix/> cannot be used ● Deprecated from release 3.1 - use either <TitlePrefix> or <NoPrefix>, plus <TitleWithoutPrefix> instead ● Added textscript attribute at revision 3.0.2 ● Added collationkey attribute at revision 3.0.1 This tag may be included in the following composites:

Possible placements within ONIX message:
See Also:

  • Field Details

    • refname

      public static final String refname
      Deprecated.
      See Also:

    • shortname

      public static final String shortname
      Deprecated.
      See Also:

    • datestamp

      public String datestamp
      Deprecated.
      (type: dt.DateOrDateTime)

    • sourcename

      public String sourcename
      Deprecated.
      (type: dt.NonEmptyString)

    • sourcetype

      public RecordSourceTypes sourcetype
      Deprecated.

    • collationkey

      public String collationkey
      Deprecated.
      (type: dt.NonEmptyString)

    • language

      public Languages language
      Deprecated.

    • textscript

      public TextScripts textscript
      Deprecated.

    • textcase

      public TextCaseFlags textcase
      Deprecated.

    • value

      public String value
      Deprecated.
      This is the raw content of TitleText. Could be null if exists() == false. Use OnixElement.value() instead if you want to get this as an Optional.

      Raw Format: Variable length text, suggested maximum 300 characters

      (type: dt.NonEmptyString)

    • EMPTY

      public static final TitleText EMPTY
      Deprecated.

  • Constructor Details

    • TitleText

      public TitleText()
      Deprecated.

    • TitleText

      public TitleText(Element element)
      Deprecated.

  • Method Details

    • __v

      public String __v()
      Deprecated.
      Internal API, use the OnixElement.value() method or the OnixElement.value() field instead
      Specified by:
      __v in interface OnixElement<String>

    • exists

      public boolean exists()
      Deprecated.
      Description copied from interface: OnixTag
      indicates whether this tag exists in the ONIX record
      Specified by:
      exists in interface OnixTag
      Returns:
      whether this tag (<TitleText> or <b203>) is explicitly provided in the ONIX XML

    • ifExists

      public void ifExists(Consumer<TitleText> action)
      Deprecated.