Module jonix.onix2

Package com.tectonica.jonix.onix2

Class EpubFormat

java.lang.Object

com.tectonica.jonix.onix2.EpubFormat

All Implemented Interfaces:

OnixElement<EpublicationFormats>, OnixTag, Serializable

public class EpubFormat
extends Object
implements OnixElement<EpublicationFormats>, Serializable

Epublication format code

An ONIX code identifying the underlying format of an epublication. Optional and non-repeating, and can occur only if the <EpubType> field is present. Note that where the epublication type is wholly defined by the delivery format, this element effectively duplicates the <EpubType> field.

Format	Fixed-length, 2 numeric digits
Codelist	List 11
Reference name	<EpubFormat>
Short tag	<b214>
Example	<b214>02</b214>

This tag may be included in the following composites:

• <Product>
• <RelatedProduct>

Possible placements within ONIX message:

• Product ⯈ EpubFormat
• Product ⯈ RelatedProduct ⯈ EpubFormat

See Also:

• Serialized Form

Field Summary

Fields

Modifier and Type	Field	Description
String	datestamp	(type: DateOrDateTime)
static final EpubFormat	EMPTY
Languages	language
static final String	refname
static final String	shortname
String	sourcename
RecordSourceTypes	sourcetype
TextCaseFlags	textcase
TextFormats	textformat
TransliterationSchemes	transliteration
EpublicationFormats	value

Constructor Summary

Constructors

Constructor	Description
EpubFormat()
EpubFormat(Element element)

Method Summary

Modifier and Type	Method	Description
EpublicationFormats	__v()	Internal API, use the OnixElement.value() method or the OnixElement.value() field instead
String	codeOrNull()
String	descriptionOrNull()
boolean	exists()	indicates whether this tag exists in the ONIX record
void	ifExists(Consumer<EpubFormat> action)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface com.tectonica.jonix.common.OnixElement

equal, is, isNull, value

Field Details

refname

public static final String refname

See Also:

• Constant Field Values

shortname

public static final String shortname

See Also:

• Constant Field Values

textformat

public TextFormats textformat

textcase

public TextCaseFlags textcase

language

public Languages language

transliteration

public TransliterationSchemes transliteration

datestamp

public String datestamp

(type: DateOrDateTime)

sourcetype

public RecordSourceTypes sourcetype

sourcename

public String sourcename

value

public EpublicationFormats value

EMPTY

public static final EpubFormat EMPTY

Constructor Details

EpubFormat

public EpubFormat()

EpubFormat

public EpubFormat(Element element)

Method Details

__v

public EpublicationFormats __v()

Internal API, use the OnixElement.value() method or the OnixElement.value() field instead

Specified by:

__v in interface OnixElement<EpublicationFormats>

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 (<EpubFormat> or <b214>) is explicitly provided in the ONIX XML

ifExists

public void ifExists(Consumer<EpubFormat> action)

codeOrNull

public String codeOrNull()

descriptionOrNull

public String descriptionOrNull()