Module jonix.common

Enum Class TextTypes

java.lang.Object
java.lang.Enum<TextTypes>
com.tectonica.jonix.common.codelist.TextTypes
All Implemented Interfaces:
OnixCodelist, Serializable, Comparable<TextTypes>, Constable

public enum TextTypes extends Enum<TextTypes> implements OnixCodelist
Enum that corresponds to ONIX Codelist 153

Description: Text type

See Also:
  • Enum Constant Details

    • Sender_defined_text

      public static final TextTypes Sender_defined_text
      To be used only in circumstances where the parties to an exchange have agreed to include text which (a) is not for general distribution, and (b) cannot be coded elsewhere. If more than one type of text is sent, it must be identified by tagging within the text itself
    • Short_description_annotation

      public static final TextTypes Short_description_annotation
      Of the product. Limited to a maximum of 350 characters
    • Description

      public static final TextTypes Description
      Of the product. Length unrestricted
    • Table_of_contents

      public static final TextTypes Table_of_contents
      Used for a table of contents sent as a single text field, which may or may not carry structure expressed using XHTML
    • Primary_cover_copy

      public static final TextTypes Primary_cover_copy
      Primary descriptive blurb usually taken from the back cover or jacket, or occasionally from the cover/jacket flaps. See also code 27
    • Review_quote

      public static final TextTypes Review_quote
      A quote taken from a review of the product or of the work in question where there is no need to take account of different editions
    • Review_quote_previous_edition

      public static final TextTypes Review_quote_previous_edition
      A quote taken from a review of a previous edition of the work
    • Review_quote_previous_work

      public static final TextTypes Review_quote_previous_work
      A quote taken from a review of a previous work by the same author(s) or in the same series
    • Endorsement

      public static final TextTypes Endorsement
      A quote usually provided by a celebrity or another author to promote a new book, not from a review
    • Promotional_headline

      public static final TextTypes Promotional_headline
      A promotional phrase which is intended to headline a description of the product
    • Feature

      public static final TextTypes Feature
      Text describing a feature of a product to which the publisher wishes to draw attention for promotional purposes. Each separate feature should be described by a separate repeat, so that formatting can be applied at the discretion of the receiver of the ONIX record, or multiple features can be described using appropriate XHTML markup
    • Biographical_note

      public static final TextTypes Biographical_note
      A note referring to all contributors to a product - NOT linked to a single contributor
    • Publishers_notice

      public static final TextTypes Publishers_notice
      A statement included by a publisher in fulfillment of contractual obligations, such as a disclaimer, sponsor statement, or legal notice of any sort. Note that the inclusion of such a notice cannot and does not imply that a user of the ONIX record is obliged to reproduce it
    • Excerpt

      public static final TextTypes Excerpt
      A short excerpt from the main text of the work
    • Index

      public static final TextTypes Index
      Used for an index sent as a single text field, which may be structured using XHTML
    • Short_description_annotation_for_collection

      public static final TextTypes Short_description_annotation_for_collection
      (of which the product is a part.) Limited to a maximum of 350 characters
    • Description_for_collection

      public static final TextTypes Description_for_collection
      (of which the product is a part.) Length unrestricted
    • New_feature

      public static final TextTypes New_feature
      As code 11 but used for a new feature of this edition or version
    • Version_history

      public static final TextTypes Version_history
    • Open_access_statement

      public static final TextTypes Open_access_statement
      Short summary statement of open access status and any related conditions (eg 'Open access - no commercial use'), primarily for marketing purposes. Should always be accompanied by a link to the complete license (see <EpubLicense> or code 99 in List 158)
    • Digital_exclusivity_statement

      public static final TextTypes Digital_exclusivity_statement
      Short summary statement that the product is available only in digital formats (eg 'Digital exclusive'). If a non-digital version is planned, <ContentDate> should be used to specify the date when exclusivity will end (use content date role code 15). If a non-digital version is available, the statement should not be included
    • Official_recommendation

      public static final TextTypes Official_recommendation
      For example a recommendation or approval provided by a ministry of education or other official body. Use <Text> to provide details and ideally use <TextSourceCorporate> to name the approver
    • JBPA_description

      public static final TextTypes JBPA_description
      Short description in format specified by Japanese Book Publishers Association
    • schema_org_snippet

      public static final TextTypes schema_org_snippet
      JSON-LD snippet suitable for use within an HTML <script type="application/ld+json"> tag, containing structured metadata suitable for use with schema.org
    • Errata

      public static final TextTypes Errata
      Jonix-Comment: Introduced in Onix3
    • Introduction

      public static final TextTypes Introduction
      Introduction, preface or the text of other preliminary material, sent as a single text field, which may be structured using XHTML

      Jonix-Comment: Introduced in Onix3

    • Secondary_cover_copy

      public static final TextTypes Secondary_cover_copy
      Secondary descriptive blurb taken from the cover/jacket flaps, or occasionally from the back cover or jacket, used only when there are two separate texts and the primary text is included using code 05

      Jonix-Comment: Introduced in Onix3

    • Full_cast_and_credit_list

      public static final TextTypes Full_cast_and_credit_list
      For use with dramatized audiobooks, filmed entertainment etc, for a cast list sent as a single text field, which may or may not carry structure expressed using XHTML

      Jonix-Comment: Introduced in Onix3

    • Bibliography

      public static final TextTypes Bibliography
      Complete list of books by the author(s), supplied as a single text field, which may be structured using (X)HTML

      Jonix-Comment: Introduced in Onix3

    • Abstract

      public static final TextTypes Abstract
      Formal summary of content (normally used with academic and scholarly content only)

      Jonix-Comment: Introduced in Onix3

    • Rules_or_instructions

      public static final TextTypes Rules_or_instructions
      Eg for a game, kit

      Jonix-Comment: Introduced in Onix3

    • List_of_contents

      public static final TextTypes List_of_contents
      Eg for a game, kit. Note: use code 04 for a Table of Contents of a book

      Jonix-Comment: Introduced in Onix3

    • Short_description_annotation_for_imprint

      public static final TextTypes Short_description_annotation_for_imprint
      Length limited to a maximum of 350 characters

      Jonix-Comment: Introduced in Onix3

    • Description_for_imprint

      public static final TextTypes Description_for_imprint
      Length unrestricted

      Jonix-Comment: Introduced in Onix3

    • Short_description_annotation_for_publisher

      public static final TextTypes Short_description_annotation_for_publisher
      Length limited to a maximum of 350 characters

      Jonix-Comment: Introduced in Onix3

    • Description_for_publisher

      public static final TextTypes Description_for_publisher
      Length unrestricted

      Jonix-Comment: Introduced in Onix3

    • Cover_line

      public static final TextTypes Cover_line
      (US) Reading line - line of usually explanatory copy on cover, somewhat like a subtitle but not on the title page and added by the publisher, eg 'with 125 illustrated recipes'

      Jonix-Comment: Introduced in Onix3

  • Field Details

    • code

      public final String code
    • description

      public final String description
  • Method Details

    • values

      public static TextTypes[] values()
      Returns an array containing the constants of this enum class, in the order they are declared.
      Returns:
      an array containing the constants of this enum class, in the order they are declared
    • valueOf

      public static TextTypes valueOf(String name)
      Returns the enum constant of this class with the specified name. The string must match exactly an identifier used to declare an enum constant in this class. (Extraneous whitespace characters are not permitted.)
      Parameters:
      name - the name of the enum constant to be returned.
      Returns:
      the enum constant with the specified name
      Throws:
      IllegalArgumentException - if this enum class has no constant with the specified name
      NullPointerException - if the argument is null
    • getCode

      public String getCode()
      Specified by:
      getCode in interface OnixCodelist
    • getDescription

      public String getDescription()
      Specified by:
      getDescription in interface OnixCodelist
    • byCode

      public static TextTypes byCode(String code)
    • byCodeOptional

      public static Optional<TextTypes> byCodeOptional(String code)
    • codeToDesciption

      public static String codeToDesciption(String code)