Module jonix.onix3

Package com.tectonica.jonix.onix3

Class ResourceFileDescription

java.lang.Object

com.tectonica.jonix.onix3.ResourceFileDescription

All Implemented Interfaces:

OnixElement<String>, OnixTag, Serializable

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

Resource file description

If the Resource file details and features do not adequately describe the resource, a short text description may be added to give a more detailed description. The field is optional but may only be used when <ResourceFileLink> is present, and is repeatable to provide parallel specifications in multiple languages. The language attribute is optional for a single instance of <ResourceFileDescription>, but must be included in each instance if <ResourceFileDescription> is repeated to provide parallel descriptions in multiple languages.

Format	Variable length text, suggested maximum length 500 characters
Reference name	<ResourceFileDescription>
Short tag	<x571>
Cardinality	0…n
Attributes	language
Example	<ResourceFileDescription>96kHz sampling frequency, 16-bit sample depth, uncompressed</ResourceFileDescription>

This tag may be included in the following composites:

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

Possible placements within ONIX message:

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

Since:

Onix-3.08

See Also:

• Serialized Form

Field Summary

Fields

Modifier and Type	Field	Description
String	datestamp	(type: dt.DateOrDateTime)
static final ResourceFileDescription	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 ResourceFileDescription.

Constructor Summary

Constructors

Constructor	Description
ResourceFileDescription()
ResourceFileDescription(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<ResourceFileDescription> 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 ResourceFileDescription. 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 ResourceFileDescription EMPTY

Constructor Details

ResourceFileDescription

public ResourceFileDescription()

ResourceFileDescription

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

ifExists

public void ifExists(Consumer<ResourceFileDescription> action)