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

Class Annotation

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

Annotation

A brief descriptive paragraph about the product, length strictly limited to 350 characters. Optional and non-repeating. The <OtherText> composite on the next page provides a more general method of handling annotations, and is to be preferred.

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

Format Variable-length text, maximum 350 characters (XHTML is enabled in this element - see ONIX for Books - Product Information Message - XML Message Specification, Section 7)
Reference name <Annotation>
Short tag <d100>
Example <d100>Set on the Greek island of Cephallonia during World War II, this is the story of a beautiful young woman and her two suitors: a gentle fisherman turned ruthless guerrilla, and the charming mandolin-playing head of the Italian garrison on the island.</d100>

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:

    • textformat

      public TextFormats textformat
      Deprecated.

    • textcase

      public TextCaseFlags textcase
      Deprecated.

    • language

      public Languages language
      Deprecated.

    • transliteration

      public TransliterationSchemes transliteration
      Deprecated.

    • datestamp

      public String datestamp
      Deprecated.
      (type: DateOrDateTime)

    • sourcetype

      public RecordSourceTypes sourcetype
      Deprecated.

    • sourcename

      public String sourcename
      Deprecated.

    • value

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

      Raw Format: Variable-length text, maximum 350 characters (XHTML is enabled in this element - see ONIX for Books - Product Information Message - XML Message Specification, Section 7)

      (type: XHTML)

    • EMPTY

      public static final Annotation EMPTY
      Deprecated.

  • Constructor Details

    • Annotation

      public Annotation()
      Deprecated.

    • Annotation

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

    • ifExists

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