Module jonix.onix3

Package com.tectonica.jonix.onix3

Class Date

java.lang.Object

com.tectonica.jonix.onix3.Date

All Implemented Interfaces:

OnixElement<String>, OnixTag, Serializable

public class Date
extends Object
implements OnixElement<String>, Serializable

Date

The date specified in the <EpubLicenseDateRole> field. Mandatory in each occurrence of the <EpubLicenseDate> composite, and non-repeating. <Date> may carry a dateformat attribute: if the attribute is missing, then the default format is YYYYMMDD.

Format	As specified by the value in the dateformat attribute, or the default YYYYMMDD
Reference name	<Date>
Short tag	<b306>
Cardinality	1
Attributes	dateformat
Example	<Date>20221028</Date>
Notes	Note that all dates are inclusive, so 'Valid from' is the first date on which the license is effective, and 'Valid until' is the last date on which it is effective.

This tag may be included in the following composites:

• <PublishingDate>
• <SupplyDate>
• <MarketDate>
• <ContributorDate>
• <ContentDate>
• <SubjectDate>
• <ResourceFileDate>
• <PriceDate>
• <OccurrenceDate>
• <EpubLicenseDate>

Possible placements within ONIX message:

• Product ⯈ PublishingDetail ⯈ PublishingDate ⯈ Date
• Product ⯈ ProductSupply ⯈ SupplyDetail ⯈ SupplyDate ⯈ Date
• Product ⯈ ProductSupply ⯈ MarketPublishingDetail ⯈ MarketDate ⯈ Date
• Product ⯈ DescriptiveDetail ⯈ Contributor ⯈ ContributorDate ⯈ Date
• Product ⯈ ContentDetail ⯈ ContentItem ⯈ Contributor ⯈ ContributorDate ⯈ Date
• Product ⯈ PromotionDetail ⯈ PromotionalEvent ⯈ Contributor ⯈ ContributorDate ⯈ Date
• Product ⯈ DescriptiveDetail ⯈ Collection ⯈ Contributor ⯈ ContributorDate ⯈ Date
• Product ⯈ ContentDetail ⯈ ContentItem ⯈ TextContent ⯈ ContentDate ⯈ Date
• Product ⯈ CollateralDetail ⯈ TextContent ⯈ ContentDate ⯈ Date
• Product ⯈ ContentDetail ⯈ ContentItem ⯈ CitedContent ⯈ ContentDate ⯈ Date
• Product ⯈ CollateralDetail ⯈ CitedContent ⯈ ContentDate ⯈ Date
• Product ⯈ ContentDetail ⯈ ContentItem ⯈ SupportingResource ⯈ ResourceVersion ⯈ ContentDate ⯈ Date
• Product ⯈ CollateralDetail ⯈ SupportingResource ⯈ ResourceVersion ⯈ ContentDate ⯈ Date
• Product ⯈ PromotionDetail ⯈ PromotionalEvent ⯈ EventOccurrence ⯈ SupportingResource ⯈ ResourceVersion ⯈ ContentDate ⯈ Date
• Product ⯈ PromotionDetail ⯈ PromotionalEvent ⯈ SupportingResource ⯈ ResourceVersion ⯈ ContentDate ⯈ Date
• Product ⯈ DescriptiveDetail ⯈ NameAsSubject ⯈ SubjectDate ⯈ Date
• Product ⯈ ContentDetail ⯈ ContentItem ⯈ NameAsSubject ⯈ SubjectDate ⯈ Date
• Product ⯈ ProductionDetail ⯈ ProductionManifest ⯈ SupplementManifest ⯈ CoverManifest ⯈ CoverResource ⯈ ResourceFileDate ⯈ Date
• Product ⯈ ProductionDetail ⯈ ProductionManifest ⯈ CoverManifest ⯈ CoverResource ⯈ ResourceFileDate ⯈ Date
• Product ⯈ ProductionDetail ⯈ ProductionManifest ⯈ SupplementManifest ⯈ BodyManifest ⯈ BodyResource ⯈ ResourceFileDate ⯈ Date
• Product ⯈ ProductionDetail ⯈ ProductionManifest ⯈ BodyManifest ⯈ BodyResource ⯈ ResourceFileDate ⯈ Date
• Product ⯈ ProductionDetail ⯈ ProductionManifest ⯈ SupplementManifest ⯈ InsertManifest ⯈ InsertResource ⯈ ResourceFileDate ⯈ Date
• Product ⯈ ProductionDetail ⯈ ProductionManifest ⯈ InsertManifest ⯈ InsertResource ⯈ ResourceFileDate ⯈ Date
• Product ⯈ ProductSupply ⯈ SupplyDetail ⯈ Price ⯈ PriceDate ⯈ Date
• Product ⯈ PromotionDetail ⯈ PromotionalEvent ⯈ EventOccurrence ⯈ OccurrenceDate ⯈ Date
• Product ⯈ DescriptiveDetail ⯈ EpubLicenseWithDateType ⯈ EpubLicenseDate ⯈ Date
• Product ⯈ ContentDetail ⯈ ContentItem ⯈ EpubLicenseWithDateType ⯈ EpubLicenseDate ⯈ Date
• Product ⯈ ContentDetail ⯈ ContentItem ⯈ TextContent ⯈ EpubLicenseWithDateType ⯈ EpubLicenseDate ⯈ Date
• Product ⯈ CollateralDetail ⯈ TextContent ⯈ EpubLicenseWithDateType ⯈ EpubLicenseDate ⯈ Date
• Product ⯈ ContentDetail ⯈ ContentItem ⯈ SupportingResource ⯈ ResourceVersion ⯈ EpubLicenseWithDateType ⯈ EpubLicenseDate ⯈ Date
• Product ⯈ CollateralDetail ⯈ SupportingResource ⯈ ResourceVersion ⯈ EpubLicenseWithDateType ⯈ EpubLicenseDate ⯈ Date
• Product ⯈ PromotionDetail ⯈ PromotionalEvent ⯈ EventOccurrence ⯈ SupportingResource ⯈ ResourceVersion ⯈ EpubLicenseWithDateType ⯈ EpubLicenseDate ⯈ Date
• Product ⯈ PromotionDetail ⯈ PromotionalEvent ⯈ SupportingResource ⯈ ResourceVersion ⯈ EpubLicenseWithDateType ⯈ EpubLicenseDate ⯈ Date

Since:

Onix-3.10

See Also:

• Serialized Form

Field Summary

Fields

Modifier and Type	Field	Description
DateFormats	dateformat
String	datestamp	(type: dt.DateOrDateTime)
static final Date	EMPTY
static final String	refname
static final String	shortname
String	sourcename	(type: dt.NonEmptyString)
RecordSourceTypes	sourcetype
String	value	This is the raw content of Date.

Constructor Summary

Constructors

Constructor	Description
Date()
Date(Element element)

Method Summary

Modifier and Type	Method	Description
String	__v()	Internal API, use the OnixElement.value() method or the OnixElement.value() field instead
boolean	exists()	indicates whether this tag exists in the ONIX record
void	ifExists(Consumer<Date> 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

datestamp

public String datestamp

(type: dt.DateOrDateTime)

sourcename

public String sourcename

(type: dt.NonEmptyString)

sourcetype

public RecordSourceTypes sourcetype

dateformat

public DateFormats dateformat

value

public String value

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

Raw Format: As specified by the value in the dateformat attribute, or the default YYYYMMDD

(type: dt.NonEmptyString)

EMPTY

public static final Date EMPTY

Constructor Details

Date

public Date()

Date

public Date(Element element)

Method Details

__v

public String __v()

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

Specified by:

__v in interface OnixElement<String>

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

ifExists

public void ifExists(Consumer<Date> action)