Module jonix.onix3

Package com.tectonica.jonix.onix3

Class ResourceFileContentDescription

java.lang.Object

com.tectonica.jonix.onix3.ResourceFileContentDescription

All Implemented Interfaces:

OnixElement<String>, OnixTag, Serializable

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

Resource file content description

The content contained in the resource may be described, for manual confirmation – for example ‘Foil block overlay’ or ‘CMYK separations of rear cover’.

Note that individual resources do not need to be aligned with the physical organization of the book (eg with the folded signatures of a print-on-demand product), nor with the logical organization (eg with the chapters in the work).

The field is optional but may only be used when <ResourceFileLink> is present, and is repeatable to provide parallel descriptions in multiple languages. The language attribute is optional for a single instance of <ResourceFileContentDescription>, but must be included in each instance if <ResourceFileContentDescription> is repeated to provide parallel descriptions in multiple languages.

Format	Variable length text, suggested maximum length 500 characters
Reference name	<ResourceFileContentDescription>
Short tag	<x576>
Cardinality	0…n
Attributes	language
Example	<ResourceFileContentDescription>Chapters 2 and 3</ResourceFileContentDescription>

This tag may be included in the following composites:

• <CoverResource>
• <BodyResource>
• <InsertResource>

Possible placements within ONIX message:

• Product ⯈ ProductionDetail ⯈ ProductionManifest ⯈ SupplementManifest ⯈ CoverManifest ⯈ CoverResource ⯈ ResourceFileContentDescription
• Product ⯈ ProductionDetail ⯈ ProductionManifest ⯈ CoverManifest ⯈ CoverResource ⯈ ResourceFileContentDescription
• Product ⯈ ProductionDetail ⯈ ProductionManifest ⯈ SupplementManifest ⯈ BodyManifest ⯈ BodyResource ⯈ ResourceFileContentDescription
• Product ⯈ ProductionDetail ⯈ ProductionManifest ⯈ BodyManifest ⯈ BodyResource ⯈ ResourceFileContentDescription
• Product ⯈ ProductionDetail ⯈ ProductionManifest ⯈ SupplementManifest ⯈ InsertManifest ⯈ InsertResource ⯈ ResourceFileContentDescription
• Product ⯈ ProductionDetail ⯈ ProductionManifest ⯈ InsertManifest ⯈ InsertResource ⯈ ResourceFileContentDescription

Since:

Onix-3.08

See Also:

• Serialized Form

Field Summary

Fields

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

Constructor Summary

Constructors

Constructor	Description
ResourceFileContentDescription()
ResourceFileContentDescription(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<ResourceFileContentDescription> 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

language

public Languages language

value

public String value

This is the raw content of ResourceFileContentDescription. 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 length 500 characters

(type: dt.NonEmptyString)

EMPTY

public static final ResourceFileContentDescription EMPTY

Constructor Details

ResourceFileContentDescription

public ResourceFileContentDescription()

ResourceFileContentDescription

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

ifExists

public void ifExists(Consumer<ResourceFileContentDescription> action)