Module jonix.onix3
Package com.tectonica.jonix.onix3

Class BodyResource

java.lang.Object
com.tectonica.jonix.onix3.BodyResource
All Implemented Interfaces:
OnixComposite, OnixComposite.OnixSuperComposite, OnixTag, Serializable
public class BodyResource extends Object implements OnixComposite.OnixSuperComposite, Serializable

Body resource composite

A group of data elements that together provide details of a single file or resource of which the body is composed. At least one resource is required in each <BodyManifest>, and the <BodyResource> composite is repeatable to describe multiple resources.

Reference name <BodyResource>
Short tag <bodyresource>
Cardinality 1…n

This tag may be included in the following composites:

Possible placements within ONIX message:

Since:
Onix-3.08
See Also:

  • Field Details

  • Constructor Details

    • BodyResource

      public BodyResource()

    • BodyResource

      public BodyResource(Element element)

  • Method Details

    • _initialize

      public void _initialize()
      Description copied from interface: OnixComposite
      This is an internal API. Since Jonix 8.0, composite objects are being populated lazily. This method initiates the population process, and is invoked internally by the accessor APIs of the composites
      Specified by:
      _initialize in interface OnixComposite

    • 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 (<BodyResource> or <bodyresource>) is explicitly provided in the ONIX XML

    • ifExists

      public void ifExists(Consumer<BodyResource> action)

    • getXmlElement

      public Element getXmlElement()
      Description copied from interface: OnixComposite
      For advanced use-cases only.
      Specified by:
      getXmlElement in interface OnixComposite
      Returns:
      native representation of the XML element underlying to this tag

    • resourceFileLinks

      public ListOfOnixElement<ResourceFileLink,String> resourceFileLinks()

      A URL which provides a link to a resource. Mandatory in each occurrence of the <BodyResource> composite, and repeatable if the resource can be linked in more than one way, eg by HTTP, FTP and DOI URLs.

      Jonix-Comment: this list is required to contain at least one item

    • sequenceNumber

      public SequenceNumber sequenceNumber()

      A number which specifies a single overall sequence of body resources. Optional and non-repeating. It is strongly recommended that each occurrence of the <BodyResource> composite should carry a <SequenceNumber>, and that primary resources are numbered in ‘spine order’. Ancillary resources (eg an image file referenced by a primary HTML file) should be numbered after the primary resources.

      Jonix-Comment: this field is optional

    • resourceRole

      public ResourceRole resourceRole()

      An ONIX code which identifies the role or purpose of the resource file which is specified in <ResourceFileLink>. Optional and non-repeating.

      Jonix-Comment: this field is optional

    • resourceIdentifiers

      public ListOfOnixDataCompositeWithKey<ResourceIdentifier,JonixResourceIdentifier,ResourceIdentifierTypes> resourceIdentifiers()

      A group of data elements which together specify an identifier of the resource, in accordance with the specified scheme. The composite is optional, and repeatable to specify multiple identifiers for the resource.

      Jonix-Comment: this list may be empty

    • resourceFileDetails

      public ListOfOnixCodelist<ResourceFileDetail,ResourceFileDetails> resourceFileDetails()

      An ONIX code which provides added detail of the resource file which is specified in <ResourceFileLink>, eg the file type of the resource. Optional, and repeatable in order to provide multiple additional details.

      Jonix-Comment: this list may be empty

    • resourceFileFeatures

      public ListOfOnixDataCompositeWithKey<ResourceFileFeature,JonixResourceFileFeature,ResourceFileFeatureTypes> resourceFileFeatures()

      An optional group of data elements which together describe an aspect of a resource file specified in <ResourceFileLink> that is too specific to be covered in the <ResourceFileDetail> element. The composite is repeatable in order to describe different aspects of the resource file.

      Jonix-Comment: this list may be empty

    • resourceFileDescriptions

      public ListOfOnixElement<ResourceFileDescription,String> resourceFileDescriptions()

      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, 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.

      Jonix-Comment: this list may be empty

    • resourceFileContentDescriptions

      public ListOfOnixElement<ResourceFileContentDescription,String> resourceFileContentDescriptions()

      The content contained in the resource may be described, for manual confirmation – for example ‘Chapters 2 and 3’ or ‘CMYK separations pages 16–31’.

      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, 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.

      Jonix-Comment: this list may be empty

    • resourceFileDates

      public ListOfOnixDataCompositeWithKey<ResourceFileDate,JonixResourceFileDate,ResourceFileDateRoles> resourceFileDates()

      An optional group of data elements which together specify a date associated with the resource file specified in <ResourceFileLink>, eg date when the resource was last updated. Repeatable to specify different dates with their various roles.

      Jonix-Comment: this list may be empty